blob: 73409b7893e63ccf441a9794983da5595815f8df [file] [log] [blame]
Bram Moolenaar86b48162022-12-06 18:20:10 +00001*options.txt* For Vim version 9.0. Last change: 2022 Nov 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...
37
Bram Moolenaar47003982021-12-05 21:54:04 +000038:se[t]! termcap Idem, but don't use multiple columns.
39
Bram Moolenaar071d4272004-06-13 20:20:40 +000040 *E518* *E519*
41:se[t] {option}? Show value of {option}.
42
43:se[t] {option} Toggle option: set, switch it on.
44 Number option: show value.
45 String option: show value.
46
47:se[t] no{option} Toggle option: Reset, switch it off.
48
Bram Moolenaar00a927d2010-05-14 23:24:24 +020049 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000050:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020051:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
53 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
54:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020055 current value of 'compatible'.
56:se[t] {option}&vi Reset option to its Vi default value.
57:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010059:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020060 these options are not changed:
61 all terminal options, starting with t_
62 'columns'
63 'cryptmethod'
64 'encoding'
65 'key'
66 'lines'
67 'term'
68 'ttymouse'
69 'ttytype'
70 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000071
72 *:set-args* *E487* *E521*
73:se[t] {option}={value} or
74:se[t] {option}:{value}
75 Set string or number option to {value}.
76 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010077 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000078 The old value can be inserted by typing 'wildchar' (by
79 default this is a <Tab> or CTRL-E if 'compatible' is
80 set). See |cmdline-completion|.
81 White space between {option} and '=' is allowed and
82 will be ignored. White space between '=' and {value}
83 is not allowed.
84 See |option-backslash| for using white space and
85 backslashes in {value}.
86
87:se[t] {option}+={value} *:set+=*
88 Add the {value} to a number option, or append the
89 {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010090 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 value was empty.
92 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000093 are removed. When adding a flag that was already
94 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000095 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000096
97:se[t] {option}^={value} *:set^=*
98 Multiply the {value} to a number option, or prepend
99 the {value} to a string option. When the option is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100100 comma-separated list, a comma is added, unless the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101 value was empty.
102 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
104:se[t] {option}-={value} *:set-=*
105 Subtract the {value} from a number option, or remove
106 the {value} from a string option, if it is there.
107 If the {value} is not found in a string option, there
108 is no error or warning. When the option is a comma
109 separated list, a comma is deleted, unless the option
110 becomes empty.
111 When the option is a list of flags, {value} must be
112 exactly as they appear in the option. Remove flags
113 one by one to avoid problems.
114 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116The {option} arguments to ":set" may be repeated. For example: >
117 :set ai nosi sw=3 ts=3
118If you make an error in one of the arguments, an error message will be given
119and the following arguments will be ignored.
120
121 *:set-verbose*
122When 'verbose' is non-zero, displaying an option value will also tell where it
123was last set. Example: >
124 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200125< shiftwidth=4 ~
126 Last set from modeline line 1 ~
127 cindent ~
128 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000129This is only done when specific option values are requested, not for ":verbose
130set all" or ":verbose set" without an argument.
131When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132When the option was set while executing a function, user command or
133autocommand, the script in which it was defined is reported.
134Note that an option may also have been set as a side effect of setting
135'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200137 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000138 Option was set in a |modeline|.
139 Last set from --cmd argument ~
140 Option was set with command line argument |--cmd| or +.
141 Last set from -c argument ~
142 Option was set with command line argument |-c|, +, |-S| or
143 |-q|.
144 Last set from environment variable ~
145 Option was set from an environment variable, $VIMINIT,
146 $GVIMINIT or $EXINIT.
147 Last set from error handler ~
148 Option was cleared when evaluating it resulted in an error.
149
Bram Moolenaardb84e452010-08-15 13:50:43 +0200150{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000153For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000154override the value from the termcap. You can then use it in a mapping. If
155the "xx" part contains special characters, use the <t_xx> form: >
156 :set <t_#4>=^[Ot
157This can also be used to translate a special code for a normal key. For
158example, if Alt-b produces <Esc>b, use this: >
159 :set <M-b>=^[b
160(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
161The advantage over a mapping is that it works in all situations.
162
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100163You can define any key codes, e.g.: >
164 :set t_xy=^[foo;
165There is no warning for using a name that isn't recognized. You can map these
166codes as you like: >
167 :map <t_xy> something
168< *E846*
169When a key code is not set, it's like it does not exist. Trying to get its
170value will result in an error: >
171 :set t_kb=
172 :set t_kb
Bram Moolenaar6f4754b2022-01-23 12:07:04 +0000173< E846: Key code not set: t_kb ~
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100174
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000175The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
176security reasons.
177
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000179at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180"set all" probably does not fit on the screen, causing Vim to give the
181|more-prompt|.
182
183 *option-backslash*
184To include white space in a string option value it has to be preceded with a
185backslash. To include a backslash you have to use two. Effectively this
186means that the number of backslashes in an option value is halved (rounded
187down).
188A few examples: >
189 :set tags=tags\ /usr/tags results in "tags /usr/tags"
190 :set tags=tags\\,file results in "tags\,file"
191 :set tags=tags\\\ file results in "tags\ file"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193The "|" character separates a ":set" command from a following command. To
194include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195'titlestring' option to "hi|there": >
196 :set titlestring=hi\|there
197This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
198 :set titlestring=hi|set iconstring=there
199
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200200Similarly, in legacy script the double quote character starts a comment. To
201include the '"' in the option value, use '\"' instead. This example sets the
202'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000203 :set titlestring=hi\ \"there\"
204
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200205In |Vim9| script it's simpler, comments start with a '#' character, and only
206when preceded by white space. A backslash is needed less often: >
207 vim9script
208 set titlestring=hi\ "there"
209 set titlestring=hi#there#
210 set titlestring=hi\ \#there#
211
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100212For Win32 backslashes in file names are mostly not removed. More precise: For
213options that expect a file name (those where environment variables are
214expanded) a backslash before a normal file name character is not removed. But
215a backslash before a special character (space, backslash, comma, etc.) is used
216like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217There is one special situation, when the value starts with "\\": >
218 :set dir=\\machine\path results in "\\machine\path"
219 :set dir=\\\\machine\\path results in "\\machine\path"
220 :set dir=\\path\\file results in "\\path\file" (wrong!)
221For the first one the start is kept, but for the second one the backslashes
222are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000223halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224result which is probably not what you want. Avoid it.
225
226 *add-option-flags* *remove-option-flags*
227 *E539* *E550* *E551* *E552*
228Some options are a list of flags. When you want to add a flag to such an
229option, without changing the existing ones, you can do it like this: >
230 :set guioptions+=a
231Remove a flag from an option like this: >
232 :set guioptions-=a
233This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000234Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
236doesn't appear.
237
238 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000239Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240environment variable exists the '$' and the following environment variable
241name is replaced with its value. If it does not exist the '$' and the name
242are not modified. Any non-id character (not a letter, digit or '_') may
243follow the environment variable name. That character and what follows is
244appended to the value of the environment variable. Examples: >
245 :set term=$TERM.new
246 :set path=/usr/$INCLUDE,$HOME/include,.
247When adding or removing a string from an option with ":set opt-=val" or ":set
248opt+=val" the expansion is done before the adding or removing.
249
250
251Handling of local options *local-options*
252
253Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100254has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255allows you to set 'list' in one window but not in another. And set
256'shiftwidth' to 3 in one buffer and 4 in another.
257
258The following explains what happens to these local options in specific
259situations. You don't really need to know all of this, since Vim mostly uses
260the option values you would expect. Unfortunately, doing what the user
261expects is a bit complicated...
262
263When splitting a window, the local options are copied to the new window. Thus
264right after the split the contents of the two windows look the same.
265
266When editing a new buffer, its local option values must be initialized. Since
267the local options of the current buffer might be specifically for that buffer,
268these are not used. Instead, for each buffer-local option there also is a
269global value, which is used for new buffers. With ":set" both the local and
270global value is changed. With "setlocal" only the local value is changed,
271thus this value is not used when editing a new buffer.
272
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200273When editing a buffer that has been edited before, the options from the window
274that was last closed are used again. If this buffer has been edited in this
275window, the values from back then are used. Otherwise the values from the
276last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278It's possible to set a local window option specifically for a type of buffer.
279When you edit another buffer in the same window, you don't want to keep
280using these local window options. Therefore Vim keeps a global value of the
281local window options, which is used when editing another buffer. Each window
282has its own copy of these values. Thus these are local to the window, but
283global to all buffers in the window. With this you can do: >
284 :e one
285 :set list
286 :e two
287Now the 'list' option will also be set in "two", since with the ":set list"
288command you have also set the global value. >
289 :set nolist
290 :e one
291 :setlocal list
292 :e two
293Now the 'list' option is not set, because ":set nolist" resets the global
294value, ":setlocal list" only changes the local value and ":e two" gets the
295global value. Note that if you do this next: >
296 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200297You will get back the 'list' value as it was the last time you edited "one".
298The options local to a window are remembered for each buffer. This also
299happens when the buffer is not loaded, but they are lost when the buffer is
300wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100303:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 current buffer or window. Not all options have a
305 local value. If the option does not have a local
306 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200307 With the "all" argument: display local values for all
308 local options.
309 Without argument: Display local values for all local
310 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000312 local value. For a global/local boolean option, when
313 the global value is being used, "--" is displayed
314 before the option name.
315 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318:setl[ocal] {option}< Set the local value of {option} to its global value by
319 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000320
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100321:se[t] {option}< For |global-local| options: Remove the local value of
322 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100325:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 option without changing the local value.
327 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200328 With the "all" argument: display global values for all
329 local options.
330 Without argument: display global values for all local
331 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333For buffer-local and window-local options:
334 Command global value local value ~
335 :set option=value set set
336 :setlocal option=value - set
337:setglobal option=value set -
338 :set option? - display
339 :setlocal option? - display
340:setglobal option? display -
341
342
343Global options with a local value *global-local*
344
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000345Options are global when you mostly use one value for all buffers and windows.
346For some global options it's useful to sometimes have a different local value.
347You can set the local value with ":setlocal". That buffer or window will then
348use the local value, while other buffers and windows continue using the global
349value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350
351For example, you have two windows, both on C source code. They use the global
352'makeprg' option. If you do this in one of the two windows: >
353 :set makeprg=gmake
354then the other window will switch to the same value. There is no need to set
355the 'makeprg' option in the other C source window too.
356However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000357another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000358files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal makeprg=perlmake
360You can switch back to using the global value by making the local value empty: >
361 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100362This only works for a string option. For a number or boolean option you need
363to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100365Note that for non-boolean and non-number options using "<" copies the global
366value to the local value, it doesn't switch back to using the global value
367(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000368 :set path<
369This will make the local value of 'path' empty, so that the global value is
370used. Thus it does the same as: >
371 :setlocal path=
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000372Note: In the future more global options can be made |global-local|. Using
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373":setlocal" on a global option might work differently then.
374
375
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000376 *option-value-function*
377Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +0000378'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000379a function name or a function reference or a lambda function. When using a
380lambda it will be converted to the name, e.g. "<lambda>123". Examples:
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000381>
382 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000383 set opfunc=function('MyOpFunc')
384 set opfunc=funcref('MyOpFunc')
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000385 set opfunc={a\ ->\ MyOpFunc(a)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000386
387Set to a script-local function: >
388 set opfunc=s:MyLocalFunc
389 set opfunc=<SID>MyLocalFunc
390In |Vim9| script the "s:" and "<SID>" can be omitted if the function exists in
391the script: >
392 set opfunc=MyLocalFunc
393
394Set using a funcref variable: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000395 let Fn = function('MyTagFunc')
Bram Moolenaarfa3b7232021-12-24 13:18:38 +0000396 let &tagfunc = Fn
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000397
398Set using a lambda expression: >
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000399 let &tagfunc = {t -> MyTagFunc(t)}
Bram Moolenaar1fca5f32022-02-18 17:50:47 +0000400
401Set using a variable with lambda expression: >
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000402 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000403 let &tagfunc = L
Bram Moolenaar7b1463b2021-12-11 17:24:39 +0000404
405In Vim9 script, in a compiled function, you can use a lambda, but a
406closured does not work, because the function will be called without the
407context of where it was defined.
408
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000409
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410Setting the filetype
411
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200412:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413 Set the 'filetype' option to {filetype}, but only if
414 not done yet in a sequence of (nested) autocommands.
415 This is short for: >
416 :if !did_filetype()
417 : setlocal filetype={filetype}
418 :endif
419< This command is used in a filetype.vim file to avoid
420 setting the 'filetype' option twice, causing different
421 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200422
423 When the optional FALLBACK argument is present, a
424 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100425 'filetype'. This is to be used for filetype
426 detections that are just a guess. |did_filetype()|
427 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200428
Bram Moolenaard58e9292011-02-09 17:07:58 +0100429 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
431:opt[ions] Open a window for viewing and setting all options.
432 Options are grouped by function.
433 Offers short help for each option. Hit <CR> on the
434 short help to open a help window with more help for
435 the option.
436 Modify the value of the option and hit <CR> on the
437 "set" line to set the new value. For window and
438 buffer specific options, the last accessed window is
439 used to set the option value in, unless this is a help
440 window, in which case the window below help window is
441 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100442 {not available when compiled without the |+eval|
443 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444
445 *$HOME*
446Using "~" is like using "$HOME", but it is only recognized at the start of an
447option and after a space or comma.
448
449On Unix systems "~user" can be used too. It is replaced by the home directory
450of user "user". Example: >
451 :set path=~mool/include,/usr/include,.
452
453On Unix systems the form "${HOME}" can be used too. The name between {} can
454contain non-id characters then. Note that if you want to use this for the
455"gf" command, you need to add the '{' and '}' characters to 'isfname'.
456
457NOTE: expanding environment variables and "~/" is only done with the ":set"
458command, not when assigning a value to an option with ":let".
459
Bram Moolenaarc572da52017-08-27 16:52:01 +0200460 *$HOME-windows*
461On MS-Windows, if $HOME is not defined as an environment variable, then
462at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200463If $HOMEDRIVE is not set then $USERPROFILE is used.
464
465This expanded value is not exported to the environment, this matters when
466running an external command: >
467 :echo system('set | findstr ^HOME=')
468and >
469 :echo luaeval('os.getenv("HOME")')
470should echo nothing (an empty string) despite exists('$HOME') being true.
471When setting $HOME to a non-empty string it will be exported to the
472subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200473
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475Note the maximum length of an expanded option is limited. How much depends on
476the system, mostly it is something like 256 or 1024 characters.
477
478 *:fix* *:fixdel*
479:fix[del] Set the value of 't_kD':
480 't_kb' is 't_kD' becomes ~
481 CTRL-? CTRL-H
482 not CTRL-? CTRL-?
483
Bram Moolenaar82be4842021-01-11 19:40:15 +0100484 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485
486 If your delete key terminal code is wrong, but the
487 code for backspace is alright, you can put this in
488 your .vimrc: >
489 :fixdel
490< This works no matter what the actual code for
491 backspace is.
492
493 If the backspace key terminal code is wrong you can
494 use this: >
495 :if &term == "termname"
496 : set t_kb=^V<BS>
497 : fixdel
498 :endif
499< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000500 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000501 with your terminal name.
502
503 If your <Delete> key sends a strange key sequence (not
504 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
505 :if &term == "termname"
506 : set t_kD=^V<Delete>
507 :endif
508< Where "^V" is CTRL-V and "<Delete>" is the delete key
509 (don't type eight characters!). Replace "termname"
510 with your terminal name.
511
512 *Linux-backspace*
513 Note about Linux: By default the backspace key
514 produces CTRL-?, which is wrong. You can fix it by
515 putting this line in your rc.local: >
516 echo "keycode 14 = BackSpace" | loadkeys
517<
518 *NetBSD-backspace*
519 Note about NetBSD: If your backspace doesn't produce
520 the right code, try this: >
521 xmodmap -e "keycode 22 = BackSpace"
522< If this works, add this in your .Xmodmap file: >
523 keysym 22 = BackSpace
524< You need to restart for this to take effect.
525
526==============================================================================
5272. Automatically setting options *auto-setting*
528
529Besides changing options with the ":set" command, there are three alternatives
530to set options automatically for one or more files:
531
5321. When starting Vim initializations are read from various places. See
533 |initialization|. Most of them are performed for all editing sessions,
534 and some of them depend on the directory where Vim is started.
535 You can create an initialization file with |:mkvimrc|, |:mkview| and
536 |:mksession|.
5372. If you start editing a new file, the automatic commands are executed.
538 This can be used to set options for files matching a particular pattern and
539 many other things. See |autocommand|.
5403. If you start editing a new file, and the 'modeline' option is on, a
541 number of lines at the beginning and end of the file are checked for
542 modelines. This is explained here.
543
544 *modeline* *vim:* *vi:* *ex:* *E520*
545There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100546 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100548[text{white}] empty or any text followed by at least one blank
549 character (<Space> or <Tab>); "ex:" always requires at
550 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200551{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552[white] optional white space
553{options} a list of option settings, separated with white space
554 or ':', where each part between ':' is the argument
555 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556
Bram Moolenaar14b69452013-06-29 23:05:20 +0200557Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000558 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200559 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560
561The second form (this is compatible with some versions of Vi):
562
Bram Moolenaarade0d392020-01-21 22:33:58 +0100563 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaarade0d392020-01-21 22:33:58 +0100565[text{white}] empty or any text followed by at least one blank
566 character (<Space> or <Tab>); "ex:" always requires at
567 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200568{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
569[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200570se[t] the string "set " or "se " (note the space); When
571 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200572{options} a list of options, separated with white space, which
573 is the argument for a ":set" command
574: a colon
575[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
Bram Moolenaar14b69452013-06-29 23:05:20 +0200577Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000578 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200579 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200581The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
582chance that a normal word like "lex:" is caught. There is one exception:
583"vi:" and "vim:" can also be at the start of the line (for compatibility with
584version 3.0). Using "ex:" at the start of the line will be ignored (this
585could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586
Hu Jialun9dcd3492021-08-28 20:42:50 +0200587If the modeline is disabled within a modeline, subsequent modelines will be
588ignored. This is to allow turning off modeline on a per-file basis. This is
589useful when a line looks like a modeline but isn't. For example, it would be
590good to start a YAML file containing strings like "vim:" with
591 # vim: nomodeline ~
592so as to avoid modeline misdetection. Following options on the same line
593after modeline deactivation, if any, are still evaluated (but you would
594normally not have any).
595
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 *modeline-local*
597The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000598buffer and window that contain the file. Although it's possible to set global
599options from a modeline, this is unusual. If you have two windows open and
600the files in it set the same global option to a different value, the result
601depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000603When editing a file that was already loaded, only the window-local options
604from the modeline are used. Thus if you manually changed a buffer-local
605option after opening the file, it won't be changed if you edit the same buffer
606in another window. But window-local options will be set.
607
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608 *modeline-version*
609If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200610number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 vim{vers}: version {vers} or later
612 vim<{vers}: version before {vers}
613 vim={vers}: version {vers}
614 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100615{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
616For example, to use a modeline only for Vim 7.0:
617 /* vim700: set foldmethod=marker */ ~
618To use a modeline for Vim after version 7.2:
619 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620There can be no blanks between "vim" and the ":".
621
622
623The number of lines that are checked can be set with the 'modelines' option.
624If 'modeline' is off or 'modelines' is 0 no lines are checked.
625
626Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000627like:
628 /* vi:ts=4: */ ~
629will give an error message for the trailing "*/". This line is OK:
630 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
632If an error is detected the rest of the line is skipped.
633
634If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000635backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100636 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
637This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
638before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200639 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000641might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200642can be set. For some options a flag is set, so that when the value is used
643the |sandbox| is effective. Some options can only be set from the modeline
644when 'modelineexpr' is set (the default is off).
645
646Still, there is always a small risk that a modeline causes trouble. E.g.,
647when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
648So disable modelines before editing untrusted text. The mail ftplugin does
649this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650
651Hint: If you would like to do something else than setting an option, you could
652define an autocommand that checks the file for a specific string. For
653example: >
654 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
655And define a function SetVar() that does something with the line containing
656"VAR".
657
658==============================================================================
6593. Options summary *option-summary*
660
661In the list below all the options are mentioned with their full name and with
662an abbreviation if there is one. Both forms may be used.
663
664In this document when a boolean option is "set" that means that ":set option"
665is entered. When an option is "reset", ":set nooption" is used.
666
667For some options there are two default values: The "Vim default", which is
668used when 'compatible' is not set, and the "Vi default", which is used when
669'compatible' is set.
670
671Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000672are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673different value in each window. For example the 'list' option can be set in
674one window and reset in another for the same text, giving both types of view
675at the same time. There are a few options that are specific to a certain
676file. These can have a different value for each file or buffer. For example
677the 'textwidth' option can be 78 for a normal text file and 0 for a C
678program.
679
680 global one option for all buffers and windows
681 local to window each window has its own copy of this option
682 local to buffer each buffer has its own copy of this option
683
684When creating a new window the option values from the currently active window
685are used as a default value for the window-specific options. For the
686buffer-specific options this depends on the 's' and 'S' flags in the
687'cpoptions' option. If 's' is included (which is the default) the values for
688buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000689first entered. If 'S' is present the options are copied each time the buffer
690is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691present, the options are copied from the currently active buffer when the
692buffer is created.
693
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000694Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000696Not all options are supported in all versions. This depends on the supported
697features and sometimes on the system. A remark about this is in curly braces
698below. When an option is not supported it may still be set without getting an
699error, this is called a hidden option. You can't get the value of a hidden
700option though, it is not stored.
701
702To test if option "foo" can be used with ":set" use something like this: >
703 if exists('&foo')
704This also returns true for a hidden option. To test if option "foo" is really
705supported use something like this: >
706 if exists('+foo')
707<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 *E355*
709A jump table for the options with a short description can be found at |Q_op|.
710
711 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100712'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 {only available when compiled with the |+rightleft|
715 feature}
716 The ASCII code for the first letter of the Hebrew alphabet. The
717 routine that maps the keyboard in Hebrew mode, both in Insert mode
718 (when hkmap is set) and on the command-line (when hitting CTRL-_)
719 outputs the Hebrew characters in the range [aleph..aleph+26].
720 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
721 See |rileft.txt|.
722
723 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
724'allowrevins' 'ari' boolean (default off)
725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 {only available when compiled with the |+rightleft|
727 feature}
728 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
729 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
730 into reverse Insert mode, and don't know how to get out. See
731 'revins'.
732 NOTE: This option is reset when 'compatible' is set.
733
734 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
735'altkeymap' 'akm' boolean (default off)
736 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 {only available when compiled with the |+farsi|
738 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100739 This option was for using Farsi, which has been removed. See
740 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741
742 *'ambiwidth'* *'ambw'*
743'ambiwidth' 'ambw' string (default: "single")
744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
746 Tells Vim what to do with characters with East Asian Width Class
747 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
748 letters, Cyrillic letters).
749
750 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000751 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 expected by most users.
753 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200754 *E834* *E835*
755 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100756 contains a character that would be double width. These errors may
757 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200758
759 The values are overruled for characters specified with
760 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
762 There are a number of CJK fonts for which the width of glyphs for
763 those characters are solely based on how many octets they take in
764 legacy/traditional CJK encodings. In those encodings, Euro,
765 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000766 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000768 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Vim is running inside a terminal (emulators) that uses a CJK font
770 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
771 this option should be set to "double" to match the width perceived
772 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100773 to be set to "double" under CJK MS-Windows when the system locale is
774 set to one of CJK locales. See Unicode Standard Annex #11
775 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100777 Vim may set this option automatically at startup time when Vim is
778 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200779 escape sequence to request cursor position report. The response can
780 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100781
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
783'antialias' 'anti' boolean (default: off)
784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200786 on macOS}
787 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
789 which can be easier to read at certain sizes on certain displays.
790 Setting this option can sometimes cause problems if 'guifont' is set
791 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100792 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793
794 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
795'autochdir' 'acd' boolean (default off)
796 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200797 {only available when compiled with it, use
798 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000799 When on, Vim will change the current working directory whenever you
800 open a file, switch buffers, delete a buffer or open/close a window.
801 It will change to the directory containing the file which was opened
Bram Moolenaare8008642022-08-19 17:15:35 +0100802 or selected. When a buffer has no name it also has no directory, thus
803 the current directory won't change when navigating to it.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000804 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200806 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
807'autoshelldir' 'asd' boolean (default off)
808 global
809 When on, Vim will change the current working directory whenever you
810 change the directory of the shell running in a terminal window. You
811 need proper setting-up, so whenever the shell's pwd changes an OSC 7
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100812 escape sequence will be emitted. For example, on Linux, you can
813 source /etc/profile.d/vte.sh in your shell profile if you use bash or
814 zsh. For bash this should work (put it in a bash init file): >
815 if [[ -n "$VIM_TERMINAL" ]]; then
816 PROMPT_COMMAND='_vim_sync_PWD'
817 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100818 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100819 }
820 fi
821<
822 Or, in a zsh init file: >
823 if [[ -n "$VIM_TERMINAL" ]]; then
824 autoload -Uz add-zsh-hook
825 add-zsh-hook -Uz chpwd _vim_sync_PWD
826 function _vim_sync_PWD() {
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100827 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100828 }
829 fi
830<
831 In a fish init file: >
832 if test -n "$VIM_TERMINAL"
833 function _vim_sync_PWD --on-variable=PWD
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100834 printf '\033]7;file://%s\033\\' "$PWD"
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +0100835 end
836 end
837<
838 You can find an alternative method at |terminal-autoshelldir|.
Bram Moolenaara2baa732022-02-04 16:09:54 +0000839 When the parsing of the OSC sequence fails you get *E1179* .
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200840
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
842'arabic' 'arab' boolean (default off)
843 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 {only available when compiled with the |+arabic|
845 feature}
846 This option can be set to start editing Arabic text.
847 Setting this option will:
848 - Set the 'rightleft' option, unless 'termbidi' is set.
849 - Set the 'arabicshape' option, unless 'termbidi' is set.
850 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
851 between typing English and Arabic key mapping.
852 - Set the 'delcombine' option
853 Note that 'encoding' must be "utf-8" for working with Arabic text.
854
855 Resetting this option will:
856 - Reset the 'rightleft' option.
857 - Disable the use of 'keymap' (without changing its value).
858 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200859 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100860 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 Also see |arabic.txt|.
862
863 *'arabicshape'* *'arshape'*
864 *'noarabicshape'* *'noarshape'*
865'arabicshape' 'arshape' boolean (default on)
866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 {only available when compiled with the |+arabic|
868 feature}
869 When on and 'termbidi' is off, the required visual character
870 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200871 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 one which encompasses:
873 a) the changing/morphing of characters based on their location
874 within a word (initial, medial, final and stand-alone).
875 b) the enabling of the ability to compose characters
876 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877 When disabled the display shows each character's true stand-alone
878 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 Arabic is a complex language which requires other settings, for
880 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100881 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882
883 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
884'autoindent' 'ai' boolean (default off)
885 local to buffer
886 Copy indent from current line when starting a new line (typing <CR>
887 in Insert mode or when using the "o" or "O" command). If you do not
888 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000889 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
890 to another line has the same effect, unless the 'I' flag is included
891 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000892 When autoindent is on, formatting (with the "gq" command or when you
893 reach 'textwidth' in Insert mode) uses the indentation of the first
894 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 When 'smartindent' or 'cindent' is on the indent is changed in
896 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200897 The 'autoindent' option is reset when the 'paste' option is set and
898 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899
900 *'autoread'* *'ar'* *'noautoread'* *'noar'*
901'autoread' 'ar' boolean (default off)
902 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 When a file has been detected to have been changed outside of Vim and
904 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200905 When the file has been deleted this is not done, so you have the text
906 from before it was deleted. When it appears again then it is read.
907 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 If this option has a local value, use this command to switch back to
909 using the global value: >
910 :set autoread<
911<
912 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
913'autowrite' 'aw' boolean (default off)
914 global
915 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000916 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000917 `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
918 a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
Bram Moolenaar47003982021-12-05 21:54:04 +0000919 to another file.
920 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000921 set to "hide" and `:next` is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 Note that for some commands the 'autowrite' option is not used, see
923 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200924 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200925 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
927 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
928'autowriteall' 'awa' boolean (default off)
929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
931 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
932 Setting this option also implies that Vim behaves like 'autowrite' has
933 been set.
934
935 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200936'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 When set to "dark", Vim will try to use colors that look good on a
939 dark background. When set to "light", Vim will try to use colors that
940 look good on a light background. Any other value is illegal.
941 Vim tries to set the default value according to the terminal used.
942 This will not always be correct.
943 Setting this option does not change the background color, it tells Vim
944 what the background color looks like. For changing the background
945 color, see |:hi-normal|.
946
947 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000948 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000949 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100950 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 setting 'background' will cause the color scheme to be reloaded. If
952 the color scheme adjusts to the value of 'background' this will work.
953 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100954 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955
956 When setting 'background' to the default value with: >
957 :set background&
958< Vim will guess the value. In the GUI this should work correctly,
959 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200960 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200961 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200963 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200964 color from the terminal. If the returned RGB value is dark/light and
965 'background' is not dark/light, 'background' will be set and the
966 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200967 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100968 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200969
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 When starting the GUI, the default value for 'background' will be
971 "light". When the value is not set in the .gvimrc, and Vim detects
972 that the background is actually quite dark, 'background' is set to
973 "dark". But this happens only AFTER the .gvimrc file has been read
974 (because the window needs to be opened to find the actual background
975 color). To get around this, force the GUI window to be opened by
976 putting a ":gui" command in the .gvimrc file, before where the value
977 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200978
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100979 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200980 For other systems "dark" is used when 'term' is "linux",
981 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
982 background. Otherwise the default is "light".
983
Bram Moolenaarc572da52017-08-27 16:52:01 +0200984 The |:terminal| command and the |term_start()| function use the
985 'background' value to decide whether the terminal window will start
986 with a white or black background.
987
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 Normally this option would be set in the .vimrc file. Possibly
989 depending on the terminal name. Example: >
990 :if &term == "pcterm"
991 : set background=dark
992 :endif
993< When this option is set, the default settings for the highlight groups
994 will change. To use other settings, place ":highlight" commands AFTER
995 the setting of the 'background' option.
996 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
997 to select the colors for syntax highlighting. After changing this
998 option, you must load syntax.vim again to see the result. This can be
999 done with ":syntax on".
1000
1001 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001002'backspace' 'bs' string (default "", set to "indent,eol,start"
1003 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
1006 mode. This is a list of items, separated by commas. Each item allows
1007 a way to backspace over something:
1008 value effect ~
1009 indent allow backspacing over autoindent
1010 eol allow backspacing over line breaks (join lines)
1011 start allow backspacing over the start of insert; CTRL-W and CTRL-U
1012 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001013 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
1014 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015
Bram Moolenaar46eea442022-03-30 10:51:39 +01001016 When the value is empty, Vi compatible backspacing is used, none of
1017 the ways mentioned for the items above are possible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018
1019 For backwards compatibility with version 5.4 and earlier:
1020 value effect ~
1021 0 same as ":set backspace=" (Vi compatible)
1022 1 same as ":set backspace=indent,eol"
1023 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +02001024 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025
1026 See |:fixdel| if your <BS> or <Del> key does not do what you want.
1027 NOTE: This option is set to "" when 'compatible' is set.
1028
1029 *'backup'* *'bk'* *'nobackup'* *'nobk'*
1030'backup' 'bk' boolean (default off)
1031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 Make a backup before overwriting a file. Leave it around after the
1033 file has been successfully written. If you do not want to keep the
1034 backup file, but you do want a backup while the file is being
1035 written, reset this option and set the 'writebackup' option (this is
1036 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001037 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 |backup-table| for more explanations.
1039 When the 'backupskip' pattern matches, a backup is not made anyway.
1040 When 'patchmode' is set, the backup may be renamed to become the
1041 oldest version of a file.
1042 NOTE: This option is reset when 'compatible' is set.
1043
1044 *'backupcopy'* *'bkc'*
1045'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001046 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 When writing a file and a backup is made, this option tells how it's
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001048 done. This is a comma-separated list of words.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049
1050 The main values are:
1051 "yes" make a copy of the file and overwrite the original one
1052 "no" rename the file and write a new one
1053 "auto" one of the previous, what works best
1054
1055 Extra values that can be combined with the ones above are:
1056 "breaksymlink" always break symlinks when writing
1057 "breakhardlink" always break hardlinks when writing
1058
1059 Making a copy and overwriting the original file:
1060 - Takes extra time to copy the file.
1061 + When the file has special attributes, is a (hard/symbolic) link or
1062 has a resource fork, all this is preserved.
1063 - When the file is a link the backup will have the name of the link,
1064 not of the real file.
1065
1066 Renaming the file and writing a new one:
1067 + It's fast.
1068 - Sometimes not all attributes of the file can be copied to the new
1069 file.
1070 - When the file is a link the new file will not be a link.
1071
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001072 The "auto" value is the middle way: When Vim sees that renaming the
1073 file is possible without side effects (the attributes can be passed on
1074 and the file is not a link) that is used. When problems are expected,
1075 a copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076
1077 The "breaksymlink" and "breakhardlink" values can be used in
1078 combination with any of "yes", "no" and "auto". When included, they
1079 force Vim to always break either symbolic or hard links by doing
1080 exactly what the "no" option does, renaming the original file to
1081 become the backup and writing a new file in its place. This can be
1082 useful for example in source trees where all the files are symbolic or
1083 hard links and any changes should stay in the local source tree, not
1084 be propagated back to the original source.
1085 *crontab*
1086 One situation where "no" and "auto" will cause problems: A program
1087 that opens a file, invokes Vim to edit that file, and then tests if
1088 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001089 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 example.
1091
1092 When a copy is made, the original file is truncated and then filled
1093 with the new text. This means that protection bits, owner and
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001094 symbolic links of the original file are unmodified. The backup file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001095 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 group of the backup is set to the group of the original file. If this
1097 fails, the protection bits for the group are made the same as for
1098 others.
1099
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001100 When the file is renamed, this is the other way around: The backup has
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 the same attributes of the original file, and the newly written file
1102 is owned by the current user. When the file was a (hard/symbolic)
1103 link, the new file will not! That's why the "auto" value doesn't
1104 rename when the file is a link. The owner and group of the newly
1105 written file will be set to the same ones as the original file, but
1106 the system may refuse to do this. In that case the "auto" value will
1107 again not rename the file.
1108
Bram Moolenaar036986f2017-03-16 17:41:02 +01001109 NOTE: This option is set to the Vi default value when 'compatible' is
1110 set and to the Vim default value when 'compatible' is reset.
1111
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 *'backupdir'* *'bdir'*
1113'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001114 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 for Unix: ".,~/tmp,~/")
1116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 List of directories for the backup file, separated with commas.
1118 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001119 where this is possible. The directory must exist, Vim will not
1120 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001121 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 impossible!). Writing may fail because of this.
1123 - A directory "." means to put the backup file in the same directory
1124 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001125 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1126 the backup file relative to where the edited file is. The leading
1127 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 ("." inside a directory name has no special meaning).
1129 - Spaces after the comma are ignored, other spaces are considered part
1130 of the directory name. To have a space at the start of a directory
1131 name, precede it with a backslash.
1132 - To include a comma in a directory name precede it with a backslash.
1133 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001134 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001135 the backup file name will be built from the complete path to the
1136 file with all path separators changed to percent '%' signs. This
1137 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001138 On Win32, it is also possible to end with "\\". However, When a
1139 separating comma is following, you must use "//", since "\\" will
1140 include the comma in the file name. Therefore it is recommended to
1141 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 - Environment variables are expanded |:set_env|.
1143 - Careful with '\' characters, type one before a space, type two to
1144 get one in the option (see |option-backslash|), for example: >
1145 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1146< - For backwards compatibility with Vim version 3.0 a '>' at the start
1147 of the option is removed.
1148 See also 'backup' and 'writebackup' options.
1149 If you want to hide your backup files on Unix, consider this value: >
1150 :set backupdir=./.backup,~/.backup,.,/tmp
1151< You must create a ".backup" directory in each directory and in your
1152 home directory for this to work properly.
1153 The use of |:set+=| and |:set-=| is preferred when adding or removing
1154 directories from the list. This avoids problems when a future version
1155 uses another default.
1156 This option cannot be set from a |modeline| or in the |sandbox|, for
1157 security reasons.
1158
1159 *'backupext'* *'bex'* *E589*
1160'backupext' 'bex' string (default "~", for VMS: "_")
1161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 String which is appended to a file name to make the name of the
1163 backup file. The default is quite unusual, because this avoids
1164 accidentally overwriting existing files with a backup file. You might
1165 prefer using ".bak", but make sure that you don't have files with
1166 ".bak" that you want to keep.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001167 Only normal file name characters can be used; "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001169 If you like to keep a lot of backups, you could use a BufWritePre
1170 autocommand to change 'backupext' just before writing the file to
1171 include a timestamp. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001172 :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001173< Use 'backupdir' to put the backup in a different directory.
1174
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001176'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1177 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1178 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 A list of file patterns. When one of the patterns matches with the
1181 name of the file which is written, no backup file is created. Both
1182 the specified file name and the full path name of the file are used.
1183 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1184 Watch out for special characters, see |option-backslash|.
1185 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001186 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001187
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001188 WARNING: Not having a backup file means that when Vim fails to write
1189 your buffer correctly and then, for whatever reason, Vim exits, you
1190 lose both the original file and what you were writing. Only disable
1191 backups if you don't care about losing the file.
1192
Bram Moolenaar02467872007-05-06 13:22:01 +00001193 Note that environment variables are not expanded. If you want to use
1194 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001195 :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001196
1197< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001198 backup would be made by renaming the original file crontab won't see
1199 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200
1201 *'balloondelay'* *'bdlay'*
1202'balloondelay' 'bdlay' number (default: 600)
1203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 {only available when compiled with the |+balloon_eval|
1205 feature}
1206 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1207
1208 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1209'ballooneval' 'beval' boolean (default off)
1210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001212 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001213 Switch on the |balloon-eval| functionality for the GUI.
1214
1215 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1216 *'nobevalterm'*
1217'balloonevalterm' 'bevalterm' boolean (default off)
1218 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001219 {only available when compiled with the
1220 |+balloon_eval_term| feature}
1221 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001223 *'balloonexpr'* *'bexpr'*
1224'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001225 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001226 {only available when compiled with the |+balloon_eval|
1227 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001228 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001229 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1230 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001231
1232 v:beval_bufnr number of the buffer in which balloon is going to show
1233 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001234 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001235 v:beval_lnum line number
1236 v:beval_col column number (byte index)
1237 v:beval_text word under or after the mouse pointer
1238
Bram Moolenaar54775062019-07-31 21:07:14 +02001239 Instead of showing a balloon, which is limited to plain text, consider
1240 using a popup window, see |popup_beval_example|. A popup window can
1241 use highlighting and show a border.
1242
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001243 The evaluation of the expression must not have side effects!
1244 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001245 function MyBalloonExpr()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001246 return 'Cursor is at line ' .. v:beval_lnum ..
1247 \ ', column ' .. v:beval_col ..
1248 \ ' of file ' .. bufname(v:beval_bufnr) ..
1249 \ ' on word "' .. v:beval_text .. '"'
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001250 endfunction
1251 set bexpr=MyBalloonExpr()
1252 set ballooneval
1253<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001254 Also see |balloon_show()|, it can be used if the content of the balloon
1255 is to be fetched asynchronously. In that case evaluating
1256 'balloonexpr' should result in an empty string. If you get a balloon
1257 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001258
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001259 NOTE: The balloon is displayed only if the cursor is on a text
1260 character. If the result of evaluating 'balloonexpr' is not empty,
1261 Vim does not try to send a message to an external debugger (Netbeans
1262 or Sun Workshop).
1263
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00001264 If the expression starts with s: or |<SID>|, then it is replaced with
1265 the script ID (|local-function|). Example: >
1266 set bexpr=s:MyBalloonExpr()
1267 set bexpr=<SID>SomeBalloonExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001268< Otherwise, the expression is evaluated in the context of the script
1269 where the option was set, thus script-local items are available.
1270
Bram Moolenaar30b65812012-07-12 22:01:11 +02001271 The expression will be evaluated in the |sandbox| when set from a
1272 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001273 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001274
1275 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001276 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001277
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001278 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001279 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001280< When they are supported "\n" characters will start a new line. If the
1281 expression evaluates to a |List| this is equal to using each List item
1282 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001283 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001284
Bram Moolenaar165bc692015-07-21 17:53:25 +02001285 *'belloff'* *'bo'*
1286'belloff' 'bo' string (default "")
1287 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001288 Specifies for which events the bell will not be rung. It is a comma
1289 separated list of items. For each item that is present, the bell
1290 will be silenced. This is most useful to specify specific events in
1291 insert mode to be silenced.
LemonBoy77771d32022-04-13 11:47:25 +01001292 You can also make it flash by using 'visualbell'.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001293
1294 item meaning when present ~
1295 all All events.
1296 backspace When hitting <BS> or <Del> and deleting results in an
1297 error.
1298 cursor Fail to move around using the cursor keys or
1299 <PageUp>/<PageDown> in |Insert-mode|.
1300 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1301 |i_CTRL-X_CTRL-T|.
1302 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1303 |i_CTRL-E|.
1304 ctrlg Unknown Char after <C-G> in Insert mode.
1305 error Other Error occurred (e.g. try to join last line)
1306 (mostly used in |Normal-mode| or |Cmdline-mode|).
1307 esc hitting <Esc> in |Normal-mode|.
1308 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001309 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001310 insertmode Pressing <Esc> in 'insertmode'.
1311 lang Calling the beep module for Lua/Mzscheme/TCL.
1312 mess No output available for |g<|.
1313 showmatch Error occurred for 'showmatch' function.
1314 operator Empty region error |cpo-E|.
1315 register Unknown register after <C-R> in |Insert-mode|.
1316 shell Bell from shell output |:!|.
1317 spell Error happened on spell suggest.
LemonBoy77771d32022-04-13 11:47:25 +01001318 term Bell from |:terminal| output.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001319 wildmode More matches in |cmdline-completion| available
1320 (depends on the 'wildmode' setting).
1321
Bram Moolenaar036986f2017-03-16 17:41:02 +01001322 This is most useful to fine tune when in Insert mode the bell should
1323 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001324 indicate that an error occurred. It can be silenced by adding the
1325 "error" keyword.
1326
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1328'binary' 'bin' boolean (default off)
1329 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330 This option should be set before editing a binary file. You can also
1331 use the |-b| Vim argument. When this option is switched on a few
1332 options will be changed (also when it already was on):
1333 'textwidth' will be set to 0
1334 'wrapmargin' will be set to 0
1335 'modeline' will be off
1336 'expandtab' will be off
1337 Also, 'fileformat' and 'fileformats' options will not be used, the
1338 file is read and written like 'fileformat' was "unix" (a single <NL>
1339 separates lines).
1340 The 'fileencoding' and 'fileencodings' options will not be used, the
1341 file is read without conversion.
1342 NOTE: When you start editing a(nother) file while the 'bin' option is
1343 on, settings from autocommands may change the settings again (e.g.,
1344 'textwidth'), causing trouble when editing. You might want to set
1345 'bin' again when the file has been loaded.
1346 The previous values of these options are remembered and restored when
1347 'bin' is switched from on to off. Each buffer has its own set of
1348 saved option values.
1349 To edit a file with 'binary' set you can use the |++bin| argument.
1350 This avoids you have to do ":set bin", which would have effect for all
1351 files you edit.
1352 When writing a file the <EOL> for the last line is only written if
1353 there was one in the original file (normally Vim appends an <EOL> to
1354 the last line if there is none; this would make the file longer). See
1355 the 'endofline' option.
1356
1357 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1358'bioskey' 'biosk' boolean (default on)
1359 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001360 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001361 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
1363 *'bomb'* *'nobomb'*
1364'bomb' boolean (default off)
1365 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 When writing a file and the following conditions are met, a BOM (Byte
1367 Order Mark) is prepended to the file:
1368 - this option is on
1369 - the 'binary' option is off
1370 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1371 endian variants.
1372 Some applications use the BOM to recognize the encoding of the file.
1373 Often used for UCS-2 files on MS-Windows. For other applications it
1374 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001375 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1377 check for the presence of the BOM is done and 'bomb' set accordingly.
1378 Unless 'binary' is set, it is removed from the first line, so that you
1379 don't see it when editing. When you don't change the options, the BOM
1380 will be restored when writing the file.
1381
1382 *'breakat'* *'brk'*
1383'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1384 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001385 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 feature}
1387 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001388 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1389 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001391 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001392'breakindent' 'bri' boolean (default off)
1393 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001394 {not available when compiled without the |+linebreak|
1395 feature}
1396 Every wrapped line will continue visually indented (same amount of
1397 space as the beginning of that line), thus preserving horizontal blocks
1398 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001399 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001400
1401 *'breakindentopt'* *'briopt'*
1402'breakindentopt' 'briopt' string (default empty)
1403 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001404 {not available when compiled without the |+linebreak|
1405 feature}
1406 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001407 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001408 min:{n} Minimum text width that will be kept after
1409 applying 'breakindent', even if the resulting
1410 text should normally be narrower. This prevents
1411 text indented almost to the right window border
1412 occupying lot of vertical space when broken.
Christian Brabandtc53b4672022-01-15 10:01:05 +00001413 (default: 20)
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001414 shift:{n} After applying 'breakindent', the wrapped line's
1415 beginning will be shifted by the given number of
1416 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001417 indentation (negative) or emphasizing the line
1418 continuation (positive).
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001419 (default: 0)
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001420 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001421 additional indent.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001422 (default: off)
Maxim Kimf674b352021-07-22 11:46:59 +02001423 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001424 numbered or bulleted list (using the
1425 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001426 list:-1 Uses the length of a match with 'formatlistpat'
1427 for indentation.
Christian Brabandte7d6dbc2022-05-06 12:21:04 +01001428 (default: 0)
1429 column:{n} Indent at column {n}. Will overrule the other
1430 sub-options. Note: an additional indent may be
1431 added for the 'showbreak' setting.
1432 (default: off)
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001433
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001435'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001437 {only for Motif, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001439 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001440 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 buffer Use the directory of the related buffer.
1442 current Use the current directory.
1443 {path} Use the specified directory
1444
1445 *'bufhidden'* *'bh'*
1446'bufhidden' 'bh' string (default: "")
1447 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 This option specifies what happens when a buffer is no longer
1449 displayed in a window:
1450 <empty> follow the global 'hidden' option
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001451 hide hide the buffer (don't unload it), even if 'hidden' is
1452 not set
1453 unload unload the buffer, even if 'hidden' is set; the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001454 |:hide| command will also unload the buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001455 delete delete the buffer from the buffer list, even if
1456 'hidden' is set; the |:hide| command will also delete
1457 the buffer, making it behave like |:bdelete|
1458 wipe wipe the buffer from the buffer list, even if
1459 'hidden' is set; the |:hide| command will also wipe
1460 out the buffer, making it behave like |:bwipeout|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001462 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001463 are lost without a warning. Also, these values may break autocommands
1464 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 This option is used together with 'buftype' and 'swapfile' to specify
1466 special kinds of buffers. See |special-buffers|.
1467
1468 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1469'buflisted' 'bl' boolean (default: on)
1470 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 When this option is set, the buffer shows up in the buffer list. If
1472 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1473 This option is reset by Vim for buffers that are only used to remember
1474 a file name or marks. Vim sets it when starting to edit a buffer.
1475 But not when moving to a buffer with ":buffer".
1476
1477 *'buftype'* *'bt'* *E382*
1478'buftype' 'bt' string (default: "")
1479 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480 The value of this option specifies the type of a buffer:
1481 <empty> normal buffer
1482 nofile buffer which is not related to a file and will not be
1483 written
1484 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001485 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001486 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001488 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 help help buffer (you are not supposed to set this
1490 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001491 terminal buffer for a |terminal| (you are not supposed to set
1492 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001493 prompt buffer where only the last line can be edited, meant
1494 to be used by a plugin, see |prompt-buffer|
1495 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001496 popup buffer used in a popup window, see |popup|.
1497 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498
1499 This option is used together with 'bufhidden' and 'swapfile' to
1500 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001501 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502
1503 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001504 One such effect is that Vim will not check the timestamp of the file,
1505 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506
Bram Moolenaar280f1262006-01-30 00:14:18 +00001507 A "quickfix" buffer is only used for the error list and the location
1508 list. This value is set by the |:cwindow| and |:lwindow| commands and
1509 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510
1511 "nofile" and "nowrite" buffers are similar:
1512 both: The buffer is not to be written to disk, ":w" doesn't
1513 work (":w filename" does work though).
1514 both: The buffer is never considered to be |'modified'|.
1515 There is no warning when the changes will be lost, for
1516 example when you quit Vim.
1517 both: A swap file is only created when using too much memory
1518 (when 'swapfile' has been reset there is never a swap
1519 file).
1520 nofile only: The buffer name is fixed, it is not handled like a
1521 file name. It is not modified in response to a |:cd|
1522 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001523 both: When using ":e bufname" and already editing "bufname"
1524 the buffer is made empty and autocommands are
1525 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001526 *E676*
1527 "acwrite" implies that the buffer name is not related to a file, like
1528 "nofile", but it will be written. Thus, in contrast to "nofile" and
1529 "nowrite", ":w" does work and a modified buffer can't be abandoned
1530 without saving. For writing there must be matching |BufWriteCmd|,
1531 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532
1533 *'casemap'* *'cmp'*
1534'casemap' 'cmp' string (default: "internal,keepascii")
1535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 Specifies details about changing the case of letters. It may contain
1537 these words, separated by a comma:
1538 internal Use internal case mapping functions, the current
1539 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001540 matters when 'encoding' is a Unicode encoding,
1541 "latin1" or "iso-8859-15". When "internal" is
1542 omitted, the towupper() and towlower() system library
1543 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1545 case mapping, the current locale is not effective.
1546 This probably only matters for Turkish.
1547
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001548 *'cdhome'* *'cdh'*
1549'cdhome' 'cdh' boolean (default: off)
1550 global
1551 When on, |:cd|, |:tcd| and |:lcd| without an argument changes the
1552 current working directory to the |$HOME| directory like in Unix.
1553 When off, those commands just print the current directory name.
1554 On Unix this option has no effect.
1555 NOTE: This option is reset when 'compatible' is set.
1556
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 *'cdpath'* *'cd'* *E344* *E346*
1558'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001561 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1562 searched for has a relative path, not an absolute part starting with
1563 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 The 'cdpath' option's value has the same form and semantics as
1565 |'path'|. Also see |file-searching|.
1566 The default value is taken from $CDPATH, with a "," prepended to look
1567 in the current directory first.
1568 If the default value taken from $CDPATH is not what you want, include
1569 a modified version of the following command in your vimrc file to
1570 override it: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001571 :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572< This option cannot be set from a |modeline| or in the |sandbox|, for
1573 security reasons.
1574 (parts of 'cdpath' can be passed to the shell to expand file names).
1575
1576 *'cedit'*
1577'cedit' string (Vi default: "", Vim default: CTRL-F)
1578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579 The key used in Command-line Mode to open the command-line window.
1580 The default is CTRL-F when 'compatible' is off.
1581 Only non-printable keys are allowed.
1582 The key can be specified as a single character, but it is difficult to
1583 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001584 :exe "set cedit=\<C-Y>"
1585 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586< |Nvi| also has this option, but it only uses the first character.
1587 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001588 NOTE: This option is set to the Vim default value when 'compatible'
1589 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590
1591 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1592'charconvert' 'ccv' string (default "")
1593 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001594 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 An expression that is used for character encoding conversion. It is
1596 evaluated when a file that is to be read or has been written has a
1597 different encoding from what is desired.
1598 'charconvert' is not used when the internal iconv() function is
1599 supported and is able to do the conversion. Using iconv() is
1600 preferred, because it is much faster.
1601 'charconvert' is not used when reading stdin |--|, because there is no
1602 file to convert from. You will have to save the text in a file first.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001603 The expression must return zero, false or an empty string for success,
1604 non-zero or true for failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 The possible encoding names encountered are in 'encoding'.
1606 Additionally, names given in 'fileencodings' and 'fileencoding' are
1607 used.
1608 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1609 is done internally by Vim, 'charconvert' is not used for this.
1610 'charconvert' is also used to convert the viminfo file, if the 'c'
1611 flag is present in 'viminfo'. Also used for Unicode conversion.
1612 Example: >
1613 set charconvert=CharConvert()
1614 fun CharConvert()
1615 system("recode "
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001616 \ .. v:charconvert_from .. ".." .. v:charconvert_to
1617 \ .. " <" .. v:fname_in .. " >" .. v:fname_out)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 return v:shell_error
1619 endfun
1620< The related Vim variables are:
1621 v:charconvert_from name of the current encoding
1622 v:charconvert_to name of the desired encoding
1623 v:fname_in name of the input file
1624 v:fname_out name of the output file
1625 Note that v:fname_in and v:fname_out will never be the same.
1626 Note that v:charconvert_from and v:charconvert_to may be different
1627 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001628
Bram Moolenaara4e0b972022-10-01 19:43:52 +01001629 The advantage of using a function call without arguments is that it is
1630 faster, see |expr-option-function|.
1631
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 Encryption is not done by Vim when using 'charconvert'. If you want
1633 to encrypt the file after conversion, 'charconvert' should take care
1634 of this.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001635
1636 If the 'charconvert' expression starts with s: or |<SID>|, then it is
1637 replaced with the script ID (|local-function|). Example: >
1638 set charconvert=s:MyConvert()
1639 set charconvert=<SID>SomeConvert()
1640< Otherwise the expression is evaluated in the context of the script
1641 where the option was set, thus script-local items are available.
1642
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 This option cannot be set from a |modeline| or in the |sandbox|, for
1644 security reasons.
1645
1646 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1647'cindent' 'cin' boolean (default off)
1648 local to buffer
Bram Moolenaar446cb832008-06-24 21:56:24 +00001649 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 that trigger reindenting in insert mode and 'cinoptions' to set your
1651 preferred indent style.
1652 If 'indentexpr' is not empty, it overrules 'cindent'.
1653 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1654 the "=" operator indents using this algorithm rather than calling an
1655 external program.
1656 See |C-indenting|.
1657 When you don't like the way 'cindent' works, try the 'smartindent'
1658 option or 'indentexpr'.
1659 This option is not used when 'paste' is set.
1660 NOTE: This option is reset when 'compatible' is set.
1661
1662 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001663'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 A list of keys that, when typed in Insert mode, cause reindenting of
1666 the current line. Only used if 'cindent' is on and 'indentexpr' is
1667 empty.
1668 For the format of this option see |cinkeys-format|.
1669 See |C-indenting|.
1670
1671 *'cinoptions'* *'cino'*
1672'cinoptions' 'cino' string (default "")
1673 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1675 program. See |cinoptions-values| for the values of this option, and
1676 |C-indenting| for info on C indenting in general.
1677
1678
1679 *'cinwords'* *'cinw'*
1680'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1681 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 These keywords start an extra indent in the next line when
1683 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1684 an appropriate place (inside {}).
1685 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1686 matter, include the keyword both the uppercase and lowercase:
1687 "if,If,IF".
1688
Tom Praschan3506cf32022-04-07 12:39:08 +01001689 *'cinscopedecls'* *'cinsd'*
1690'cinscopedecls' 'cinsd' string (default "public,protected,private")
1691 local to buffer
Tom Praschan3506cf32022-04-07 12:39:08 +01001692 Keywords that are interpreted as a C++ scope declaration by |cino-g|.
1693 Useful e.g. for working with the Qt framework that defines additional
1694 scope declarations "signals", "public slots" and "private slots": >
1695 set cinscopedecls+=signals,public\ slots,private\ slots
1696
1697< *'clipboard'* *'cb'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1699 for X-windows, "" otherwise)
1700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 {only in GUI versions or when the |+xterm_clipboard|
1702 feature is included}
Tom Praschan3506cf32022-04-07 12:39:08 +01001703 This option is a list of comma-separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001704 Note: if one of the items is "exclude:", then you can't add an item
Bram Moolenaar5ed11532022-07-06 13:18:11 +01001705 after that. Therefore do not append an item with += but use ^= to
Bram Moolenaar942db232021-02-13 18:14:48 +01001706 prepend, e.g.: >
1707 set clipboard^=unnamed
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001708< When using the GUI see |'go-A'|.
1709 These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001711 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 unnamed When included, Vim will use the clipboard register '*'
1713 for all yank, delete, change and put operations which
1714 would normally go to the unnamed register. When a
1715 register is explicitly specified, it will always be
1716 used regardless of whether "unnamed" is in 'clipboard'
1717 or not. The clipboard register can always be
1718 explicitly accessed using the "* notation. Also see
1719 |gui-clipboard|.
1720
Bram Moolenaar30b65812012-07-12 22:01:11 +02001721 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001722 unnamedplus A variant of the "unnamed" flag which uses the
1723 clipboard register '+' (|quoteplus|) instead of
1724 register '*' for all yank, delete, change and put
1725 operations which would normally go to the unnamed
1726 register. When "unnamed" is also included to the
1727 option, yank operations (but not delete, change or
1728 put) will additionally copy the text into register
1729 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001730 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001731 Availability can be checked with: >
1732 if has('unnamedplus')
1733<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001734 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 autoselect Works like the 'a' flag in 'guioptions': If present,
1736 then whenever Visual mode is started, or the Visual
1737 area extended, Vim tries to become the owner of the
1738 windowing system's global selection or put the
1739 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001740 register "*. See |'go-a'| and |quotestar| for details.
1741 When the GUI is active, the 'a' flag in 'guioptions'
1742 is used, when the GUI is not active, this "autoselect"
1743 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 Also applies to the modeless selection.
1745
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001746 *clipboard-autoselectplus*
1747 autoselectplus Like "autoselect" but using the + register instead of
1748 the * register. Compare to the 'P' flag in
1749 'guioptions'.
1750
1751 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 autoselectml Like "autoselect", but for the modeless selection
1753 only. Compare to the 'A' flag in 'guioptions'.
1754
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001755 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001756 html When the clipboard contains HTML, use this when
1757 pasting. When putting text on the clipboard, mark it
1758 as HTML. This works to copy rendered HTML from
1759 Firefox, paste it as raw HTML in Vim, select the HTML
1760 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001761 You probably want to add this only temporarily,
1762 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001763 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001764
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001765 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 exclude:{pattern}
1767 Defines a pattern that is matched against the name of
1768 the terminal 'term'. If there is a match, no
1769 connection will be made to the X server. This is
1770 useful in this situation:
1771 - Running Vim in a console.
1772 - $DISPLAY is set to start applications on another
1773 display.
1774 - You do not want to connect to the X server in the
1775 console, but do want this in a terminal emulator.
1776 To never connect to the X server use: >
1777 exclude:.*
1778< This has the same effect as using the |-X| argument.
1779 Note that when there is no connection to the X server
1780 the window title won't be restored and the clipboard
1781 cannot be accessed.
1782 The value of 'magic' is ignored, {pattern} is
1783 interpreted as if 'magic' was on.
1784 The rest of the option value will be used for
1785 {pattern}, this must be the last entry.
1786
1787 *'cmdheight'* *'ch'*
1788'cmdheight' 'ch' number (default 1)
Shougo Matsushitaf39cfb72022-07-30 16:54:05 +01001789 global or local to tab page
Bram Moolenaara2a89732022-08-31 14:46:18 +01001790 Number of screen lines to use for the command-line. A larger value
1791 helps avoiding |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001792 The value of this option is stored with the tab page, so that each tab
1793 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794
1795 *'cmdwinheight'* *'cwh'*
1796'cmdwinheight' 'cwh' number (default 7)
1797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 Number of screen lines to use for the command-line window. |cmdwin|
1799
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001800 *'colorcolumn'* *'cc'*
1801'colorcolumn' 'cc' string (default "")
1802 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001803 {not available when compiled without the |+syntax|
1804 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001805 'colorcolumn' is a comma-separated list of screen columns that are
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001806 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1807 text. Will make screen redrawing slower.
1808 The screen column can be an absolute number, or a number preceded with
1809 '+' or '-', which is added to or subtracted from 'textwidth'. >
1810
1811 :set cc=+1 " highlight column after 'textwidth'
1812 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1813 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1814<
1815 When 'textwidth' is zero then the items with '-' and '+' are not used.
1816 A maximum of 256 columns are highlighted.
1817
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 *'columns'* *'co'* *E594*
1819'columns' 'co' number (default 80 or terminal width)
1820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001822 initialization and does not have to be set by hand. Also see
1823 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 When Vim is running in the GUI or in a resizable window, setting this
1825 option will cause the window size to be changed. When you only want
1826 to use the size for the GUI, put the command in your |gvimrc| file.
1827 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001828 number of columns of the display, the display may be messed up. For
1829 the GUI it is always possible and Vim limits the number of columns to
1830 what fits on the screen. You can use this command to get the widest
1831 window possible: >
1832 :set columns=9999
1833< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834
1835 *'comments'* *'com'* *E524* *E525*
1836'comments' 'com' string (default
1837 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1838 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001839 A comma-separated list of strings that can start a comment line. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 |format-comments|. See |option-backslash| about using backslashes to
1841 insert a space.
1842
1843 *'commentstring'* *'cms'* *E537*
1844'commentstring' 'cms' string (default "/*%s*/")
1845 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 {not available when compiled without the |+folding|
1847 feature}
1848 A template for a comment. The "%s" in the value is replaced with the
1849 comment text. Currently only used to add markers for folding, see
1850 |fold-marker|.
1851
1852 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001853'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001854 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 This option has the effect of making Vim either more Vi-compatible, or
1857 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001858
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001860 other options are also changed as a side effect.
1861 NOTE: Setting or resetting this option can have a lot of unexpected
1862 effects: Mappings are interpreted in another way, undo behaves
1863 differently, etc. If you set this option in your vimrc file, you
1864 should probably put it at the very start.
1865
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 By default this option is on and the Vi defaults are used for the
1867 options. This default was chosen for those people who want to use Vim
1868 just like Vi, and don't even (want to) know about the 'compatible'
1869 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001870 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001871 this option is switched off, and all options that have not been
1872 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001873 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001874 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001875 happen for the system-wide vimrc or gvimrc file, nor for a file given
1876 with the |-u| argument). Also see |compatible-default| and
1877 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 You can also set this option with the "-C" argument, and reset it with
1879 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001880 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881
Bram Moolenaar214641f2017-03-05 17:04:09 +01001882 When this option is set, numerous other options are set to make Vim as
1883 Vi-compatible as possible. When this option is unset, various options
1884 are set to make Vim more useful. The table below lists all the
1885 options affected.
1886 The {?} column indicates when the options are affected:
1887 + Means that the option is set to the value given in {set value} when
1888 'compatible' is set.
1889 & Means that the option is set to the value given in {set value} when
1890 'compatible' is set AND is set to its Vim default value when
1891 'compatible' is unset.
1892 - Means the option is NOT changed when setting 'compatible' but IS
1893 set to its Vim default when 'compatible' is unset.
1894 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895
Bram Moolenaar036986f2017-03-16 17:41:02 +01001896 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001897
1898 'allowrevins' + off no CTRL-_ command
1899 'antialias' + off don't use antialiased fonts
1900 'arabic' + off reset arabic-related options
1901 'arabicshape' + on correct character shapes
1902 'backspace' + "" normal backspace
1903 'backup' + off no backup file
1904 'backupcopy' & Unix: "yes" backup file is a copy
1905 else: "auto" copy or rename backup file
1906 'balloonexpr' + "" text to show in evaluation balloon
1907 'breakindent' + off don't indent when wrapping lines
1908 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
Bram Moolenaar7b1463b2021-12-11 17:24:39 +00001909 'cdhome' + off ":cd" don't chdir to home on non-Unix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001910 'cindent' + off no C code indentation
1911 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1912 'copyindent' + off don't copy indent structure
1913 'cpoptions' & (all flags) Vi-compatible flags
1914 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001915 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001916 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001917 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001918 'cscopeverbose' + off see |cscopeverbose|
1919 'delcombine' + off unicode: delete whole char combination
1920 'digraph' + off no digraphs
1921 'esckeys' & off no <Esc>-keys in Insert mode
1922 'expandtab' + off tabs not expanded to spaces
1923 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001924 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001925 'formatexpr' + "" use 'formatprg' for auto-formatting
1926 'formatoptions' & "vt" Vi compatible formatting
1927 'gdefault' + off no default 'g' flag for ":s"
1928 'history' & 0 no commandline history
1929 'hkmap' + off no Hebrew keyboard mapping
1930 'hkmapp' + off no phonetic Hebrew keyboard mapping
1931 'hlsearch' + off no highlighting of search matches
1932 'incsearch' + off no incremental searching
1933 'indentexpr' + "" no indenting by expression
1934 'insertmode' + off do not start in Insert mode
1935 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001937 'joinspaces' + on insert 2 spaces after period
1938 'modeline' & off no modelines
1939 'more' & off no pauses in listings
1940 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1941 'numberwidth' & 8 min number of columns for line number
1942 'preserveindent'+ off don't preserve current indent structure
1943 when changing it
1944 'revins' + off no reverse insert
1945 'ruler' + off no ruler
1946 'scrolljump' + 1 no jump scroll
1947 'scrolloff' + 0 no scroll offset
1948 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1949 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001950 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001951 'showcmd' & off command characters not shown
1952 'showmode' & off current mode not shown
1953 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1954 'smartcase' + off no automatic ignore case switch
1955 'smartindent' + off no smart indentation
1956 'smarttab' + off no smart tab size
1957 'softtabstop' + 0 tabs are always 'tabstop' positions
1958 'startofline' + on goto startofline with some commands
1959 'tagcase' & "followic" 'ignorecase' when searching tags file
1960 'tagrelative' & off tag file names are not relative
1961 'termguicolors' + off don't use highlight-(guifg|guibg)
1962 'textauto' & off no automatic textmode detection
1963 'textwidth' + 0 no automatic line wrap
1964 'tildeop' + off tilde is not an operator
1965 'ttimeout' + off no terminal timeout
1966 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001967 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001968 'virtualedit' + "" cursor can only be placed on characters
1969 'whichwrap' & "" left-right movements don't wrap
1970 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001972 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973
1974 *'complete'* *'cpt'* *E535*
1975'complete' 'cpt' string (default: ".,w,b,u,t,i")
1976 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 This option specifies how keyword completion |ins-completion| works
1978 when CTRL-P or CTRL-N are used. It is also used for whole-line
1979 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001980 and the places to scan. It is a comma-separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001981 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 w scan buffers from other windows
1983 b scan other loaded buffers that are in the buffer list
1984 u scan the unloaded buffers that are in the buffer list
1985 U scan the buffers that are not in the buffer list
1986 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001987 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 k{dict} scan the file {dict}. Several "k" flags can be given,
1989 patterns are valid too. For example: >
1990 :set cpt=k/usr/dict/*,k~/spanish
1991< s scan the files given with the 'thesaurus' option
1992 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1993 are valid too.
1994 i scan current and included files
1995 d scan current and included files for defined name or macro
1996 |i_CTRL-X_CTRL-D|
1997 ] tag completion
1998 t same as "]"
1999
2000 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
2001 not executed, this may lead to unexpected completions from some files
2002 (gzipped files for example). Unloaded buffers are not scanned for
2003 whole-line completion.
2004
2005 The default is ".,w,b,u,t,i", which means to scan:
2006 1. the current buffer
2007 2. buffers in other windows
2008 3. other loaded buffers
2009 4. unloaded buffers
2010 5. tags
2011 6. included files
2012
2013 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00002014 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
2015 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00002017 *'completefunc'* *'cfu'*
2018'completefunc' 'cfu' string (default: empty)
2019 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02002020 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02002021 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00002022 This option specifies a function to be used for Insert mode completion
2023 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00002024 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00002025 invoked and what it should return. The value can be the name of a
2026 function, a |lambda| or a |Funcref|. See |option-value-function| for
2027 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002028 This option cannot be set from a |modeline| or in the |sandbox|, for
2029 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00002030
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002031 *'completeslash'* *'csl'*
2032'completeslash' 'csl' string (default: "")
2033 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002034 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002035 When this option is set it overrules 'shellslash' for completion:
2036 - When this option is set to "slash", a forward slash is used for path
2037 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002038 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002039 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01002040 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02002041 - When this option is empty, same character is used as for
2042 'shellslash'.
2043 For Insert mode completion the buffer-local value is used. For
2044 command line completion the global value is used.
2045
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002046 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002047'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002048 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002049 A comma-separated list of options for Insert mode completion
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002050 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00002051
2052 menu Use a popup menu to show the possible completions. The
2053 menu is only shown when there is more than one match and
2054 sufficient colors are available. |ins-completion-menu|
2055
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002056 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002057 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00002058 match, e.g., what file it comes from.
2059
Bram Moolenaarc1e37902006-04-18 21:55:01 +00002060 longest Only insert the longest common text of the matches. If
2061 the menu is displayed you can use CTRL-L to add more
2062 characters. Whether case is ignored depends on the kind
2063 of completion. For buffer text the 'ignorecase' option is
2064 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00002065
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002066 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00002067 completion in the preview window. Only works in
2068 combination with "menu" or "menuone".
2069
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002070 popup Show extra information about the currently selected
2071 completion in a popup window. Only works in combination
2072 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002073 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02002074 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02002075
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002076 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002077 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002078 |CompleteChanged| autocommand to fetch the info and call
2079 |popup_show()| once the popup has been filled.
2080 See the example at |complete-popuphidden|.
2081 {only works when compiled with the |+textprop| feature}
2082
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002083 noinsert Do not insert any text for a match until the user selects
2084 a match from the menu. Only works in combination with
2085 "menu" or "menuone". No effect if "longest" is present.
2086
2087 noselect Do not select a match in the menu, force the user to
2088 select one from the menu. Only works in combination with
2089 "menu" or "menuone".
2090
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002091
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002092 *'completepopup'* *'cpp'*
2093'completepopup' 'cpp' string (default empty)
2094 global
2095 {not available when compiled without the |+textprop|
2096 or |+quickfix| feature}
2097 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002098 properties of the info popup when it is created. If an info popup
2099 window already exists it is closed, so that the option value is
2100 applied when it is created again.
2101 You can also use |popup_findinfo()| and then set properties for an
2102 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002103
2104
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002105 *'concealcursor'* *'cocu'*
2106'concealcursor' 'cocu' string (default: "")
2107 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002108 {not available when compiled without the |+conceal|
2109 feature}
2110 Sets the modes in which text in the cursor line can also be concealed.
2111 When the current mode is listed then concealing happens just like in
2112 other lines.
2113 n Normal mode
2114 v Visual mode
2115 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002116 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002117
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002118 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002119 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002120 are moving around text is concealed, but when starting to insert text
2121 or selecting a Visual area the concealed text is displayed, so that
2122 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002123 Keep in mind that the cursor position is not always where it's
2124 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002125
2126
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002127 *'conceallevel'* *'cole'*
2128'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002129 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002130 {not available when compiled without the |+conceal|
2131 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002132 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2133 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002134
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002135 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002136 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002137 1 Each block of concealed text is replaced with one
2138 character. If the syntax item does not have a custom
2139 replacement character defined (see |:syn-cchar|) the
2140 character defined in 'listchars' is used (default is a
2141 space).
2142 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002143 2 Concealed text is completely hidden unless it has a
2144 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002145 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002146 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002147
Bram Moolenaara7781e02010-07-19 20:13:22 +02002148 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002149 edit and copy the text. This can be changed with the 'concealcursor'
2150 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002151
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2153'confirm' 'cf' boolean (default off)
2154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 When 'confirm' is on, certain operations that would normally
2156 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2157 instead raise a |dialog| asking if you wish to save the current
2158 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2159 If 'confirm' is off you can still activate confirmation for one
2160 command only (this is most useful in mappings) with the |:confirm|
2161 command.
2162 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2163
2164 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2165'conskey' 'consk' boolean (default off)
2166 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002167 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168
2169 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2170'copyindent' 'ci' boolean (default off)
2171 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 Copy the structure of the existing lines indent when autoindenting a
2173 new line. Normally the new indent is reconstructed by a series of
2174 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2175 in which case only spaces are used). Enabling this option makes the
2176 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002177 existing line. 'expandtab' has no effect on these characters, a Tab
2178 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002180 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 Also see 'preserveindent'.
2182
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002183 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184'cpoptions' 'cpo' string (Vim default: "aABceFs",
2185 Vi default: all flags)
2186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002188 this indicates Vi-compatible behavior. This is used for things where
2189 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 'cpoptions' stands for "compatible-options".
2191 Commas can be added for readability.
2192 To avoid problems with flags that are added in the future, use the
2193 "+=" and "-=" feature of ":set" |add-option-flags|.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002194
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 NOTE: This option is set to the Vi default value when 'compatible' is
2196 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar71eb3ad2021-12-26 12:07:30 +00002197
2198 NOTE: In a |Vim9| script, when `vim9script` is encountered, the value
2199 is saved, 'cpoptions' is set to the Vim default, and the saved value
2200 is restored at the end of the script. Changes to the value of
2201 'cpoptions' will be applied to the saved value, but keep in mind that
2202 removing a flag that is not present when 'cpoptions' is changed has no
2203 effect. In the |.vimrc| file the value is not restored, thus using
2204 `vim9script` in the |.vimrc| file results in using the Vim default.
2205
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002206 NOTE: This option is set to the POSIX default value at startup when
2207 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002208 variable exists |posix|. This means Vim tries to behave like the
2209 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210
2211 contains behavior ~
2212 *cpo-a*
2213 a When included, a ":read" command with a file name
2214 argument will set the alternate file name for the
2215 current window.
2216 *cpo-A*
2217 A When included, a ":write" command with a file name
2218 argument will set the alternate file name for the
2219 current window.
2220 *cpo-b*
2221 b "\|" in a ":map" command is recognized as the end of
2222 the map command. The '\' is included in the mapping,
2223 the text after the '|' is interpreted as the next
2224 command. Use a CTRL-V instead of a backslash to
2225 include the '|' in the mapping. Applies to all
2226 mapping, abbreviation, menu and autocmd commands.
2227 See also |map_bar|.
2228 *cpo-B*
2229 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002230 abbreviations, user commands and the "to" part of the
2231 menu commands. Remove this flag to be able to use a
2232 backslash like a CTRL-V. For example, the command
2233 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 'B' included: "\^[" (^[ is a real <Esc>)
2235 'B' excluded: "<Esc>" (5 characters)
2236 ('<' excluded in both cases)
2237 *cpo-c*
2238 c Searching continues at the end of any match at the
2239 cursor position, but not further than the start of the
2240 next line. When not present searching continues
2241 one character from the cursor position. With 'c'
2242 "abababababab" only gets three matches when repeating
2243 "/abab", without 'c' there are five matches.
2244 *cpo-C*
2245 C Do not concatenate sourced lines that start with a
2246 backslash. See |line-continuation|.
2247 *cpo-d*
2248 d Using "./" in the 'tags' option doesn't mean to use
2249 the tags file relative to the current file, but the
2250 tags file in the current directory.
2251 *cpo-D*
2252 D Can't use CTRL-K to enter a digraph after Normal mode
2253 commands with a character argument, like |r|, |f| and
2254 |t|.
2255 *cpo-e*
2256 e When executing a register with ":@r", always add a
2257 <CR> to the last line, also when the register is not
2258 linewise. If this flag is not present, the register
2259 is not linewise and the last line does not end in a
2260 <CR>, then the last line is put on the command-line
2261 and can be edited before hitting <CR>.
2262 *cpo-E*
2263 E It is an error when using "y", "d", "c", "g~", "gu" or
2264 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002265 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 This makes "y0" fail in the first column.
2267 *cpo-f*
2268 f When included, a ":read" command with a file name
2269 argument will set the file name for the current buffer,
2270 if the current buffer doesn't have a file name yet.
2271 *cpo-F*
2272 F When included, a ":write" command with a file name
2273 argument will set the file name for the current
2274 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002275 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276 *cpo-g*
2277 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002278 *cpo-H*
2279 H When using "I" on a line with only blanks, insert
2280 before the last blank. Without this flag insert after
2281 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 *cpo-i*
2283 i When included, interrupting the reading of a file will
2284 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002285 *cpo-I*
2286 I When moving the cursor up or down just after inserting
2287 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 *cpo-j*
2289 j When joining lines, only add two spaces after a '.',
2290 not after '!' or '?'. Also see 'joinspaces'.
2291 *cpo-J*
2292 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002293 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 white space.
2295 *cpo-k*
2296 k Disable the recognition of raw key codes in
2297 mappings, abbreviations, and the "to" part of menu
2298 commands. For example, if <Key> sends ^[OA (where ^[
2299 is <Esc>), the command ":map X ^[OA" results in X
2300 being mapped to:
2301 'k' included: "^[OA" (3 characters)
2302 'k' excluded: "<Key>" (one key code)
2303 Also see the '<' flag below.
2304 *cpo-K*
2305 K Don't wait for a key code to complete when it is
2306 halfway a mapping. This breaks mapping <F1><F1> when
2307 only part of the second <F1> has been read. It
2308 enables cancelling the mapping by typing <F1><Esc>.
2309 *cpo-l*
2310 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002311 literally, only "\]", "\^", "\-" and "\\" are special.
2312 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2314 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002315 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 *cpo-L*
2317 L When the 'list' option is set, 'wrapmargin',
2318 'textwidth', 'softtabstop' and Virtual Replace mode
2319 (see |gR|) count a <Tab> as two characters, instead of
2320 the normal behavior of a <Tab>.
2321 *cpo-m*
2322 m When included, a showmatch will always wait half a
2323 second. When not included, a showmatch will wait half
2324 a second or until a character is typed. |'showmatch'|
2325 *cpo-M*
2326 M When excluded, "%" matching will take backslashes into
2327 account. Thus in "( \( )" and "\( ( \)" the outer
2328 parenthesis match. When included "%" ignores
2329 backslashes, which is Vi compatible.
2330 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002331 n When included, the column used for 'number' and
2332 'relativenumber' will also be used for text of wrapped
2333 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 *cpo-o*
2335 o Line offset to search command is not remembered for
2336 next search.
2337 *cpo-O*
2338 O Don't complain if a file is being overwritten, even
2339 when it didn't exist when editing it. This is a
2340 protection against a file unexpectedly created by
2341 someone else. Vi didn't complain about this.
2342 *cpo-p*
2343 p Vi compatible Lisp indenting. When not present, a
2344 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002345 *cpo-P*
2346 P When included, a ":write" command that appends to a
2347 file will set the file name for the current buffer, if
2348 the current buffer doesn't have a file name yet and
2349 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002350 *cpo-q*
2351 q When joining multiple lines leave the cursor at the
2352 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 *cpo-r*
2354 r Redo ("." command) uses "/" to repeat a search
2355 command, instead of the actually used search string.
2356 *cpo-R*
2357 R Remove marks from filtered lines. Without this flag
2358 marks are kept like |:keepmarks| was used.
2359 *cpo-s*
2360 s Set buffer options when entering the buffer for the
2361 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002362 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 set when the buffer is created.
2364 *cpo-S*
2365 S Set buffer options always when entering a buffer
2366 (except 'readonly', 'fileformat', 'filetype' and
2367 'syntax'). This is the (most) Vi compatible setting.
2368 The options are set to the values in the current
2369 buffer. When you change an option and go to another
2370 buffer, the value is copied. Effectively makes the
2371 buffer options global to all buffers.
2372
2373 's' 'S' copy buffer options
2374 no no when buffer created
2375 yes no when buffer first entered (default)
2376 X yes each time when buffer entered (vi comp.)
2377 *cpo-t*
2378 t Search pattern for the tag command is remembered for
2379 "n" command. Otherwise Vim only puts the pattern in
2380 the history for search pattern, but doesn't change the
2381 last used search pattern.
2382 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002383 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 *cpo-v*
2385 v Backspaced characters remain visible on the screen in
2386 Insert mode. Without this flag the characters are
2387 erased from the screen right away. With this flag the
2388 screen newly typed text overwrites backspaced
2389 characters.
2390 *cpo-w*
2391 w When using "cw" on a blank character, only change one
2392 character and not all blanks until the start of the
2393 next word.
2394 *cpo-W*
2395 W Don't overwrite a readonly file. When omitted, ":w!"
2396 overwrites a readonly file, if possible.
2397 *cpo-x*
2398 x <Esc> on the command-line executes the command-line.
2399 The default in Vim is to abandon the command-line,
2400 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002401 *cpo-X*
2402 X When using a count with "R" the replaced text is
2403 deleted only once. Also when repeating "R" with "."
2404 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002406 y A yank command can be redone with ".". Think twice if
2407 you really want to use this, it may break some
2408 plugins, since most people expect "." to only repeat a
2409 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002410 *cpo-Z*
2411 Z When using "w!" while the 'readonly' option is set,
2412 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 *cpo-!*
2414 ! When redoing a filter command, use the last used
2415 external command, whatever it was. Otherwise the last
2416 used -filter- command is used.
2417 *cpo-$*
2418 $ When making a change to one line, don't redisplay the
2419 line, but put a '$' at the end of the changed text.
2420 The changed text will be overwritten when you type the
2421 new text. The line is redisplayed if you type any
2422 command that moves the cursor from the insertion
2423 point.
2424 *cpo-%*
2425 % Vi-compatible matching is done for the "%" command.
2426 Does not recognize "#if", "#endif", etc.
2427 Does not recognize "/*" and "*/".
2428 Parens inside single and double quotes are also
2429 counted, causing a string that contains a paren to
2430 disturb the matching. For example, in a line like
2431 "if (strcmp("foo(", s))" the first paren does not
2432 match the last one. When this flag is not included,
2433 parens inside single and double quotes are treated
2434 specially. When matching a paren outside of quotes,
2435 everything inside quotes is ignored. When matching a
2436 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002437 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002438 This flag is also used for other features, such as
2439 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002440 *cpo--*
2441 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002442 it would go above the first line or below the last
2443 line. Without it the cursor moves to the first or
2444 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002445 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002446 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002447 *cpo-+*
2448 + When included, a ":write file" command will reset the
2449 'modified' flag of the buffer, even though the buffer
2450 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002451 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 * Use ":*" in the same way as ":@". When not included,
2453 ":*" is an alias for ":'<,'>", select the Visual area.
2454 *cpo-<*
2455 < Disable the recognition of special key codes in |<>|
2456 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002457 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 ":map X <Tab>" results in X being mapped to:
2459 '<' included: "<Tab>" (5 characters)
2460 '<' excluded: "^I" (^I is a real <Tab>)
2461 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002462 *cpo->*
2463 > When appending to a register, put a line break before
2464 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002465 *cpo-;*
2466 ; When using |,| or |;| to repeat the last |t| search
2467 and the cursor is right in front of the searched
2468 character, the cursor won't move. When not included,
2469 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002470 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002471
2472 POSIX flags. These are not included in the Vi default value, except
2473 when $VIM_POSIX was set on startup. |posix|
2474
2475 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002476 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002477 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002478 *cpo-&*
2479 & When ":preserve" was used keep the swap file when
2480 exiting normally while this buffer is still loaded.
2481 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002482 *cpo-\*
2483 \ Backslash in a [] range in a search pattern is taken
2484 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002485 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2486 '\' excluded: "/[ \-]" finds <Space> and '-'
2487 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002488 *cpo-/*
2489 / When "%" is used as the replacement string in a |:s|
2490 command, use the previous replacement string. |:s%|
2491 *cpo-{*
2492 { The |{| and |}| commands also stop at a "{" character
2493 at the start of a line.
2494 *cpo-.*
2495 . The ":chdir" and ":cd" commands fail if the current
2496 buffer is modified, unless ! is used. Vim doesn't
2497 need this, since it remembers the full path of an
2498 opened file.
2499 *cpo-bar*
2500 | The value of the $LINES and $COLUMNS environment
2501 variables overrule the terminal size values obtained
2502 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002503
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002505 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002506'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002507 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002508 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002509 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002510 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002511 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002512 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002513 blowfish Blowfish method. Medium strong encryption but it has
2514 an implementation flaw. Requires Vim 7.3 or later,
2515 files can NOT be read by Vim 7.2 and older. This adds
2516 a "seed" to the file, every time you write the file
2517 the encrypted bytes will be different.
2518 *blowfish2*
2519 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002520 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002521 and older. This adds a "seed" to the file, every time
2522 you write the file the encrypted bytes will be
2523 different. The whole undo file is encrypted, not just
2524 the pieces of text.
Bram Moolenaara2baa732022-02-04 16:09:54 +00002525 *E1193* *E1194* *E1195* *E1196* *E1230*
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002526 *E1197* *E1198* *E1199* *E1200* *E1201*
2527 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2528 Code. Medium strong till strong encryption.
2529 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002530 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002531 It adds a seed and a message authentication code (MAC)
2532 to the file. This needs at least a Vim 8.2.3022 to
2533 read the encrypted file.
2534 Encryption of swap files is not supported, therefore
2535 no swap file will be used when xchacha20 encryption is
2536 enabled.
2537 Encryption of undo files is not yet supported,
2538 therefore no undo file will currently be written.
2539 CURRENTLY EXPERIMENTAL: Files written with this method
2540 might have to be read back with the same version of
2541 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002542
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002543 You should use "blowfish2", also to re-encrypt older files.
2544
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002545 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002546 to the detected method of the file being read. Thus if you write it
2547 without changing 'cryptmethod' the same method will be used.
2548 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002549 explicitly write it, you don't get a warning unless there are other
2550 modifications. Also see |:X|.
2551
2552 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002553 the value "blowfish2". When setting the local value to an empty
2554 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002555
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002556 When a new encryption method is added in a later version of Vim, and
2557 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002558 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002559
2560
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 *'cscopepathcomp'* *'cspc'*
2562'cscopepathcomp' 'cspc' number (default 0)
2563 global
2564 {not available when compiled without the |+cscope|
2565 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 Determines how many components of the path to show in a list of tags.
2567 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002568 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569
2570 *'cscopeprg'* *'csprg'*
2571'cscopeprg' 'csprg' string (default "cscope")
2572 global
2573 {not available when compiled without the |+cscope|
2574 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 Specifies the command to execute cscope. See |cscopeprg|.
2576 This option cannot be set from a |modeline| or in the |sandbox|, for
2577 security reasons.
2578
2579 *'cscopequickfix'* *'csqf'*
2580'cscopequickfix' 'csqf' string (default "")
2581 global
2582 {not available when compiled without the |+cscope|
2583 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 Specifies whether to use quickfix window to show cscope results.
2585 See |cscopequickfix|.
2586
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002587 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002588'cscoperelative' 'csre' boolean (default off)
2589 global
2590 {not available when compiled without the |+cscope|
2591 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002592 In the absence of a prefix (-P) for cscope. setting this option enables
2593 to use the basename of cscope.out path as the prefix.
2594 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002595 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002596
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2598'cscopetag' 'cst' boolean (default off)
2599 global
2600 {not available when compiled without the |+cscope|
2601 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 Use cscope for tag commands. See |cscope-options|.
2603 NOTE: This option is reset when 'compatible' is set.
2604
2605 *'cscopetagorder'* *'csto'*
2606'cscopetagorder' 'csto' number (default 0)
2607 global
2608 {not available when compiled without the |+cscope|
2609 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610 Determines the order in which ":cstag" performs a search. See
2611 |cscopetagorder|.
2612 NOTE: This option is set to 0 when 'compatible' is set.
2613
2614 *'cscopeverbose'* *'csverb'*
2615 *'nocscopeverbose'* *'nocsverb'*
2616'cscopeverbose' 'csverb' boolean (default off)
2617 global
2618 {not available when compiled without the |+cscope|
2619 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620 Give messages when adding a cscope database. See |cscopeverbose|.
2621 NOTE: This option is reset when 'compatible' is set.
2622
Bram Moolenaar860cae12010-06-05 23:22:07 +02002623 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2624'cursorbind' 'crb' boolean (default off)
2625 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002626 When this option is set, as the cursor in the current
2627 window moves other cursorbound windows (windows that also have
2628 this option set) move their cursors to the corresponding line and
2629 column. This option is useful for viewing the
2630 differences between two versions of a file (see 'diff'); in diff mode,
2631 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002632 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002633
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002634
2635 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2636'cursorcolumn' 'cuc' boolean (default off)
2637 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002638 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002639 feature}
2640 Highlight the screen column of the cursor with CursorColumn
2641 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2642 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002643 If you only want the highlighting in the current window you can use
2644 these autocommands: >
2645 au WinLeave * set nocursorline nocursorcolumn
2646 au WinEnter * set cursorline cursorcolumn
2647<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002648
2649 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2650'cursorline' 'cul' boolean (default off)
2651 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002652 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002653 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002654 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2655 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002656 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002657 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002658
2659
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002660 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002661'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002662 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002663 {not available when compiled without the |+syntax|
2664 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002665 Comma-separated list of settings for how 'cursorline' is displayed.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002666 Valid values:
2667 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002668 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002669 "screenline" Highlight only the screen line of the cursor with
2670 CursorLine |hl-CursorLine|.
2671 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002672 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002673
2674 Special value:
2675 "both" Alias for the values "line,number".
2676
2677 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002678
2679
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 *'debug'*
2681'debug' string (default "")
2682 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002683 These values can be used:
2684 msg Error messages that would otherwise be omitted will be given
2685 anyway.
2686 throw Error messages that would otherwise be omitted will be given
2687 anyway and also throw an exception and set |v:errmsg|.
2688 beep A message will be given when otherwise only a beep would be
2689 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002690 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002691 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2692 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693
2694 *'define'* *'def'*
2695'define' 'def' string (default "^\s*#\s*define")
2696 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002697 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 pattern, just like for the "/" command. This option is used for the
2699 commands like "[i" and "[d" |include-search|. The 'isident' option is
2700 used to recognize the defined name after the match:
2701 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2702 See |option-backslash| about inserting backslashes to include a space
2703 or backslash.
2704 The default value is for C programs. For C++ this value would be
2705 useful, to include const type declarations: >
2706 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002707< You can also use "\ze" just before the name and continue the pattern
2708 to check what is following. E.g. for Javascript, if a function is
2709 defined with "func_name = function(args)": >
2710 ^\s*\ze\i\+\s*=\s*function(
2711< If the function is defined with "func_name : function() {...": >
2712 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002714 To avoid that use `:let` with a single quote string: >
2715 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002716<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717
2718 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2719'delcombine' 'deco' boolean (default off)
2720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 If editing Unicode and this option is set, backspace and Normal mode
2722 "x" delete each combining character on its own. When it is off (the
2723 default) the character along with its combining characters are
2724 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002725 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726
2727 This is useful for Arabic, Hebrew and many other languages where one
2728 may have combining characters overtop of base characters, and want
2729 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
2732 *'dictionary'* *'dict'*
2733'dictionary' 'dict' string (default "")
2734 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 List of file names, separated by commas, that are used to lookup words
2736 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2737 contain a list of words. This can be one word per line, or several
2738 words per line, separated by non-keyword characters (white space is
2739 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002740
2741 When this option is empty or an entry "spell" is present, and spell
2742 checking is enabled, words in the word lists for the currently active
2743 'spelllang' are used. See |spell|.
2744
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002745 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 after a comma are ignored, otherwise spaces are included in the file
2747 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002748 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 Where to find a list of words?
2750 - On FreeBSD, there is the file "/usr/share/dict/words".
2751 - In the Simtel archive, look in the "msdos/linguist" directory.
2752 - In "miscfiles" of the GNU collection.
2753 The use of |:set+=| and |:set-=| is preferred when adding or removing
2754 directories from the list. This avoids problems when a future version
2755 uses another default.
2756 Backticks cannot be used in this option for security reasons.
2757
2758 *'diff'* *'nodiff'*
2759'diff' boolean (default off)
2760 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 {not available when compiled without the |+diff|
2762 feature}
2763 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002764 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765
2766 *'dex'* *'diffexpr'*
2767'diffexpr' 'dex' string (default "")
2768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 {not available when compiled without the |+diff|
2770 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002771 Expression which is evaluated to obtain a diff file (either ed-style
2772 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 This option cannot be set from a |modeline| or in the |sandbox|, for
2774 security reasons.
2775
2776 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002777'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 {not available when compiled without the |+diff|
2780 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002781 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 All are optional. Items must be separated by a comma.
2783
2784 filler Show filler lines, to keep the text
2785 synchronized with a window that has inserted
2786 lines at the same position. Mostly useful
2787 when windows are side-by-side and 'scrollbind'
2788 is set.
2789
2790 context:{n} Use a context of {n} lines between a change
2791 and a fold that contains unchanged lines.
2792 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002793 When using zero the context is actually one,
2794 since folds require a line in between, also
2795 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 See |fold-diff|.
2797
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002798 iblank Ignore changes where lines are all blank. Adds
2799 the "-B" flag to the "diff" command if
2800 'diffexpr' is empty. Check the documentation
2801 of the "diff" command for what this does
2802 exactly.
2803 NOTE: the diff windows will get out of sync,
2804 because no differences between blank lines are
2805 taken into account.
2806
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 icase Ignore changes in case of text. "a" and "A"
2808 are considered the same. Adds the "-i" flag
2809 to the "diff" command if 'diffexpr' is empty.
2810
2811 iwhite Ignore changes in amount of white space. Adds
2812 the "-b" flag to the "diff" command if
2813 'diffexpr' is empty. Check the documentation
2814 of the "diff" command for what this does
2815 exactly. It should ignore adding trailing
2816 white space, but not leading white space.
2817
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002818 iwhiteall Ignore all white space changes. Adds
2819 the "-w" flag to the "diff" command if
2820 'diffexpr' is empty. Check the documentation
2821 of the "diff" command for what this does
2822 exactly.
2823
2824 iwhiteeol Ignore white space changes at end of line.
2825 Adds the "-Z" flag to the "diff" command if
2826 'diffexpr' is empty. Check the documentation
2827 of the "diff" command for what this does
2828 exactly.
2829
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002830 horizontal Start diff mode with horizontal splits (unless
2831 explicitly specified otherwise).
2832
2833 vertical Start diff mode with vertical splits (unless
2834 explicitly specified otherwise).
2835
Bram Moolenaarc8234772019-11-10 21:00:27 +01002836 closeoff When a window is closed where 'diff' is set
2837 and there is only one window remaining in the
2838 same tab page with 'diff' set, execute
2839 `:diffoff` in that window. This undoes a
2840 `:diffsplit` command.
2841
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002842 hiddenoff Do not use diff mode for a buffer when it
2843 becomes hidden.
2844
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002845 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2846 starting diff mode. Without this 2 is used.
2847
Bram Moolenaar4223d432021-02-10 13:18:17 +01002848 followwrap Follow the 'wrap' option and leave as it is.
2849
Bram Moolenaare828b762018-09-10 17:51:58 +02002850 internal Use the internal diff library. This is
2851 ignored when 'diffexpr' is set. *E960*
2852 When running out of memory when writing a
2853 buffer this item will be ignored for diffs
2854 involving that buffer. Set the 'verbose'
2855 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856
Bram Moolenaare828b762018-09-10 17:51:58 +02002857 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002858 Use the indent heuristic for the internal
2859 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002860
2861 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002862 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002863 algorithms are:
2864 myers the default algorithm
2865 minimal spend extra time to generate the
2866 smallest possible diff
2867 patience patience diff algorithm
2868 histogram histogram diff algorithm
2869
2870 Examples: >
2871 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002873 :set diffopt=internal,filler,foldcolumn:3
2874 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875<
2876 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2877'digraph' 'dg' boolean (default off)
2878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 {not available when compiled without the |+digraphs|
2880 feature}
2881 Enable the entering of digraphs in Insert mode with {char1} <BS>
2882 {char2}. See |digraphs|.
2883 NOTE: This option is reset when 'compatible' is set.
2884
2885 *'directory'* *'dir'*
2886'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002887 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 for Unix: ".,~/tmp,/var/tmp,/tmp")
2889 global
2890 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002891 Recommended value: ".,~/vimswap//" - this will put the swap file next
2892 to the edited file if possible, and in your personal swap directory
2893 otherwise. Make sure "~/vimswap//" is only readable for you.
2894
2895 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 - The swap file will be created in the first directory where this is
2897 possible.
2898 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002899 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 - A directory "." means to put the swap file in the same directory as
2901 the edited file. On Unix, a dot is prepended to the file name, so
2902 it doesn't show in a directory listing. On MS-Windows the "hidden"
2903 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002904 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2905 the swap file relative to where the edited file is. The leading "."
2906 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002907 - For Unix and Win32, if a directory ends in two path separators "//",
2908 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002909 with all path separators replaced by percent '%' signs (including
2910 the colon following the drive letter on Win32). This will ensure
2911 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002912 On Win32, it is also possible to end with "\\". However, When a
2913 separating comma is following, you must use "//", since "\\" will
2914 include the comma in the file name. Therefore it is recommended to
2915 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 - Spaces after the comma are ignored, other spaces are considered part
2917 of the directory name. To have a space at the start of a directory
2918 name, precede it with a backslash.
2919 - To include a comma in a directory name precede it with a backslash.
2920 - A directory name may end in an ':' or '/'.
2921 - Environment variables are expanded |:set_env|.
2922 - Careful with '\' characters, type one before a space, type two to
2923 get one in the option (see |option-backslash|), for example: >
2924 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2925< - For backwards compatibility with Vim version 3.0 a '>' at the start
2926 of the option is removed.
2927 Using "." first in the list is recommended. This means that editing
2928 the same file twice will result in a warning. Using "/tmp" on Unix is
2929 discouraged: When the system crashes you lose the swap file.
2930 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002931 choice than "/tmp". But others on the computer may be able to see the
2932 files, and it can contain a lot of files, your swap files get lost in
2933 the crowd. That is why a "tmp" directory in your home directory is
2934 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935 The use of |:set+=| and |:set-=| is preferred when adding or removing
2936 directories from the list. This avoids problems when a future version
2937 uses another default.
2938 This option cannot be set from a |modeline| or in the |sandbox|, for
2939 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940
2941 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002942'display' 'dy' string (default "", set to "truncate" in
2943 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 global
Bram Moolenaarf269eab2022-10-03 18:04:35 +01002945 Change the way text is displayed. This is a comma-separated list of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 flags:
2947 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002948 in a window will be displayed. "@@@" is put in the
2949 last columns of the last screen line to indicate the
2950 rest of the line is not displayed.
2951 truncate Like "lastline", but "@@@" is displayed in the first
2952 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 uhex Show unprintable characters hexadecimal as <xx>
2954 instead of using ^C and ~C.
2955
Bram Moolenaard0796902016-09-16 20:02:31 +02002956 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002957 doesn't fit is replaced with "@" lines.
2958
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01002959 The "@" character can be changed by setting the "lastline" item in
2960 'fillchars'. The character is highlighted with |hl-NonText|.
2961
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 *'eadirection'* *'ead'*
2963'eadirection' 'ead' string (default "both")
2964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 Tells when the 'equalalways' option applies:
2966 ver vertically, width of windows is not affected
2967 hor horizontally, height of windows is not affected
2968 both width and height of windows is affected
2969
2970 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2971'edcompatible' 'ed' boolean (default off)
2972 global
2973 Makes the 'g' and 'c' flags of the ":substitute" command to be
2974 toggled each time the flag is given. See |complex-change|. See
2975 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002976 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002977 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978
Bram Moolenaar03413f42016-04-12 21:07:15 +02002979 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002980'emoji' 'emo' boolean (default: on)
2981 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002982 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002983 This excludes "text emoji" characters, which are normally displayed as
2984 single width. Unfortunately there is no good specification for this
2985 and it has been determined on trial-and-error basis. Use the
2986 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002987
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002989'encoding' 'enc' string (default for MS-Windows: "utf-8",
2990 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 Sets the character encoding used inside Vim. It applies to text in
2993 the buffers, registers, Strings in expressions, text stored in the
2994 viminfo file, etc. It sets the kind of characters which Vim can work
2995 with. See |encoding-names| for the possible values.
2996
2997 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002998 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00003000 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001
Bram Moolenaar865242e2010-07-14 21:12:05 +02003002 This option cannot be set from a |modeline|. It would most likely
3003 corrupt the text.
3004
Bram Moolenaar3df01732017-02-17 22:47:16 +01003005 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
3006 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 'encoding', "utf-8" is the natural choice for the environment and
3008 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003009 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 versions, and to avoid changing the encoding of newly created files
3011 without your knowledge (in case 'fileencodings' is empty).
3012
3013 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003014 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 iconv() or as specified with 'charconvert'.
3016
Bram Moolenaar207f0092020-08-30 17:20:20 +02003017 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003018 can use: >
3019 if has("multi_byte_encoding")
3020<
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 Normally 'encoding' will be equal to your current locale. This will
3022 be the default if Vim recognizes your environment settings. If
3023 'encoding' is not set to the current locale, 'termencoding' must be
3024 set to convert typed and displayed text. See |encoding-table|.
3025
3026 When you set this option, it fires the |EncodingChanged| autocommand
3027 event so that you can set up fonts if necessary.
3028
3029 When the option is set, the value is converted to lowercase. Thus
3030 you can set it with uppercase values too. Underscores are translated
3031 to '-' signs.
3032 When the encoding is recognized, it is changed to the standard name.
3033 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
3034 "iso-8859-2" and "utf8" becomes "utf-8".
3035
3036 Note: "latin1" is also used when the encoding could not be detected.
3037 This only works when editing files in the same encoding! When the
3038 actual character set is not latin1, make sure 'fileencoding' and
3039 'fileencodings' are empty. When conversion is needed, switch to using
3040 utf-8.
3041
3042 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
3043 You don't notice this while editing, but it does matter for the
3044 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
3045 setting 'encoding' to one of these values instead of utf-8 only has
3046 effect for encoding used for files when 'fileencoding' is empty.
3047
Bram Moolenaar661b1822005-07-28 22:36:45 +00003048 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
3049 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003051 *'endoffile'* *'eof'* *'noendoffile'* *'noeof'*
Bram Moolenaar0aad88f2022-11-12 11:54:26 +00003052'endoffile' 'eof' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 local to buffer
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003054 Indicates that a CTRL-Z character was found at the end of the file
3055 when reading it. Normally only happens when 'fileformat' is "dos".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 When writing a file and this option is off and the 'binary' option
Bram Moolenaar6ebe4f92022-10-28 20:47:54 +01003057 is on, or 'fixeol' option is off, no CTRL-Z will be written at the
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003058 end of the file.
K.Takata3af98212022-11-01 20:36:19 +00003059 See |eol-and-eof| for example settings.
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003060
3061 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
3062'endofline' 'eol' boolean (default on)
3063 local to buffer
3064 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003065 is on, or 'fixeol' option is off, no <EOL> will be written for the
3066 last line in the file. This option is automatically set or reset when
3067 starting to edit a new file, depending on whether file has an <EOL>
3068 for the last line in the file. Normally you don't have to set or
3069 reset this option.
3070 When 'binary' is off and 'fixeol' is on the value is not used when
3071 writing the file. When 'binary' is on or 'fixeol' is off it is used
3072 to remember the presence of a <EOL> for the last line in the file, so
3073 that when you write the file the situation from the original file can
3074 be kept. But you can change it if you want to.
K.Takata3af98212022-11-01 20:36:19 +00003075 See |eol-and-eof| for example settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076
3077 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
3078'equalalways' 'ea' boolean (default on)
3079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00003081 splitting or closing a window. This also happens the moment the
3082 option is switched on. When off, splitting a window will reduce the
3083 size of the current window and leave the other windows the same. When
3084 closing a window the extra lines are given to the window next to it
3085 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 When mixing vertically and horizontally split windows, a minimal size
3087 is computed and some windows may be larger if there is room. The
3088 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00003089 Changing the height and width of a window can be avoided by setting
3090 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003091 If a window size is specified when creating a new window sizes are
3092 currently not equalized (it's complicated, but may be implemented in
3093 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094
3095 *'equalprg'* *'ep'*
3096'equalprg' 'ep' string (default "")
3097 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00003099 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003100 or 'indentexpr'. When Vim was compiled without internal formatting,
3101 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003102 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 about including spaces and backslashes.
3104 This option cannot be set from a |modeline| or in the |sandbox|, for
3105 security reasons.
3106
3107 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3108'errorbells' 'eb' boolean (default off)
3109 global
3110 Ring the bell (beep or screen flash) for error messages. This only
3111 makes a difference for error messages, the bell will be used always
3112 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003113 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003114 screen flash or do nothing. See 'belloff' to finetune when to ring the
3115 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116
3117 *'errorfile'* *'ef'*
3118'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3119 others: "errors.err")
3120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 {not available when compiled without the |+quickfix|
3122 feature}
3123 Name of the errorfile for the QuickFix mode (see |:cf|).
3124 When the "-q" command-line argument is used, 'errorfile' is set to the
3125 following argument. See |-q|.
3126 NOT used for the ":make" command. See 'makeef' for that.
3127 Environment variables are expanded |:set_env|.
3128 See |option-backslash| about including spaces and backslashes.
3129 This option cannot be set from a |modeline| or in the |sandbox|, for
3130 security reasons.
3131
3132 *'errorformat'* *'efm'*
3133'errorformat' 'efm' string (default is very long)
3134 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 {not available when compiled without the |+quickfix|
3136 feature}
3137 Scanf-like description of the format for the lines in the error file
3138 (see |errorformat|).
3139
3140 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3141'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 Function keys that start with an <Esc> are recognized in Insert
3144 mode. When this option is off, the cursor and function keys cannot be
3145 used in Insert mode if they start with an <Esc>. The advantage of
3146 this is that the single <Esc> is recognized immediately, instead of
3147 after one second. Instead of resetting this option, you might want to
3148 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3149 when 'esckeys' is off, you can still map anything, but the cursor keys
3150 won't work by default.
3151 NOTE: This option is set to the Vi default value when 'compatible' is
3152 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003153 NOTE: when this option is off then the |modifyOtherKeys| functionality
3154 is disabled while in Insert mode to avoid ending Insert mode with any
3155 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156
3157 *'eventignore'* *'ei'*
3158'eventignore' 'ei' string (default "")
3159 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003161 When set to "all" or when "all" is one of the items, all autocommand
3162 events are ignored, autocommands will not be executed.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003163 Otherwise this is a comma-separated list of event names. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 :set ei=WinEnter,WinLeave
3165<
3166 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3167'expandtab' 'et' boolean (default off)
3168 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003170 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3172 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003173 This option is reset when the 'paste' option is set and restored when
3174 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 NOTE: This option is reset when 'compatible' is set.
3176
3177 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3178'exrc' 'ex' boolean (default off)
3179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003181 directory.
3182
3183 Setting this option is a potential security leak. E.g., consider
3184 unpacking a package or fetching files from github, a .vimrc in there
3185 might be a trojan horse. BETTER NOT SET THIS OPTION!
3186 Instead, define an autocommand in your .vimrc to set options for a
3187 matching directory.
3188
3189 If you do switch this option on you should also consider setting the
3190 'secure' option (see |initialization|).
3191 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 This option cannot be set from a |modeline| or in the |sandbox|, for
3193 security reasons.
3194
3195 *'fileencoding'* *'fenc'* *E213*
3196'fileencoding' 'fenc' string (default: "")
3197 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003199
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003201 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 When 'fileencoding' is empty, the same value as 'encoding' will be
3203 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003204 No error will be given when the value is set, only when it is used,
3205 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003206 Conversion will also be done when 'encoding' and 'fileencoding' are
3207 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3208 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003210 'encoding' is "utf-8" or another Unicode encoding, conversion
3211 is most likely done in a way that the reverse conversion
3212 results in the same text. When 'encoding' is not "utf-8" some
3213 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003214
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 See 'encoding' for the possible values. Additionally, values may be
3216 specified that can be handled by the converter, see
3217 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003218
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 When reading a file 'fileencoding' will be set from 'fileencodings'.
3220 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003221 'fileencoding', use the |++enc| argument. One exception: when
3222 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003223 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003224
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3226 When the option is set, the value is converted to lowercase. Thus
3227 you can set it with uppercase values too. '_' characters are
3228 replaced with '-'. If a name is recognized from the list for
3229 'encoding', it is replaced by the standard name. For example
3230 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003231
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 When this option is set, after starting to edit a file, the 'modified'
3233 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003234
3235 Keep in mind that changing 'fenc' from a modeline happens
3236 AFTER the text has been read, thus it applies to when the file will be
3237 written. If you do set 'fenc' in a modeline, you might want to set
3238 'nomodified' to avoid not being able to ":q".
3239
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 This option can not be changed when 'modifiable' is off.
3241
3242 *'fe'*
3243 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003244 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 old short name was 'fe', which is no longer used.
3246
3247 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003248'fileencodings' 'fencs' string (default: "ucs-bom",
3249 "ucs-bom,utf-8,default,latin1" when
3250 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 This is a list of character encodings considered when starting to edit
3253 an existing file. When a file is read, Vim tries to use the first
3254 mentioned character encoding. If an error is detected, the next one
3255 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003256 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 an empty string, which means the value of 'encoding' is used.
3258 WARNING: Conversion can cause loss of information! When
3259 'encoding' is "utf-8" (or one of the other Unicode variants)
3260 conversion is most likely done in a way that the reverse
3261 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003262 "utf-8" some non-ASCII characters may be lost! You can use
3263 the |++bad| argument to specify what is done with characters
3264 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 For an empty file or a file with only ASCII characters most encodings
3266 will work and the first entry of 'fileencodings' will be used (except
3267 "ucs-bom", which requires the BOM to be present). If you prefer
3268 another encoding use an BufReadPost autocommand event to test if your
3269 preferred encoding is to be used. Example: >
3270 au BufReadPost * if search('\S', 'w') == 0 |
3271 \ set fenc=iso-2022-jp | endif
3272< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3273 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003274 When the |++enc| argument is used then the value of 'fileencodings' is
3275 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003276 Note that 'fileencodings' is not used for a new file, the global value
3277 of 'fileencoding' is used instead. You can set it with: >
3278 :setglobal fenc=iso-8859-2
3279< This means that a non-existing file may get a different encoding than
3280 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 The special value "ucs-bom" can be used to check for a Unicode BOM
3282 (Byte Order Mark) at the start of the file. It must not be preceded
3283 by "utf-8" or another Unicode encoding for this to work properly.
3284 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3285 because Vim cannot detect an error, thus the encoding is always
3286 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003287 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003288 environment. On MS-Windows this is the system encoding. Otherwise
3289 this is the default value for 'encoding'. It is useful when
3290 'encoding' is set to "utf-8" and your environment uses a non-latin1
3291 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003292 When 'encoding' is "utf-8" and a file contains an illegal byte
3293 sequence it won't be recognized as UTF-8. You can use the |8g8|
3294 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 WRONG VALUES: WHAT'S WRONG:
3296 latin1,utf-8 "latin1" will always be used
3297 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3298 file
3299 cp1250,latin1 "cp1250" will always be used
3300 If 'fileencodings' is empty, 'fileencoding' is not modified.
3301 See 'fileencoding' for the possible values.
3302 Setting this option does not have an effect until the next time a file
3303 is read.
3304
3305 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003306'fileformat' 'ff' string (MS-Windows default: "dos",
3307 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 This gives the <EOL> of the current buffer, which is used for
3310 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003311 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 unix <NL>
3313 mac <CR>
3314 When "dos" is used, CTRL-Z at the end of a file is ignored.
3315 See |file-formats| and |file-read|.
3316 For the character encoding of the file see 'fileencoding'.
3317 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003318 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 This option is set automatically when starting to edit a file and
3320 'fileformats' is not empty and 'binary' is off.
3321 When this option is set, after starting to edit a file, the 'modified'
3322 option is set, because the file would be different when written.
3323 This option can not be changed when 'modifiable' is off.
3324 For backwards compatibility: When this option is set to "dos",
3325 'textmode' is set, otherwise 'textmode' is reset.
3326
3327 *'fileformats'* *'ffs'*
3328'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003329 Vim+Vi MS-Windows: "dos,unix",
3330 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 Vi Cygwin: "unix,dos",
3332 Vi others: "")
3333 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 This gives the end-of-line (<EOL>) formats that will be tried when
3335 starting to edit a new buffer and when reading a file into an existing
3336 buffer:
3337 - When empty, the format defined with 'fileformat' will be used
3338 always. It is not set automatically.
3339 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003340 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 'fileformats' name will be used when a file is read into an existing
3342 buffer, no matter what 'fileformat' for that buffer is set to.
3343 - When more than one name is present, separated by commas, automatic
3344 <EOL> detection will be done when reading a file. When starting to
3345 edit a file, a check is done for the <EOL>:
3346 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3347 'fileformat' is set to "dos".
3348 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003349 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003351 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3352 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003353 This means that "mac" is only chosen when:
3354 "unix" is not present or no <NL> is found in the file, and
3355 "dos" is not present or no <CR><NL> is found in the file.
3356 Except: if "unix" was chosen, but there is a <CR> before
3357 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003358 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 4. If 'fileformat' is still not set, the first name from
3360 'fileformats' is used.
3361 When reading a file into an existing buffer, the same is done, but
3362 this happens like 'fileformat' has been set appropriately for that
3363 file only, the option is not changed.
3364 When 'binary' is set, the value of 'fileformats' is not used.
3365
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003366 When Vim starts up with an empty buffer the first item is used. You
3367 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003368
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3370 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3371 done:
3372 - When 'fileformats' is empty, there is no automatic detection. Dos
3373 format will be used.
3374 - When 'fileformats' is set to one or more names, automatic detection
3375 is done. This is based on the first <NL> in the file: If there is a
3376 <CR> in front of it, Dos format is used, otherwise Unix format is
3377 used.
3378 Also see |file-formats|.
3379 For backwards compatibility: When this option is set to an empty
3380 string or one format (no comma is included), 'textauto' is reset,
3381 otherwise 'textauto' is set.
3382 NOTE: This option is set to the Vi default value when 'compatible' is
3383 set and to the Vim default value when 'compatible' is reset.
3384
Bram Moolenaarbf884932013-04-05 22:26:15 +02003385 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3386'fileignorecase' 'fic' boolean (default on for systems where case in file
3387 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003388 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003389 When set case is ignored when using file names and directories.
3390 See 'wildignorecase' for only ignoring case when doing completion.
3391
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 *'filetype'* *'ft'*
3393'filetype' 'ft' string (default: "")
3394 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 When this option is set, the FileType autocommand event is triggered.
3396 All autocommands that match with the value of this option will be
3397 executed. Thus the value of 'filetype' is used in place of the file
3398 name.
3399 Otherwise this option does not always reflect the current file type.
3400 This option is normally set when the file type is detected. To enable
3401 this use the ":filetype on" command. |:filetype|
3402 Setting this option to a different value is most useful in a modeline,
3403 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003404 Example, for in an IDL file:
3405 /* vim: set filetype=idl : */ ~
3406 |FileType| |filetypes|
3407 When a dot appears in the value then this separates two filetype
3408 names. Example:
3409 /* vim: set filetype=c.doxygen : */ ~
3410 This will use the "c" filetype first, then the "doxygen" filetype.
3411 This works both for filetype plugins and for syntax files. More than
3412 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 This option is not copied to another buffer, independent of the 's' or
3414 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003415 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416
3417 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003418'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003419 global or local to window |global-local|
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003420 {not available when compiled without the |+folding|
3421 feature}
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003422 Characters to fill the statuslines, vertical separators and special
3423 lines in the window.
3424 It is a comma-separated list of items. Each item has a name, a colon
3425 and the value of that item:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003427 item name default Used for ~
3428 stl ' ' or '^' statusline of the current window
3429 stlnc ' ' or '=' statusline of the non-current windows
3430 vert '|' vertical separators |:vsplit|
3431 fold '-' filling 'foldtext'
3432 foldopen '-' mark the beginning of a fold
3433 foldclose '+' show a closed fold
3434 foldsep '|' open fold middle character
3435 diff '-' deleted lines of the 'diff' option
3436 eob '~' empty lines below the end of a buffer
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003437 lastline '@' 'display' contains lastline/truncate
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003439 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003440 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 otherwise.
3442
3443 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003444 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445< This is similar to the default, except that these characters will also
3446 be used when there is highlighting.
3447
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01003448 For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
3449 single-byte and multibyte characters are supported. But double-width
3450 characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003451
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 The highlighting used for these items:
Bram Moolenaar96ba25a2022-07-04 17:34:33 +01003453 item name highlight group ~
3454 stl StatusLine |hl-StatusLine|
3455 stlnc StatusLineNC |hl-StatusLineNC|
3456 vert VertSplit |hl-VertSplit|
3457 fold Folded |hl-Folded|
3458 diff DiffDelete |hl-DiffDelete|
3459 eob EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar4ba5f1d2022-10-04 14:36:29 +01003460 lastline NonText |hl-NonText|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003462 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3463'fixendofline' 'fixeol' boolean (default on)
3464 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003465 When writing a file and this option is on, <EOL> at the end of file
Bram Moolenaarfb0cf232022-10-22 11:25:19 +01003466 will be restored if missing. Turn this option off if you want to
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003467 preserve the situation from the original file.
3468 When the 'binary' option is set the value of this option doesn't
3469 matter.
3470 See the 'endofline' option.
K.Takata3af98212022-11-01 20:36:19 +00003471 See |eol-and-eof| for example settings.
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003472
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003474'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 {only available when compiled with the |+rightleft|
3477 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003478 This option was for using Farsi, which has been removed. See
3479 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480
3481 *'foldclose'* *'fcl'*
3482'foldclose' 'fcl' string (default "")
3483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 {not available when compiled without the |+folding|
3485 feature}
3486 When set to "all", a fold is closed when the cursor isn't in it and
3487 its level is higher than 'foldlevel'. Useful if you want folds to
3488 automatically close when moving out of them.
3489
3490 *'foldcolumn'* *'fdc'*
3491'foldcolumn' 'fdc' number (default 0)
3492 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 {not available when compiled without the |+folding|
3494 feature}
3495 When non-zero, a column with the specified width is shown at the side
3496 of the window which indicates open and closed folds. The maximum
3497 value is 12.
3498 See |folding|.
3499
3500 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3501'foldenable' 'fen' boolean (default on)
3502 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 {not available when compiled without the |+folding|
3504 feature}
3505 When off, all folds are open. This option can be used to quickly
3506 switch between showing all text unfolded and viewing the text with
3507 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003508 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 'foldenable' is off.
3510 This option is set by commands that create a new fold or close a fold.
3511 See |folding|.
3512
3513 *'foldexpr'* *'fde'*
3514'foldexpr' 'fde' string (default: "0")
3515 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003517 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003519 for each line to obtain its fold level. The context is set to the
3520 script where 'foldexpr' was set, script-local items can be accessed.
3521 See |fold-expr| for the usage.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003522
Bram Moolenaar30b65812012-07-12 22:01:11 +02003523 The expression will be evaluated in the |sandbox| if set from a
3524 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003525 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003526 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003527
3528 It is not allowed to change text or jump to another window while
3529 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530
3531 *'foldignore'* *'fdi'*
3532'foldignore' 'fdi' string (default: "#")
3533 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 {not available when compiled without the |+folding|
3535 feature}
3536 Used only when 'foldmethod' is "indent". Lines starting with
3537 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003538 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 The default "#" works well for C programs. See |fold-indent|.
3540
3541 *'foldlevel'* *'fdl'*
3542'foldlevel' 'fdl' number (default: 0)
3543 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 {not available when compiled without the |+folding|
3545 feature}
3546 Sets the fold level: Folds with a higher level will be closed.
3547 Setting this option to zero will close all folds. Higher numbers will
3548 close fewer folds.
3549 This option is set by commands like |zm|, |zM| and |zR|.
3550 See |fold-foldlevel|.
3551
3552 *'foldlevelstart'* *'fdls'*
3553'foldlevelstart' 'fdls' number (default: -1)
3554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 {not available when compiled without the |+folding|
3556 feature}
3557 Sets 'foldlevel' when starting to edit another buffer in a window.
3558 Useful to always start editing with all folds closed (value zero),
3559 some folds closed (one) or no folds closed (99).
3560 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003561 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 ignores this option and closes all folds.
3563 It is also done before BufReadPre autocommands, to allow an autocmd to
3564 overrule the 'foldlevel' value for specific files.
3565 When the value is negative, it is not used.
3566
3567 *'foldmarker'* *'fmr'* *E536*
3568'foldmarker' 'fmr' string (default: "{{{,}}}")
3569 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 {not available when compiled without the |+folding|
3571 feature}
3572 The start and end marker used when 'foldmethod' is "marker". There
3573 must be one comma, which separates the start and end marker. The
3574 marker is a literal string (a regular expression would be too slow).
3575 See |fold-marker|.
3576
3577 *'foldmethod'* *'fdm'*
3578'foldmethod' 'fdm' string (default: "manual")
3579 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 {not available when compiled without the |+folding|
3581 feature}
3582 The kind of folding used for the current window. Possible values:
3583 |fold-manual| manual Folds are created manually.
3584 |fold-indent| indent Lines with equal indent form a fold.
3585 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3586 |fold-marker| marker Markers are used to specify folds.
3587 |fold-syntax| syntax Syntax highlighting items specify folds.
3588 |fold-diff| diff Fold text that is not changed.
3589
3590 *'foldminlines'* *'fml'*
3591'foldminlines' 'fml' number (default: 1)
3592 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 {not available when compiled without the |+folding|
3594 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003595 Sets the number of screen lines above which a fold can be displayed
3596 closed. Also for manually closed folds. With the default value of
3597 one a fold can only be closed if it takes up two or more screen lines.
3598 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003599 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 "zc" to close a fold, which is displayed open because it's smaller
3601 than 'foldminlines', a following "zc" may close a containing fold.
3602
3603 *'foldnestmax'* *'fdn'*
3604'foldnestmax' 'fdn' number (default: 20)
3605 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 {not available when compiled without the |+folding|
3607 feature}
3608 Sets the maximum nesting of folds for the "indent" and "syntax"
3609 methods. This avoids that too many folds will be created. Using more
3610 than 20 doesn't work, because the internal limit is 20.
3611
3612 *'foldopen'* *'fdo'*
3613'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3614 search,tag,undo")
3615 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 {not available when compiled without the |+folding|
3617 feature}
3618 Specifies for which type of commands folds will be opened, if the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003619 command moves the cursor into a closed fold. It is a comma-separated
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003621 NOTE: When the command is part of a mapping this option is not used.
3622 Add the |zv| command to the mapping to get the same effect.
3623 (rationale: the mapping may want to control opening folds itself)
3624
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 item commands ~
3626 all any
3627 block "(", "{", "[[", "[{", etc.
3628 hor horizontal movements: "l", "w", "fx", etc.
3629 insert any command in Insert mode
3630 jump far jumps: "G", "gg", etc.
3631 mark jumping to a mark: "'m", CTRL-O, etc.
3632 percent "%"
3633 quickfix ":cn", ":crew", ":make", etc.
3634 search search for a pattern: "/", "n", "*", "gd", etc.
3635 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003636 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 tag jumping to a tag: ":ta", CTRL-T, etc.
3638 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 When a movement command is used for an operator (e.g., "dl" or "y%")
3640 this option is not used. This means the operator will include the
3641 whole closed fold.
3642 Note that vertical movements are not here, because it would make it
3643 very difficult to move onto a closed fold.
3644 In insert mode the folds containing the cursor will always be open
3645 when text is inserted.
3646 To close folds you can re-apply 'foldlevel' with the |zx| command or
3647 set the 'foldclose' option to "all".
3648
3649 *'foldtext'* *'fdt'*
3650'foldtext' 'fdt' string (default: "foldtext()")
3651 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 {not available when compiled without the |+folding|
3653 feature}
3654 An expression which is used to specify the text displayed for a closed
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003655 fold. The context is set to the script where 'foldexpr' was set,
3656 script-local items can be accessed. See |fold-foldtext| for the
3657 usage.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658
Bram Moolenaar30b65812012-07-12 22:01:11 +02003659 The expression will be evaluated in the |sandbox| if set from a
3660 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003661 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003662
3663 It is not allowed to change text or jump to another window while
3664 evaluating 'foldtext' |textlock|.
3665
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003666 *'formatexpr'* *'fex'*
3667'formatexpr' 'fex' string (default "")
3668 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003669 {not available when compiled without the |+eval|
3670 feature}
3671 Expression which is evaluated to format a range of lines for the |gq|
3672 operator or automatic formatting (see 'formatoptions'). When this
3673 option is empty 'formatprg' is used.
3674
3675 The |v:lnum| variable holds the first line to be formatted.
3676 The |v:count| variable holds the number of lines to be formatted.
3677 The |v:char| variable holds the character that is going to be
3678 inserted if the expression is being evaluated due to
3679 automatic formatting. This can be empty. Don't insert
3680 it yet!
3681
3682 Example: >
3683 :set formatexpr=mylang#Format()
3684< This will invoke the mylang#Format() function in the
3685 autoload/mylang.vim file in 'runtimepath'. |autoload|
3686
Bram Moolenaara4e0b972022-10-01 19:43:52 +01003687 The advantage of using a function call without arguments is that it is
3688 faster, see |expr-option-function|.
3689
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003690 The expression is also evaluated when 'textwidth' is set and adding
3691 text beyond that limit. This happens under the same conditions as
3692 when internal formatting is used. Make sure the cursor is kept in the
3693 same spot relative to the text then! The |mode()| function will
3694 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003695
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003696 When the expression evaluates to non-zero Vim will fall back to using
3697 the internal format mechanism.
3698
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00003699 If the expression starts with s: or |<SID>|, then it is replaced with
3700 the script ID (|local-function|). Example: >
3701 set formatexpr=s:MyFormatExpr()
3702 set formatexpr=<SID>SomeFormatExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003703< Otherwise, the expression is evaluated in the context of the script
3704 where the option was set, thus script-local items are available.
3705
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003706 The expression will be evaluated in the |sandbox| when set from a
3707 modeline, see |sandbox-option|. That stops the option from working,
3708 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003709 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003710 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003711
Bram Moolenaar86b68352004-12-27 21:59:20 +00003712 *'formatlistpat'* *'flp'*
3713'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3714 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003715 A pattern that is used to recognize a list header. This is used for
3716 the "n" flag in 'formatoptions'.
3717 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003718 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003719 while still checking more characters. There must be a character
3720 following the pattern, when it matches the whole line it is handled
3721 like there is no match.
3722 The default recognizes a number, followed by an optional punctuation
3723 character and white space.
3724
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003725 *'formatoptions'* *'fo'*
3726'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3727 local to buffer
3728 This is a sequence of letters which describes how automatic
3729 formatting is to be done. See |fo-table|. When the 'paste' option is
3730 on, no formatting is done (like 'formatoptions' is empty). Commas can
3731 be inserted for readability.
3732 To avoid problems with flags that are added in the future, use the
3733 "+=" and "-=" feature of ":set" |add-option-flags|.
3734 NOTE: This option is set to the Vi default value when 'compatible' is
3735 set and to the Vim default value when 'compatible' is reset.
3736
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 *'formatprg'* *'fp'*
3738'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003739 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003741 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003743 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003744 If the 'formatexpr' option is not empty it will be used instead.
3745 Otherwise, if 'formatprg' option is an empty string, the internal
3746 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003747 Environment variables are expanded |:set_env|. See |option-backslash|
3748 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003749 This option cannot be set from a |modeline| or in the |sandbox|, for
3750 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751
Bram Moolenaard94464e2015-11-02 15:28:18 +01003752 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003753'fsync' 'fs' boolean (default on)
3754 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003755 When on, the library function fsync() will be called after writing a
3756 file. This will flush a file to disk, ensuring that it is safely
3757 written even on filesystems which do metadata-only journaling. This
3758 will force the harddrive to spin up on Linux systems running in laptop
3759 mode, so it may be undesirable in some situations. Be warned that
3760 turning this off increases the chances of data loss after a crash. On
3761 systems without an fsync() implementation, this variable is always
3762 off.
3763 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003764 'fsync' also applies to |writefile()| (unless a flag is used to
3765 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003766 This option cannot be set from a |modeline| or in the |sandbox|, for
3767 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003768
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3770'gdefault' 'gd' boolean (default off)
3771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 When on, the ":substitute" flag 'g' is default on. This means that
3773 all matches in a line are substituted instead of one. When a 'g' flag
3774 is given to a ":substitute" command, this will toggle the substitution
3775 of all or one match. See |complex-change|.
3776
3777 command 'gdefault' on 'gdefault' off ~
3778 :s/// subst. all subst. one
3779 :s///g subst. one subst. all
3780 :s///gg subst. all subst. one
3781
3782 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003783 DEPRECATED: Setting this option may break plugins that are not aware
3784 of this option. Also, many users get confused that adding the /g flag
3785 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003786 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787
3788 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003789'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 Format to recognize for the ":grep" command output.
3792 This is a scanf-like string that uses the same format as the
3793 'errorformat' option: see |errorformat|.
3794
3795 *'grepprg'* *'gp'*
3796'grepprg' 'gp' string (default "grep -n ",
3797 Unix: "grep -n $* /dev/null",
3798 Win32: "findstr /n" or "grep -n",
3799 VMS: "SEARCH/NUMBERS ")
3800 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003801 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 and '#' characters, which are expanded like when used in a command-
3803 line. The placeholder "$*" is allowed to specify where the arguments
3804 will be included. Environment variables are expanded |:set_env|. See
3805 |option-backslash| about including spaces and backslashes.
3806 When your "grep" accepts the "-H" argument, use this to make ":grep"
3807 also work well with a single file: >
3808 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003809< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003810 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3811 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003812 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 apply equally to 'grepprg'.
3814 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3815 otherwise it's "grep -n".
3816 This option cannot be set from a |modeline| or in the |sandbox|, for
3817 security reasons.
3818
3819 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3820'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3821 ve:ver35-Cursor,
3822 o:hor50-Cursor,
3823 i-ci:ver25-Cursor/lCursor,
3824 r-cr:hor20-Cursor/lCursor,
3825 sm:block-Cursor
3826 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003827 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 "n-v-c:block,o:hor50,i-ci:hor15,
3829 r-cr:hor30,sm:block")
3830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003832 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003834 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003835 height of the cursor can be changed. This can be done by specifying a
3836 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003837 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3838 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003840 The option is a comma-separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 mode-list and an argument-list:
3842 mode-list:argument-list,mode-list:argument-list,..
3843 The mode-list is a dash separated list of these modes:
3844 n Normal mode
3845 v Visual mode
3846 ve Visual mode with 'selection' "exclusive" (same as 'v',
3847 if not specified)
3848 o Operator-pending mode
3849 i Insert mode
3850 r Replace mode
3851 c Command-line Normal (append) mode
3852 ci Command-line Insert mode
3853 cr Command-line Replace mode
3854 sm showmatch in Insert mode
3855 a all modes
3856 The argument-list is a dash separated list of these arguments:
3857 hor{N} horizontal bar, {N} percent of the character height
3858 ver{N} vertical bar, {N} percent of the character width
3859 block block cursor, fills the whole character
3860 [only one of the above three should be present]
3861 blinkwait{N} *cursor-blinking*
3862 blinkon{N}
3863 blinkoff{N}
3864 blink times for cursor: blinkwait is the delay before
3865 the cursor starts blinking, blinkon is the time that
3866 the cursor is shown and blinkoff is the time that the
3867 cursor is not shown. The times are in msec. When one
3868 of the numbers is zero, there is no blinking. The
3869 default is: "blinkwait700-blinkon400-blinkoff250".
3870 These numbers are used for a missing entry. This
3871 means that blinking is enabled by default. To switch
3872 blinking off you can use "blinkon0". The cursor only
3873 blinks when Vim is waiting for input, not while
3874 executing a command.
3875 To make the cursor blink in an xterm, see
3876 |xterm-blink|.
3877 {group-name}
3878 a highlight group name, that sets the color and font
3879 for the cursor
3880 {group-name}/{group-name}
3881 Two highlight group names, the first is used when
3882 no language mappings are used, the other when they
3883 are. |language-mapping|
3884
3885 Examples of parts:
3886 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3887 block cursor with colors from the "nCursor"
3888 highlight group
3889 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3890 In Insert and Command-line Insert mode, use a
3891 30% vertical bar cursor with colors from the
3892 "iCursor" highlight group. Blink a bit
3893 faster.
3894
3895 The 'a' mode is different. It will set the given argument-list for
3896 all modes. It does not reset anything to defaults. This can be used
3897 to do a common setting for all modes. For example, to switch off
3898 blinking: "a:blinkon0"
3899
3900 Examples of cursor highlighting: >
3901 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3902 :highlight Cursor gui=NONE guifg=bg guibg=fg
3903<
3904 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003905 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906'guifont' 'gfn' string (default "")
3907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 {only available when compiled with GUI enabled}
3909 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003910 In its simplest form the value is just one font name.
3911 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912
3913 *'guifontset'* *'gfs'*
3914 *E250* *E252* *E234* *E597* *E598*
3915'guifontset' 'gfs' string (default "")
3916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 {only available when compiled with GUI enabled and
3918 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003919 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 When not empty, specifies two (or more) fonts to be used. The first
3921 one for normal English, the second one for your special language. See
3922 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003923
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3925'guifontwide' 'gfw' string (default "")
3926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 {only available when compiled with GUI enabled}
3928 When not empty, specifies a comma-separated list of fonts to be used
3929 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003930 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003931
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 *'guiheadroom'* *'ghr'*
3933'guiheadroom' 'ghr' number (default 50)
3934 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003935 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 The number of pixels subtracted from the screen height when fitting
3937 the GUI window on the screen. Set this before the GUI is started,
3938 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003939 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 lines will be left for window decorations and other items on the
3941 screen. Set it to a negative value to allow windows taller than the
3942 screen.
3943
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003944 *'guiligatures'* *'gli'* *E1243*
3945'guiligatures' 'gli' string (default "")
3946 global
3947 {only for GTK GUI}
3948 List of ASCII characters that, when combined together, can create more
3949 complex shapes. Each character must be a printable ASCII character
3950 with a value in the 32-127 range.
3951 Example: >
3952 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3953< Changing this option updates screen output immediately. Set it to an
3954 empty string to disable ligatures.
3955
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003957'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3958 "t" is removed in |defaults.vim|),
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01003959 "aegimrLtT" (GTK and Motif),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003960 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003963 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 sequence of letters which describes what components and options of the
3965 GUI should be used.
3966 To avoid problems with flags that are added in the future, use the
3967 "+=" and "-=" feature of ":set" |add-option-flags|.
3968
Bram Moolenaar13568252018-03-16 20:46:58 +01003969 Valid characters are as follows:
3970 *'go-!'*
3971 '!' External commands are executed in a terminal window. Without
3972 this flag the MS-Windows GUI will open a console window to
3973 execute the command. The Unix GUI will simulate a dumb
3974 terminal to list the command output.
3975 The terminal window will be positioned at the bottom, and grow
3976 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003977 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 'a' Autoselect: If present, then whenever VISUAL mode is started,
3979 or the Visual area extended, Vim tries to become the owner of
3980 the windowing system's global selection. This means that the
3981 Visually highlighted text is available for pasting into other
3982 applications as well as into Vim itself. When the Visual mode
3983 ends, possibly due to an operation on the text, or when an
3984 application wants to paste the selection, the highlighted text
3985 is automatically yanked into the "* selection register.
3986 Thus the selection is still available for pasting into other
3987 applications after the VISUAL mode has ended.
3988 If not present, then Vim won't become the owner of the
3989 windowing system's global selection unless explicitly told to
3990 by a yank or delete operation for the "* register.
3991 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003992 *'go-P'*
3993 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003994 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003995 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003996 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 applies to the modeless selection.
3998
3999 'guioptions' autoselect Visual autoselect modeless ~
4000 "" - -
4001 "a" yes yes
4002 "A" - yes
4003 "aA" yes yes
4004
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01004005 When using a terminal see the 'clipboard' option.
4006
Bram Moolenaar02467872007-05-06 13:22:01 +00004007 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 'c' Use console dialogs instead of popup dialogs for simple
4009 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02004010 *'go-d'*
4011 'd' Use dark theme variant if available. Currently only works for
4012 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004013 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00004014 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004015 'guitablabel' can be used to change the text in the labels.
4016 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00004017 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01004018 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00004019 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 'f' Foreground: Don't use fork() to detach the GUI from the shell
4021 where it was started. Use this for programs that wait for the
4022 editor to finish (e.g., an e-mail program). Alternatively you
4023 can use "gvim -f" or ":gui -f" to start the GUI in the
4024 foreground. |gui-fork|
4025 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004026 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00004027 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
4029 corner of the window. It's black&white on non-GTK, because of
4030 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004031 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004033 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004034 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004036 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01004038 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004039 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 'g' Grey menu items: Make menu items that are not active grey. If
4041 'g' is not included inactive menu items are not shown at all.
Bram Moolenaar02467872007-05-06 13:22:01 +00004042 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 't' Include tearoff menu items. Currently only works for Win32,
4044 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00004045 *'go-T'*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004046 'T' Include Toolbar. Currently only in Win32, GTK+, Motif and
4047 Photon GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00004048 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004050 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 'R' Right-hand scrollbar is present when there is a vertically
4052 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004053 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004055 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 'L' Left-hand scrollbar is present when there is a vertically
4057 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00004058 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 'b' Bottom (horizontal) scrollbar is present. Its size depends on
4060 the longest visible line, or on the cursor line if the 'h'
4061 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004062 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 'h' Limit horizontal scrollbar size to the length of the cursor
4064 line. Reduces computations. |gui-horiz-scroll|
4065
4066 And yes, you may even have scrollbars on the left AND the right if
4067 you really want to :-). See |gui-scrollbars| for more information.
4068
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004069 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 'v' Use a vertical button layout for dialogs. When not included,
4071 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02004072 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004073 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 'p' Use Pointer callbacks for X11 GUI. This is required for some
4075 window managers. If the cursor is not blinking or hollow at
4076 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004077 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004079 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004080 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004081 *'go-k'*
4082 'k' Keep the GUI window size when adding/removing a scrollbar, or
4083 toolbar, tabline, etc. Instead, the behavior is similar to
4084 when the window is maximized and will adjust 'lines' and
4085 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004086 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004087 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004088
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 *'guipty'* *'noguipty'*
4090'guipty' boolean (default on)
4091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 {only available when compiled with GUI enabled}
4093 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4094 I/O to/from shell commands. See |gui-pty|.
4095
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004096 *'guitablabel'* *'gtl'*
4097'guitablabel' 'gtl' string (default empty)
4098 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004099 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004100 When non-empty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004101 pages line. When empty and when the result is empty Vim will use a
4102 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004103
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004104 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004105 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004106 The expression will be evaluated in the |sandbox| when set from a
4107 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004108 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004109
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004110 Only used when the GUI tab pages line is displayed. 'e' must be
4111 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4112 used.
4113
Bram Moolenaar57657d82006-04-21 22:12:41 +00004114 *'guitabtooltip'* *'gtt'*
4115'guitabtooltip' 'gtt' string (default empty)
4116 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02004117 {only available when compiled with GUI enabled}
Bram Moolenaar944697a2022-02-20 19:48:20 +00004118 When non-empty describes the text to use in a tooltip for the GUI tab
Bram Moolenaar57657d82006-04-21 22:12:41 +00004119 pages line. When empty Vim will use a default tooltip.
4120 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004121 You can include a line break. Simplest method is to use |:let|: >
4122 :let &guitabtooltip = "line one\nline two"
4123<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004124
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004126'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 (others) "$VIMRUNTIME/doc/help.txt")
4128 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 Name of the main help file. All distributed help files should be
4130 placed together in one directory. Additionally, all "doc" directories
4131 in 'runtimepath' will be used.
4132 Environment variables are expanded |:set_env|. For example:
4133 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004134 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 spaces and backslashes.
4136 This option cannot be set from a |modeline| or in the |sandbox|, for
4137 security reasons.
4138
4139 *'helpheight'* *'hh'*
4140'helpheight' 'hh' number (default 20)
4141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 Minimal initial height of the help window when it is opened with the
4143 ":help" command. The initial height of the help window is half of the
4144 current window, or (when the 'ea' option is on) the same as other
4145 windows. When the height is less than 'helpheight', the height is
4146 set to 'helpheight'. Set to zero to disable.
4147
4148 *'helplang'* *'hlg'*
4149'helplang' 'hlg' string (default: messages language or empty)
4150 global
4151 {only available when compiled with the |+multi_lang|
4152 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004153 Comma-separated list of languages. Vim will use the first language
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 for which the desired help can be found. The English help will always
4155 be used as a last resort. You can add "en" to prefer English over
4156 another language, but that will only find tags that exist in that
4157 language and not in the English help.
4158 Example: >
4159 :set helplang=de,it
4160< This will first search German, then Italian and finally English help
4161 files.
4162 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4163 try to find the tag in the current language before using this option.
4164 See |help-translated|.
4165
4166 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4167'hidden' 'hid' boolean (default off)
4168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 When off a buffer is unloaded when it is |abandon|ed. When on a
4170 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4171 displayed in another window, it does not become hidden, of course.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004172
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 The commands that move through the buffer list sometimes make a buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004174 hidden even if the 'hidden' option is off when these three are true:
4175 - the buffer is modified
4176 - 'autowrite' is off or writing is not possible
4177 - the '!' flag was used
4178 Also see |windows.txt|.
4179
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004180 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 This option is set for one command with ":hide {command}" |:hide|.
4182 WARNING: It's easy to forget that you have changes in hidden buffers.
4183 Think twice when using ":q!" or ":qa!".
4184
4185 *'highlight'* *'hl'*
4186'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004187 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4188 d:Directory,e:ErrorMsg,i:IncSearch,
4189 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004190 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004191 N:CursorLineNr,r:Question,s:StatusLine,
4192 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004193 v:Visual,V:VisualNOS,w:WarningMsg,
4194 W:WildMenu,f:Folded,F:FoldColumn,
4195 A:DiffAdd,C:DiffChange,D:DiffDelete,
4196 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004197 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004198 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004199 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4200 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004201 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004202 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 This option can be used to set highlighting mode for various
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004205 occasions. It is a comma-separated list of character pairs. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004207 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004209 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4210 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 characters from 'showbreak'
4212 |hl-Directory| d directories in CTRL-D listing and other special
4213 things in listings
4214 |hl-ErrorMsg| e error messages
4215 h (obsolete, ignored)
4216 |hl-IncSearch| i 'incsearch' highlighting
LemonBoya4399382022-04-09 21:04:08 +01004217 |hl-CurSearch| y current instance of last search pattern
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4219 |hl-MoreMsg| m |more-prompt|
4220 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004221 |hl-LineNr| n line number for ":number" and ":#" commands, and
4222 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004223 |hl-LineNrAbove| a line number above the cursor for when the
4224 'relativenumber' option is set.
4225 |hl-LineNrBelow| b line number below the cursor for when the
4226 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004227 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4228 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 |hl-Question| r |hit-enter| prompt and yes/no questions
4230 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004231 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4233 |hl-VertSplit| c column used to separate vertically split windows
4234 |hl-Visual| v Visual mode
4235 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4236 Selection" Only X11 Gui's |gui-x11| and
4237 |xterm-clipboard|.
4238 |hl-WarningMsg| w warning messages
4239 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4240 |hl-Folded| f line used for closed folds
4241 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004242 |hl-DiffAdd| A added line in diff mode
4243 |hl-DiffChange| C changed line in diff mode
4244 |hl-DiffDelete| D deleted line in diff mode
4245 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004247 |hl-Conceal| - the placeholders used for concealed characters
4248 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004249 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004250 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004251 |hl-SpellRare| R rare word |spell|
4252 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004253 |hl-Pmenu| + popup menu normal line
4254 |hl-PmenuSel| = popup menu selected line
4255 |hl-PmenuSbar| x popup menu scrollbar
4256 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257
4258 The display modes are:
4259 r reverse (termcap entry "mr" and "me")
4260 i italic (termcap entry "ZH" and "ZR")
4261 b bold (termcap entry "md" and "me")
4262 s standout (termcap entry "so" and "se")
4263 u underline (termcap entry "us" and "ue")
Bram Moolenaar84f54632022-06-29 18:39:11 +01004264 c undercurl (termcap entry "Us" and "Ce")
4265 2 double underline (termcap entry "Ds" and "Ce")
4266 d dotted underline (termcap entry "ds" and "Ce")
4267 = dashed underline (termcap entry "Ds" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004268 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 n no highlighting
4270 - no highlighting
4271 : use a highlight group
4272 The default is used for occasions that are not included.
4273 If you want to change what the display modes do, see |dos-colors|
4274 for an example.
4275 When using the ':' display mode, this must be followed by the name of
4276 a highlight group. A highlight group can be used to define any type
4277 of highlighting, including using color. See |:highlight| on how to
4278 define one. The default uses a different group for each occasion.
4279 See |highlight-default| for the default highlight groups.
4280
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004282'history' 'hi' number (Vim default: 50, Vi default: 0,
4283 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004286 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004288 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 NOTE: This option is set to the Vi default value when 'compatible' is
4290 set and to the Vim default value when 'compatible' is reset.
4291
4292 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4293'hkmap' 'hk' boolean (default off)
4294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 {only available when compiled with the |+rightleft|
4296 feature}
4297 When on, the keyboard is mapped for the Hebrew character set.
4298 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4299 toggle this option. See |rileft.txt|.
4300 NOTE: This option is reset when 'compatible' is set.
4301
4302 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4303'hkmapp' 'hkp' boolean (default off)
4304 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 {only available when compiled with the |+rightleft|
4306 feature}
4307 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4308 This is useful if you have a non-Hebrew keyboard.
4309 See |rileft.txt|.
4310 NOTE: This option is reset when 'compatible' is set.
4311
Bram Moolenaar036986f2017-03-16 17:41:02 +01004312 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4313'hlsearch' 'hls' boolean (default off)
4314 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004315 {not available when compiled without the
4316 |+extra_search| feature}
4317 When there is a previous search pattern, highlight all its matches.
4318 The type of highlighting used can be set with the 'l' occasion in the
4319 'highlight' option. This uses the "Search" highlight group by
4320 default. Note that only the matching text is highlighted, any offsets
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01004321 are not applied. If the "CurSearch" highlight group is set then the
4322 current match is highlighted with that.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004323 See also: 'incsearch' and |:match|.
4324 When you get bored looking at the highlighted matches, you can turn it
4325 off with |:nohlsearch|. This does not change the option value, as
4326 soon as you use a search command, the highlighting comes back.
4327 'redrawtime' specifies the maximum time spent on finding matches.
4328 When the search pattern can match an end-of-line, Vim will try to
4329 highlight all of the matched text. However, this depends on where the
4330 search starts. This will be the first line in the window or the first
4331 line below a closed fold. A match in a previous line which is not
4332 drawn may not continue in a newly drawn line.
4333 You can specify whether the highlight status is restored on startup
4334 with the 'h' flag in 'viminfo' |viminfo-h|.
4335 NOTE: This option is reset when 'compatible' is set.
4336
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 *'icon'* *'noicon'*
4338'icon' boolean (default off, on when title can be restored)
4339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 When on, the icon text of the window will be set to the value of
4341 'iconstring' (if it is not empty), or to the name of the file
4342 currently being edited. Only the last part of the name is used.
4343 Overridden by the 'iconstring' option.
4344 Only works if the terminal supports setting window icons (currently
4345 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4346 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4347 builtin termcap).
4348 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004349 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004351 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352
4353 *'iconstring'*
4354'iconstring' string (default "")
4355 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 When this option is not empty, it will be used for the icon text of
4357 the window. This happens only when the 'icon' option is on.
4358 Only works if the terminal supports setting window icon text
4359 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004360 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 When Vim was compiled with HAVE_X11 defined, the original icon will be
4362 restored if possible |X11|.
4363 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004364 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004366 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 {not available when compiled without the |+statusline| feature}
4368
4369 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4370'ignorecase' 'ic' boolean (default off)
4371 global
4372 Ignore case in search patterns. Also used when searching in the tags
4373 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004374 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 Can be overruled by using "\c" or "\C" in the pattern, see
4376 |/ignorecase|.
4377
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004378 *'imactivatefunc'* *'imaf'*
4379'imactivatefunc' 'imaf' string (default "")
4380 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004381 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004382 activate or deactivate the Input Method. The value can be the name of
4383 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4384 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004385 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004386 The expression will be evaluated in the |sandbox| when set from a
4387 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004388
4389 Example: >
4390 function ImActivateFunc(active)
4391 if a:active
4392 ... do something
4393 else
4394 ... do something
4395 endif
4396 " return value is not used
4397 endfunction
4398 set imactivatefunc=ImActivateFunc
4399<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 *'imactivatekey'* *'imak'*
4401'imactivatekey' 'imak' string (default "")
4402 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004404 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 Specifies the key that your Input Method in X-Windows uses for
4406 activation. When this is specified correctly, vim can fully control
4407 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4408 You can't use this option to change the activation key, the option
4409 tells Vim what the key is.
4410 Format:
4411 [MODIFIER_FLAG-]KEY_STRING
4412
4413 These characters can be used for MODIFIER_FLAG (case is ignored):
4414 S Shift key
4415 L Lock key
4416 C Control key
4417 1 Mod1 key
4418 2 Mod2 key
4419 3 Mod3 key
4420 4 Mod4 key
4421 5 Mod5 key
4422 Combinations are allowed, for example "S-C-space" or "SC-space" are
4423 both shift+ctrl+space.
4424 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4425
4426 Example: >
4427 :set imactivatekey=S-space
4428< "S-space" means shift+space. This is the activation key for kinput2 +
4429 canna (Japanese), and ami (Korean).
4430
4431 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4432'imcmdline' 'imc' boolean (default off)
4433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 When set the Input Method is always on when starting to edit a command
4435 line, unless entering a search pattern (see 'imsearch' for that).
4436 Setting this option is useful when your input method allows entering
4437 English characters directly, e.g., when it's used to type accented
4438 characters with dead keys.
4439
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004440 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 When set the Input Method is never used. This is useful to disable
4444 the IM when it doesn't work properly.
4445 Currently this option is on by default for SGI/IRIX machines. This
4446 may change in later releases.
4447
4448 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004449'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 Specifies whether :lmap or an Input Method (IM) is to be used in
4452 Insert mode. Valid values:
4453 0 :lmap is off and IM is off
4454 1 :lmap is ON and IM is off
4455 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 To always reset the option to zero when leaving Insert mode with <Esc>
4457 this can be used: >
4458 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4459< This makes :lmap and IM turn off automatically when leaving Insert
4460 mode.
4461 Note that this option changes when using CTRL-^ in Insert mode
4462 |i_CTRL-^|.
4463 The value is set to 1 when setting 'keymap' to a valid keymap name.
4464 It is also used for the argument of commands like "r" and "f".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004465 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 methods. Use 'imdisable' to disable XIM then.
4467
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004468 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004469 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004470 |+multi_byte_ime| or |global-ime|.
4471
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004473'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 Specifies whether :lmap or an Input Method (IM) is to be used when
4476 entering a search pattern. Valid values:
4477 -1 the value of 'iminsert' is used, makes it look like
4478 'iminsert' is also used when typing a search pattern
4479 0 :lmap is off and IM is off
4480 1 :lmap is ON and IM is off
4481 2 :lmap is off and IM is ON
4482 Note that this option changes when using CTRL-^ in Command-line mode
4483 |c_CTRL-^|.
4484 The value is set to 1 when it is not -1 and setting the 'keymap'
4485 option to a valid keymap name.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004486 The value 0 may not work correctly with Motif with some XIM
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 methods. Use 'imdisable' to disable XIM then.
4488
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004489 *'imstatusfunc'* *'imsf'*
4490'imstatusfunc' 'imsf' string (default "")
4491 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004492 This option specifies a function that is called to obtain the status
4493 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004494 The value can be the name of a function, a |lambda| or a |Funcref|.
4495 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004496 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004497
4498 Example: >
4499 function ImStatusFunc()
4500 let is_active = ...do something
4501 return is_active ? 1 : 0
4502 endfunction
4503 set imstatusfunc=ImStatusFunc
4504<
4505 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004506 The expression will be evaluated in the |sandbox| when set from a
4507 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004508
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004509 *'imstyle'* *'imst'*
4510'imstyle' 'imst' number (default 1)
4511 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004512 {only available when compiled with |+xim| and
4513 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004514 This option specifies the input style of Input Method:
4515 0 use on-the-spot style
4516 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004517 See: |xim-input-style|
4518
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004519 For a long time on-the-spot style had been used in the GTK version of
4520 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004521 |single-repeat|, etc. Therefore over-the-spot style becomes the
4522 default now. This should work fine for most people, however if you
4523 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004524 The expression will be evaluated in the |sandbox| when set from a
4525 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004526
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 *'include'* *'inc'*
4528'include' 'inc' string (default "^\s*#\s*include")
4529 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 {not available when compiled without the
4531 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004532 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 pattern, just like for the "/" command (See |pattern|). The default
4534 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004535 "]I", "[d", etc.
4536 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004537 comes after the matched pattern. But if "\zs" appears in the pattern
4538 then the text matched from "\zs" to the end, or until "\ze" if it
4539 appears, is used as the file name. Use this to include characters
4540 that are not in 'isfname', such as a space. You can then use
4541 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004542 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543
4544 *'includeexpr'* *'inex'*
4545'includeexpr' 'inex' string (default "")
4546 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004548 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004550 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004551 :setlocal includeexpr=substitute(v:fname,'\\.','/','g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004553 Note the double backslash: the `:set` command first halves them, then
4554 one remains it the value, where "\." matches a dot literally. For
4555 simple character replacements `tr()` avoids the need for escaping: >
4556 :setlocal includeexpr=tr(v:fname,'.','/')
4557<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004559 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 Also used for |<cfile>|.
4561
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004562 If the expression starts with s: or |<SID>|, then it is replaced with
4563 the script ID (|local-function|). Example: >
Bram Moolenaarb59ae592022-11-23 23:46:31 +00004564 setlocal includeexpr=s:MyIncludeExpr()
4565 setlocal includeexpr=<SID>SomeIncludeExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004566< Otherwise, the expression is evaluated in the context of the script
4567 where the option was set, thus script-local items are available.
4568
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004569 It is more efficient if the value is just a function call without
4570 arguments, see |expr-option-function|.
4571
Bram Moolenaar30b65812012-07-12 22:01:11 +02004572 The expression will be evaluated in the |sandbox| when set from a
4573 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004574 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004575
4576 It is not allowed to change text or jump to another window while
4577 evaluating 'includeexpr' |textlock|.
4578
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004580'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004581 |+reltime| feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004584 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004585 While typing a search command, show where the pattern, as it was typed
4586 so far, matches. The matched string is highlighted. If the pattern
4587 is invalid or not found, nothing is shown. The screen will be updated
4588 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004589 Also applies to the pattern in commands: >
4590 :global
4591 :lvimgrep
4592 :lvimgrepadd
4593 :smagic
4594 :snomagic
4595 :sort
4596 :substitute
4597 :vglobal
4598 :vimgrep
4599 :vimgrepadd
4600< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004601 original position when no match is found and when pressing <Esc>. You
4602 still need to finish the search command with <Enter> to move the
4603 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004604 You can use the CTRL-G and CTRL-T keys to move to the next and
4605 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004606 When compiled with the |+reltime| feature Vim only searches for about
4607 half a second. With a complicated pattern and/or a lot of text the
4608 match may not be found. This is to avoid that Vim hangs while you
4609 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004610 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004611 When 'hlsearch' is on, all matched strings are highlighted too while
4612 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004613 If you don't want to turn 'hlsearch' on, but want to highlight all
4614 matches while searching, you can turn on and off 'hlsearch' with
4615 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004616 augroup vimrc-incsearch-highlight
4617 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004618 autocmd CmdlineEnter /,\? :set hlsearch
4619 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004620 augroup END
4621<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004622 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004623 to the command line. If 'ignorecase' and 'smartcase' are set and the
4624 command line has no uppercase characters, the added character is
4625 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004626 CTRL-R CTRL-W can be used to add the word at the end of the current
4627 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 NOTE: This option is reset when 'compatible' is set.
4629
4630 *'indentexpr'* *'inde'*
4631'indentexpr' 'inde' string (default "")
4632 local to buffer
Bram Moolenaar8e145b82022-05-21 20:17:31 +01004633 {not available when compiled without the |+eval|
4634 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 Expression which is evaluated to obtain the proper indent for a line.
4636 It is used when a new line is created, for the |=| operator and
4637 in Insert mode as specified with the 'indentkeys' option.
4638 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004639 'smartindent' indenting. When 'lisp' is set, this option is
Bram Moolenaar49846fb2022-10-15 16:05:33 +01004640 is only used when 'lispoptions' contains "expr:1".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 When 'paste' is set this option is not used for indenting.
4642 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004643 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 when the expression is evaluated (but it may be moved around).
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004645
Yegappan Lakshmanan8bb65f22021-12-26 10:51:39 +00004646 If the expression starts with s: or |<SID>|, then it is replaced with
4647 the script ID (|local-function|). Example: >
4648 set indentexpr=s:MyIndentExpr()
4649 set indentexpr=<SID>SomeIndentExpr()
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00004650< Otherwise, the expression is evaluated in the context of the script
4651 where the option was set, thus script-local items are available.
4652
Bram Moolenaara4e0b972022-10-01 19:43:52 +01004653 The advantage of using a function call without arguments is that it is
4654 faster, see |expr-option-function|.
4655
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 The expression must return the number of spaces worth of indent. It
4657 can return "-1" to keep the current indent (this means 'autoindent' is
4658 used for the indent).
4659 Functions useful for computing the indent are |indent()|, |cindent()|
4660 and |lispindent()|.
4661 The evaluation of the expression must not have side effects! It must
4662 not change the text, jump to another window, etc. Afterwards the
4663 cursor position is always restored, thus the cursor may be moved.
4664 Normally this option would be set to call a function: >
4665 :set indentexpr=GetMyIndent()
4666< Error messages will be suppressed, unless the 'debug' option contains
4667 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004668 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004669 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670
Bram Moolenaar30b65812012-07-12 22:01:11 +02004671 The expression will be evaluated in the |sandbox| when set from a
4672 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004673 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004674
4675 It is not allowed to change text or jump to another window while
4676 evaluating 'indentexpr' |textlock|.
4677
4678
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004680'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 A list of keys that, when typed in Insert mode, cause reindenting of
4683 the current line. Only happens if 'indentexpr' isn't empty.
4684 The format is identical to 'cinkeys', see |indentkeys-format|.
4685 See |C-indenting| and |indent-expression|.
4686
4687 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4688'infercase' 'inf' boolean (default off)
4689 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004691 'ignorecase' is also on, the case of the match is adjusted depending
4692 on the typed text. If the typed text contains a lowercase letter
4693 where the match has an upper case letter, the completed part is made
4694 lowercase. If the typed text has no lowercase letters and the match
4695 has a lowercase letter where the typed text has an uppercase letter,
4696 and there is a letter before it, the completed part is made uppercase.
4697 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698
4699 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4700'insertmode' 'im' boolean (default off)
4701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 Makes Vim work in a way that Insert mode is the default mode. Useful
4703 if you want to use Vim as a modeless editor. Used for |evim|.
4704 These Insert mode commands will be useful:
4705 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004706 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 this is a mapping, it is executed as if 'insertmode' was off.
4708 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004710 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4711 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712
4713 These items change when 'insertmode' is set:
4714 - when starting to edit of a file, Vim goes to Insert mode.
4715 - <Esc> in Insert mode is a no-op and beeps.
4716 - <Esc> in Normal mode makes Vim go to Insert mode.
4717 - CTRL-L in Insert mode is a command, it is not inserted.
4718 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4719 However, when <Esc> is used inside a mapping, it behaves like
4720 'insertmode' was not set. This was done to be able to use the same
4721 mappings with 'insertmode' set or not set.
4722 When executing commands with |:normal| 'insertmode' is not used.
4723
4724 NOTE: This option is reset when 'compatible' is set.
4725
4726 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004727'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4729 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4730 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4731 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4732 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 The characters specified by this option are included in file names and
4735 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004736 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 Multi-byte characters 256 and above are always included, only the
4738 characters up to 255 are specified with this option.
4739 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004740 Think twice before adding white space to this option. Although a
4741 space may appear inside a file name, the effect will be that Vim
4742 doesn't know where a file name starts or ends when doing completion.
4743 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744
4745 Note that on systems using a backslash as path separator, Vim tries to
4746 do its best to make it work as you would expect. That is a bit
4747 tricky, since Vi originally used the backslash to escape special
4748 characters. Vim will not remove a backslash in front of a normal file
4749 name character on these systems, but it will on Unix and alikes. The
4750 '&' and '^' are not included by default, because these are special for
4751 cmd.exe.
4752
4753 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004754 Each part can be a single character number or a range. A range is two
4755 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 decimal number between 0 and 255 or the ASCII character itself (does
4757 not work for digits). Example:
4758 "_,-,128-140,#-43" (include '_' and '-' and the range
4759 128 to 140 and '#' to 43)
4760 If a part starts with '^', the following character number or range
4761 will be excluded from the option. The option is interpreted from left
4762 to right. Put the excluded character after the range where it is
4763 included. To include '^' itself use it as the last character of the
4764 option or the end of a range. Example:
4765 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4766 If the character is '@', all characters where isalpha() returns TRUE
4767 are included. Normally these are the characters a to z and A to Z,
4768 plus accented characters. To include '@' itself use "@-@". Examples:
4769 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004770 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 "a-z,A-Z,@-@" All letters plus the '@' character.
4772 A comma can be included by using it where a character number is
4773 expected. Example:
4774 "48-57,,,_" Digits, comma and underscore.
4775 A comma can be excluded by prepending a '^'. Example:
4776 " -~,^,,9" All characters from space to '~', excluding
4777 comma, plus <Tab>.
4778 See |option-backslash| about including spaces and backslashes.
4779
4780 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004781'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 "@,48-57,_,128-167,224-235"
4783 otherwise: "@,48-57,_,192-255")
4784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 The characters given by this option are included in identifiers.
4786 Identifiers are used in recognizing environment variables and after a
4787 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004788 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004789 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004791 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4793
4794 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004795'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 "@,48-57,_,128-167,224-235"
4797 otherwise: "@,48-57,_,192-255"
4798 Vi default: "@,48-57,_")
4799 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004801 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004802 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004803 characters above 255 check the "word" character class (any character
4804 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004805 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 For a help file it is set to all non-blank printable characters except
4807 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4808 command).
4809 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004810 This option also influences syntax highlighting, unless the syntax
4811 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 NOTE: This option is set to the Vi default value when 'compatible' is
4813 set and to the Vim default value when 'compatible' is reset.
4814
4815 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004816'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 "@,~-255"; otherwise: "@,161-255")
4818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 The characters given by this option are displayed directly on the
4820 screen. It is also used for "\p" in a |pattern|. The characters from
4821 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4822 even when they are not included in 'isprint' or excluded. See
4823 'isfname' for a description of the format of this option.
4824
4825 Non-printable characters are displayed with two characters:
4826 0 - 31 "^@" - "^_"
4827 32 - 126 always single characters
4828 127 "^?"
4829 128 - 159 "~@" - "~_"
4830 160 - 254 "| " - "|~"
4831 255 "~?"
4832 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4833 displayed as <xx>, with the hexadecimal value of the byte.
4834 When 'display' contains "uhex" all unprintable characters are
4835 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004836 The SpecialKey highlighting will be used for unprintable characters.
4837 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838
4839 Multi-byte characters 256 and above are always included, only the
4840 characters up to 255 are specified with this option. When a character
4841 is printable but it is not available in the current font, a
4842 replacement character will be shown.
4843 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4844 There is no option to specify these characters.
4845
4846 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4847'joinspaces' 'js' boolean (default on)
4848 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 Insert two spaces after a '.', '?' and '!' with a join command.
4850 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4851 Otherwise only one space is inserted.
4852 NOTE: This option is set when 'compatible' is set.
4853
4854 *'key'*
4855'key' string (default "")
4856 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004857 {only available when compiled with the |+cryptv|
4858 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004860 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861 Careful: Do not set the key value by hand, someone might see the typed
4862 key. Use the |:X| command. But you can make 'key' empty: >
4863 :set key=
4864< It is not possible to get the value of this option with ":set key" or
4865 "echo &key". This is to avoid showing it to someone who shouldn't
4866 know. It also means you cannot see it yourself once you have set it,
4867 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004868 You can use "&key" in an expression to detect whether encryption is
4869 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870
4871 *'keymap'* *'kmp'* *E544*
4872'keymap' 'kmp' string (default "")
4873 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 {only available when compiled with the |+keymap|
4875 feature}
4876 Name of a keyboard mapping. See |mbyte-keymap|.
4877 Setting this option to a valid keymap name has the side effect of
4878 setting 'iminsert' to one, so that the keymap becomes effective.
4879 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004880 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881
4882 *'keymodel'* *'km'*
4883'keymodel' 'km' string (default "")
4884 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01004885 List of comma-separated words, which enable special things that keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 can do. These values can be used:
4887 startsel Using a shifted special key starts selection (either
4888 Select mode or Visual mode, depending on "key" being
4889 present in 'selectmode').
4890 stopsel Using a not-shifted special key stops selection.
4891 Special keys in this context are the cursor keys, <End>, <Home>,
4892 <PageUp> and <PageDown>.
4893 The 'keymodel' option is set by the |:behave| command.
4894
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004895 *'keyprotocol'* *'kpc'*
4896'keyprotocol' 'kpc' string (default: see below)
4897 global
4898 Specifies what keyboard protocol to use depending on the value of
4899 'term'. The supported keyboard protocols names are:
4900 none whatever the terminal uses
4901 mok2 modifyOtherKeys level 2, as supported by xterm
4902 kitty Kitty keyboard protocol, as supported by Kitty
4903
Bram Moolenaara87749e2022-11-30 10:23:17 +00004904 The option value is a list of comma separated items. Each item has
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004905 a pattern that is matched against the 'term' option, a colon and the
4906 protocol name to be used. To illustrate this, the default value would
4907 be set with: >
4908 set keyprotocol=kitty:kitty,foot:kitty,wezterm:kitty,xterm:mok2
4909
4910< This means that when 'term' contains "kitty, "foot" or "wezterm"
4911 somewhere then the "kitty" protocol is used. When 'term' contains
4912 "xterm" somewhere, then the "mok2" protocol is used.
4913
4914 The first match is used, thus if you want to have "kitty" use the
4915 kitty protocol, but "badkitty" not, then you should match "badkitty"
4916 first and use the "none" value: >
4917 set keyprotocol=badkitty:none,kitty:kitty
4918<
4919 The option is used after 'term' has been changed. First the termcap
4920 entries are set, possibly using the builtin list, see |builtin-terms|.
4921 Then this option is inspected and if there is a match and a protocol
4922 is specified the following happens:
4923 none Nothing, the regular t_TE and t_TI values remain
4924
4925 mok2 The t_TE value is changed to:
4926 CSI >4;m disables modifyOtherKeys
4927 The t_TI value is changed to:
4928 CSI >4;2m enables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00004929 CSI ?4m request the modifyOtherKeys state
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004930
4931 kitty The t_TE value is changed to:
4932 CSI >4;m disables modifyOtherKeys
Bram Moolenaara87749e2022-11-30 10:23:17 +00004933 CSI =0;1u disables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004934 The t_TI value is changed to:
Bram Moolenaara87749e2022-11-30 10:23:17 +00004935 CSI =1;1u enables the kitty keyboard protocol
Bram Moolenaar63a2e362022-11-23 20:20:18 +00004936 CSI ?u request kitty keyboard protocol state
4937 CSI >c request the termresponse
4938
4939
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 *'keywordprg'* *'kp'*
4941'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004942 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 Program to use for the |K| command. Environment variables are
4945 expanded |:set_env|. ":help" may be used to access the Vim internal
4946 help. (Note that previously setting the global option to the empty
4947 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004948 When the first character is ":", the command is invoked as a Vim
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01004949 Ex command with [count] added as an argument if it is not zero.
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004950 When "man", "man -s" or an Ex command is used, Vim will automatically
4951 translate a count for the "K" command and pass it as the first
4952 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 See |option-backslash| about including spaces and backslashes.
4954 Example: >
4955 :set keywordprg=man\ -s
4956< This option cannot be set from a |modeline| or in the |sandbox|, for
4957 security reasons.
4958
4959 *'langmap'* *'lmap'* *E357* *E358*
4960'langmap' 'lmap' string (default "")
4961 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 {only available when compiled with the |+langmap|
4963 feature}
4964 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004965 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004966 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 care of translating these special characters to the original meaning
4968 of the key. This means you don't have to change the keyboard mode to
4969 be able to execute Normal mode commands.
4970 This is the opposite of the 'keymap' option, where characters are
4971 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004972 Also consider setting 'langremap' to off, to prevent 'langmap' from
4973 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004974 This option cannot be set from a |modeline| or in the |sandbox|, for
4975 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004977 Example (for Greek, in UTF-8): *greek* >
4978 :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 +00004979< Example (exchanges meaning of z and y for commands): >
4980 :set langmap=zy,yz,ZY,YZ
4981<
4982 The 'langmap' option is a list of parts, separated with commas. Each
4983 part can be in one of two forms:
4984 1. A list of pairs. Each pair is a "from" character immediately
4985 followed by the "to" character. Examples: "aA", "aAbBcC".
4986 2. A list of "from" characters, a semi-colon and a list of "to"
4987 characters. Example: "abc;ABC"
4988 Example: "aA,fgh;FGH,cCdDeE"
4989 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004990 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991
4992 This will allow you to activate vim actions without having to switch
4993 back and forth between the languages. Your language characters will
4994 be understood as normal vim English characters (according to the
4995 langmap mappings) in the following cases:
4996 o Normal/Visual mode (commands, buffer/register names, user mappings)
4997 o Insert/Replace Mode: Register names after CTRL-R
4998 o Insert/Replace Mode: Mappings
4999 Characters entered in Command-line mode will NOT be affected by
5000 this option. Note that this option can be changed at any time
5001 allowing to switch between mappings for different languages/encodings.
5002 Use a mapping to avoid having to type it each time!
5003
5004 *'langmenu'* *'lm'*
5005'langmenu' 'lm' string (default "")
5006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 {only available when compiled with the |+menu| and
5008 |+multi_lang| features}
5009 Language to use for menu translation. Tells which file is loaded
5010 from the "lang" directory in 'runtimepath': >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005011 "lang/menu_" .. &langmenu .. ".vim"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012< (without the spaces). For example, to always use the Dutch menus, no
5013 matter what $LANG is set to: >
5014 :set langmenu=nl_NL.ISO_8859-1
5015< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005016 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 If your $LANG is set to a non-English language but you do want to use
5018 the English menus: >
5019 :set langmenu=none
5020< This option must be set before loading menus, switching on filetype
5021 detection or syntax highlighting. Once the menus are defined setting
5022 this option has no effect. But you could do this: >
5023 :source $VIMRUNTIME/delmenu.vim
5024 :set langmenu=de_DE.ISO_8859-1
5025 :source $VIMRUNTIME/menu.vim
5026< Warning: This deletes all menus that you defined yourself!
5027
Bram Moolenaard94464e2015-11-02 15:28:18 +01005028 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005029'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005030 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005031 {only available when compiled with the |+langmap|
5032 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005033 This is just like 'langremap' but with the value inverted. It only
5034 exists for backwards compatibility. When setting 'langremap' then
5035 'langnoremap' is set to the inverted value, and the other way around.
5036
5037 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01005038'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005039 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005040 {only available when compiled with the |+langmap|
5041 feature}
5042 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005043 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02005044 'langmap' disables some of your mappings, try resetting this option.
5045 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01005046 that works for you to avoid mappings to break.
5047
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 *'laststatus'* *'ls'*
5049'laststatus' 'ls' number (default 1)
5050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 The value of this option influences when the last window will have a
5052 status line:
5053 0: never
5054 1: only if there are at least two windows
5055 2: always
5056 The screen looks nicer with a status line if you have several
5057 windows, but it takes another screen line. |status-line|
5058
5059 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
5060'lazyredraw' 'lz' boolean (default off)
5061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 When this option is set, the screen will not be redrawn while
5063 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005064 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 update use |:redraw|.
Bram Moolenaara57b5532022-06-24 11:48:03 +01005066 This may occasionally cause display errors. It is only meant to be set
5067 temporarily when performing an operation where redrawing may cause
Bram Moolenaar8cc5b552022-06-23 13:04:20 +01005068 flickering or cause a slow down.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069
5070 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
5071'linebreak' 'lbr' boolean (default off)
5072 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02005073 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005075 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 than at the last character that fits on the screen. Unlike
5077 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02005078 it only affects the way the file is displayed, not its contents.
5079 If 'breakindent' is set, line is visually indented. Then, the value
5080 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02005081 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 Note that <Tab> characters after an <EOL> are mostly not displayed
5083 with the right amount of white space.
5084
5085 *'lines'* *E593*
5086'lines' number (default 24 or terminal height)
5087 global
5088 Number of lines of the Vim window.
5089 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00005090 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 When Vim is running in the GUI or in a resizable window, setting this
5092 option will cause the window size to be changed. When you only want
5093 to use the size for the GUI, put the command in your |gvimrc| file.
5094 Vim limits the number of lines to what fits on the screen. You can
5095 use this command to get the tallest window possible: >
5096 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00005097< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02005098 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099 When you set this option and Vim is unable to change the physical
5100 number of lines of the display, the display may be messed up.
5101
5102 *'linespace'* *'lsp'*
5103'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
5104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 {only in the GUI}
5106 Number of pixel lines inserted between characters. Useful if the font
5107 uses the full character cell height, making lines touch each other.
5108 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005109 With some fonts there can be too much room between lines (to have
5110 space for ascents and descents). Then it makes sense to set
5111 'linespace' to a negative value. This may cause display problems
5112 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113
5114 *'lisp'* *'nolisp'*
5115'lisp' boolean (default off)
5116 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 Lisp mode: When <Enter> is typed in insert mode set the indent for
5118 the next line to Lisp standards (well, sort of). Also happens with
5119 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5120 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5121 better. Also see 'lispwords'.
5122 The '-' character is included in keyword characters. Redefines the
5123 "=" operator to use this same indentation algorithm rather than
5124 calling an external program if 'equalprg' is empty.
5125 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126
Bram Moolenaar49846fb2022-10-15 16:05:33 +01005127 *'lispoptions'* *'lop'*
5128'lispoptions' 'lop' string (default "")
5129 local to buffer
5130 Comma-separated list of items that influence the Lisp indenting when
5131 enabled with the |'lisp'| option. Currently only one item is
5132 supported:
5133 expr:1 use 'indentexpr' for Lisp indenting when it is set
5134 expr:0 do not use 'indentexpr' for Lisp indenting (default)
5135 Note that when using 'indentexpr' the `=` operator indents all the
5136 lines, otherwise the first line is not indented (Vi-compatible).
5137
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 *'lispwords'* *'lw'*
5139'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005140 global or local to buffer |global-local|
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01005141 Comma-separated list of words that influence the Lisp indenting when
5142 enabled with the |'lisp'| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143
5144 *'list'* *'nolist'*
5145'list' boolean (default off)
5146 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00005147 List mode: By default show tabs as CTRL-I is displayed, display $
5148 after end of line. Useful to see the difference between tabs and
5149 spaces and for trailing blanks. Further changed by the 'listchars'
5150 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005151
5152 The cursor is displayed at the start of the space a Tab character
5153 occupies, not at the end as usual in Normal mode. To get this cursor
5154 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005155 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005156<
5157 Note that list mode will also affect formatting (set with 'textwidth'
5158 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 changing the way tabs are displayed.
5160
5161 *'listchars'* *'lcs'*
5162'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01005163 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005164 Strings to use in 'list' mode and for the |:list| command. It is a
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005165 comma-separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005166 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 eol:c Character to show at the end of each line. When
5168 omitted, there is no extra character at the end of the
5169 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005170 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005171 tab:xy[z] Two or three characters to be used to show a tab.
5172 The third character is optional.
5173
5174 tab:xy The 'x' is always used, then 'y' as many times as will
5175 fit. Thus "tab:>-" displays:
5176 >
5177 >-
5178 >--
5179 etc.
5180
5181 tab:xyz The 'z' is always used, then 'x' is prepended, and
5182 then 'y' is used as many times as will fit. Thus
5183 "tab:<->" displays:
5184 >
5185 <>
5186 <->
5187 <-->
5188 etc.
5189
5190 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005191 *lcs-space*
5192 space:c Character to show for a space. When omitted, spaces
5193 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02005194 *lcs-multispace*
5195 multispace:c...
5196 One or more characters to use cyclically to show for
5197 multiple consecutive spaces. Overrides the "space"
5198 setting, except for single spaces. When omitted, the
5199 "space" setting is used. For example,
5200 `:set listchars=multispace:---+` shows ten consecutive
5201 spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005202 ---+---+-- ~
Bram Moolenaar91478ae2021-02-03 15:58:13 +01005203 *lcs-lead*
5204 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005205 leading spaces are blank. Overrides the "space" and
5206 "multispace" settings for leading spaces. You can
5207 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01005208 :set listchars+=tab:>-,lead:.
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005209< *lcs-leadmultispace*
5210 leadmultispace:c...
Bram Moolenaar069a7d52022-06-27 22:16:08 +01005211 Like the |lcs-multispace| value, but for leading
5212 spaces only. Also overrides |lcs-lead| for leading
5213 multiple spaces.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01005214 `:set listchars=leadmultispace:---+` shows ten
5215 consecutive leading spaces as:
Bram Moolenaaraca12fd2022-06-07 10:16:15 +01005216 ---+---+--XXX ~
5217 Where "XXX" denotes the first non-blank characters in
5218 the line.
5219 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005220 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005221 trailing spaces are blank. Overrides the "space" and
5222 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005223 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 extends:c Character to show in the last column, when 'wrap' is
5225 off and the line continues beyond the right of the
5226 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005227 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005228 precedes:c Character to show in the first visible column of the
5229 physical line, when there is text preceding the
5230 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005231 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005232 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005233 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005234 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005235 nbsp:c Character to show for a non-breakable space character
5236 (0xA0 (160 decimal) and U+202F). Left blank when
5237 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005239 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005241 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005243 Each character can be specified as hex: >
5244 set listchars=eol:\\x24
5245 set listchars=eol:\\u21b5
5246 set listchars=eol:\\U000021b5
5247< Note that a double backslash is used. The number of hex characters
5248 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5249
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250 Examples: >
5251 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005252 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 :set lcs=extends:>,precedes:<
5254< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005255 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5256 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005257 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258
5259 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5260'loadplugins' 'lpl' boolean (default on)
5261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 When on the plugin scripts are loaded when starting up |load-plugins|.
5263 This option can be reset in your |vimrc| file to disable the loading
5264 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005265 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5266 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267
Bram Moolenaard94464e2015-11-02 15:28:18 +01005268 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005269'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005270 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005271 {only available when compiled with the |+lua/dyn|
5272 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005273 Specifies the name of the Lua shared library. The default is
5274 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005275 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005276 This option cannot be set from a |modeline| or in the |sandbox|, for
5277 security reasons.
5278
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005279 *'macatsui'* *'nomacatsui'*
5280'macatsui' boolean (default on)
5281 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005282 {not supported}
5283 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005284
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 *'magic'* *'nomagic'*
5286'magic' boolean (default on)
5287 global
5288 Changes the special characters that can be used in search patterns.
5289 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005290 WARNING: Switching this option off most likely breaks plugins! That
5291 is because many patterns assume it's on and will fail when it's off.
5292 Only switch it off when working with old Vi scripts. In any other
5293 situation write patterns that work when 'magic' is on. Include "\M"
5294 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005295 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5296 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297
5298 *'makeef'* *'mef'*
5299'makeef' 'mef' string (default: "")
5300 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 {not available when compiled without the |+quickfix|
5302 feature}
5303 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5304 and the |:grep| command.
5305 When it is empty, an internally generated temp file will be used.
5306 When "##" is included, it is replaced by a number to make the name
5307 unique. This makes sure that the ":make" command doesn't overwrite an
5308 existing file.
5309 NOT used for the ":cf" command. See 'errorfile' for that.
5310 Environment variables are expanded |:set_env|.
5311 See |option-backslash| about including spaces and backslashes.
5312 This option cannot be set from a |modeline| or in the |sandbox|, for
5313 security reasons.
5314
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005315 *'makeencoding'* *'menc'*
5316'makeencoding' 'menc' string (default "")
5317 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005318 Encoding used for reading the output of external commands. When empty,
5319 encoding is not converted.
5320 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5321 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5322 and `:laddfile`.
5323
5324 This would be mostly useful when you use MS-Windows and set 'encoding'
5325 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5326 'makeencoding' to "char" has the same effect as setting to the system
5327 locale encoding. Example: >
5328 :set encoding=utf-8
5329 :set makeencoding=char " system locale is used
5330<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 *'makeprg'* *'mp'*
5332'makeprg' 'mp' string (default "make", VMS: "MMS")
5333 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005334 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005335 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5336 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005337 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005338 Environment variables are expanded |:set_env|. See |option-backslash|
5339 about including spaces and backslashes.
5340 Note that a '|' must be escaped twice: once for ":set" and once for
5341 the interpretation of a command. When you use a filter called
5342 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 :set makeprg=gmake\ \\\|\ myfilter
5344< The placeholder "$*" can be given (even multiple times) to specify
5345 where the arguments will be included, for example: >
5346 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5347< This option cannot be set from a |modeline| or in the |sandbox|, for
5348 security reasons.
5349
5350 *'matchpairs'* *'mps'*
5351'matchpairs' 'mps' string (default "(:),{:},[:]")
5352 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005354 other.
5355 Only character pairs are allowed that are different, thus you cannot
5356 jump between two double quotes.
5357 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005358 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005359 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 :set mps+=<:>
5361
5362< A more exotic example, to jump between the '=' and ';' in an
5363 assignment, useful for languages like C and Java: >
5364 :au FileType c,cpp,java set mps+==:;
5365
5366< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005367 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368
5369 *'matchtime'* *'mat'*
5370'matchtime' 'mat' number (default 5)
5371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 Tenths of a second to show the matching paren, when 'showmatch' is
5373 set. Note that this is not in milliseconds, like other options that
5374 set a time. This is to be compatible with Nvi.
5375
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005376 *'maxcombine'* *'mco'*
5377'maxcombine' 'mco' number (default 2)
5378 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005379 The maximum number of combining characters supported for displaying.
5380 Only used when 'encoding' is "utf-8".
5381 The default is OK for most languages. Hebrew may require 4.
5382 Maximum value is 6.
5383 Even when this option is set to 2 you can still edit text with more
5384 combining characters, you just can't see them. Use |g8| or |ga|.
5385 See |mbyte-combining|.
5386
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387 *'maxfuncdepth'* *'mfd'*
5388'maxfuncdepth' 'mfd' number (default 100)
5389 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005390 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005391 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 Maximum depth of function calls for user functions. This normally
5393 catches endless recursion. When using a recursive function with
5394 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5395 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005396 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005397 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 See also |:function|.
5399
5400 *'maxmapdepth'* *'mmd'* *E223*
5401'maxmapdepth' 'mmd' number (default 1000)
5402 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403 Maximum number of times a mapping is done without resulting in a
5404 character to be used. This normally catches endless mappings, like
5405 ":map x y" with ":map y x". It still does not catch ":map g wg",
5406 because the 'w' is used before the next mapping is done. See also
5407 |key-mapping|.
5408
5409 *'maxmem'* *'mm'*
5410'maxmem' 'mm' number (default between 256 to 5120 (system
5411 dependent) or half the amount of memory
5412 available)
5413 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5415 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005416 other memory to be freed.
5417 The maximum usable value is about 2000000. Use this to work without a
5418 limit.
5419 The value is ignored when 'swapfile' is off.
5420 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005422 *'maxmempattern'* *'mmp'*
5423'maxmempattern' 'mmp' number (default 1000)
5424 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005425 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005426 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005427 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005428 When Vim runs into the limit it gives an error message and mostly
5429 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005430 Running into the limit often means that the pattern is very
5431 inefficient or too complex. This may already happen with the pattern
5432 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005433 Might also happen on redraw, when syntax rules try to match a complex
5434 text structure.
5435 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5436 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005437
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438 *'maxmemtot'* *'mmt'*
5439'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5440 dependent) or half the amount of memory
5441 available)
5442 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005443 Maximum amount of memory in Kbyte to use for all buffers together.
5444 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005445 without a limit.
5446 On 64 bit machines higher values might work. But hey, do you really
5447 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005448 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005449 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005450 Buffers with 'swapfile' off still count to the total amount of memory
5451 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005452 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453
5454 *'menuitems'* *'mis'*
5455'menuitems' 'mis' number (default 25)
5456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 {not available when compiled without the |+menu|
5458 feature}
5459 Maximum number of items to use in a menu. Used for menus that are
5460 generated from a list of items, e.g., the Buffers menu. Changing this
5461 option has no direct effect, the menu must be refreshed first.
5462
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005463 *'mkspellmem'* *'msm'*
5464'mkspellmem' 'msm' string (default "460000,2000,500")
5465 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005466 {not available when compiled without the |+syntax|
5467 feature}
5468 Parameters for |:mkspell|. This tunes when to start compressing the
5469 word tree. Compression can be slow when there are many words, but
5470 it's needed to avoid running out of memory. The amount of memory used
5471 per word depends very much on how similar the words are, that's why
5472 this tuning is complicated.
5473
5474 There are three numbers, separated by commas:
5475 {start},{inc},{added}
5476
5477 For most languages the uncompressed word tree fits in memory. {start}
5478 gives the amount of memory in Kbyte that can be used before any
5479 compression is done. It should be a bit smaller than the amount of
5480 memory that is available to Vim.
5481
5482 When going over the {start} limit the {inc} number specifies the
5483 amount of memory in Kbyte that can be allocated before another
5484 compression is done. A low number means compression is done after
5485 less words are added, which is slow. A high number means more memory
5486 will be allocated.
5487
5488 After doing compression, {added} times 1024 words can be added before
5489 the {inc} limit is ignored and compression is done when any extra
5490 amount of memory is needed. A low number means there is a smaller
5491 chance of hitting the {inc} limit, less memory is used but it's
5492 slower.
5493
5494 The languages for which these numbers are important are Italian and
5495 Hungarian. The default works for when you have about 512 Mbyte. If
5496 you have 1 Gbyte you could use: >
5497 :set mkspellmem=900000,3000,800
5498< If you have less than 512 Mbyte |:mkspell| may fail for some
5499 languages, no matter what you set 'mkspellmem' to.
5500
Bram Moolenaar07607392019-05-26 19:20:43 +02005501 This option cannot be set from a |modeline| or in the |sandbox|.
5502
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005504'modeline' 'ml' boolean (Vim default: on (off for root),
5505 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005507 If 'modeline' is on 'modelines' gives the number of lines that is
5508 checked for set commands. If 'modeline' is off or 'modelines' is zero
5509 no lines are checked. See |modeline|.
5510
5511 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5512'modelineexpr' 'mle' boolean (default: off)
5513 global
5514 When on allow some options that are an expression to be set in the
5515 modeline. Check the option for whether it is affected by
5516 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005517 This option cannot be set from a |modeline| or in the |sandbox|, for
5518 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005519
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 *'modelines'* *'mls'*
5521'modelines' 'mls' number (default 5)
5522 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523 If 'modeline' is on 'modelines' gives the number of lines that is
5524 checked for set commands. If 'modeline' is off or 'modelines' is zero
5525 no lines are checked. See |modeline|.
5526 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5527 set and to the Vim default value when 'compatible' is reset.
5528
5529 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005530 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531'modifiable' 'ma' boolean (default on)
5532 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 When off the buffer contents cannot be changed. The 'fileformat' and
5534 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005535 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536
5537 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5538'modified' 'mod' boolean (default off)
5539 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 When on, the buffer is considered to be modified. This option is set
5541 when:
5542 1. A change was made to the text since it was last written. Using the
5543 |undo| command to go back to the original text will reset the
5544 option. But undoing changes that were made before writing the
5545 buffer will set the option again, since the text is different from
5546 when it was written.
5547 2. 'fileformat' or 'fileencoding' is different from its original
5548 value. The original value is set when the buffer is read or
5549 written. A ":set nomodified" command also resets the original
5550 values to the current values and the 'modified' option will be
5551 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005552 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005553 This option is not set when a change is made to the buffer as the
5554 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5555 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5556 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5558 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005559 Note that the text may actually be the same, e.g. 'modified' is set
5560 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561
5562 *'more'* *'nomore'*
5563'more' boolean (Vim default: on, Vi default: off)
5564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 When on, listings pause when the whole screen is filled. You will get
5566 the |more-prompt|. When this option is off there are no pauses, the
5567 listing continues until finished.
5568 NOTE: This option is set to the Vi default value when 'compatible' is
5569 set and to the Vim default value when 'compatible' is reset.
5570
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005571 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005572'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005573 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005575 Enable the use of the mouse. Works for most terminals (xterm, Win32
5576 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5577 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5578 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005579 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 v Visual mode
5581 i Insert mode
5582 c Command-line mode
5583 h all previous modes when editing a help file
5584 a all previous modes
5585 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005586 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005588< If your terminal can't overrule the mouse events going to the
5589 application, use: >
5590 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005591< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005592 back to Vim using the mouse events.
5593 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5594 "xterm".
5595
5596 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 modeless selection. This doesn't move the text cursor.
5598
5599 See |mouse-using|. Also see |'clipboard'|.
5600
5601 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005602 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 the mouse buttons can still be used by keeping the shift key pressed.
5604 Also see the 'clipboard' option.
5605
5606 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5607'mousefocus' 'mousef' boolean (default off)
5608 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 {only works in the GUI}
5610 The window that the mouse pointer is on is automatically activated.
5611 When changing the window layout or window focus in another way, the
5612 mouse pointer is moved to the window with keyboard focus. Off is the
5613 default because it makes using the pull down menus a little goofy, as
5614 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005615 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005616 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617
5618 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5619'mousehide' 'mh' boolean (default on)
5620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 {only works in the GUI}
5622 When on, the mouse pointer is hidden when characters are typed.
5623 The mouse pointer is restored when the mouse is moved.
5624
5625 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005626'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 Sets the model to use for the mouse. The name mostly specifies what
5629 the right mouse button is used for:
5630 extend Right mouse button extends a selection. This works
5631 like in an xterm.
5632 popup Right mouse button pops up a menu. The shifted left
5633 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005634 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 popup_setpos Like "popup", but the cursor will be moved to the
5636 position where the mouse was clicked, and thus the
5637 selected operation will act upon the clicked object.
5638 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005639 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 course, that right clicking outside a selection will
5641 end Visual mode.
5642 Overview of what button does what for each model:
5643 mouse extend popup(_setpos) ~
5644 left click place cursor place cursor
5645 left drag start selection start selection
5646 shift-left search word extend selection
5647 right click extend selection popup menu (place cursor)
5648 right drag extend selection -
5649 middle click paste paste
5650
5651 In the "popup" model the right mouse button produces a pop-up menu.
5652 You need to define this first, see |popup-menu|.
5653
5654 Note that you can further refine the meaning of buttons with mappings.
5655 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5656 selection (because that's handled in the GUI code directly).
5657
5658 The 'mousemodel' option is set by the |:behave| command.
5659
Ernie Raelc4cb5442022-04-03 15:47:28 +01005660 *'mousemoveevent'* *'mousemev'*
5661'mousemoveevent' 'mousemev' boolean (default off)
5662 global
5663 {only works in the GUI}
5664 When on, mouse move events are delivered to the input queue and are
5665 available for mapping. The default, off, avoids the mouse movement
5666 overhead except when needed. See |gui-mouse-mapping|.
5667 Warning: Setting this option can make pending mappings to be aborted
5668 when the mouse is moved.
5669 Currently only works in the GUI, may be made to work in a terminal
5670 later.
5671
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005673'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5674 vs:leftright,vd:lrsizing,m:no,
5675 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 {only available when compiled with the |+mouseshape|
5678 feature}
5679 This option tells Vim what the mouse pointer should look like in
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005680 different modes. The option is a comma-separated list of parts, much
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 like used for 'guicursor'. Each part consist of a mode/location-list
5682 and an argument-list:
5683 mode-list:shape,mode-list:shape,..
5684 The mode-list is a dash separated list of these modes/locations:
5685 In a normal window: ~
5686 n Normal mode
5687 v Visual mode
5688 ve Visual mode with 'selection' "exclusive" (same as 'v',
5689 if not specified)
5690 o Operator-pending mode
5691 i Insert mode
5692 r Replace mode
5693
5694 Others: ~
5695 c appending to the command-line
5696 ci inserting in the command-line
5697 cr replacing in the command-line
5698 m at the 'Hit ENTER' or 'More' prompts
5699 ml idem, but cursor in the last line
5700 e any mode, pointer below last window
5701 s any mode, pointer on a status line
5702 sd any mode, while dragging a status line
5703 vs any mode, pointer on a vertical separator line
5704 vd any mode, while dragging a vertical separator line
5705 a everywhere
5706
5707 The shape is one of the following:
5708 avail name looks like ~
5709 w x arrow Normal mouse pointer
5710 w x blank no pointer at all (use with care!)
5711 w x beam I-beam
5712 w x updown up-down sizing arrows
5713 w x leftright left-right sizing arrows
5714 w x busy The system's usual busy pointer
5715 w x no The system's usual 'no input' pointer
5716 x udsizing indicates up-down resizing
5717 x lrsizing indicates left-right resizing
5718 x crosshair like a big thin +
5719 x hand1 black hand
5720 x hand2 white hand
5721 x pencil what you write with
5722 x question big ?
5723 x rightup-arrow arrow pointing right-up
5724 w x up-arrow arrow pointing up
5725 x <number> any X11 pointer number (see X11/cursorfont.h)
5726
5727 The "avail" column contains a 'w' if the shape is available for Win32,
5728 x for X11.
5729 Any modes not specified or shapes not available use the normal mouse
5730 pointer.
5731
5732 Example: >
5733 :set mouseshape=s:udsizing,m:no
5734< will make the mouse turn to a sizing arrow over the status lines and
5735 indicate no input when the hit-enter prompt is displayed (since
5736 clicking the mouse has no effect in this state.)
5737
5738 *'mousetime'* *'mouset'*
5739'mousetime' 'mouset' number (default 500)
5740 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005741 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 time in msec between two mouse clicks for the second click to be
5743 recognized as a multi click.
5744
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005745 *'mzschemedll'*
5746'mzschemedll' string (default depends on the build)
5747 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005748 {only available when compiled with the |+mzscheme/dyn|
5749 feature}
5750 Specifies the name of the MzScheme shared library. The default is
5751 DYNAMIC_MZSCH_DLL which was specified at compile time.
5752 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005753 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005754 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005755 This option cannot be set from a |modeline| or in the |sandbox|, for
5756 security reasons.
5757
5758 *'mzschemegcdll'*
5759'mzschemegcdll' string (default depends on the build)
5760 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005761 {only available when compiled with the |+mzscheme/dyn|
5762 feature}
5763 Specifies the name of the MzScheme GC shared library. The default is
5764 DYNAMIC_MZGC_DLL which was specified at compile time.
5765 The value can be equal to 'mzschemedll' if it includes the GC code.
5766 Environment variables are expanded |:set_env|.
5767 This option cannot be set from a |modeline| or in the |sandbox|, for
5768 security reasons.
5769
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005770 *'mzquantum'* *'mzq'*
5771'mzquantum' 'mzq' number (default 100)
5772 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005773 {not available when compiled without the |+mzscheme|
5774 feature}
5775 The number of milliseconds between polls for MzScheme threads.
5776 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005777 NOTE: This option is set to the Vim default value when 'compatible'
5778 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005779
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005781'nrformats' 'nf' string (default "bin,octal,hex",
5782 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 This defines what bases Vim will consider for numbers when using the
5785 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5786 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005787 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005789 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005790 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005792 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 considered to be hexadecimal. Example: Using CTRL-X on
5794 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005795 bin If included, numbers starting with "0b" or "0B" will be
5796 considered to be binary. Example: Using CTRL-X on
5797 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005798 unsigned If included, numbers are recognized as unsigned. Thus a
5799 leading dash or negative sign won't be considered as part of
5800 the number. Examples:
5801 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5802 (without "unsigned" it would become "9-2021").
5803 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5804 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005805 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5806 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 Numbers which simply begin with a digit in the range 1-9 are always
5808 considered decimal. This also happens for numbers that are not
5809 recognized as octal or hex.
5810
5811 *'number'* *'nu'* *'nonumber'* *'nonu'*
5812'number' 'nu' boolean (default off)
5813 local to window
5814 Print the line number in front of each line. When the 'n' option is
5815 excluded from 'cpoptions' a wrapped line will not use the column of
5816 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005817 The 'numberwidth' option can be used to set the room used for the line
5818 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 When a long, wrapped line doesn't start with the first character, '-'
5820 characters are put before the number.
James McCoya80aad72021-12-22 19:45:28 +00005821 For highlighting see |hl-LineNr|, and |hl-CursorLineNr|, and the
5822 |:sign-define| "numhl" argument.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005823 *number_relativenumber*
5824 The 'relativenumber' option changes the displayed number to be
5825 relative to the cursor. Together with 'number' there are these
5826 four combinations (cursor in line 3):
5827
Bram Moolenaar3848e002016-03-19 18:42:29 +01005828 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005829 'nornu' 'nornu' 'rnu' 'rnu'
5830
5831 |apple | 1 apple | 2 apple | 2 apple
5832 |pear | 2 pear | 1 pear | 1 pear
5833 |nobody | 3 nobody | 0 nobody |3 nobody
5834 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005836 *'numberwidth'* *'nuw'*
5837'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5838 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005839 {only available when compiled with the |+linebreak|
5840 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005841 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005842 when the 'number' or 'relativenumber' option is set or printing lines
5843 with a line number. Since one space is always between the number and
5844 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005845 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005846 fit the highest line number in the buffer respectively the number of
5847 rows in the window, depending on whether 'number' or 'relativenumber'
5848 is set. Thus with the Vim default of 4 there is room for a line number
5849 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005850 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005851 NOTE: This option is set to the Vi default value when 'compatible' is
5852 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005853
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005854 *'omnifunc'* *'ofu'*
5855'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005856 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005857 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005858 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005859 This option specifies a function to be used for Insert mode omni
5860 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005861 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005862 invoked and what it should return. The value can be the name of a
5863 function, a |lambda| or a |Funcref|. See |option-value-function| for
5864 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005865 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005866 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005867 This option cannot be set from a |modeline| or in the |sandbox|, for
5868 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005869
5870
Bram Moolenaar02467872007-05-06 13:22:01 +00005871 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005872'opendevice' 'odev' boolean (default off)
5873 global
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00005874 {only for MS-Windows} *E796*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005875 Enable reading and writing from devices. This may get Vim stuck on a
5876 device that can be opened but doesn't actually do the I/O. Therefore
5877 it is off by default.
5878 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5879 result in editing a device.
5880
5881
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005882 *'operatorfunc'* *'opfunc'*
5883'operatorfunc' 'opfunc' string (default: empty)
5884 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005885 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005886 See |:map-operator| for more info and an example. The value can be
5887 the name of a function, a |lambda| or a |Funcref|. See
5888 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005889
5890 This option cannot be set from a |modeline| or in the |sandbox|, for
5891 security reasons.
5892
5893
Bram Moolenaar251e1912011-06-19 05:09:16 +02005894 *'osfiletype'* *'oft'*
5895'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005897 This option was supported on RISC OS, which has been removed.
5898
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005900 *'packpath'* *'pp'*
5901'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005902 Directories used to find packages. See |packages|.
5903
5904
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005906'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 global
5908 Specifies the nroff macros that separate paragraphs. These are pairs
5909 of two letters (see |object-motions|).
5910
5911 *'paste'* *'nopaste'*
5912'paste' boolean (default off)
5913 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005914 Put Vim in Paste mode. This is useful if you want to cut or copy
5915 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 unexpected effects.
5917 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005918 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 knows about pasting and will mostly do the right thing without 'paste'
5920 being set. The same is true for a terminal where Vim handles the
5921 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005922 This option is reset when starting the GUI. Thus if you set it in
5923 your .vimrc it will work in a terminal, but not in the GUI. Setting
5924 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5925 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 When the 'paste' option is switched on (also when it was already on):
5927 - mapping in Insert mode and Command-line mode is disabled
5928 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005930 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005931 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932 - 'revins' is reset
5933 - 'ruler' is reset
5934 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005935 - 'smarttab' is reset
5936 - 'softtabstop' is set to 0
5937 - 'textwidth' is set to 0
5938 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005939 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005941 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005942 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005943 - 'indentexpr'
5944 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005945 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946 NOTE: When you start editing another file while the 'paste' option is
5947 on, settings from the modelines or autocommands may change the
5948 settings again, causing trouble when pasting text. You might want to
5949 set the 'paste' option again.
5950 When the 'paste' option is reset the mentioned options are restored to
5951 the value before the moment 'paste' was switched from off to on.
5952 Resetting 'paste' before ever setting it does not have any effect.
5953 Since mapping doesn't work while 'paste' is active, you need to use
5954 the 'pastetoggle' option to toggle the 'paste' option with some key.
5955
5956 *'pastetoggle'* *'pt'*
5957'pastetoggle' 'pt' string (default "")
5958 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959 When non-empty, specifies the key sequence that toggles the 'paste'
5960 option. This is like specifying a mapping: >
5961 :map {keys} :set invpaste<CR>
5962< Where {keys} is the value of 'pastetoggle'.
5963 The difference is that it will work even when 'paste' is set.
5964 'pastetoggle' works in Insert mode and Normal mode, but not in
5965 Command-line mode.
5966 Mappings are checked first, thus overrule 'pastetoggle'. However,
5967 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5968 this: >
5969 :map <F10> :set paste<CR>
5970 :map <F11> :set nopaste<CR>
5971 :imap <F10> <C-O>:set paste<CR>
5972 :imap <F11> <nop>
5973 :set pastetoggle=<F11>
5974< This will make <F10> start paste mode and <F11> stop paste mode.
5975 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5976 mode everything is inserted literally, except the 'pastetoggle' key
5977 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005978 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979
5980 *'pex'* *'patchexpr'*
5981'patchexpr' 'pex' string (default "")
5982 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983 {not available when compiled without the |+diff|
5984 feature}
5985 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005986 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987
Bram Moolenaardbc28022014-07-26 13:40:44 +02005988 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989'patchmode' 'pm' string (default "")
5990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 When non-empty the oldest version of a file is kept. This can be used
5992 to keep the original version of a file if you are changing files in a
5993 source distribution. Only the first time that a file is written a
5994 copy of the original file will be kept. The name of the copy is the
5995 name of the original file with the string in the 'patchmode' option
5996 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005997 ".orig" or ".org". 'backupdir' must not be empty for this to work
5998 (Detail: The backup file is renamed to the patchmode file after the
5999 new file has been successfully written, that's why it must be possible
6000 to write a backup file). If there was no file to be backed up, an
6001 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 When the 'backupskip' pattern matches, a patchmode file is not made.
6003 Using 'patchmode' for compressed files appends the extension at the
6004 end (e.g., "file.gz.orig"), thus the resulting name isn't always
6005 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006006 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01006008 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 other systems: ".,,")
6011 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00006013 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
6014 provided that the file being searched for has a relative path (not
6015 starting with "/", "./" or "../"). The directories in the 'path'
6016 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 - Use commas to separate directory names: >
6018 :set path=.,/usr/local/include,/usr/include
6019< - Spaces can also be used to separate directory names (for backwards
6020 compatibility with version 3.0). To have a space in a directory
6021 name, precede it with an extra backslash, and escape the space: >
6022 :set path=.,/dir/with\\\ space
6023< - To include a comma in a directory name precede it with an extra
6024 backslash: >
6025 :set path=.,/dir/with\\,comma
6026< - To search relative to the directory of the current file, use: >
6027 :set path=.
6028< - To search in the current directory use an empty string between two
6029 commas: >
6030 :set path=,,
6031< - A directory name may end in a ':' or '/'.
6032 - Environment variables are expanded |:set_env|.
6033 - When using |netrw.vim| URLs can be used. For example, adding
6034 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00006035 - Search upwards and downwards in a directory tree using "*", "**" and
6036 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 - Careful with '\' characters, type two to get one in the option: >
6038 :set path=.,c:\\include
6039< Or just use '/' instead: >
6040 :set path=.,c:/include
6041< Don't forget "." or files won't even be found in the same directory as
6042 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006043 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 it is something like 256 or 1024 characters.
6045 You can check if all the include files are found, using the value of
6046 'path', see |:checkpath|.
6047 The use of |:set+=| and |:set-=| is preferred when adding or removing
6048 directories from the list. This avoids problems when a future version
6049 uses another default. To remove the current directory use: >
6050 :set path-=
6051< To add the current directory use: >
6052 :set path+=
6053< To use an environment variable, you probably need to replace the
6054 separator. Here is an example to append $INCL, in which directory
6055 names are separated with a semi-colon: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006056 :let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057< Replace the ';' with a ':' or whatever separator is used. Note that
6058 this doesn't work when $INCL contains a comma or white space.
6059
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006060 *'perldll'*
6061'perldll' string (default depends on the build)
6062 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02006063 {only available when compiled with the |+perl/dyn|
6064 feature}
6065 Specifies the name of the Perl shared library. The default is
6066 DYNAMIC_PERL_DLL, which was specified at compile time.
6067 Environment variables are expanded |:set_env|.
6068 This option cannot be set from a |modeline| or in the |sandbox|, for
6069 security reasons.
6070
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
6072'preserveindent' 'pi' boolean (default off)
6073 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 When changing the indent of the current line, preserve as much of the
6075 indent structure as possible. Normally the indent is replaced by a
6076 series of tabs followed by spaces as required (unless |'expandtab'| is
6077 enabled, in which case only spaces are used). Enabling this option
6078 means the indent will preserve as many existing characters as possible
6079 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006080 'expandtab' does not apply to the preserved white space, a Tab remains
6081 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 NOTE: When using ">>" multiple times the resulting indent is a mix of
6083 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006084 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 Also see 'copyindent'.
6086 Use |:retab| to clean up white space.
6087
6088 *'previewheight'* *'pvh'*
6089'previewheight' 'pvh' number (default 12)
6090 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006091 {not available when compiled without the |+quickfix|
6092 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02006094 commands. Used for |CTRL-W_}| when no count is given. Not used when
6095 'previewpopup' is set.
6096
6097 *'previewpopup'* *'pvp'*
6098'previewpopup' 'pvp' string (default empty)
6099 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006100 {not available when compiled without the |+textprop|
6101 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02006102 When not empty a popup window is used for commands that would open a
6103 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02006104 Not used for the insert completion info, add "popup" to
6105 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106
6107 *'previewwindow'* *'nopreviewwindow'*
6108 *'pvw'* *'nopvw'* *E590*
6109'previewwindow' 'pvw' boolean (default off)
6110 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02006111 {not available when compiled without the |+quickfix|
6112 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006113 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 set. It's normally not set directly, but by using one of the commands
6115 |:ptag|, |:pedit|, etc.
6116
6117 *'printdevice'* *'pdev'*
6118'printdevice' 'pdev' string (default empty)
6119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120 {only available when compiled with the |+printer|
6121 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006122 The name of the printer to be used for |:hardcopy|.
6123 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006124 This option cannot be set from a |modeline| or in the |sandbox|, for
6125 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126
Bram Moolenaar8299df92004-07-10 09:47:34 +00006127 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006128'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130 {only available when compiled with the |+printer|
6131 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006132 Sets the character encoding used when printing.
6133 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134
6135 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02006136'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 {only available when compiled with the |+printer|
6139 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006140 Expression used to print the PostScript produced with |:hardcopy|.
6141 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01006142 This option cannot be set from a |modeline| or in the |sandbox|, for
6143 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144
Bram Moolenaar8299df92004-07-10 09:47:34 +00006145 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146'printfont' 'pfn' string (default "courier")
6147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 {only available when compiled with the |+printer|
6149 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006150 The name of the font that will be used for |:hardcopy|.
6151 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152
6153 *'printheader'* *'pheader'*
6154'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 {only available when compiled with the |+printer|
6157 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006158 The format of the header produced in |:hardcopy| output.
6159 See |pheader-option|.
6160
6161 *'printmbcharset'* *'pmbcs'*
6162'printmbcharset' 'pmbcs' string (default "")
6163 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006164 {only available when compiled with the |+printer|
6165 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006166 The CJK character set to be used for CJK output from |:hardcopy|.
6167 See |pmbcs-option|.
6168
6169 *'printmbfont'* *'pmbfn'*
6170'printmbfont' 'pmbfn' string (default "")
6171 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006172 {only available when compiled with the |+printer|
6173 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006174 List of font names to be used for CJK output from |:hardcopy|.
6175 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176
6177 *'printoptions'* *'popt'*
6178'printoptions' 'popt' string (default "")
6179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006181 List of items that control the format of the output of |:hardcopy|.
6182 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006184 *'prompt'* *'noprompt'*
6185'prompt' boolean (default on)
6186 global
6187 When on a ":" prompt is used in Ex mode.
6188
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006189 *'pumheight'* *'ph'*
6190'pumheight' 'ph' number (default 0)
6191 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006192 Determines the maximum number of items to show in the popup menu for
6193 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006194 |ins-completion-menu|.
6195
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006196 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006197'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006198 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006199 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006200 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006201
Bram Moolenaard94464e2015-11-02 15:28:18 +01006202 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006203'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006204 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006205 {only available when compiled with the |+python/dyn|
6206 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006207 Specifies the name of the Python 2.x shared library. The default is
6208 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006209 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006210 This option cannot be set from a |modeline| or in the |sandbox|, for
6211 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006212
Bram Moolenaar94073162018-01-31 21:49:05 +01006213 *'pythonhome'*
6214'pythonhome' string (default "")
6215 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006216 {only available when compiled with the |+python/dyn|
6217 feature}
6218 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6219 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6220 which was specified at compile time, will be used for the Python 2.x
6221 home directory.
6222 Environment variables are expanded |:set_env|.
6223 This option cannot be set from a |modeline| or in the |sandbox|, for
6224 security reasons.
6225
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006226 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006227'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006228 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006229 {only available when compiled with the |+python3/dyn|
6230 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006231 Specifies the name of the Python 3 shared library. The default is
6232 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006233 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006234 This option cannot be set from a |modeline| or in the |sandbox|, for
6235 security reasons.
6236
Bram Moolenaar94073162018-01-31 21:49:05 +01006237 *'pythonthreehome'*
6238'pythonthreehome' string (default "")
6239 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006240 {only available when compiled with the |+python3/dyn|
6241 feature}
6242 Specifies the name of the Python 3 home directory. When
6243 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6244 PYTHON3_HOME, which was specified at compile time, will be used for
6245 the Python 3 home directory.
6246 Environment variables are expanded |:set_env|.
6247 This option cannot be set from a |modeline| or in the |sandbox|, for
6248 security reasons.
6249
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006250 *'pyxversion'* *'pyx'*
6251'pyxversion' 'pyx' number (default depends on the build)
6252 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006253 {only available when compiled with the |+python| or
6254 the |+python3| feature}
6255 Specifies the python version used for pyx* functions and commands
6256 |python_x|. The default value is as follows:
6257
6258 Compiled with Default ~
6259 |+python| and |+python3| 0
6260 only |+python| 2
6261 only |+python3| 3
6262
6263 Available values are 0, 2 and 3.
6264 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6265 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6266 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6267 to 2 if Python 2 is available.
6268 See also: |has-pythonx|
6269
6270 If Vim is compiled with only |+python| or |+python3| setting
6271 'pyxversion' has no effect. The pyx* functions and commands are
6272 always the same as the compiled version.
6273
6274 This option cannot be set from a |modeline| or in the |sandbox|, for
6275 security reasons.
6276
Bram Moolenaar858ba062020-05-31 23:11:59 +02006277 *'quickfixtextfunc'* *'qftf'*
6278'quickfixtextfunc' 'qftf' string (default "")
6279 global
6280 {only available when compiled with the |+quickfix|
6281 feature}
6282 This option specifies a function to be used to get the text to display
6283 in the quickfix and location list windows. This can be used to
6284 customize the information displayed in the quickfix or location window
6285 for each entry in the corresponding quickfix or location list. See
6286 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006287 function and an example. The value can be the name of a function, a
6288 |lambda| or a |Funcref|. See |option-value-function| for more
6289 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006290
6291 This option cannot be set from a |modeline| or in the |sandbox|, for
6292 security reasons.
6293
Bram Moolenaar677ee682005-01-27 14:41:15 +00006294 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006295'quoteescape' 'qe' string (default "\")
6296 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006297 The characters that are used to escape quotes in a string. Used for
6298 objects like a', a" and a` |a'|.
6299 When one of the characters in this option is found inside a string,
6300 the following character will be skipped. The default value makes the
6301 text "foo\"bar\\" considered to be one string.
6302
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6304'readonly' 'ro' boolean (default off)
6305 local to buffer
6306 If on, writes fail unless you use a '!'. Protects you from
6307 accidentally overwriting a file. Default on when Vim is started
6308 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006309 When using ":w!" the 'readonly' option is reset for the current
6310 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006311 When using the ":view" command the 'readonly' option is set for the
6312 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006313 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006315 *'redrawtime'* *'rdt'*
6316'redrawtime' 'rdt' number (default 2000)
6317 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006318 {only available when compiled with the |+reltime|
6319 feature}
6320 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006321 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006322 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006323 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006324 matches will be highlighted.
6325 For syntax highlighting the time applies per window. When over the
6326 limit syntax highlighting is disabled until |CTRL-L| is used.
6327 This is used to avoid that Vim hangs when using a very complicated
6328 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006329
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006330 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006331'regexpengine' 're' number (default 0)
6332 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006333 This selects the default regexp engine. |two-engines|
6334 The possible values are:
6335 0 automatic selection
6336 1 old engine
6337 2 NFA engine
6338 Note that when using the NFA engine and the pattern contains something
6339 that is not supported the pattern will not match. This is only useful
6340 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006341 Using automatic selection enables Vim to switch the engine, if the
6342 default engine becomes too costly. E.g., when the NFA engine uses too
6343 many states. This should prevent Vim from hanging on a combination of
6344 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006345
Bram Moolenaar64486672010-05-16 15:46:46 +02006346 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6347'relativenumber' 'rnu' boolean (default off)
6348 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006349 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006350 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006351 precede some vertical motion commands (e.g. j k + -) with, without
6352 having to calculate it yourself. Especially useful in combination with
6353 other commands (e.g. y d c < > gq gw =).
6354 When the 'n' option is excluded from 'cpoptions' a wrapped
6355 line will not use the column of line numbers (this is the default when
6356 'compatible' isn't set).
6357 The 'numberwidth' option can be used to set the room used for the line
6358 number.
6359 When a long, wrapped line doesn't start with the first character, '-'
6360 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006361 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6362 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006363
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006364 The number in front of the cursor line also depends on the value of
6365 'number', see |number_relativenumber| for all combinations of the two
6366 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006367
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368 *'remap'* *'noremap'*
6369'remap' boolean (default on)
6370 global
6371 Allows for mappings to work recursively. If you do not want this for
6372 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006373 NOTE: To avoid portability problems with Vim scripts, always keep
6374 this option at the default "on". Only switch it off when working with
6375 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006377 *'renderoptions'* *'rop'*
6378'renderoptions' 'rop' string (default: empty)
6379 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006380 {only available when compiled with GUI and DIRECTX on
6381 MS-Windows}
6382 Select a text renderer and set its options. The options depend on the
6383 renderer.
6384
6385 Syntax: >
6386 set rop=type:{renderer}(,{name}:{value})*
6387<
6388 Currently, only one optional renderer is available.
6389
6390 render behavior ~
6391 directx Vim will draw text using DirectX (DirectWrite). It makes
6392 drawn glyphs more beautiful than default GDI.
6393 It requires 'encoding' is "utf-8", and only works on
6394 MS-Windows Vista or newer version.
6395
6396 Options:
6397 name meaning type value ~
6398 gamma gamma float 1.0 - 2.2 (maybe)
6399 contrast enhancedContrast float (unknown)
6400 level clearTypeLevel float (unknown)
6401 geom pixelGeometry int 0 - 2 (see below)
6402 renmode renderingMode int 0 - 6 (see below)
6403 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006404 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006405
Bram Moolenaar92467d32017-12-05 13:22:16 +01006406 See this URL for detail (except for scrlines):
6407 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006408
6409 For geom: structure of a device pixel.
6410 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6411 1 - DWRITE_PIXEL_GEOMETRY_RGB
6412 2 - DWRITE_PIXEL_GEOMETRY_BGR
6413
6414 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006415 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006416
6417 For renmode: method of rendering glyphs.
6418 0 - DWRITE_RENDERING_MODE_DEFAULT
6419 1 - DWRITE_RENDERING_MODE_ALIASED
6420 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6421 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6422 4 - DWRITE_RENDERING_MODE_NATURAL
6423 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6424 6 - DWRITE_RENDERING_MODE_OUTLINE
6425
6426 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006427 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006428
6429 For taamode: antialiasing mode used for drawing text.
6430 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6431 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6432 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6433 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6434
6435 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006436 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6437
Bram Moolenaara338adc2018-01-31 20:51:47 +01006438 For scrlines:
6439 This was used for optimizing scrolling behavior, however this
6440 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006441
6442 Example: >
6443 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006444 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006445 set rop=type:directx
6446<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006447 If select a raster font (Courier, Terminal or FixedSys which
6448 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006449 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006450
6451 NOTE: It is known that some fonts and options combination
6452 causes trouble on drawing glyphs.
6453
Bram Moolenaar92467d32017-12-05 13:22:16 +01006454 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006455 special made fonts (True-Type fonts which includes only
6456 bitmap glyphs).
6457 - 'taamode:3' will not work with some vector fonts.
6458
6459 NOTE: With this option, you can display colored emoji
6460 (emoticon) in Windows 8.1 or later. To display colored emoji,
6461 there are some conditions which you should notice.
6462
6463 - If your font includes non-colored emoji already, it will
6464 be used.
6465 - If your font doesn't have emoji, the system chooses an
6466 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6467 will be used.
6468 - When this alternative font didn't have fixed width glyph,
6469 emoji might be rendered beyond the bounding box of drawing
6470 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006471
6472 Other render types are currently not supported.
6473
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 *'report'*
6475'report' number (default 2)
6476 global
6477 Threshold for reporting number of lines changed. When the number of
6478 changed lines is more than 'report' a message will be given for most
6479 ":" commands. If you want it always, set 'report' to 0.
6480 For the ":substitute" command the number of substitutions is used
6481 instead of the number of lines.
6482
6483 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6484'restorescreen' 'rs' boolean (default on)
6485 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006486 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 When set, the screen contents is restored when exiting Vim. This also
6488 happens when executing external commands.
6489
6490 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6491 options in your .vimrc. To disable restoring:
6492 set t_ti= t_te=
6493 To enable restoring (for an xterm):
6494 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6495 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6496
6497 *'revins'* *'ri'* *'norevins'* *'nori'*
6498'revins' 'ri' boolean (default off)
6499 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 {only available when compiled with the |+rightleft|
6501 feature}
6502 Inserting characters in Insert mode will work backwards. See "typing
6503 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6504 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006505 NOTE: This option is reset when 'compatible' is set.
6506 This option is reset when 'paste' is set and restored when 'paste' is
6507 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508
6509 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6510'rightleft' 'rl' boolean (default off)
6511 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 {only available when compiled with the |+rightleft|
6513 feature}
6514 When on, display orientation becomes right-to-left, i.e., characters
6515 that are stored in the file appear from the right to the left.
6516 Using this option, it is possible to edit files for languages that
6517 are written from the right to the left such as Hebrew and Arabic.
6518 This option is per window, so it is possible to edit mixed files
6519 simultaneously, or to view the same file in both ways (this is
6520 useful whenever you have a mixed text file with both right-to-left
6521 and left-to-right strings so that both sets are displayed properly
6522 in different windows). Also see |rileft.txt|.
6523
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006524 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525'rightleftcmd' 'rlc' string (default "search")
6526 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 {only available when compiled with the |+rightleft|
6528 feature}
6529 Each word in this option enables the command line editing to work in
6530 right-to-left mode for a group of commands:
6531
6532 search "/" and "?" commands
6533
6534 This is useful for languages such as Hebrew, Arabic and Farsi.
6535 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6536
Bram Moolenaard94464e2015-11-02 15:28:18 +01006537 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006538'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006539 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006540 {only available when compiled with the |+ruby/dyn|
6541 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006542 Specifies the name of the Ruby shared library. The default is
6543 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006544 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006545 This option cannot be set from a |modeline| or in the |sandbox|, for
6546 security reasons.
6547
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006549'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006552 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 text in the file is shown on the far right:
6554 Top first line is visible
6555 Bot last line is visible
6556 All first and last line are visible
6557 45% relative position in the file
6558 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006559 Each window has its own ruler. If a window has a status line, the
Bram Moolenaara2a89732022-08-31 14:46:18 +01006560 ruler is shown there. Otherwise it is shown in the last line of the
6561 screen. If the statusline is given by 'statusline' (i.e. not empty),
6562 this option takes precedence over 'ruler' and 'rulerformat'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006564 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 the text column (byte number) and the screen column are shown,
6566 separated with a dash.
6567 For an empty line "0-1" is shown.
6568 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006569 This option is reset when 'paste' is set and restored when 'paste' is
6570 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 If you don't want to see the ruler all the time but want to know where
6572 you are, use "g CTRL-G" |g_CTRL-G|.
6573 NOTE: This option is reset when 'compatible' is set.
6574
6575 *'rulerformat'* *'ruf'*
6576'rulerformat' 'ruf' string (default empty)
6577 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 {not available when compiled without the |+statusline|
6579 feature}
6580 When this option is not empty, it determines the content of the ruler
6581 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006582 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006583 This option cannot be set in a modeline when 'modelineexpr' is off.
6584
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 The default ruler width is 17 characters. To make the ruler 15
6586 characters wide, put "%15(" at the start and "%)" at the end.
6587 Example: >
6588 :set rulerformat=%15(%c%V\ %p%%%)
6589<
6590 *'runtimepath'* *'rtp'* *vimfiles*
6591'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006592 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593 $VIM/vimfiles,
6594 $VIMRUNTIME,
6595 $VIM/vimfiles/after,
6596 $HOME/.vim/after"
6597 Amiga: "home:vimfiles,
6598 $VIM/vimfiles,
6599 $VIMRUNTIME,
6600 $VIM/vimfiles/after,
6601 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006602 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 $VIM/vimfiles,
6604 $VIMRUNTIME,
6605 $VIM/vimfiles/after,
6606 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006607 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 $VIMRUNTIME,
6609 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006610 Haiku: "$BE_USER_SETTINGS/vim,
6611 $VIM/vimfiles,
6612 $VIMRUNTIME,
6613 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006614 $BE_USER_SETTINGS/vim/after"
6615 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 $VIM/vimfiles,
6617 $VIMRUNTIME,
6618 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006619 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 This is a list of directories which will be searched for runtime
6622 files:
6623 filetype.vim filetypes by file name |new-filetype|
6624 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006625 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 colors/ color scheme files |:colorscheme|
6627 compiler/ compiler files |:compiler|
6628 doc/ documentation |write-local-help|
6629 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006630 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 indent/ indent scripts |indent-expression|
6632 keymap/ key mapping files |mbyte-keymap|
6633 lang/ menu translations |:menutrans|
6634 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006635 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 plugin/ plugin scripts |write-plugin|
6637 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006638 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 syntax/ syntax files |mysyntaxfile|
6640 tutor/ files for vimtutor |tutor|
6641
6642 And any other file searched for with the |:runtime| command.
6643
6644 The defaults for most systems are setup to search five locations:
6645 1. In your home directory, for your personal preferences.
6646 2. In a system-wide Vim directory, for preferences from the system
6647 administrator.
6648 3. In $VIMRUNTIME, for files distributed with Vim.
6649 *after-directory*
6650 4. In the "after" directory in the system-wide Vim directory. This is
6651 for the system administrator to overrule or add to the distributed
6652 defaults (rarely needed)
6653 5. In the "after" directory in your home directory. This is for
6654 personal preferences to overrule or add to the distributed defaults
6655 or system-wide settings (rarely needed).
6656
Bram Moolenaard0796902016-09-16 20:02:31 +02006657 More entries are added when using |packages|. If it gets very long
6658 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6659 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006660
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6662 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006663 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 wildcards.
6665 See |:runtime|.
6666 Example: >
6667 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6668< This will use the directory "~/vimruntime" first (containing your
6669 personal Vim runtime files), then "/mygroup/vim" (shared between a
6670 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6671 files).
6672 You probably should always include $VIMRUNTIME somewhere, to use the
6673 distributed runtime files. You can put a directory before $VIMRUNTIME
6674 to find files which replace a distributed runtime files. You can put
6675 a directory after $VIMRUNTIME to find files which add to distributed
6676 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006677 When Vim is started with |--clean| the home directory entries are not
6678 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 This option cannot be set from a |modeline| or in the |sandbox|, for
6680 security reasons.
6681
6682 *'scroll'* *'scr'*
6683'scroll' 'scr' number (default: half the window height)
6684 local to window
6685 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6686 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006687 changes. This may happen when enabling the |status-line| or
6688 'tabline' option after setting the 'scroll' option.
6689 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006690 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006691 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692
6693 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6694'scrollbind' 'scb' boolean (default off)
6695 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 See also |scroll-binding|. When this option is set, the current
6697 window scrolls as other scrollbind windows (windows that also have
6698 this option set) scroll. This option is useful for viewing the
6699 differences between two versions of a file, see 'diff'.
6700 See |'scrollopt'| for options that determine how this option should be
6701 interpreted.
6702 This option is mostly reset when splitting a window to edit another
6703 file. This means that ":split | edit file" results in two windows
6704 with scroll-binding, but ":split file" does not.
6705
Bram Moolenaarae20f342019-11-05 21:09:23 +01006706 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6707'scrollfocus' 'scf' boolean (default off)
6708 global
6709 {only for MS-Windows GUI}
6710 When using the scroll wheel and this option is set, the window under
6711 the mouse pointer is scrolled. With this option off the current
6712 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006713 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006714
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 *'scrolljump'* *'sj'*
6716'scrolljump' 'sj' number (default 1)
6717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 Minimal number of lines to scroll when the cursor gets off the
6719 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6720 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006721 When set to a negative number from -1 to -100 this is used as the
6722 percentage of the window height. Thus -50 scrolls half the window
6723 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 NOTE: This option is set to 1 when 'compatible' is set.
6725
6726 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006727'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006728 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 Minimal number of screen lines to keep above and below the cursor.
6730 This will make some context visible around where you are working. If
6731 you set it to a very large value (999) the cursor line will always be
6732 in the middle of the window (except at the start or end of the file or
6733 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006734 After using the local value, go back the global value with one of
6735 these two: >
6736 setlocal scrolloff<
6737 setlocal scrolloff=-1
6738< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 NOTE: This option is set to 0 when 'compatible' is set.
6740
6741 *'scrollopt'* *'sbo'*
6742'scrollopt' 'sbo' string (default "ver,jump")
6743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006745 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6746 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 The following words are available:
6748 ver Bind vertical scrolling for 'scrollbind' windows
6749 hor Bind horizontal scrolling for 'scrollbind' windows
6750 jump Applies to the offset between two windows for vertical
6751 scrolling. This offset is the difference in the first
6752 displayed line of the bound windows. When moving
6753 around in a window, another 'scrollbind' window may
6754 reach a position before the start or after the end of
6755 the buffer. The offset is not changed though, when
6756 moving back the 'scrollbind' window will try to scroll
6757 to the desired position when possible.
6758 When now making that window the current one, two
6759 things can be done with the relative offset:
6760 1. When "jump" is not included, the relative offset is
6761 adjusted for the scroll position in the new current
6762 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006763 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 2. When "jump" is included, the other windows are
6765 scrolled to keep the same relative offset. When
6766 going back to the other window, it still uses the
6767 same relative offset.
6768 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006769 When 'diff' mode is active there always is vertical scroll binding,
6770 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771
6772 *'sections'* *'sect'*
6773'sections' 'sect' string (default "SHNHH HUnhsh")
6774 global
6775 Specifies the nroff macros that separate sections. These are pairs of
6776 two letters (See |object-motions|). The default makes a section start
6777 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6778
6779 *'secure'* *'nosecure'* *E523*
6780'secure' boolean (default off)
6781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 When on, ":autocmd", shell and write commands are not allowed in
6783 ".vimrc" and ".exrc" in the current directory and map commands are
6784 displayed. Switch it off only if you know that you will not run into
6785 problems, or when the 'exrc' option is off. On Unix this option is
6786 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006787 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 'secure' at the end of your ~/.vimrc then.
6789 This option cannot be set from a |modeline| or in the |sandbox|, for
6790 security reasons.
6791
6792 *'selection'* *'sel'*
6793'selection' 'sel' string (default "inclusive")
6794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 This option defines the behavior of the selection. It is only used
6796 in Visual and Select mode.
6797 Possible values:
6798 value past line inclusive ~
6799 old no yes
6800 inclusive yes yes
6801 exclusive yes no
6802 "past line" means that the cursor is allowed to be positioned one
6803 character past the line.
6804 "inclusive" means that the last character of the selection is included
6805 in an operation. For example, when "x" is used to delete the
6806 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006807 When "old" is used and 'virtualedit' allows the cursor to move past
6808 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 Note that when "exclusive" is used and selecting from the end
6810 backwards, you cannot include the last character of a line, when
6811 starting in Normal mode and 'virtualedit' empty.
6812
6813 The 'selection' option is set by the |:behave| command.
6814
6815 *'selectmode'* *'slm'*
6816'selectmode' 'slm' string (default "")
6817 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006818 This is a comma-separated list of words, which specifies when to start
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 Select mode instead of Visual mode, when a selection is started.
6820 Possible values:
6821 mouse when using the mouse
6822 key when using shifted special keys
6823 cmd when using "v", "V" or CTRL-V
6824 See |Select-mode|.
6825 The 'selectmode' option is set by the |:behave| command.
6826
6827 *'sessionoptions'* *'ssop'*
6828'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006829 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006831 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 feature}
6833 Changes the effect of the |:mksession| command. It is a comma
6834 separated list of words. Each word enables saving and restoring
6835 something:
6836 word save and restore ~
6837 blank empty windows
6838 buffers hidden and unloaded buffers, not just those in windows
6839 curdir the current directory
6840 folds manually created folds, opened/closed folds and local
6841 fold options
6842 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006843 and contain at least one lowercase letter. Only
6844 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 help the help window
6846 localoptions options and mappings local to a window or buffer (not
6847 global values for local options)
6848 options all options and mappings (also global values for local
6849 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006850 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 resize size of the Vim window: 'lines' and 'columns'
6852 sesdir the directory in which the session file is located
6853 will become the current directory (useful with
6854 projects accessed over a network from different
6855 systems)
6856 slash backslashes in file names replaced with forward
6857 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006858 tabpages all tab pages; without this only the current tab page
6859 is restored, so that you can make a session for each
6860 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006861 terminal include terminal windows where the command can be
6862 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 unix with Unix end-of-line format (single <NL>), even when
6864 on Windows or DOS
6865 winpos position of the whole Vim window
6866 winsize window sizes
6867
6868 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006869 When neither "curdir" nor "sesdir" is included, file names are stored
6870 with absolute paths.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00006871 If you leave out "options" many things won't work well after restoring
6872 the session.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 "slash" and "unix" are useful on Windows when sharing session files
6874 with Unix. The Unix version of Vim cannot source dos format scripts,
6875 but the Windows version of Vim can source unix format scripts.
6876
6877 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006878'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 global
6880 Name of the shell to use for ! and :! commands. When changing the
6881 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6882 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006883 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 See |option-backslash| about including spaces and backslashes.
6885 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006886
Bram Moolenaara2baa732022-02-04 16:09:54 +00006887 In |restricted-mode| shell commands will not be possible. This mode
6888 is used if the value of $SHELL ends in "false" or "nologin".
6889
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006890 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006891 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6893< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006894 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006896 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006898 Example with escaped space (Vim will do this when initializing the
6899 option from $SHELL): >
6900 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006901< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006902 backslashes are consumed by `:set`.
6903
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 Under MS-Windows, when the executable ends in ".com" it must be
6905 included. Thus setting the shell to "command.com" or "4dos.com"
6906 works, but "command" and "4dos" do not work for all commands (e.g.,
6907 filtering).
6908 For unknown reasons, when using "4dos.com" the current directory is
6909 changed to "C:\". To avoid this set 'shell' like this: >
6910 :set shell=command.com\ /c\ 4dos
6911< This option cannot be set from a |modeline| or in the |sandbox|, for
6912 security reasons.
6913
6914 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006915'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006916 Win32, when 'shell' contains "powershell":
6917 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006918 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006921 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6922 For MS-Windows, the default is set according to the value of 'shell',
6923 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006924 On Unix it can have more than one flag. Each white space separated
6925 part is passed as an argument to the shell command.
6926 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006927 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 This option cannot be set from a |modeline| or in the |sandbox|, for
6929 security reasons.
6930
6931 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006932'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6933 "2>&1| tee", or
6934 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 {not available when compiled without the |+quickfix|
6937 feature}
6938 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006939 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 including spaces and backslashes.
6941 The name of the temporary file can be represented by "%s" if necessary
6942 (the file name is appended automatically if no %s appears in the value
6943 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006944 For the Amiga the default is ">". For MS-Windows using powershell the
6945 default is "2>&1 | Out-File -Encoding default", otherwise the default
6946 is ">%s 2>&1". The output is directly saved in a file and not echoed
6947 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006948 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 in a file and echoed to the screen. If the 'shell' option is "csh" or
6950 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006951 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006952 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6953 means that stderr is also included. Before using the 'shell' option a
6954 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006955 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6956 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 The initialization of this option is done after reading the ".vimrc"
6958 and the other initializations, so that when the 'shell' option is set
6959 there, the 'shellpipe' option changes automatically, unless it was
6960 explicitly set before.
6961 When 'shellpipe' is set to an empty string, no redirection of the
6962 ":make" output will be done. This is useful if you use a 'makeprg'
6963 that writes to 'makeef' by itself. If you want no piping, but do
6964 want to include the 'makeef', set 'shellpipe' to a single space.
6965 Don't forget to precede the space with a backslash: ":set sp=\ ".
6966 In the future pipes may be used for filtering and this option will
6967 become obsolete (at least for Unix).
6968 This option cannot be set from a |modeline| or in the |sandbox|, for
6969 security reasons.
6970
6971 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006972'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 Quoting character(s), put around the command passed to the shell, for
6975 the "!" and ":!" commands. The redirection is kept outside of the
6976 quoting. See 'shellxquote' to include the redirection. It's
6977 probably not useful to set both options.
6978 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006979 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006980 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 This option cannot be set from a |modeline| or in the |sandbox|, for
6982 security reasons.
6983
6984 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006985'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6986 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 String to be used to put the output of a filter command in a temporary
6989 file. See also |:!|. See |option-backslash| about including spaces
6990 and backslashes.
6991 The name of the temporary file can be represented by "%s" if necessary
6992 (the file name is appended automatically if no %s appears in the value
6993 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006994 The default is ">". For Unix, if the 'shell' option is "csh" or
6995 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006996 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006997 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6998 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006999 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
7000 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02007001 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
7002 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 The initialization of this option is done after reading the ".vimrc"
7004 and the other initializations, so that when the 'shell' option is set
7005 there, the 'shellredir' option changes automatically unless it was
7006 explicitly set before.
7007 In the future pipes may be used for filtering and this option will
7008 become obsolete (at least for Unix).
7009 This option cannot be set from a |modeline| or in the |sandbox|, for
7010 security reasons.
7011
7012 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
7013'shellslash' 'ssl' boolean (default off)
7014 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007015 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02007017 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02007018 powershell.exe. Backward slashes can still be typed, but they are
7019 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 Note that setting or resetting this option has no effect for some
7021 existing file names, thus this option needs to be set before opening
7022 any file for best results. This might change in the future.
7023 'shellslash' only works when a backslash can be used as a path
7024 separator. To test if this is so use: >
7025 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02007026< Also see 'completeslash'.
7027
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007028 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
7029'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
7030 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007031 When on, use temp files for shell commands. When off use a pipe.
7032 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02007033 Currently a pipe is only supported on Unix and MS-Windows 2K and
7034 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007035 :if has("filterpipe")
7036< The advantage of using a pipe is that nobody can read the temp file
7037 and the 'shell' command does not need to support redirection.
7038 The advantage of using a temp file is that the file type and encoding
7039 can be detected.
7040 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
7041 |FilterWritePost| autocommands event are not triggered when
7042 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02007043 The `system()` function does not respect this option and always uses
7044 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007045 NOTE: This option is set to the Vim default value when 'compatible'
7046 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00007047
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 *'shelltype'* *'st'*
7049'shelltype' 'st' number (default 0)
7050 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007051 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 On the Amiga this option influences the way how the commands work
7053 which use a shell.
7054 0 and 1: always use the shell
7055 2 and 3: use the shell only to filter lines
7056 4 and 5: use shell only for ':sh' command
7057 When not using the shell, the command is executed directly.
7058
7059 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
7060 1 and 3: use "shell cmd" to start external commands
7061
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007062 *'shellxescape'* *'sxe'*
7063'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007064 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007065 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007066 When 'shellxquote' is set to "(" then the characters listed in this
7067 option will be escaped with a '^' character. This makes it possible
7068 to execute most external commands with cmd.exe.
7069
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 *'shellxquote'* *'sxq'*
7071'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007072 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02007073 for Win32, when 'shell' is
7074 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007075 for Win32, when 'shell' contains "sh"
7076 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 for Unix, when using system(): "\"")
7078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 Quoting character(s), put around the command passed to the shell, for
7080 the "!" and ":!" commands. Includes the redirection. See
7081 'shellquote' to exclude the redirection. It's probably not useful
7082 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01007083 When the value is '(' then ')' is appended. When the value is '"('
7084 then ')"' is appended.
7085 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01007086 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02007087 useful for on Win32 version, either for cmd.exe, powershell.exe, or
7088 pwsh.exe which automatically strips off the first and last quote on a
7089 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
7090 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02007091 'shell', to reduce the need to set this option by the user. See
7092 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 This option cannot be set from a |modeline| or in the |sandbox|, for
7094 security reasons.
7095
7096 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
7097'shiftround' 'sr' boolean (default off)
7098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 Round indent to multiple of 'shiftwidth'. Applies to > and <
7100 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
7101 a multiple of 'shiftwidth' (this is Vi compatible).
7102 NOTE: This option is reset when 'compatible' is set.
7103
7104 *'shiftwidth'* *'sw'*
7105'shiftwidth' 'sw' number (default 8)
7106 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007107 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007109 When zero the 'ts' value will be used. Use the |shiftwidth()|
7110 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111
7112 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007113'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
7114 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 This option helps to avoid all the |hit-enter| prompts caused by file
7117 messages, for example with CTRL-G, and to avoid some other messages.
7118 It is a list of flags:
7119 flag meaning when present ~
7120 f use "(3 of 5)" instead of "(file 3 of 5)"
7121 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02007122 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 m use "[+]" instead of "[Modified]"
7124 n use "[New]" instead of "[New File]"
7125 r use "[RO]" instead of "[readonly]"
7126 w use "[w]" instead of "written" for file write message
7127 and "[a]" instead of "appended" for ':w >> file' command
7128 x use "[dos]" instead of "[dos format]", "[unix]" instead of
7129 "[unix format]" and "[mac]" instead of "[mac format]".
7130 a all of the above abbreviations
7131
7132 o overwrite message for writing a file with subsequent message
7133 for reading a file (useful for ":wn" or when 'autowrite' on)
7134 O message for reading a file overwrites any previous message.
7135 Also for quickfix message (e.g., ":cn").
7136 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02007137 hit TOP, continuing at BOTTOM" messages; when using the search
7138 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 t truncate file message at the start if it is too long to fit
7140 on the command-line, "<" will appear in the left most column.
7141 Ignored in Ex mode.
7142 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00007143 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 Ignored in Ex mode.
7145 W don't give "written" or "[w]" when writing a file
7146 A don't give the "ATTENTION" message when an existing swap file
7147 is found.
7148 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007149 c don't give |ins-completion-menu| messages. For example,
7150 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7151 "Pattern not found", "Back at original", etc.
=?UTF-8?q?Bj=C3=B6rn=20Linse?=91ccbad2022-10-13 12:51:13 +01007152 C don't give messages while scanning for ins-completion items,
7153 for instance "scanning tags"
Bram Moolenaar426dd022016-03-15 15:09:29 +01007154 q use "recording" instead of "recording @a"
7155 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02007156 was used for the command; note that this also affects messages
7157 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02007158 S do not show search count message when searching, e.g.
7159 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160
7161 This gives you the opportunity to avoid that a change between buffers
7162 requires you to hit <Enter>, but still gives as useful a message as
7163 possible for the space available. To get the whole message that you
7164 would have got with 'shm' empty, use ":file!"
7165 Useful values:
7166 shm= No abbreviation of message.
7167 shm=a Abbreviation, but no loss of information.
7168 shm=at Abbreviation, and truncate message when necessary.
7169
7170 NOTE: This option is set to the Vi default value when 'compatible' is
7171 set and to the Vim default value when 'compatible' is reset.
7172
7173 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7174'shortname' 'sn' boolean (default off)
7175 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 Filenames are assumed to be 8 characters plus one extension of 3
7177 characters. Multiple dots in file names are not allowed. When this
7178 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01007179 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01007181 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182
7183 *'showbreak'* *'sbr'* *E595*
7184'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01007185 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02007186 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 feature}
7188 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007189 values are "> " or "+++ ": >
7190 :set showbreak=>\
7191< Note the backslash to escape the trailing space. It's easier like
7192 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007193 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007194< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 comma (in a future version the comma might be used to separate the
7196 part that is shown at the end and at the start of a line).
7197 The characters are highlighted according to the '@' flag in
7198 'highlight'.
7199 Note that tabs after the showbreak will be displayed differently.
7200 If you want the 'showbreak' to appear in between line numbers, add the
7201 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01007202 A window-local value overrules a global value. If the global value is
7203 set and you want no value in the current window use NONE: >
7204 :setlocal showbreak=NONE
7205<
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007207'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7208 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 global
Bram Moolenaar02467872007-05-06 13:22:01 +00007210 Show (partial) command in the last line of the screen. Set this
7211 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 In Visual mode the size of the selected area is shown:
7213 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007214 If the number of bytes is different it is also displayed: "2-6"
7215 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007217 - When selecting a block, the size in screen characters:
7218 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 NOTE: This option is set to the Vi default value when 'compatible' is
7220 set and to the Vim default value when 'compatible' is reset.
7221
7222 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7223'showfulltag' 'sft' boolean (default off)
7224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 When completing a word in insert mode (see |ins-completion|) from the
7226 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007227 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 matched a C function, you can see a template for what arguments are
7229 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007230 Note that this doesn't work well together with having "longest" in
7231 'completeopt', because the completion from the search pattern may not
7232 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233
7234 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7235'showmatch' 'sm' boolean (default off)
7236 global
7237 When a bracket is inserted, briefly jump to the matching one. The
7238 jump is only done if the match can be seen on the screen. The time to
7239 show the match can be set with 'matchtime'.
7240 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007241 seen or not).
7242 This option is reset when 'paste' is set and restored when 'paste' is
7243 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 When the 'm' flag is not included in 'cpoptions', typing a character
7245 will immediately move the cursor back to where it belongs.
7246 See the "sm" field in 'guicursor' for setting the cursor shape and
7247 blinking when showing the match.
7248 The 'matchpairs' option can be used to specify the characters to show
7249 matches for. 'rightleft' and 'revins' are used to look for opposite
7250 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007251 Also see the matchparen plugin for highlighting the match when moving
7252 around |pi_paren.txt|.
7253 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254
7255 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7256'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7257 global
7258 If in Insert, Replace or Visual mode put a message on the last line.
7259 Use the 'M' flag in 'highlight' to set the type of highlighting for
7260 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007261 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 doesn't mean XIM is really active, especially when 'imactivatekey' is
7263 not set.
7264 NOTE: This option is set to the Vi default value when 'compatible' is
7265 set and to the Vim default value when 'compatible' is reset.
7266
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007267 *'showtabline'* *'stal'*
7268'showtabline' 'stal' number (default 1)
7269 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007270 The value of this option specifies when the line with tab page labels
7271 will be displayed:
7272 0: never
7273 1: only if there are at least two tab pages
7274 2: always
7275 This is both for the GUI and non-GUI implementation of the tab pages
7276 line.
7277 See |tab-page| for more information about tab pages.
7278
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 *'sidescroll'* *'ss'*
7280'sidescroll' 'ss' number (default 0)
7281 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 The minimal number of columns to scroll horizontally. Used only when
7283 the 'wrap' option is off and the cursor is moved off of the screen.
7284 When it is zero the cursor will be put in the middle of the screen.
7285 When using a slow terminal set it to a large number or 0. When using
7286 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7287 commands.
7288
7289 *'sidescrolloff'* *'siso'*
7290'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007291 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007293 right of the cursor if 'nowrap' is set. Setting this option to a
7294 value greater than 0 while having |'sidescroll'| also at a non-zero
7295 value makes some context visible in the line you are scrolling in
7296 horizontally (except at beginning of the line). Setting this option
7297 to a large value (like 999) has the effect of keeping the cursor
7298 horizontally centered in the window, as long as one does not come too
7299 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007300 After using the local value, go back the global value with one of
7301 these two: >
7302 setlocal sidescrolloff<
7303 setlocal sidescrolloff=-1
7304< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305
7306 Example: Try this together with 'sidescroll' and 'listchars' as
7307 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007308 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309
7310 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7311 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007312<
7313 *'signcolumn'* *'scl'*
7314'signcolumn' 'scl' string (default "auto")
7315 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007316 {not available when compiled without the |+signs|
7317 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007318 Whether or not to draw the signcolumn. Valid values are:
7319 "auto" only when there is a sign to display
7320 "no" never
7321 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007322 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007323 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324
7325
7326 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7327'smartcase' 'scs' boolean (default off)
7328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 Override the 'ignorecase' option if the search pattern contains upper
7330 case characters. Only used when the search pattern is typed and
7331 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007332 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7334 recalling the search pattern from history and hitting <Enter>.
7335 NOTE: This option is reset when 'compatible' is set.
7336
7337 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7338'smartindent' 'si' boolean (default off)
7339 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340 Do smart autoindenting when starting a new line. Works for C-like
7341 programs, but can also be used for other languages. 'cindent' does
7342 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007343 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007344 setting 'si' has no effect. 'indentexpr' is a more advanced
7345 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 Normally 'autoindent' should also be on when using 'smartindent'.
7347 An indent is automatically inserted:
7348 - After a line ending in '{'.
7349 - After a line starting with a keyword from 'cinwords'.
7350 - Before a line starting with '}' (only with the "O" command).
7351 When typing '}' as the first character in a new line, that line is
7352 given the same indent as the matching '{'.
7353 When typing '#' as the first character in a new line, the indent for
7354 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007355 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7357 When using the ">>" command, lines starting with '#' are not shifted
7358 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007359 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007360 This option is reset when 'paste' is set and restored when 'paste' is
7361 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362
7363 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7364'smarttab' 'sta' boolean (default off)
7365 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007367 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7368 <BS> will delete a 'shiftwidth' worth of space at the start of the
7369 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007370 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007371 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7372 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007373 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007375 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007376 This option is reset when 'paste' is set and restored when 'paste' is
7377 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 NOTE: This option is reset when 'compatible' is set.
7379
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007380 *'smoothscroll'* *'sms'* *'nosmoothscroll'* *'nosms'*
7381'smoothscroll' 'sms' boolean (default off)
7382 local to window
7383 Scrolling works with screen lines. When 'wrap' is set and the first
7384 line in the window wraps part of it may not be visible, as if it is
Bram Moolenaarf269eab2022-10-03 18:04:35 +01007385 above the window. "<<<" is displayed at the start of the first line,
7386 highlighted with |hl-NonText|.
7387 NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
7388 and scrolling with the mouse.
Bram Moolenaarf6196f42022-10-02 21:29:55 +01007389
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 *'softtabstop'* *'sts'*
7391'softtabstop' 'sts' number (default 0)
7392 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 Number of spaces that a <Tab> counts for while performing editing
7394 operations, like inserting a <Tab> or using <BS>. It "feels" like
7395 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7396 used. This is useful to keep the 'ts' setting at its standard value
7397 of 8, while being able to edit like it is set to 'sts'. However,
7398 commands like "x" still work on the actual characters.
7399 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007400 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007401 'softtabstop' is set to 0 when the 'paste' option is set and restored
7402 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7404 spaces is minimized by using <Tab>s.
7405 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7406 set.
7407 NOTE: This option is set to 0 when 'compatible' is set.
7408
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007409 If Vim is compiled with the |+vartabs| feature then the value of
7410 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7411 anything other than an empty string.
7412
Bram Moolenaar217ad922005-03-20 22:37:15 +00007413 *'spell'* *'nospell'*
7414'spell' boolean (default off)
7415 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007416 {not available when compiled without the |+syntax|
7417 feature}
7418 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007419 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007420
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007421 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007422'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007423 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007424 {not available when compiled without the |+syntax|
7425 feature}
7426 Pattern to locate the end of a sentence. The following word will be
7427 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007428 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007429 When this check is not wanted make this option empty.
7430 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007431 Be careful with special characters, see |option-backslash| about
7432 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007433 To set this option automatically depending on the language, see
7434 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007435
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007436 *'spellfile'* *'spf'*
7437'spellfile' 'spf' string (default empty)
7438 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007439 {not available when compiled without the |+syntax|
7440 feature}
7441 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007442 commands. It must end in ".{encoding}.add". You need to include the
7443 path, otherwise the file is placed in the current directory.
Bram Moolenaar48c3f4e2022-08-08 15:42:38 +01007444 The path may include characters from 'isfname', space, comma and '@'.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007445 *E765*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007446 It may also be a comma-separated list of names. A count before the
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007447 |zg| and |zw| commands can be used to access each. This allows using
7448 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007449 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007450 you: Using the first directory in 'runtimepath' that is writable. If
7451 there is no "spell" directory yet it will be created. For the file
7452 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007453 ignoring the region.
7454 The resulting ".spl" file will be used for spell checking, it does not
7455 have to appear in 'spelllang'.
7456 Normally one file is used for all regions, but you can add the region
7457 name if you want to. However, it will then only be used when
7458 'spellfile' is set to it, for entries in 'spelllang' only files
7459 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007460 This option cannot be set from a |modeline| or in the |sandbox|, for
7461 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007462
Bram Moolenaar217ad922005-03-20 22:37:15 +00007463 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007464'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007465 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007466 {not available when compiled without the |+syntax|
7467 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007468 A comma-separated list of word list names. When the 'spell' option is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007469 on spellchecking will be done for these languages. Example: >
7470 set spelllang=en_us,nl,medical
7471< This means US English, Dutch and medical words are recognized. Words
7472 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007473 The word list name must consist of alphanumeric characters, a dash or
7474 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007475 recommended to separate the two letter language name from a
7476 specification. Thus "en-rare" is used for rare English words.
7477 A region name must come last and have the form "_xx", where "xx" is
7478 the two-letter, lower case region name. You can use more than one
7479 region by listing them: "en_us,en_ca" supports both US and Canadian
7480 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007481 Britain. (Note: currently en_au and en_nz dictionaries are older than
7482 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007483 If the name "cjk" is included East Asian characters are excluded from
7484 spell checking. This is useful when editing text that also has Asian
7485 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007486 Note that the "medical" dictionary does not exist, it is just an
7487 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007488 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007489 As a special case the name of a .spl file can be given as-is. The
7490 first "_xx" in the name is removed and used as the region name
7491 (_xx is an underscore, two letters and followed by a non-letter).
7492 This is mainly for testing purposes. You must make sure the correct
7493 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007494 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007495 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7496 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007497 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007498
Bram Moolenaar98692072006-02-04 00:57:42 +00007499 If the |spellfile.vim| plugin is active and you use a language name
7500 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7501 will ask you if you want to download the file.
7502
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007503 After this option has been set successfully, Vim will source the files
7504 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007505 up to the first character that is not an ASCII letter or number and
7506 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007507
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007508 *'spelloptions'* *'spo'*
7509'spelloptions' 'spo' string (default "")
7510 local to buffer
7511 {not available when compiled without the |+syntax|
7512 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007513 A comma-separated list of options for spell checking:
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007514 camel When a word is CamelCased, assume "Cased" is a
7515 separate word: every upper-case character in a word
7516 that comes after a lower case character indicates the
7517 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007518
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007519 *'spellsuggest'* *'sps'*
7520'spellsuggest' 'sps' string (default "best")
7521 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007522 {not available when compiled without the |+syntax|
7523 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007524 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007525 the |spellsuggest()| function. This is a comma-separated list of
7526 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007527
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007528 best Internal method that works best for English. Finds
7529 changes like "fast" and uses a bit of sound-a-like
7530 scoring to improve the ordering.
7531
7532 double Internal method that uses two methods and mixes the
7533 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007534 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007535 word. That only works when the language specifies
7536 sound folding. Can be slow and doesn't always give
7537 better results.
7538
7539 fast Internal method that only checks for simple changes:
7540 character inserts/deletes/swaps. Works well for
7541 simple typing mistakes.
7542
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007543 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007544 Not used for |spellsuggest()|. The number of
7545 suggestions is never more than the value of 'lines'
7546 minus two.
7547
Bram Moolenaar585ee072022-01-29 11:22:17 +00007548 timeout:{millisec} Limit the time searching for suggestions to
7549 {millisec} milli seconds. Applies to the following
7550 methods. When omitted the limit is 5000. When
7551 negative there is no limit. {only works when built
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01007552 with the |+reltime| feature}
Bram Moolenaar585ee072022-01-29 11:22:17 +00007553
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007554 file:{filename} Read file {filename}, which must have two columns,
7555 separated by a slash. The first column contains the
7556 bad word, the second column the suggested good word.
7557 Example:
7558 theribal/terrible ~
7559 Use this for common mistakes that do not appear at the
7560 top of the suggestion list with the internal methods.
7561 Lines without a slash are ignored, use this for
7562 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007563 The word in the second column must be correct,
7564 otherwise it will not be used. Add the word to an
7565 ".add" file if it is currently flagged as a spelling
7566 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007567 The file is used for all languages.
7568
7569 expr:{expr} Evaluate expression {expr}. Use a function to avoid
Bram Moolenaara4e0b972022-10-01 19:43:52 +01007570 trouble with spaces. Best is to call a function
7571 without arguments, see |expr-option-function|.
7572 |v:val| holds the badly spelled word. The expression
7573 must evaluate to a List of Lists, each with a
7574 suggestion and a score.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007575 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007576 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007577 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007578 internal methods use. A lower score is better.
7579 This may invoke |spellsuggest()| if you temporarily
7580 set 'spellsuggest' to exclude the "expr:" part.
7581 Errors are silently ignored, unless you set the
7582 'verbose' option to a non-zero value.
7583
7584 Only one of "best", "double" or "fast" may be used. The others may
7585 appear several times in any order. Example: >
7586 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7587<
7588 This option cannot be set from a |modeline| or in the |sandbox|, for
7589 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007590
7591
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7593'splitbelow' 'sb' boolean (default off)
7594 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 When on, splitting a window will put the new window below the current
7596 one. |:split|
7597
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007598 *'splitkeep'* *'spk'*
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007599'splitkeep' 'spk' string (default "cursor")
7600 global
7601 The value of this option determines the scroll behavior when opening,
7602 closing or resizing horizontal splits.
7603
7604 Possible values are:
7605 cursor Keep the same relative cursor position.
7606 screen Keep the text on the same screen line.
7607 topline Keep the topline the same.
7608
7609 For the "screen" and "topline" values, the cursor position will be
7610 changed when necessary. In this case, the jumplist will be populated
7611 with the previous cursor position. For "screen", the text cannot always
Bram Moolenaar3c053a12022-10-16 13:11:12 +01007612 be kept on the same screen line when 'wrap' is enabled.
Luuk van Baal13ece2a2022-10-03 15:28:08 +01007613
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7615'splitright' 'spr' boolean (default off)
7616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 When on, splitting a window will put the new window right of the
7618 current one. |:vsplit|
7619
7620 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7621'startofline' 'sol' boolean (default on)
7622 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007624 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007625 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007626 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627 with a linewise operator, with "%" with a count and to buffer changing
7628 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7629 only has a line number, e.g., ":25" or ":+".
7630 In case of buffer changing commands the cursor is placed at the column
7631 where it was the last time the buffer was edited.
7632 NOTE: This option is set when 'compatible' is set.
7633
Bram Moolenaar00654022011-02-25 14:42:19 +01007634 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007636 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637 {not available when compiled without the |+statusline|
7638 feature}
Bram Moolenaar944697a2022-02-20 19:48:20 +00007639 When non-empty, this option determines the content of the status line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 Also see |status-line|.
7641
7642 The option consists of printf style '%' items interspersed with
7643 normal text. Each status line item is of the form:
7644 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007645 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007646 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647
Bram Moolenaar238a5642006-02-21 22:12:05 +00007648 When the option starts with "%!" then it is used as an expression,
7649 evaluated and the result is used as the option value. Example: >
7650 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007651< The *g:statusline_winid* variable will be set to the |window-ID| of the
7652 window that the status line belongs to.
7653 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007654 Note that the "%!" expression is evaluated in the context of the
7655 current window and buffer, while %{} items are evaluated in the
7656 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007657
7658 When there is error while evaluating the option then it will be made
7659 empty to avoid further errors. Otherwise screen updating would loop.
7660
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 Note that the only effect of 'ruler' when this option is set (and
7662 'laststatus' is 2) is controlling the output of |CTRL-G|.
7663
7664 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007665 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007667 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 minwid Minimum width of the item, padding as set by '-' & '0'.
7669 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007670 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671 on the left for text items. Numeric items will be
7672 shifted down to maxwid-2 digits followed by '>'number
7673 where number is the amount of missing digits, much like
7674 an exponential notation.
7675 item A one letter code as described below.
7676
7677 Following is a description of the possible statusline items. The
7678 second character in "item" is the type:
7679 N for number
7680 S for string
7681 F for flags as described below
7682 - not applicable
7683
7684 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007685 f S Path to the file in the buffer, as typed or relative to current
7686 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 F S Full path to the file in the buffer.
7688 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007689 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007691 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007693 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007695 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007697 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007699 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7701 being used: "<keymap>"
7702 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007703 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 B N As above, in hexadecimal.
7705 o N Byte number in file of byte under cursor, first byte is 1.
7706 Mnemonic: Offset from start of file (with one added)
7707 {not available when compiled without |+byte_offset| feature}
7708 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007709 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 l N Line number.
7711 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007712 c N Column number (byte index).
7713 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007714 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 p N Percentage through file in lines as in |CTRL-G|.
7716 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007717 percentage described for 'ruler'. Always 3 in length, unless
7718 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007719 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007721 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007722 Note that there is no '%' before the closing '}'. The
7723 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007724 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007725 {% - This is almost same as { except the result of the expression is
7726 re-evaluated as a statusline format string. Thus if the
7727 return value of expr contains % items they will get expanded.
7728 The expression can contain the } character, the end of
7729 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007730 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007731 func! Stl_filename() abort
7732 return "%t"
7733 endfunc
7734< `stl=%{Stl_filename()}` results in `"%t"`
7735 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007736 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 ( - Start of item group. Can be used for setting the width and
7738 alignment of a section. Must be followed by %) somewhere.
7739 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007740 T N For 'tabline': start of tab page N label. Use %T after the last
7741 label. This information is used for mouse clicks.
7742 X N For 'tabline': start of close tab N label. Use %X after the
7743 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7744 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 < - Where to truncate line if too long. Default is at the start.
7746 No width fields allowed.
7747 = - Separation point between left and right aligned items.
7748 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007749 # - Set highlight group. The name must follow and then a # again.
7750 Thus use %#HLname# for highlight group HLname. The same
7751 highlighting is used, also for the statusline of non-current
7752 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007754 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 The difference between User{N} and StatusLine will be applied
7756 to StatusLineNC for the statusline of non-current windows.
7757 The number N must be between 1 and 9. See |hl-User1..9|
7758
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007759 When displaying a flag, Vim removes the leading comma, if any, when
7760 that flag comes right after plaintext. This will make a nice display
7761 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762
Bram Moolenaar582fd852005-03-28 20:58:01 +00007763 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764 not set) and a minwid is not set for the group, the whole group will
7765 become empty. This will make a group like the following disappear
7766 completely from the statusline when none of the flags are set. >
7767 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007768< Beware that an expression is evaluated each and every time the status
7769 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007770 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007771 While evaluating %{} the current buffer and current window will be set
7772 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007773 currently being drawn. The expression will evaluate in this context.
7774 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7775 real current buffer and "g:actual_curwin" to the |window-ID| of the
7776 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007777
Bram Moolenaar30b65812012-07-12 22:01:11 +02007778 The 'statusline' option will be evaluated in the |sandbox| if set from
7779 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007780 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007781
7782 It is not allowed to change text or jump to another window while
7783 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784
7785 If the statusline is not updated when you want it (e.g., after setting
7786 a variable that's used in an expression), you can force an update by
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007787 using `:redrawstatus`.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007788
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01007789 A result of all digits is regarded a number for display purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 Otherwise the result is taken as flag text and applied to the rules
7791 described above.
7792
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007793 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007795 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796
7797 Examples:
7798 Emulate standard status line with 'ruler' set >
7799 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7800< Similar, but add ASCII value of char under the cursor (like "ga") >
7801 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7802< Display byte count and byte value, modified flag in red. >
7803 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7804 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7805< Display a ,GZ flag if a compressed file is loaded >
7806 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7807< In the |:autocmd|'s: >
7808 :let b:gzflag = 1
7809< And: >
7810 :unlet b:gzflag
7811< And define this function: >
7812 :function VarExists(var, val)
7813 : if exists(a:var) | return a:val | else | return '' | endif
7814 :endfunction
7815<
7816 *'suffixes'* *'su'*
7817'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 Files with these suffixes get a lower priority when multiple files
7820 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007821 suffixes. Spaces after the comma are ignored. A dot is also seen as
7822 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 separator, precede it with a backslash (see |option-backslash| about
7824 including spaces and backslashes).
7825 See 'wildignore' for completely ignoring files.
7826 The use of |:set+=| and |:set-=| is preferred when adding or removing
7827 suffixes from the list. This avoids problems when a future version
7828 uses another default.
7829
7830 *'suffixesadd'* *'sua'*
7831'suffixesadd' 'sua' string (default "")
7832 local to buffer
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007833 Comma-separated list of suffixes, which are used when searching for a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834 file for the "gf", "[I", etc. commands. Example: >
7835 :set suffixesadd=.java
7836<
7837 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7838'swapfile' 'swf' boolean (default on)
7839 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007840 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 swapfile is not wanted for a specific buffer. For example, with
7842 confidential information that even root must not be able to access.
7843 Careful: All text will be in memory:
7844 - Don't use this for big files.
7845 - Recovery will be impossible!
7846 A swapfile will only be present when |'updatecount'| is non-zero and
7847 'swapfile' is set.
7848 When 'swapfile' is reset, the swap file for the current buffer is
7849 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7850 non-zero, a swap file is immediately created.
7851 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007852 If you want to open a new buffer without creating a swap file for it,
7853 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007854 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855
7856 This option is used together with 'bufhidden' and 'buftype' to
7857 specify special kinds of buffers. See |special-buffers|.
7858
7859 *'swapsync'* *'sws'*
7860'swapsync' 'sws' string (default "fsync")
7861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007863 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 When this option is empty parts of the swap file may be in memory and
7865 not written to disk. When the system crashes you may lose more work.
7866 On Unix the system does a sync now and then without Vim asking for it,
7867 so the disadvantage of setting this option off is small. On some
7868 systems the swap file will not be written at all. For a unix system
7869 setting it to "sync" will use the sync() call instead of the default
7870 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007871 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872
7873 *'switchbuf'* *'swb'*
7874'switchbuf' 'swb' string (default "")
7875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007877 Mostly for |quickfix| commands some values are also used for other
7878 commands, as mentioned below.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007879 Possible values (comma-separated list):
Bram Moolenaar071d4272004-06-13 20:20:40 +00007880 useopen If included, jump to the first open window that
7881 contains the specified buffer (if there is one).
7882 Otherwise: Do not examine other windows.
7883 This setting is checked with |quickfix| commands, when
7884 jumping to errors (":cc", ":cn", "cp", etc.). It is
7885 also used in all buffer related split commands, for
7886 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007887 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007888 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007890 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007891 Otherwise: do not split, use current window (when used
7892 in the quickfix window: the previously used window or
7893 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007894 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007895 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007896 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007897 uselast If included, jump to the previously used window when
7898 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007900 *'synmaxcol'* *'smc'*
7901'synmaxcol' 'smc' number (default 3000)
7902 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007903 {not available when compiled without the |+syntax|
7904 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007905 Maximum column in which to search for syntax items. In long lines the
7906 text after this column is not highlighted and following lines may not
7907 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007908 This helps to avoid very slow redrawing for an XML file that is one
7909 long line.
7910 Set to zero to remove the limit.
7911
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 *'syntax'* *'syn'*
7913'syntax' 'syn' string (default empty)
7914 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 {not available when compiled without the |+syntax|
7916 feature}
7917 When this option is set, the syntax with this name is loaded, unless
7918 syntax highlighting has been switched off with ":syntax off".
7919 Otherwise this option does not always reflect the current syntax (the
7920 b:current_syntax variable does).
7921 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007922 not automatically recognized. Example, in an IDL file:
7923 /* vim: set syntax=idl : */ ~
7924 When a dot appears in the value then this separates two filetype
7925 names. Example:
7926 /* vim: set syntax=c.doxygen : */ ~
7927 This will use the "c" syntax first, then the "doxygen" syntax.
7928 Note that the second one must be prepared to be loaded as an addition,
7929 otherwise it will be skipped. More than one dot may appear.
7930 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 :set syntax=OFF
7932< To switch syntax highlighting on according to the current value of the
7933 'filetype' option: >
7934 :set syntax=ON
7935< What actually happens when setting the 'syntax' option is that the
7936 Syntax autocommand event is triggered with the value as argument.
7937 This option is not copied to another buffer, independent of the 's' or
7938 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007939 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007940
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007941 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007942'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007943 global
Bram Moolenaar944697a2022-02-20 19:48:20 +00007944 When non-empty, this option determines the content of the tab pages
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007945 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007946 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007947
7948 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007949 option and only when there is no GUI tab line. When 'e' is in
7950 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007951 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007952
7953 The value is evaluated like with 'statusline'. You can use
7954 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007955 the text to be displayed. Use "%1T" for the first label, "%2T" for
7956 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007957
Bram Moolenaare12bab32019-01-08 22:02:56 +01007958 When changing something that is used in 'tabline' that does not
7959 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007960 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007961
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007962 Keep in mind that only one of the tab pages is the current one, others
7963 are invisible and you can't jump to their windows.
7964
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007965
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007966 *'tabpagemax'* *'tpm'*
7967'tabpagemax' 'tpm' number (default 10)
7968 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007969 Maximum number of tab pages to be opened by the |-p| command line
7970 argument or the ":tab all" command. |tabpage|
7971
7972
7973 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974'tabstop' 'ts' number (default 8)
7975 local to buffer
7976 Number of spaces that a <Tab> in the file counts for. Also see
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007977 the |:retab| command, and the 'softtabstop' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978
7979 Note: Setting 'tabstop' to any other value than 8 can make your file
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007980 appear wrong in many places, e.g., when printing it.
7981 The value must be more than 0 and less than 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982
7983 There are four main ways to use tabs in Vim:
7984 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7985 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007986 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 behave like a tab appears every 4 (or 3) characters.
7988 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7989 'expandtab'. This way you will always insert spaces. The
7990 formatting will never be messed up when 'tabstop' is changed.
7991 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007992 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 works when using Vim to edit the file.
7994 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7995 'noexpandtab'. This should then work (for initial indents only)
7996 for any tabstop setting that people use. It might be nice to have
7997 tabs after the first non-blank inserted as spaces if you do this
7998 though. Otherwise aligned comments will be wrong when 'tabstop' is
7999 changed.
8000
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008001 If Vim is compiled with the |+vartabs| feature then the value of
8002 'tabstop' will be ignored if |'vartabstop'| is set to anything other
8003 than an empty string.
8004
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
8006'tagbsearch' 'tbs' boolean (default on)
8007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008009 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 searching makes searching for a tag a LOT faster, but a linear search
8011 will find more tags if the tags file wasn't properly sorted.
8012 Vim normally assumes that your tags files are sorted, or indicate that
8013 they are not sorted. Only when this is not the case does the
8014 'tagbsearch' option need to be switched off.
8015
8016 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008017 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018 certain files, or retry all files with a linear search. When
8019 'tagbsearch' is off, only a linear search is done.
8020
8021 Linear searching is done anyway, for one file, when Vim finds a line
8022 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00008023 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024< [The whitespace before and after the '0' must be a single <Tab>]
8025
8026 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008027 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 instead of a normal tag name, a retry is done with a linear search.
8029 Tags in unsorted tags files, and matches with different case will only
8030 be found in the retry.
8031
Bram Moolenaard4755bb2004-09-02 19:12:26 +00008032 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008033 linear search can be avoided when case is ignored. Use a value of '2'
8034 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
8035 sorted with the -f switch to "sort" in most unices, as in the command:
Bram Moolenaar47c532e2022-03-19 15:18:53 +00008036 "sort -f -o tags tags". For Universal ctags and Exuberant ctags
8037 version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
8038 used for this as well. Note that case must be folded to uppercase for
8039 this to work.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008040
8041 By default, tag searches are case-sensitive. Case is ignored when
8042 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
8043 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008044 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
8045 'tagcase' is "smart", and the pattern contains only lowercase
8046 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047
8048 When 'tagbsearch' is off, tags searching is slower when a full match
8049 exists, but faster when no full match exists. Tags in unsorted tags
8050 files may only be found with 'tagbsearch' off.
8051 When the tags file is not sorted, or sorted in a wrong way (not on
8052 ASCII byte value), 'tagbsearch' should be off, or the line given above
8053 must be included in the tags file.
8054 This option doesn't affect commands that find all matching tags (e.g.,
8055 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008057 *'tagcase'* *'tc'*
8058'tagcase' 'tc' string (default "followic")
8059 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008060 This option specifies how case is handled when searching the tags
8061 file:
8062 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008063 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008064 ignore Ignore case
8065 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02008066 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01008067 NOTE: This option is set to the Vi default value when 'compatible' is
8068 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01008069
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008070 *'tagfunc'* *'tfu'*
8071'tagfunc' 'tfu' string (default: empty)
8072 local to buffer
8073 {not available when compiled without the |+eval|
8074 feature}
8075 This option specifies a function to be used to perform tag searches.
8076 The function gets the tag pattern and should return a List of matching
8077 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00008078 function and an example. The value can be the name of a function, a
8079 |lambda| or a |Funcref|. See |option-value-function| for more
8080 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02008081
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 *'taglength'* *'tl'*
8083'taglength' 'tl' number (default 0)
8084 global
8085 If non-zero, tags are significant up to this number of characters.
8086
8087 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
8088'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
8089 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00008090 If on and using a tags file in another directory, file names in that
8091 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 NOTE: This option is set to the Vi default value when 'compatible' is
8093 set and to the Vim default value when 'compatible' is reset.
8094
8095 *'tags'* *'tag'* *E433*
8096'tags' 'tag' string (default "./tags,tags", when compiled with
8097 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
8098 global or local to buffer |global-local|
8099 Filenames for the tag command, separated by spaces or commas. To
8100 include a space or comma in a file name, precede it with a backslash
8101 (see |option-backslash| about including spaces and backslashes).
8102 When a file name starts with "./", the '.' is replaced with the path
8103 of the current file. But only when the 'd' flag is not included in
8104 'cpoptions'. Environment variables are expanded |:set_env|. Also see
8105 |tags-option|.
8106 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02008107 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
8108 find all files named "tags" below "/lib". The filename itself cannot
8109 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
Bram Moolenaar2bd9dbc2022-08-25 18:12:06 +01008110 files called "tags?".
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00008111 The |tagfiles()| function can be used to get a list of the file names
8112 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
8114 files are also supported. They are automatically recognized. The
8115 default value becomes "./tags,./TAGS,tags,TAGS", unless case
8116 differences are ignored (MS-Windows). |emacs-tags|
8117 The use of |:set+=| and |:set-=| is preferred when adding or removing
8118 file names from the list. This avoids problems when a future version
8119 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120
8121 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
8122'tagstack' 'tgst' boolean (default on)
8123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 When on, the |tagstack| is used normally. When off, a ":tag" or
8125 ":tselect" command with an argument will not push the tag onto the
8126 tagstack. A following ":tag" without an argument, a ":pop" command or
8127 any other command that uses the tagstack will use the unmodified
8128 tagstack, but does change the pointer to the active entry.
8129 Resetting this option is useful when using a ":tag" command in a
8130 mapping which should not change the tagstack.
8131
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008132 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01008133'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008134 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008135 {only available when compiled with the |+tcl/dyn|
8136 feature}
8137 Specifies the name of the Tcl shared library. The default is
8138 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02008139 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01008140 This option cannot be set from a |modeline| or in the |sandbox|, for
8141 security reasons.
8142
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 *'term'* *E529* *E530* *E531*
8144'term' string (default is $TERM, if that fails:
8145 in the GUI: "builtin_gui"
8146 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01008147 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149 on Unix: "ansi"
8150 on VMS: "ansi"
8151 on Win 32: "win32")
8152 global
8153 Name of the terminal. Used for choosing the terminal control
8154 characters. Environment variables are expanded |:set_env|.
8155 For example: >
8156 :set term=$TERM
8157< See |termcap|.
8158
8159 *'termbidi'* *'tbidi'*
8160 *'notermbidi'* *'notbidi'*
8161'termbidi' 'tbidi' boolean (default off, on for "mlterm")
8162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 {only available when compiled with the |+arabic|
8164 feature}
8165 The terminal is in charge of Bi-directionality of text (as specified
8166 by Unicode). The terminal is also expected to do the required shaping
8167 that some languages (such as Arabic) require.
8168 Setting this option implies that 'rightleft' will not be set when
8169 'arabic' is set and the value of 'arabicshape' will be ignored.
8170 Note that setting 'termbidi' has the immediate effect that
8171 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
8172 This option is reset when the GUI is started.
8173 For further details see |arabic.txt|.
8174
8175 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008176'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 Encoding used for the terminal. This specifies what character
8179 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008180 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008181 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01008182 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008183 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008184 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8185 Any attempts to set a different value will be rejected, and an error
8186 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008187 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 because the Win32 system always passes Unicode characters.
8189 When empty, the same encoding is used as for the 'encoding' option.
8190 This is the normal value.
8191 Not all combinations for 'termencoding' and 'encoding' are valid. See
8192 |encoding-table|.
8193 The value for this option must be supported by internal conversions or
8194 iconv(). When this is not possible no conversion will be done and you
8195 will probably experience problems with non-ASCII characters.
8196 Example: You are working with the locale set to euc-jp (Japanese) and
8197 want to edit a UTF-8 file: >
8198 :let &termencoding = &encoding
8199 :set encoding=utf-8
8200< You need to do this when your system has no locale support for UTF-8.
8201
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008202 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008203'termguicolors' 'tgc' boolean (default off)
8204 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008205 {not available when compiled without the
8206 |+termguicolors| feature}
8207 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008208 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008209
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008210 Requires a ISO-8613-3 compatible terminal. If setting this option
8211 does not work (produces a colorless UI) reading |xterm-true-color|
8212 might help.
8213
8214 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8215 is required. Use this check to find out: >
8216 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008217< This requires Vim to be built with the |+vtp| feature.
8218
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008219 Note that the "cterm" attributes are still used, not the "gui" ones.
Yasuhiro Matsumotoaa04e1b2022-05-07 14:09:19 +01008220
8221 When using Vim with Windows Terminal, the background of Windows
8222 Terminal is normally filled with the Vim background color. Setting
8223 'termguicolors' and the guibg of the Normal highlight group to NONE
8224 will make the background transparent: >
8225 :hi Normal guibg=NONE
8226<
Bram Moolenaar036986f2017-03-16 17:41:02 +01008227 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008228
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008229 *'termwinkey'* *'twk'*
8230'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008231 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008232 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008233 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008234 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008235 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008236< The string must be one key stroke but can be multiple bytes.
8237 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008238 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008239 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008240
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008241 *'termwinscroll'* *'twsl'*
8242'termwinscroll' 'twsl' number (default 10000)
8243 local to buffer
8244 {not available when compiled without the
8245 |+terminal| feature}
8246 Number of scrollback lines to keep. When going over this limit the
8247 first 10% of the scrollback lines are deleted. This is just to reduce
8248 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00008249 Also used as a limit for text sent to the terminal in one write,
8250 multiplied by the number of columns times 3 (average number of bytes
8251 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02008252
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008253 *'termwinsize'* *'tws'*
8254'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008255 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008256 Size used when opening the |terminal| window. Format:
8257 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008258 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008259 - When set with a "x" (e.g., "24x80") the terminal size is not
8260 adjusted to the window size. If the window is smaller only the
8261 top-left part is displayed.
8262 - When set with a "*" (e.g., "10*50") the terminal size follows the
8263 window size, but will not be smaller than the specified rows and/or
8264 columns.
8265 - When rows is zero then use the height of the window.
8266 - When columns is zero then use the width of the window.
8267 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02008268 - Can be overruled in the |term_start()| options with "term_rows" and
8269 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02008270
8271 Examples:
8272 "30x0" uses 30 rows and the current window width.
8273 "20*0" uses at least 20 rows and the current window width.
8274 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008275 Note that the command running in the terminal window may still change
8276 the size of the terminal. In that case the Vim window will be
8277 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008278
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008279 *'termwintype'* *'twt'*
8280'termwintype' 'twt' string (default "")
8281 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008282 {only available when compiled with the |terminal|
8283 feature on MS-Windows}
8284 Specify the virtual console (pty) used when opening the terminal
8285 window.
8286
8287 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008288 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008289 "winpty" use winpty, fail if not supported
8290 "conpty" use |ConPTY|, fail if not supported
8291
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008292 |ConPTY| support depends on the platform. Windows 10 October 2018
8293 Update is the first version that supports ConPTY, however it is still
8294 considered unstable. ConPTY might become stable in the next release
8295 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008296 supported then you cannot open a terminal window.
8297
Bram Moolenaar071d4272004-06-13 20:20:40 +00008298 *'terse'* *'noterse'*
8299'terse' boolean (default off)
8300 global
8301 When set: Add 's' flag to 'shortmess' option (this makes the message
8302 for a search that hits the start or end of the file not being
8303 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8304 shortens a lot of messages}
8305
8306 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8307'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 This option is obsolete. Use 'fileformats'.
8310 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8311 set to the default value for the current system. When 'textauto' is
8312 reset, 'fileformats' is made empty.
8313 NOTE: This option is set to the Vi default value when 'compatible' is
8314 set and to the Vim default value when 'compatible' is reset.
8315
8316 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008317'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 others: default off)
8319 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008320 This option is obsolete. Use 'fileformat'.
8321 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8322 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8323 "unix".
8324
8325 *'textwidth'* *'tw'*
8326'textwidth' 'tw' number (default 0)
8327 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008328 Maximum width of text that is being inserted. A longer line will be
8329 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008330 this.
8331 'textwidth' is set to 0 when the 'paste' option is set and restored
8332 when 'paste' is reset.
8333 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008335 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336 NOTE: This option is set to 0 when 'compatible' is set.
8337
8338 *'thesaurus'* *'tsr'*
8339'thesaurus' 'tsr' string (default "")
8340 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008342 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8343 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008344
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008345 This option is not used if 'thesaurusfunc' is set, either for the
8346 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008347
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008348 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008350 name. See |option-backslash| about using backslashes. The use of
8351 |:set+=| and |:set-=| is preferred when adding or removing directories
8352 from the list. This avoids problems when a future version uses
8353 another default. Backticks cannot be used in this option for security
8354 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008356 *'thesaurusfunc'* *'tsrfu'*
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008357'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008358 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008359 {not available when compiled without the |+eval|
8360 feature}
8361 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008362 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008363 The value can be the name of a function, a |lambda| or a |Funcref|.
8364 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008365
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008366 This option cannot be set from a |modeline| or in the |sandbox|, for
8367 security reasons.
8368
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8370'tildeop' 'top' boolean (default off)
8371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 When on: The tilde command "~" behaves like an operator.
8373 NOTE: This option is reset when 'compatible' is set.
8374
8375 *'timeout'* *'to'* *'notimeout'* *'noto'*
8376'timeout' 'to' boolean (default on)
8377 global
8378 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008379'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381 These two options together determine the behavior when part of a
8382 mapped key sequence or keyboard code has been received:
8383
8384 'timeout' 'ttimeout' action ~
8385 off off do not time out
8386 on on or off time out on :mappings and key codes
8387 off on time out on key codes
8388
8389 If both options are off, Vim will wait until either the complete
8390 mapping or key sequence has been received, or it is clear that there
8391 is no mapping or key sequence for the received characters. For
8392 example: if you have mapped "vl" and Vim has received 'v', the next
8393 character is needed to see if the 'v' is followed by an 'l'.
8394 When one of the options is on, Vim will wait for about 1 second for
8395 the next character to arrive. After that the already received
8396 characters are interpreted as single characters. The waiting time can
8397 be changed with the 'timeoutlen' option.
8398 On slow terminals or very busy systems timing out may cause
8399 malfunctioning cursor keys. If both options are off, Vim waits
8400 forever after an entered <Esc> if there are key codes that start
8401 with <Esc>. You will have to type <Esc> twice. If you do not have
8402 problems with key codes, but would like to have :mapped key
8403 sequences not timing out in 1 second, set the 'ttimeout' option and
8404 reset the 'timeout' option.
8405
8406 NOTE: 'ttimeout' is reset when 'compatible' is set.
8407
8408 *'timeoutlen'* *'tm'*
8409'timeoutlen' 'tm' number (default 1000)
8410 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008411
Bram Moolenaar071d4272004-06-13 20:20:40 +00008412 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008413'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 The time in milliseconds that is waited for a key code or mapped key
8416 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8417 when part of a command has been typed.
8418 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8419 different timeout value for key codes is desired set 'ttimeoutlen' to
8420 a non-negative number.
8421
8422 ttimeoutlen mapping delay key code delay ~
8423 < 0 'timeoutlen' 'timeoutlen'
8424 >= 0 'timeoutlen' 'ttimeoutlen'
8425
8426 The timeout only happens when the 'timeout' and 'ttimeout' options
8427 tell so. A useful setting would be >
8428 :set timeout timeoutlen=3000 ttimeoutlen=100
8429< (time out on mapping after three seconds, time out on key codes after
8430 a tenth of a second).
8431
8432 *'title'* *'notitle'*
8433'title' boolean (default off, on when title can be restored)
8434 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 When on, the title of the window will be set to the value of
8436 'titlestring' (if it is not empty), or to:
8437 filename [+=-] (path) - VIM
8438 Where:
8439 filename the name of the file being edited
8440 - indicates the file cannot be modified, 'ma' off
8441 + indicates the file was modified
8442 = indicates the file is read-only
8443 =+ indicates the file is read-only and modified
8444 (path) is the path of the file being edited
8445 - VIM the server name |v:servername| or "VIM"
8446 Only works if the terminal supports setting window titles
8447 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008448 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8450 *X11*
8451 When Vim was compiled with HAVE_X11 defined, the original title will
8452 be restored if possible. The output of ":version" will include "+X11"
8453 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8454 works for the icon name |'icon'|.
8455 But: When Vim was started with the |-X| argument, restoring the title
8456 will not work (except in the GUI).
8457 If the title cannot be restored, it is set to the value of 'titleold'.
8458 You might want to restore the title outside of Vim then.
8459 When using an xterm from a remote machine you can use this command:
8460 rsh machine_name xterm -display $DISPLAY &
8461 then the WINDOWID environment variable should be inherited and the
8462 title of the window should change back to what it should be after
8463 exiting Vim.
8464
8465 *'titlelen'*
8466'titlelen' number (default 85)
8467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008469 title. When the title is longer, only the end of the path name is
8470 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 Using a percentage makes this adapt to the width of the window. But
8472 it won't work perfectly, because the actual number of characters
8473 available also depends on the font used and other things in the title
8474 bar. When 'titlelen' is zero the full path is used. Otherwise,
8475 values from 1 to 30000 percent can be used.
8476 'titlelen' is also used for the 'titlestring' option.
8477
8478 *'titleold'*
8479'titleold' string (default "Thanks for flying Vim")
8480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 This option will be used for the window title when exiting Vim if the
8482 original title cannot be restored. Only happens if 'title' is on or
8483 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008484 This option cannot be set from a |modeline| or in the |sandbox|, for
8485 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486 *'titlestring'*
8487'titlestring' string (default "")
8488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 When this option is not empty, it will be used for the title of the
8490 window. This happens only when the 'title' option is on.
8491 Only works if the terminal supports setting window titles (currently
8492 Amiga console, Win32 console, all GUI versions and terminals with a
8493 non-empty 't_ts' option).
8494 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008495 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008496
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 When this option contains printf-style '%' items, they will be
8498 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008499 This option cannot be set in a modeline when 'modelineexpr' is off.
8500
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008502 :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8504< The value of 'titlelen' is used to align items in the middle or right
8505 of the available space.
8506 Some people prefer to have the file name first: >
8507 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8508< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008509 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 separating space only when needed.
8511 NOTE: Use of special characters in 'titlestring' may cause the display
8512 to be garbled (e.g., when it contains a CR or NL character).
8513 {not available when compiled without the |+statusline| feature}
8514
8515 *'toolbar'* *'tb'*
8516'toolbar' 'tb' string (default "icons,tooltips")
8517 global
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008518 {only for |+GUI_GTK|, |+GUI_Motif| and |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008519 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 possible values are:
8521 icons Toolbar buttons are shown with icons.
8522 text Toolbar buttons shown with text.
8523 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008524 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525 tooltips Tooltips are active for toolbar buttons.
8526 Tooltips refer to the popup help text which appears after the mouse
8527 cursor is placed over a toolbar button for a brief moment.
8528
8529 If you want the toolbar to be shown with icons as well as text, do the
8530 following: >
8531 :set tb=icons,text
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008532< Motif cannot display icons and text at the same time. They
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 will show icons if both are requested.
8534
8535 If none of the strings specified in 'toolbar' are valid or if
8536 'toolbar' is empty, this option is ignored. If you want to disable
8537 the toolbar, you need to set the 'guioptions' option. For example: >
8538 :set guioptions-=T
8539< Also see |gui-toolbar|.
8540
8541 *'toolbariconsize'* *'tbis'*
8542'toolbariconsize' 'tbis' string (default "small")
8543 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008544 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008546 tiny Use tiny icons.
8547 small Use small icons (default).
8548 medium Use medium-sized icons.
8549 large Use large icons.
8550 huge Use even larger icons.
8551 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008553 the current theme. Common dimensions are giant=48x48, huge=32x32,
8554 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555
8556 If 'toolbariconsize' is empty, the global default size as determined
8557 by user preferences or the current theme is used.
8558
8559 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8560'ttybuiltin' 'tbi' boolean (default on)
8561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 When on, the builtin termcaps are searched before the external ones.
8563 When off the builtin termcaps are searched after the external ones.
8564 When this option is changed, you should set the 'term' option next for
8565 the change to take effect, for example: >
8566 :set notbi term=$TERM
8567< See also |termcap|.
8568 Rationale: The default for this option is "on", because the builtin
8569 termcap entries are generally better (many systems contain faulty
8570 xterm entries...).
8571
8572 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008573'ttyfast' 'tf' boolean (default on)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 Indicates a fast terminal connection. More characters will be sent to
8576 the screen for redrawing, instead of using insert/delete line
8577 commands. Improves smoothness of redrawing when there are multiple
8578 windows and the terminal does not support a scrolling region.
8579 Also enables the extra writing of characters at the end of each screen
8580 line for lines that wrap. This helps when using copy/paste with the
8581 mouse in an xterm and other terminals.
8582
Bram Moolenaarc1cf4c92022-11-25 15:09:35 +00008583 The default used to be set only for some terminal names, but these
8584 days nearly all terminals are fast, therefore the default is now "on".
8585 If you have a slow connection you may want to set this option off,
8586 e.g. depending on the host name: >
8587 if hostname() =~ 'faraway'
8588 set nottyfast
8589 endif
8590<
Bram Moolenaar071d4272004-06-13 20:20:40 +00008591 *'ttymouse'* *'ttym'*
8592'ttymouse' 'ttym' string (default depends on 'term')
8593 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594 {only in Unix and VMS, doesn't work in the GUI; not
8595 available when compiled without |+mouse|}
8596 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008597 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 *xterm-mouse*
8599 xterm xterm-like mouse handling. The mouse generates
8600 "<Esc>[Mscr", where "scr" is three bytes:
8601 "s" = button state
8602 "c" = column plus 33
8603 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008604 This only works up to 223 columns! See "dec",
8605 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 xterm2 Works like "xterm", but with the xterm reporting the
8607 mouse position while the mouse is dragged. This works
8608 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008609 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008610 work. See below for how Vim detects this
8611 automatically.
8612 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008613 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008615 for the row and column. No other mouse events are
8616 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 *dec-mouse*
8618 dec DEC terminal mouse handling. The mouse generates a
8619 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008620 This is also available for an Xterm, if it was
8621 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 *jsbterm-mouse*
8623 jsbterm JSB term mouse handling.
8624 *pterm-mouse*
8625 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008626 *urxvt-mouse*
8627 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008628 The mouse works only if the terminal supports this
8629 encoding style, but it does not have 223 columns limit
8630 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008631 *sgr-mouse*
8632 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008633 mouse reporting. The mouse works even in columns
8634 beyond 223. This option is backward compatible with
8635 "xterm2" because it can also decode "xterm2" style
8636 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637
8638 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008639 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8640 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8642 recognized, if enabled at compile time. DEC terminal mouse codes
8643 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008644 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8645 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008647 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8648 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8649 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008650 Additionally, if vim is compiled with the |+termresponse| feature and
8651 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008652 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008654 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8655 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8656 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008657 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8658 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 :set t_RV=
8660<
8661 *'ttyscroll'* *'tsl'*
8662'ttyscroll' 'tsl' number (default 999)
8663 global
8664 Maximum number of lines to scroll the screen. If there are more lines
8665 to scroll the window is redrawn. For terminals where scrolling is
8666 very slow and redrawing is not slow this can be set to a small number,
8667 e.g., 3, to speed up displaying.
8668
8669 *'ttytype'* *'tty'*
8670'ttytype' 'tty' string (default from $TERM)
8671 global
8672 Alias for 'term', see above.
8673
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008674 *'undodir'* *'udir'*
8675'undodir' 'udir' string (default ".")
8676 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008677 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008678 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008679 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008680 "." means using the directory of the file. The undo file name for
8681 "file.txt" is ".file.txt.un~".
8682 For other directories the file name is the full path of the edited
8683 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008684 When writing: The first directory that exists is used. "." always
8685 works, no directories after "." will be used for writing.
8686 When reading all entries are tried to find an undo file. The first
8687 undo file that exists is used. When it cannot be read an error is
8688 given, no further entry is used.
8689 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008690 This option cannot be set from a |modeline| or in the |sandbox|, for
8691 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008692
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008693 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008694'undofile' 'udf' boolean (default off)
8695 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008696 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008697 When on, Vim automatically saves undo history to an undo file when
8698 writing a buffer to a file, and restores undo history from the same
8699 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008700 The directory where the undo file is stored is specified by 'undodir'.
8701 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008702 The undo file is not read when 'undoreload' causes the buffer from
8703 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008704 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008705 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008706
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008708'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008709 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008711 is kept in memory, higher numbers will cause more memory to be used.
8712 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8714 itself: >
8715 set ul=0
8716< But you can also get Vi compatibility by including the 'u' flag in
8717 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008718 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008719 Set to -1 for no undo at all. You might want to do this only for the
8720 current buffer: >
8721 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008723
8724 The local value is set to -123456 when the global value is to be used.
8725
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008726 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008728 *'undoreload'* *'ur'*
8729'undoreload' 'ur' number (default 10000)
8730 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008731 Save the whole buffer for undo when reloading it. This applies to the
8732 ":e!" command and reloading for when the buffer changed outside of
8733 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008734 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008735 of lines is smaller than the value of this option.
8736 Set this option to zero to disable undo for a reload.
8737
8738 When saving undo for a reload, any undo file is not read.
8739
8740 Note that this causes the whole buffer to be stored in memory. Set
8741 this option to a lower value if you run out of memory.
8742
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 *'updatecount'* *'uc'*
8744'updatecount' 'uc' number (default: 200)
8745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 After typing this many characters the swap file will be written to
8747 disk. When zero, no swap file will be created at all (see chapter on
8748 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8749 Vim with the "-n" option, see |startup|. When editing in readonly
8750 mode this option will be initialized to 10000.
8751 The swapfile can be disabled per buffer with |'swapfile'|.
8752 When 'updatecount' is set from zero to non-zero, swap files are
8753 created for all buffers that have 'swapfile' set. When 'updatecount'
8754 is set to zero, existing swap files are not deleted.
8755 Also see |'swapsync'|.
8756 This option has no meaning in buffers where |'buftype'| is "nofile"
8757 or "nowrite".
8758
8759 *'updatetime'* *'ut'*
8760'updatetime' 'ut' number (default 4000)
8761 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 If this many milliseconds nothing is typed the swap file will be
8763 written to disk (see |crash-recovery|). Also used for the
8764 |CursorHold| autocommand event.
8765
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008766 *'varsofttabstop'* *'vsts'*
8767'varsofttabstop' 'vsts' string (default "")
8768 local to buffer
8769 {only available when compiled with the |+vartabs|
8770 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008771 A list of the number of spaces that a <Tab> counts for while editing,
8772 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8773 width <Tab>s are being inserted, while in fact a mixture of spaces
8774 and <Tab>s is used. Tab widths are separated with commas, with the
8775 final value applying to all subsequent tabs.
8776
8777 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008778 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008779 to use the following: >
8780 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008781< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8782 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008783
8784 Note that the value of |'softtabstop'| will be ignored while
8785 'varsofttabstop' is set.
8786
8787 *'vartabstop'* *'vts'*
8788'vartabstop' 'vts' string (default "")
8789 local to buffer
8790 {only available when compiled with the |+vartabs|
8791 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008792 A list of the number of spaces that a <Tab> in the file counts for,
8793 separated by commas. Each value corresponds to one tab, with the
8794 final value applying to all subsequent tabs. For example: >
8795 :set vartabstop=4,20,10,8
8796< This will make the first tab 4 spaces wide, the second 20 spaces,
8797 the third 10 spaces, and all following tabs 8 spaces.
8798
8799 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8800 is set.
8801
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 *'verbose'* *'vbs'*
8803'verbose' 'vbs' number (default 0)
8804 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008805 When bigger than zero, Vim will give messages about what it is doing.
8806 Currently, these messages are given:
8807 >= 1 When the viminfo file is read or written.
8808 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008809 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008810 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 >= 8 Files for which a group of autocommands is executed.
8812 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008813 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 >= 12 Every executed function.
8815 >= 13 When an exception is thrown, caught, finished, or discarded.
8816 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008817 >= 15 Every executed Ex command from a script (truncated at 200
8818 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008819 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820
8821 This option can also be set with the "-V" argument. See |-V|.
8822 This option is also set by the |:verbose| command.
8823
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008824 When the 'verbosefile' option is set then the verbose messages are not
8825 displayed.
8826
8827 *'verbosefile'* *'vfile'*
8828'verbosefile' 'vfile' string (default empty)
8829 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008830 When not empty all messages are written in a file with this name.
8831 When the file exists messages are appended.
8832 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008833 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008834 Setting 'verbosefile' to a new value is like making it empty first.
8835 The difference with |:redir| is that verbose messages are not
8836 displayed when 'verbosefile' is set.
8837
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008839'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 "$VIM/vimfiles/view",
8841 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008842 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008843 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008845 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 feature}
8847 Name of the directory where to store files for |:mkview|.
8848 This option cannot be set from a |modeline| or in the |sandbox|, for
8849 security reasons.
8850
8851 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008852'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008854 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 feature}
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008856 Changes the effect of the |:mkview| command. It is a comma-separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008857 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858 word save and restore ~
8859 cursor cursor position in file and in window
8860 folds manually created folds, opened/closed folds and local
8861 fold options
8862 options options and mappings local to a window or buffer (not
8863 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008864 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008865 slash backslashes in file names replaced with forward
8866 slashes
8867 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008868 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008869 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008871 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008872 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008873 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874
8875 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008876'viminfo' 'vi' string (Vi default: "", Vim default for
8877 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008878 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8879 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008880 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008881 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882 feature}
8883 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008884 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8885 "NONE".
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01008886 The string should be a comma-separated list of parameters, each
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008887 consisting of a single character identifying the particular parameter,
8888 followed by a number or string which specifies the value of that
8889 parameter. If a particular character is left out, then the default
8890 value is used for that parameter. The following is a list of the
8891 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008893 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008894 ! When included, save and restore global variables that start
8895 with an uppercase letter, and don't contain a lowercase
8896 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008897 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008898 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008899 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 " Maximum number of lines saved for each register. Old name of
8901 the '<' item, with the disadvantage that you need to put a
8902 backslash before the ", otherwise it will be recognized as the
8903 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008904 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008905 % When included, save and restore the buffer list. If Vim is
8906 started with a file name argument, the buffer list is not
8907 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008908 buffer list is restored from the viminfo file. Quickfix
8909 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8910 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008911 When followed by a number, the number specifies the maximum
8912 number of buffers that are stored. Without a number all
8913 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008914 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 ' Maximum number of previously edited files for which the marks
8916 are remembered. This parameter must always be included when
8917 'viminfo' is non-empty.
8918 Including this item also means that the |jumplist| and the
8919 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008920 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008922 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008923 patterns are also saved. When not included, the value of
8924 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008925 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008927 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008928 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 < Maximum number of lines saved for each register. If zero then
8930 registers are not saved. When not included, all lines are
8931 saved. '"' is the old name for this item.
8932 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008933 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008935 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008936 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937 c When included, convert the text in the viminfo file from the
8938 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008939 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008940 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 f Whether file marks need to be stored. If zero, file marks ('0
8942 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008943 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008945 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 h Disable the effect of 'hlsearch' when loading the viminfo
8947 file. When not included, it depends on whether ":nohlsearch"
8948 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008949 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008951 the 'n'. Must be at the end of the option! If the
8952 'viminfofile' option is set, that file name overrides the one
8953 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008954 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008955 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956 r Removable media. The argument is a string (up to the next
8957 ','). This parameter can be given several times. Each
8958 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008959 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008960 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8961 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8962 ignored. Maximum length of each 'r' argument is 50
8963 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008964 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 s Maximum size of an item in Kbyte. If zero then registers are
8966 not saved. Currently only applies to registers. The default
8967 "s10" will exclude registers with more than 10 Kbyte of text.
8968 Also see the '<' item above: line count limit.
8969
8970 Example: >
8971 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8972<
8973 '50 Marks will be remembered for the last 50 files you
8974 edited.
8975 <1000 Contents of registers (up to 1000 lines each) will be
8976 remembered.
8977 s100 Registers with more than 100 Kbyte text are skipped.
8978 :0 Command-line history will not be saved.
8979 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8980 no / Since '/' is not specified, the default will be used,
8981 that is, save all of the search history, and also the
8982 previous search and substitute patterns.
8983 no % The buffer list will not be saved nor read back.
8984 no h 'hlsearch' highlighting will be restored.
8985
8986 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8987 load the contents of the file, this is not done automatically.
8988
8989 This option cannot be set from a |modeline| or in the |sandbox|, for
8990 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008991 NOTE: This option is set to the Vim default value when 'compatible'
8992 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008994 *'viminfofile'* *'vif'*
8995'viminfofile' 'vif' string (default: "")
8996 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008997 {not available when compiled without the |+viminfo|
8998 feature}
8999 When non-empty, overrides the file name used for viminfo.
9000 When equal to "NONE" no viminfo file will be read or written.
9001 This option can be set with the |-i| command line flag. The |--clean|
9002 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02009003 This option cannot be set from a |modeline| or in the |sandbox|, for
9004 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02009005
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006 *'virtualedit'* *'ve'*
9007'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02009008 global or local to window |global-local|
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009009 A comma-separated list of these words:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010 block Allow virtual editing in Visual block mode.
9011 insert Allow virtual editing in Insert mode.
9012 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009013 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02009014 none When used as the local value, do not allow virtual
9015 editing even when the global value is set. When used
9016 as the global value, "none" is the same as "".
9017 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009018
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00009020 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 of the line. Useful for selecting a rectangle in Visual mode and
9022 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009023 "onemore" is not the same, it will only allow moving the cursor just
9024 after the last character of the line. This makes some commands more
9025 consistent. Previously the cursor was always past the end of the line
9026 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009027 break some plugins or Vim scripts. For example because |l| can move
9028 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009029 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009030 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02009031 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00009032 It doesn't make sense to combine "all" with "onemore", but you will
9033 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02009034 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01009035 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036
9037 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
9038'visualbell' 'vb' boolean (default off)
9039 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02009040 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009041 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02009042 use: >
9043 :set vb t_vb=
9044< If you want a short flash, you can use this on many terminals: >
9045 :set vb t_vb=[?5h$<100>[?5l
9046< Here $<100> specifies the time, you can use a smaller or bigger value
9047 to get a shorter or longer flash.
9048
9049 Note: Vim will limit the bell to once per half a second. This avoids
9050 having to wait for the flashing to finish when there are lots of
9051 bells, e.g. on key repeat. This also happens without 'visualbell'
9052 set.
9053
Bram Moolenaar071d4272004-06-13 20:20:40 +00009054 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
9055 for 20 msec. If you want to use a different time, use "<Esc>|40f",
9056 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02009057
9058 Note: When the GUI starts, 't_vb' is reset to its default value. You
9059 might want to set it again in your |gvimrc|.
9060
Bram Moolenaar071d4272004-06-13 20:20:40 +00009061 Does not work on the Amiga, you always get a screen flash.
9062 Also see 'errorbells'.
9063
9064 *'warn'* *'nowarn'*
9065'warn' boolean (default on)
9066 global
9067 Give a warning message when a shell command is used while the buffer
9068 has been changed.
9069
9070 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
9071'weirdinvert' 'wiv' boolean (default off)
9072 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00009073 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074 It is provided for backwards compatibility with version 4.x.
9075 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
9076 vice versa. Has no effect when the GUI is running.
9077
9078 *'whichwrap'* *'ww'*
9079'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
9080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009081 Allow specified keys that move the cursor left/right to move to the
9082 previous/next line when the cursor is on the first/last character in
9083 the line. Concatenate characters to allow this for these keys:
9084 char key mode ~
9085 b <BS> Normal and Visual
9086 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00009087 h "h" Normal and Visual (not recommended)
9088 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009089 < <Left> Normal and Visual
9090 > <Right> Normal and Visual
9091 ~ "~" Normal
9092 [ <Left> Insert and Replace
9093 ] <Right> Insert and Replace
9094 For example: >
9095 :set ww=<,>,[,]
9096< allows wrap only when cursor keys are used.
9097 When the movement keys are used in combination with a delete or change
9098 operator, the <EOL> also counts for a character. This makes "3h"
9099 different from "3dh" when the cursor crosses the end of a line. This
9100 is also true for "x" and "X", because they do the same as "dl" and
9101 "dh". If you use this, you may also want to use the mapping
9102 ":map <BS> X" to make backspace delete the character in front of the
9103 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00009104 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02009105 line (not an empty line) then it will not move to the next line. This
9106 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009107 NOTE: This option is set to the Vi default value when 'compatible' is
9108 set and to the Vim default value when 'compatible' is reset.
9109
9110 *'wildchar'* *'wc'*
9111'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
9112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009113 Character you have to type to start wildcard expansion in the
9114 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009115 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009116 The character is not recognized when used inside a macro. See
9117 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009118 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009119 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02009120 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121< NOTE: This option is set to the Vi default value when 'compatible' is
9122 set and to the Vim default value when 'compatible' is reset.
9123
9124 *'wildcharm'* *'wcm'*
9125'wildcharm' 'wcm' number (default: none (0))
9126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009127 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00009128 recognized when used inside a macro. You can find "spare" command-line
9129 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 you'll never actually type 'wildcharm', just use it in mappings that
9131 automatically invoke completion mode, e.g.: >
9132 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00009133 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00009134< Then after typing :ss you can use CTRL-P & CTRL-N.
9135
9136 *'wildignore'* *'wig'*
9137'wildignore' 'wig' string (default "")
9138 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02009140 patterns is ignored when expanding |wildcards|, completing file or
9141 directory names, and influences the result of |expand()|, |glob()| and
9142 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009143 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
9144 Also see 'suffixes'.
9145 Example: >
9146 :set wildignore=*.o,*.obj
9147< The use of |:set+=| and |:set-=| is preferred when adding or removing
9148 a pattern from the list. This avoids problems when a future version
9149 uses another default.
9150
Bram Moolenaar94950a92010-12-02 16:01:29 +01009151
Bram Moolenaar81af9252010-12-10 20:35:50 +01009152 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01009153'wildignorecase' 'wic' boolean (default off)
9154 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01009155 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01009156 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01009157 Does not apply when the shell is used to expand wildcards, which
9158 happens when there are special characters.
9159
9160
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009162'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009164 When 'wildmenu' is on, command-line completion operates in an enhanced
9165 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
Bram Moolenaar54162322022-08-26 16:58:51 +01009166 the possible matches are shown.
9167 When 'wildoptions' contains "pum", then the completion matches are
9168 shown in a popup menu. Otherwise they are displayed just above the
9169 command line, with the first match highlighted (overwriting the status
9170 line, if there is one).
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009171 Keys that show the previous/next match, such as <Tab> or
Bram Moolenaar071d4272004-06-13 20:20:40 +00009172 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9173 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9174 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009175 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009176 If there are more matches than can fit in the line, a ">" is shown on
9177 the right and/or a "<" is shown on the left. The status line scrolls
9178 as needed.
9179 The "wildmenu" mode is abandoned when a key is hit that is not used
9180 for selecting a completion.
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009181 While the "wildmenu" is active, not using the popup menu, the
9182 following keys have special meanings:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009183
9184 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9185 <Down> - in filename/menu name completion: move into a
9186 subdirectory or submenu.
9187 <CR> - in menu completion, when the cursor is just after a
9188 dot: move into a submenu.
9189 <Up> - in filename/menu name completion: move up into
9190 parent directory or parent menu.
9191
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009192 When using the popup menu for command line completion, the following
9193 keys have special meanings:
9194 <Down> - select next match (like CTRL-N)
9195 <Left> - in filename/menu name completion: move up into
9196 parent directory or parent menu.
9197 <Right> - in filename/menu name completion: move into a
9198 subdirectory or submenu.
9199 <Up> - select previous match (like CTRL-P)
9200 CTRL-E - end completion, go back to what was there before
9201 selecting a match.
9202 CTRL-N - go to the next entry
9203 CTRL-P - go to the previous entry
9204 CTRL-Y - accept the currently selected match and stop
9205 completion.
9206
Bram Moolenaar071d4272004-06-13 20:20:40 +00009207 This makes the menus accessible from the console |console-menus|.
9208
9209 If you prefer the <Left> and <Right> keys to move the cursor instead
9210 of selecting a different match, use this: >
9211 :cnoremap <Left> <Space><BS><Left>
9212 :cnoremap <Right> <Space><BS><Right>
9213<
9214 The "WildMenu" highlighting is used for displaying the current match
9215 |hl-WildMenu|.
9216
9217 *'wildmode'* *'wim'*
9218'wildmode' 'wim' string (Vim default: "full")
9219 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009220 Completion mode that is used for the character specified with
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01009221 'wildchar'. It is a comma-separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009222 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009223 first part specifies the behavior for the first use of 'wildchar',
9224 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009225
9226 Each part consists of a colon separated list consisting of the
9227 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00009228 "" Complete only the first match.
9229 "full" Complete the next full match. After the last match,
9230 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009231 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009232 "longest" Complete till longest common string. If this doesn't
9233 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009234 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009235 "lastused" When completing buffer names and more than one buffer
9236 matches, sort buffers by time last used (other than
9237 the current buffer).
9238 When there is only a single match, it is fully completed in all cases.
9239
9240 Examples of useful colon-separated values:
9241 "longest:full" Like "longest", but also start 'wildmenu' if it is
9242 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009243 "list:full" When more than one match, list all matches and
9244 complete first match.
9245 "list:longest" When more than one match, list all matches and
9246 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02009247 "list:lastused" When more than one buffer matches, list all matches
9248 and sort buffers by time last used (other than the
9249 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009250
9251 Examples: >
9252 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009253< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009254 :set wildmode=longest,full
9255< Complete longest common string, then each full match >
9256 :set wildmode=list:full
9257< List all matches and complete each full match >
9258 :set wildmode=list,full
9259< List all matches without completing, then each full match >
9260 :set wildmode=longest,list
9261< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009262 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009263
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009264 *'wildoptions'* *'wop'*
9265'wildoptions' 'wop' string (default "")
9266 global
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009267 A list of words that change how |cmdline-completion| is done.
9268 The following values are supported:
Bram Moolenaar1588bc82022-03-08 21:35:07 +00009269 fuzzy Use |fuzzy-matching| to find completion matches. When
Yegappan Lakshmanan38b85cb2022-02-24 13:28:41 +00009270 this value is specified, wildcard expansion will not
9271 be used for completion. The matches will be sorted by
9272 the "best match" rather than alphabetically sorted.
9273 This will find more matches than the wildcard
9274 expansion. Currently fuzzy matching based completion
9275 is not supported for file and directory names and
9276 instead wildcard expansion is used.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01009277 pum Display the completion matches using the popup menu
Yegappan Lakshmanan3908ef52022-02-08 12:08:07 +00009278 in the same style as the |ins-completion-menu|.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009279 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009280 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009281 is displayed per line. Often used tag kinds are:
9282 d #define
9283 f function
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009284
Bram Moolenaar071d4272004-06-13 20:20:40 +00009285 *'winaltkeys'* *'wak'*
9286'winaltkeys' 'wak' string (default "menu")
9287 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009288 {only used in Win32, Motif, GTK and Photon GUI}
9289 Some GUI versions allow the access to menu entries by using the ALT
9290 key in combination with a character that appears underlined in the
9291 menu. This conflicts with the use of the ALT key for mappings and
9292 entering special characters. This option tells what to do:
9293 no Don't use ALT keys for menus. ALT key combinations can be
9294 mapped, but there is no automatic handling. This can then be
9295 done with the |:simalt| command.
9296 yes ALT key handling is done by the windowing system. ALT key
9297 combinations cannot be mapped.
9298 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009299 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009300 keys can be mapped.
9301 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9302 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009303 This option is not used for <F10>; on Win32 and with GTK <F10> will
9304 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009305
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009306 *'wincolor'* *'wcr'*
9307'wincolor' 'wcr' string (default empty)
9308 local to window
9309 Highlight group name to use for this window instead of the Normal
9310 color |hl-Normal|.
9311
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009312 *'window'* *'wi'*
9313'window' 'wi' number (default screen height - 1)
9314 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009315 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9316 window and the value is smaller than 'lines' minus one. The screen
9317 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009318 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9319 in a much smarter way, taking care of wrapping lines.
9320 When resizing the Vim window, the value is smaller than 1 or more than
9321 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009322 Note: Do not confuse this with the height of the Vim window, use
9323 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009324
Bram Moolenaar071d4272004-06-13 20:20:40 +00009325 *'winheight'* *'wh'* *E591*
9326'winheight' 'wh' number (default 1)
9327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009328 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009329 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009330 focus goes to a window that is smaller, its size is increased, at the
9331 cost of the height of other windows.
9332 Set 'winheight' to a small number for normal editing.
9333 Set it to 999 to make the current window fill most of the screen.
9334 Other windows will be only 'winminheight' high. This has the drawback
9335 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9336 to create only two windows, set the option after startup is done,
9337 using the |VimEnter| event: >
9338 au VimEnter * set winheight=999
9339< Minimum value is 1.
9340 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009341 height of the current window.
9342 'winheight' applies to the current window. Use 'winminheight' to set
9343 the minimal height for other windows.
9344
9345 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9346'winfixheight' 'wfh' boolean (default off)
9347 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009348 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009349 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9350 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009351 The height may be changed anyway when running out of room.
9352
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009353 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9354'winfixwidth' 'wfw' boolean (default off)
9355 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009356 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009357 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009358 The width may be changed anyway when running out of room.
9359
Bram Moolenaar071d4272004-06-13 20:20:40 +00009360 *'winminheight'* *'wmh'*
9361'winminheight' 'wmh' number (default 1)
9362 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009363 The minimal height of a window, when it's not the current window.
9364 This is a hard minimum, windows will never become smaller.
9365 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9366 status bar) if necessary. They will return to at least one line when
9367 they become active (since the cursor has to have somewhere to go.)
9368 Use 'winheight' to set the minimal height of the current window.
9369 This option is only checked when making a window smaller. Don't use a
9370 large number, it will cause errors when opening more than a few
9371 windows. A value of 0 to 3 is reasonable.
9372
9373 *'winminwidth'* *'wmw'*
9374'winminwidth' 'wmw' number (default 1)
9375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009376 The minimal width of a window, when it's not the current window.
9377 This is a hard minimum, windows will never become smaller.
9378 When set to zero, windows may be "squashed" to zero columns (i.e. just
9379 a vertical separator) if necessary. They will return to at least one
9380 line when they become active (since the cursor has to have somewhere
9381 to go.)
9382 Use 'winwidth' to set the minimal width of the current window.
9383 This option is only checked when making a window smaller. Don't use a
9384 large number, it will cause errors when opening more than a few
9385 windows. A value of 0 to 12 is reasonable.
9386
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009387 *'winptydll'*
9388'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9389 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009390 {only available when compiled with the |terminal|
9391 feature on MS-Windows}
9392 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009393 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009394 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009395 a fallback.
9396 Environment variables are expanded |:set_env|.
9397 This option cannot be set from a |modeline| or in the |sandbox|, for
9398 security reasons.
9399
Bram Moolenaar071d4272004-06-13 20:20:40 +00009400 *'winwidth'* *'wiw'* *E592*
9401'winwidth' 'wiw' number (default 20)
9402 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009403 Minimal number of columns for the current window. This is not a hard
9404 minimum, Vim will use fewer columns if there is not enough room. If
9405 the current window is smaller, its size is increased, at the cost of
9406 the width of other windows. Set it to 999 to make the current window
9407 always fill the screen. Set it to a small number for normal editing.
9408 The width is not adjusted after one of the commands to change the
9409 width of the current window.
9410 'winwidth' applies to the current window. Use 'winminwidth' to set
9411 the minimal width for other windows.
9412
9413 *'wrap'* *'nowrap'*
9414'wrap' boolean (default on)
9415 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009416 This option changes how text is displayed. It doesn't change the text
9417 in the buffer, see 'textwidth' for that.
9418 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009419 displaying continues on the next line. When off lines will not wrap
9420 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009421 moved to a part that is not shown, the screen will scroll
9422 horizontally.
9423 The line will be broken in the middle of a word if necessary. See
9424 'linebreak' to get the break at a word boundary.
9425 To make scrolling horizontally a bit more useful, try this: >
9426 :set sidescroll=5
9427 :set listchars+=precedes:<,extends:>
9428< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009429 This option can't be set from a |modeline| when the 'diff' option is
9430 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009431
9432 *'wrapmargin'* *'wm'*
9433'wrapmargin' 'wm' number (default 0)
9434 local to buffer
9435 Number of characters from the right window border where wrapping
9436 starts. When typing text beyond this limit, an <EOL> will be inserted
9437 and inserting continues on the next line.
9438 Options that add a margin, such as 'number' and 'foldcolumn', cause
9439 the text width to be further reduced. This is Vi compatible.
9440 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009441 This option is set to 0 when 'paste' is set and restored when 'paste'
9442 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009443 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009444
9445 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9446'wrapscan' 'ws' boolean (default on) *E384* *E385*
9447 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009448 Searches wrap around the end of the file. Also applies to |]s| and
9449 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009450
9451 *'write'* *'nowrite'*
9452'write' boolean (default on)
9453 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009454 Allows writing files. When not set, writing a file is not allowed.
9455 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009456 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009457 argument. Filtering text is still possible, even though this requires
9458 writing a temporary file.
9459
9460 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9461'writeany' 'wa' boolean (default off)
9462 global
9463 Allows writing to any file with no need for "!" override.
9464
9465 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9466'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9467 otherwise)
9468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009469 Make a backup before overwriting a file. The backup is removed after
9470 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009471 also on.
9472 WARNING: Switching this option off means that when Vim fails to write
9473 your buffer correctly and then, for whatever reason, Vim exits, you
9474 lose both the original file and what you were writing. Only reset
9475 this option if your file system is almost full and it makes the write
9476 fail (and make sure not to exit Vim until the write was successful).
9477 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009478 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009479 Depending on 'backupcopy' the backup is a new file or the original
9480 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009481 NOTE: This option is set to the default value when 'compatible' is
9482 set.
9483
9484 *'writedelay'* *'wd'*
9485'writedelay' 'wd' number (default 0)
9486 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009487 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009488 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009489 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009490
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009491 *'xtermcodes'* *'noxtermcodes'*
9492'xtermcodes' boolean (default on)
9493 global
9494 When detecting xterm patchlevel 141 or higher with the termresponse
Bram Moolenaarfa3b7232021-12-24 13:18:38 +00009495 mechanism and this option is set, Vim will request the actual terminal
Bram Moolenaar6f79e612021-12-21 09:12:23 +00009496 key codes and number of colors from the terminal. This takes care of
9497 various configuration options of the terminal that cannot be obtained
9498 from the termlib/terminfo entry, see |xterm-codes|.
9499 A side effect may be that t_Co changes and Vim will redraw the
9500 display.
9501
9502
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009503 vim:tw=78:ts=8:noet:ft=help:norl: