blob: c49b608247f34c74f5502eb41990740e5f8bd618 [file] [log] [blame]
Bram Moolenaar47003982021-12-05 21:54:04 +00001*options.txt* For Vim version 8.2. Last change: 2021 Dec 03
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
90 comma separated list, a comma is added, unless the
91 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
100 comma separated list, a comma is added, unless the
101 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
173 E846: Key code not set: t_kb
174
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 Moolenaar071d4272004-06-13 20:20:40 +0000372Note: In the future more global options can be made global-local. Using
373":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)}
386 " set using a funcref variable
387 let Fn = function('MyTagFunc')
388 let &tagfunc = string(Fn)
389 " set using a lambda expression
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000390 let &tagfunc = {t -> MyTagFunc(t)}
Yegappan Lakshmanan05e59e32021-12-01 10:30:07 +0000391 " set using a variable with lambda expression
392 let L = {a, b, c -> MyTagFunc(a, b , c)}
Yegappan Lakshmanan64095532021-12-06 11:03:55 +0000393 let &tagfunc = L
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000394<
395
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396Setting the filetype
397
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200398:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399 Set the 'filetype' option to {filetype}, but only if
400 not done yet in a sequence of (nested) autocommands.
401 This is short for: >
402 :if !did_filetype()
403 : setlocal filetype={filetype}
404 :endif
405< This command is used in a filetype.vim file to avoid
406 setting the 'filetype' option twice, causing different
407 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200408
409 When the optional FALLBACK argument is present, a
410 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100411 'filetype'. This is to be used for filetype
412 detections that are just a guess. |did_filetype()|
413 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200414
Bram Moolenaard58e9292011-02-09 17:07:58 +0100415 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
417:opt[ions] Open a window for viewing and setting all options.
418 Options are grouped by function.
419 Offers short help for each option. Hit <CR> on the
420 short help to open a help window with more help for
421 the option.
422 Modify the value of the option and hit <CR> on the
423 "set" line to set the new value. For window and
424 buffer specific options, the last accessed window is
425 used to set the option value in, unless this is a help
426 window, in which case the window below help window is
427 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100428 {not available when compiled without the |+eval|
429 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430
431 *$HOME*
432Using "~" is like using "$HOME", but it is only recognized at the start of an
433option and after a space or comma.
434
435On Unix systems "~user" can be used too. It is replaced by the home directory
436of user "user". Example: >
437 :set path=~mool/include,/usr/include,.
438
439On Unix systems the form "${HOME}" can be used too. The name between {} can
440contain non-id characters then. Note that if you want to use this for the
441"gf" command, you need to add the '{' and '}' characters to 'isfname'.
442
443NOTE: expanding environment variables and "~/" is only done with the ":set"
444command, not when assigning a value to an option with ":let".
445
Bram Moolenaarc572da52017-08-27 16:52:01 +0200446 *$HOME-windows*
447On MS-Windows, if $HOME is not defined as an environment variable, then
448at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200449If $HOMEDRIVE is not set then $USERPROFILE is used.
450
451This expanded value is not exported to the environment, this matters when
452running an external command: >
453 :echo system('set | findstr ^HOME=')
454and >
455 :echo luaeval('os.getenv("HOME")')
456should echo nothing (an empty string) despite exists('$HOME') being true.
457When setting $HOME to a non-empty string it will be exported to the
458subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200459
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460
461Note the maximum length of an expanded option is limited. How much depends on
462the system, mostly it is something like 256 or 1024 characters.
463
464 *:fix* *:fixdel*
465:fix[del] Set the value of 't_kD':
466 't_kb' is 't_kD' becomes ~
467 CTRL-? CTRL-H
468 not CTRL-? CTRL-?
469
Bram Moolenaar82be4842021-01-11 19:40:15 +0100470 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000471
472 If your delete key terminal code is wrong, but the
473 code for backspace is alright, you can put this in
474 your .vimrc: >
475 :fixdel
476< This works no matter what the actual code for
477 backspace is.
478
479 If the backspace key terminal code is wrong you can
480 use this: >
481 :if &term == "termname"
482 : set t_kb=^V<BS>
483 : fixdel
484 :endif
485< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000486 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000487 with your terminal name.
488
489 If your <Delete> key sends a strange key sequence (not
490 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
491 :if &term == "termname"
492 : set t_kD=^V<Delete>
493 :endif
494< Where "^V" is CTRL-V and "<Delete>" is the delete key
495 (don't type eight characters!). Replace "termname"
496 with your terminal name.
497
498 *Linux-backspace*
499 Note about Linux: By default the backspace key
500 produces CTRL-?, which is wrong. You can fix it by
501 putting this line in your rc.local: >
502 echo "keycode 14 = BackSpace" | loadkeys
503<
504 *NetBSD-backspace*
505 Note about NetBSD: If your backspace doesn't produce
506 the right code, try this: >
507 xmodmap -e "keycode 22 = BackSpace"
508< If this works, add this in your .Xmodmap file: >
509 keysym 22 = BackSpace
510< You need to restart for this to take effect.
511
512==============================================================================
5132. Automatically setting options *auto-setting*
514
515Besides changing options with the ":set" command, there are three alternatives
516to set options automatically for one or more files:
517
5181. When starting Vim initializations are read from various places. See
519 |initialization|. Most of them are performed for all editing sessions,
520 and some of them depend on the directory where Vim is started.
521 You can create an initialization file with |:mkvimrc|, |:mkview| and
522 |:mksession|.
5232. If you start editing a new file, the automatic commands are executed.
524 This can be used to set options for files matching a particular pattern and
525 many other things. See |autocommand|.
5263. If you start editing a new file, and the 'modeline' option is on, a
527 number of lines at the beginning and end of the file are checked for
528 modelines. This is explained here.
529
530 *modeline* *vim:* *vi:* *ex:* *E520*
531There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100532 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100534[text{white}] empty or any text followed by at least one blank
535 character (<Space> or <Tab>); "ex:" always requires at
536 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200537{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200538[white] optional white space
539{options} a list of option settings, separated with white space
540 or ':', where each part between ':' is the argument
541 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542
Bram Moolenaar14b69452013-06-29 23:05:20 +0200543Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000544 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200545 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546
547The second form (this is compatible with some versions of Vi):
548
Bram Moolenaarade0d392020-01-21 22:33:58 +0100549 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
Bram Moolenaarade0d392020-01-21 22:33:58 +0100551[text{white}] empty or any text followed by at least one blank
552 character (<Space> or <Tab>); "ex:" always requires at
553 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200554{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
555[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200556se[t] the string "set " or "se " (note the space); When
557 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200558{options} a list of options, separated with white space, which
559 is the argument for a ":set" command
560: a colon
561[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562
Bram Moolenaar14b69452013-06-29 23:05:20 +0200563Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000564 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200565 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200567The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
568chance that a normal word like "lex:" is caught. There is one exception:
569"vi:" and "vim:" can also be at the start of the line (for compatibility with
570version 3.0). Using "ex:" at the start of the line will be ignored (this
571could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
Hu Jialun9dcd3492021-08-28 20:42:50 +0200573If the modeline is disabled within a modeline, subsequent modelines will be
574ignored. This is to allow turning off modeline on a per-file basis. This is
575useful when a line looks like a modeline but isn't. For example, it would be
576good to start a YAML file containing strings like "vim:" with
577 # vim: nomodeline ~
578so as to avoid modeline misdetection. Following options on the same line
579after modeline deactivation, if any, are still evaluated (but you would
580normally not have any).
581
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582 *modeline-local*
583The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000584buffer and window that contain the file. Although it's possible to set global
585options from a modeline, this is unusual. If you have two windows open and
586the files in it set the same global option to a different value, the result
587depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000589When editing a file that was already loaded, only the window-local options
590from the modeline are used. Thus if you manually changed a buffer-local
591option after opening the file, it won't be changed if you edit the same buffer
592in another window. But window-local options will be set.
593
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594 *modeline-version*
595If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200596number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000597 vim{vers}: version {vers} or later
598 vim<{vers}: version before {vers}
599 vim={vers}: version {vers}
600 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100601{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
602For example, to use a modeline only for Vim 7.0:
603 /* vim700: set foldmethod=marker */ ~
604To use a modeline for Vim after version 7.2:
605 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606There can be no blanks between "vim" and the ":".
607
608
609The number of lines that are checked can be set with the 'modelines' option.
610If 'modeline' is off or 'modelines' is 0 no lines are checked.
611
612Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000613like:
614 /* vi:ts=4: */ ~
615will give an error message for the trailing "*/". This line is OK:
616 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617
618If an error is detected the rest of the line is skipped.
619
620If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000621backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100622 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
623This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
624before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200625 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000627might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200628can be set. For some options a flag is set, so that when the value is used
629the |sandbox| is effective. Some options can only be set from the modeline
630when 'modelineexpr' is set (the default is off).
631
632Still, there is always a small risk that a modeline causes trouble. E.g.,
633when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
634So disable modelines before editing untrusted text. The mail ftplugin does
635this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000636
637Hint: If you would like to do something else than setting an option, you could
638define an autocommand that checks the file for a specific string. For
639example: >
640 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
641And define a function SetVar() that does something with the line containing
642"VAR".
643
644==============================================================================
6453. Options summary *option-summary*
646
647In the list below all the options are mentioned with their full name and with
648an abbreviation if there is one. Both forms may be used.
649
650In this document when a boolean option is "set" that means that ":set option"
651is entered. When an option is "reset", ":set nooption" is used.
652
653For some options there are two default values: The "Vim default", which is
654used when 'compatible' is not set, and the "Vi default", which is used when
655'compatible' is set.
656
657Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000658are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659different value in each window. For example the 'list' option can be set in
660one window and reset in another for the same text, giving both types of view
661at the same time. There are a few options that are specific to a certain
662file. These can have a different value for each file or buffer. For example
663the 'textwidth' option can be 78 for a normal text file and 0 for a C
664program.
665
666 global one option for all buffers and windows
667 local to window each window has its own copy of this option
668 local to buffer each buffer has its own copy of this option
669
670When creating a new window the option values from the currently active window
671are used as a default value for the window-specific options. For the
672buffer-specific options this depends on the 's' and 'S' flags in the
673'cpoptions' option. If 's' is included (which is the default) the values for
674buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000675first entered. If 'S' is present the options are copied each time the buffer
676is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677present, the options are copied from the currently active buffer when the
678buffer is created.
679
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000680Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000682Not all options are supported in all versions. This depends on the supported
683features and sometimes on the system. A remark about this is in curly braces
684below. When an option is not supported it may still be set without getting an
685error, this is called a hidden option. You can't get the value of a hidden
686option though, it is not stored.
687
688To test if option "foo" can be used with ":set" use something like this: >
689 if exists('&foo')
690This also returns true for a hidden option. To test if option "foo" is really
691supported use something like this: >
692 if exists('+foo')
693<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 *E355*
695A jump table for the options with a short description can be found at |Q_op|.
696
697 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100698'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 {only available when compiled with the |+rightleft|
701 feature}
702 The ASCII code for the first letter of the Hebrew alphabet. The
703 routine that maps the keyboard in Hebrew mode, both in Insert mode
704 (when hkmap is set) and on the command-line (when hitting CTRL-_)
705 outputs the Hebrew characters in the range [aleph..aleph+26].
706 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
707 See |rileft.txt|.
708
709 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
710'allowrevins' 'ari' boolean (default off)
711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 {only available when compiled with the |+rightleft|
713 feature}
714 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
715 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
716 into reverse Insert mode, and don't know how to get out. See
717 'revins'.
718 NOTE: This option is reset when 'compatible' is set.
719
720 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
721'altkeymap' 'akm' boolean (default off)
722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 {only available when compiled with the |+farsi|
724 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100725 This option was for using Farsi, which has been removed. See
726 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728 *'ambiwidth'* *'ambw'*
729'ambiwidth' 'ambw' string (default: "single")
730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
732 Tells Vim what to do with characters with East Asian Width Class
733 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
734 letters, Cyrillic letters).
735
736 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000737 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 expected by most users.
739 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200740 *E834* *E835*
741 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100742 contains a character that would be double width. These errors may
743 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200744
745 The values are overruled for characters specified with
746 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747
748 There are a number of CJK fonts for which the width of glyphs for
749 those characters are solely based on how many octets they take in
750 legacy/traditional CJK encodings. In those encodings, Euro,
751 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000752 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000754 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755 Vim is running inside a terminal (emulators) that uses a CJK font
756 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
757 this option should be set to "double" to match the width perceived
758 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100759 to be set to "double" under CJK MS-Windows when the system locale is
760 set to one of CJK locales. See Unicode Standard Annex #11
761 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100763 Vim may set this option automatically at startup time when Vim is
764 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200765 escape sequence to request cursor position report. The response can
766 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100767
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
769'antialias' 'anti' boolean (default: off)
770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200772 on macOS}
773 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
775 which can be easier to read at certain sizes on certain displays.
776 Setting this option can sometimes cause problems if 'guifont' is set
777 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100778 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779
780 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
781'autochdir' 'acd' boolean (default off)
782 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200783 {only available when compiled with it, use
784 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000785 When on, Vim will change the current working directory whenever you
786 open a file, switch buffers, delete a buffer or open/close a window.
787 It will change to the directory containing the file which was opened
788 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000789 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200791 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
792'autoshelldir' 'asd' boolean (default off)
793 global
794 When on, Vim will change the current working directory whenever you
795 change the directory of the shell running in a terminal window. You
796 need proper setting-up, so whenever the shell's pwd changes an OSC 7
797 escape sequence will be emitted. For example, on Linux, you can source
798 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
799
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
801'arabic' 'arab' boolean (default off)
802 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 {only available when compiled with the |+arabic|
804 feature}
805 This option can be set to start editing Arabic text.
806 Setting this option will:
807 - Set the 'rightleft' option, unless 'termbidi' is set.
808 - Set the 'arabicshape' option, unless 'termbidi' is set.
809 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
810 between typing English and Arabic key mapping.
811 - Set the 'delcombine' option
812 Note that 'encoding' must be "utf-8" for working with Arabic text.
813
814 Resetting this option will:
815 - Reset the 'rightleft' option.
816 - Disable the use of 'keymap' (without changing its value).
817 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200818 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100819 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 Also see |arabic.txt|.
821
822 *'arabicshape'* *'arshape'*
823 *'noarabicshape'* *'noarshape'*
824'arabicshape' 'arshape' boolean (default on)
825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 {only available when compiled with the |+arabic|
827 feature}
828 When on and 'termbidi' is off, the required visual character
829 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200830 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 one which encompasses:
832 a) the changing/morphing of characters based on their location
833 within a word (initial, medial, final and stand-alone).
834 b) the enabling of the ability to compose characters
835 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100836 When disabled the display shows each character's true stand-alone
837 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838 Arabic is a complex language which requires other settings, for
839 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100840 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841
842 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
843'autoindent' 'ai' boolean (default off)
844 local to buffer
845 Copy indent from current line when starting a new line (typing <CR>
846 in Insert mode or when using the "o" or "O" command). If you do not
847 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000848 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
849 to another line has the same effect, unless the 'I' flag is included
850 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000851 When autoindent is on, formatting (with the "gq" command or when you
852 reach 'textwidth' in Insert mode) uses the indentation of the first
853 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 When 'smartindent' or 'cindent' is on the indent is changed in
855 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200856 The 'autoindent' option is reset when the 'paste' option is set and
857 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858
859 *'autoread'* *'ar'* *'noautoread'* *'noar'*
860'autoread' 'ar' boolean (default off)
861 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 When a file has been detected to have been changed outside of Vim and
863 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200864 When the file has been deleted this is not done, so you have the text
865 from before it was deleted. When it appears again then it is read.
866 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 If this option has a local value, use this command to switch back to
868 using the global value: >
869 :set autoread<
870<
871 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
872'autowrite' 'aw' boolean (default off)
873 global
874 Write the contents of the file, if it has been modified, on each
Bram Moolenaar47003982021-12-05 21:54:04 +0000875 `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
876 `:suspend`, `:tag, `:!`, ``:make`, CTRL-] and CTRL-^ command; and when
877 a :buffer, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
878 to another file.
879 A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
880 set to "hide" and `:next` is used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881 Note that for some commands the 'autowrite' option is not used, see
882 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200883 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200884 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885
886 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
887'autowriteall' 'awa' boolean (default off)
888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
890 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
891 Setting this option also implies that Vim behaves like 'autowrite' has
892 been set.
893
894 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200895'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 When set to "dark", Vim will try to use colors that look good on a
898 dark background. When set to "light", Vim will try to use colors that
899 look good on a light background. Any other value is illegal.
900 Vim tries to set the default value according to the terminal used.
901 This will not always be correct.
902 Setting this option does not change the background color, it tells Vim
903 what the background color looks like. For changing the background
904 color, see |:hi-normal|.
905
906 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000907 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000908 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100909 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 setting 'background' will cause the color scheme to be reloaded. If
911 the color scheme adjusts to the value of 'background' this will work.
912 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100913 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914
915 When setting 'background' to the default value with: >
916 :set background&
917< Vim will guess the value. In the GUI this should work correctly,
918 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200919 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200920 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200922 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200923 color from the terminal. If the returned RGB value is dark/light and
924 'background' is not dark/light, 'background' will be set and the
925 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200926 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100927 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200928
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 When starting the GUI, the default value for 'background' will be
930 "light". When the value is not set in the .gvimrc, and Vim detects
931 that the background is actually quite dark, 'background' is set to
932 "dark". But this happens only AFTER the .gvimrc file has been read
933 (because the window needs to be opened to find the actual background
934 color). To get around this, force the GUI window to be opened by
935 putting a ":gui" command in the .gvimrc file, before where the value
936 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200937
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100938 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200939 For other systems "dark" is used when 'term' is "linux",
940 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
941 background. Otherwise the default is "light".
942
Bram Moolenaarc572da52017-08-27 16:52:01 +0200943 The |:terminal| command and the |term_start()| function use the
944 'background' value to decide whether the terminal window will start
945 with a white or black background.
946
Bram Moolenaar071d4272004-06-13 20:20:40 +0000947 Normally this option would be set in the .vimrc file. Possibly
948 depending on the terminal name. Example: >
949 :if &term == "pcterm"
950 : set background=dark
951 :endif
952< When this option is set, the default settings for the highlight groups
953 will change. To use other settings, place ":highlight" commands AFTER
954 the setting of the 'background' option.
955 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
956 to select the colors for syntax highlighting. After changing this
957 option, you must load syntax.vim again to see the result. This can be
958 done with ":syntax on".
959
960 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200961'backspace' 'bs' string (default "", set to "indent,eol,start"
962 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
965 mode. This is a list of items, separated by commas. Each item allows
966 a way to backspace over something:
967 value effect ~
968 indent allow backspacing over autoindent
969 eol allow backspacing over line breaks (join lines)
970 start allow backspacing over the start of insert; CTRL-W and CTRL-U
971 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200972 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
973 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974
975 When the value is empty, Vi compatible backspacing is used.
976
977 For backwards compatibility with version 5.4 and earlier:
978 value effect ~
979 0 same as ":set backspace=" (Vi compatible)
980 1 same as ":set backspace=indent,eol"
981 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200982 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983
984 See |:fixdel| if your <BS> or <Del> key does not do what you want.
985 NOTE: This option is set to "" when 'compatible' is set.
986
987 *'backup'* *'bk'* *'nobackup'* *'nobk'*
988'backup' 'bk' boolean (default off)
989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 Make a backup before overwriting a file. Leave it around after the
991 file has been successfully written. If you do not want to keep the
992 backup file, but you do want a backup while the file is being
993 written, reset this option and set the 'writebackup' option (this is
994 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000995 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 |backup-table| for more explanations.
997 When the 'backupskip' pattern matches, a backup is not made anyway.
998 When 'patchmode' is set, the backup may be renamed to become the
999 oldest version of a file.
1000 NOTE: This option is reset when 'compatible' is set.
1001
1002 *'backupcopy'* *'bkc'*
1003'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +02001004 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 When writing a file and a backup is made, this option tells how it's
1006 done. This is a comma separated list of words.
1007
1008 The main values are:
1009 "yes" make a copy of the file and overwrite the original one
1010 "no" rename the file and write a new one
1011 "auto" one of the previous, what works best
1012
1013 Extra values that can be combined with the ones above are:
1014 "breaksymlink" always break symlinks when writing
1015 "breakhardlink" always break hardlinks when writing
1016
1017 Making a copy and overwriting the original file:
1018 - Takes extra time to copy the file.
1019 + When the file has special attributes, is a (hard/symbolic) link or
1020 has a resource fork, all this is preserved.
1021 - When the file is a link the backup will have the name of the link,
1022 not of the real file.
1023
1024 Renaming the file and writing a new one:
1025 + It's fast.
1026 - Sometimes not all attributes of the file can be copied to the new
1027 file.
1028 - When the file is a link the new file will not be a link.
1029
1030 The "auto" value is the middle way: When Vim sees that renaming file
1031 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001032 the file is not a link) that is used. When problems are expected, a
1033 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034
1035 The "breaksymlink" and "breakhardlink" values can be used in
1036 combination with any of "yes", "no" and "auto". When included, they
1037 force Vim to always break either symbolic or hard links by doing
1038 exactly what the "no" option does, renaming the original file to
1039 become the backup and writing a new file in its place. This can be
1040 useful for example in source trees where all the files are symbolic or
1041 hard links and any changes should stay in the local source tree, not
1042 be propagated back to the original source.
1043 *crontab*
1044 One situation where "no" and "auto" will cause problems: A program
1045 that opens a file, invokes Vim to edit that file, and then tests if
1046 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001047 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 example.
1049
1050 When a copy is made, the original file is truncated and then filled
1051 with the new text. This means that protection bits, owner and
1052 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001053 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001054 group of the backup is set to the group of the original file. If this
1055 fails, the protection bits for the group are made the same as for
1056 others.
1057
1058 When the file is renamed this is the other way around: The backup has
1059 the same attributes of the original file, and the newly written file
1060 is owned by the current user. When the file was a (hard/symbolic)
1061 link, the new file will not! That's why the "auto" value doesn't
1062 rename when the file is a link. The owner and group of the newly
1063 written file will be set to the same ones as the original file, but
1064 the system may refuse to do this. In that case the "auto" value will
1065 again not rename the file.
1066
Bram Moolenaar036986f2017-03-16 17:41:02 +01001067 NOTE: This option is set to the Vi default value when 'compatible' is
1068 set and to the Vim default value when 'compatible' is reset.
1069
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 *'backupdir'* *'bdir'*
1071'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001072 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 for Unix: ".,~/tmp,~/")
1074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 List of directories for the backup file, separated with commas.
1076 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001077 where this is possible. The directory must exist, Vim will not
1078 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001079 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 impossible!). Writing may fail because of this.
1081 - A directory "." means to put the backup file in the same directory
1082 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001083 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1084 the backup file relative to where the edited file is. The leading
1085 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 ("." inside a directory name has no special meaning).
1087 - Spaces after the comma are ignored, other spaces are considered part
1088 of the directory name. To have a space at the start of a directory
1089 name, precede it with a backslash.
1090 - To include a comma in a directory name precede it with a backslash.
1091 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001092 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001093 the backup file name will be built from the complete path to the
1094 file with all path separators changed to percent '%' signs. This
1095 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001096 On Win32, it is also possible to end with "\\". However, When a
1097 separating comma is following, you must use "//", since "\\" will
1098 include the comma in the file name. Therefore it is recommended to
1099 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100 - Environment variables are expanded |:set_env|.
1101 - Careful with '\' characters, type one before a space, type two to
1102 get one in the option (see |option-backslash|), for example: >
1103 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1104< - For backwards compatibility with Vim version 3.0 a '>' at the start
1105 of the option is removed.
1106 See also 'backup' and 'writebackup' options.
1107 If you want to hide your backup files on Unix, consider this value: >
1108 :set backupdir=./.backup,~/.backup,.,/tmp
1109< You must create a ".backup" directory in each directory and in your
1110 home directory for this to work properly.
1111 The use of |:set+=| and |:set-=| is preferred when adding or removing
1112 directories from the list. This avoids problems when a future version
1113 uses another default.
1114 This option cannot be set from a |modeline| or in the |sandbox|, for
1115 security reasons.
1116
1117 *'backupext'* *'bex'* *E589*
1118'backupext' 'bex' string (default "~", for VMS: "_")
1119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120 String which is appended to a file name to make the name of the
1121 backup file. The default is quite unusual, because this avoids
1122 accidentally overwriting existing files with a backup file. You might
1123 prefer using ".bak", but make sure that you don't have files with
1124 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001125 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001127 If you like to keep a lot of backups, you could use a BufWritePre
1128 autocommand to change 'backupext' just before writing the file to
1129 include a timestamp. >
1130 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1131< Use 'backupdir' to put the backup in a different directory.
1132
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001134'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1135 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1136 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 {not available when compiled without the |+wildignore|
1139 feature}
1140 A list of file patterns. When one of the patterns matches with the
1141 name of the file which is written, no backup file is created. Both
1142 the specified file name and the full path name of the file are used.
1143 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1144 Watch out for special characters, see |option-backslash|.
1145 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001146 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001147
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001148 WARNING: Not having a backup file means that when Vim fails to write
1149 your buffer correctly and then, for whatever reason, Vim exits, you
1150 lose both the original file and what you were writing. Only disable
1151 backups if you don't care about losing the file.
1152
Bram Moolenaar02467872007-05-06 13:22:01 +00001153 Note that environment variables are not expanded. If you want to use
1154 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001155 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001156
1157< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001158 backup would be made by renaming the original file crontab won't see
1159 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001160
1161 *'balloondelay'* *'bdlay'*
1162'balloondelay' 'bdlay' number (default: 600)
1163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 {only available when compiled with the |+balloon_eval|
1165 feature}
1166 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1167
1168 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1169'ballooneval' 'beval' boolean (default off)
1170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001172 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001173 Switch on the |balloon-eval| functionality for the GUI.
1174
1175 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1176 *'nobevalterm'*
1177'balloonevalterm' 'bevalterm' boolean (default off)
1178 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001179 {only available when compiled with the
1180 |+balloon_eval_term| feature}
1181 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001183 *'balloonexpr'* *'bexpr'*
1184'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001185 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001186 {only available when compiled with the |+balloon_eval|
1187 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001188 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001189 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1190 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001191
1192 v:beval_bufnr number of the buffer in which balloon is going to show
1193 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001194 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001195 v:beval_lnum line number
1196 v:beval_col column number (byte index)
1197 v:beval_text word under or after the mouse pointer
1198
Bram Moolenaar54775062019-07-31 21:07:14 +02001199 Instead of showing a balloon, which is limited to plain text, consider
1200 using a popup window, see |popup_beval_example|. A popup window can
1201 use highlighting and show a border.
1202
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001203 The evaluation of the expression must not have side effects!
1204 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001205 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001206 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001207 \', column ' . v:beval_col .
1208 \ ' of file ' . bufname(v:beval_bufnr) .
1209 \ ' on word "' . v:beval_text . '"'
1210 endfunction
1211 set bexpr=MyBalloonExpr()
1212 set ballooneval
1213<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001214 Also see |balloon_show()|, it can be used if the content of the balloon
1215 is to be fetched asynchronously. In that case evaluating
1216 'balloonexpr' should result in an empty string. If you get a balloon
1217 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001218
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001219 NOTE: The balloon is displayed only if the cursor is on a text
1220 character. If the result of evaluating 'balloonexpr' is not empty,
1221 Vim does not try to send a message to an external debugger (Netbeans
1222 or Sun Workshop).
1223
Bram Moolenaar30b65812012-07-12 22:01:11 +02001224 The expression will be evaluated in the |sandbox| when set from a
1225 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001226 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001227
1228 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001229 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001230
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001231 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001232 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001233< When they are supported "\n" characters will start a new line. If the
1234 expression evaluates to a |List| this is equal to using each List item
1235 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001236 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001237
Bram Moolenaar165bc692015-07-21 17:53:25 +02001238 *'belloff'* *'bo'*
1239'belloff' 'bo' string (default "")
1240 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001241 Specifies for which events the bell will not be rung. It is a comma
1242 separated list of items. For each item that is present, the bell
1243 will be silenced. This is most useful to specify specific events in
1244 insert mode to be silenced.
1245
1246 item meaning when present ~
1247 all All events.
1248 backspace When hitting <BS> or <Del> and deleting results in an
1249 error.
1250 cursor Fail to move around using the cursor keys or
1251 <PageUp>/<PageDown> in |Insert-mode|.
1252 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1253 |i_CTRL-X_CTRL-T|.
1254 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1255 |i_CTRL-E|.
1256 ctrlg Unknown Char after <C-G> in Insert mode.
1257 error Other Error occurred (e.g. try to join last line)
1258 (mostly used in |Normal-mode| or |Cmdline-mode|).
1259 esc hitting <Esc> in |Normal-mode|.
1260 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001261 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001262 insertmode Pressing <Esc> in 'insertmode'.
1263 lang Calling the beep module for Lua/Mzscheme/TCL.
1264 mess No output available for |g<|.
1265 showmatch Error occurred for 'showmatch' function.
1266 operator Empty region error |cpo-E|.
1267 register Unknown register after <C-R> in |Insert-mode|.
1268 shell Bell from shell output |:!|.
1269 spell Error happened on spell suggest.
1270 wildmode More matches in |cmdline-completion| available
1271 (depends on the 'wildmode' setting).
1272
Bram Moolenaar036986f2017-03-16 17:41:02 +01001273 This is most useful to fine tune when in Insert mode the bell should
1274 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001275 indicate that an error occurred. It can be silenced by adding the
1276 "error" keyword.
1277
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1279'binary' 'bin' boolean (default off)
1280 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281 This option should be set before editing a binary file. You can also
1282 use the |-b| Vim argument. When this option is switched on a few
1283 options will be changed (also when it already was on):
1284 'textwidth' will be set to 0
1285 'wrapmargin' will be set to 0
1286 'modeline' will be off
1287 'expandtab' will be off
1288 Also, 'fileformat' and 'fileformats' options will not be used, the
1289 file is read and written like 'fileformat' was "unix" (a single <NL>
1290 separates lines).
1291 The 'fileencoding' and 'fileencodings' options will not be used, the
1292 file is read without conversion.
1293 NOTE: When you start editing a(nother) file while the 'bin' option is
1294 on, settings from autocommands may change the settings again (e.g.,
1295 'textwidth'), causing trouble when editing. You might want to set
1296 'bin' again when the file has been loaded.
1297 The previous values of these options are remembered and restored when
1298 'bin' is switched from on to off. Each buffer has its own set of
1299 saved option values.
1300 To edit a file with 'binary' set you can use the |++bin| argument.
1301 This avoids you have to do ":set bin", which would have effect for all
1302 files you edit.
1303 When writing a file the <EOL> for the last line is only written if
1304 there was one in the original file (normally Vim appends an <EOL> to
1305 the last line if there is none; this would make the file longer). See
1306 the 'endofline' option.
1307
1308 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1309'bioskey' 'biosk' boolean (default on)
1310 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001311 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001312 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313
1314 *'bomb'* *'nobomb'*
1315'bomb' boolean (default off)
1316 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 When writing a file and the following conditions are met, a BOM (Byte
1318 Order Mark) is prepended to the file:
1319 - this option is on
1320 - the 'binary' option is off
1321 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1322 endian variants.
1323 Some applications use the BOM to recognize the encoding of the file.
1324 Often used for UCS-2 files on MS-Windows. For other applications it
1325 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001326 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1328 check for the presence of the BOM is done and 'bomb' set accordingly.
1329 Unless 'binary' is set, it is removed from the first line, so that you
1330 don't see it when editing. When you don't change the options, the BOM
1331 will be restored when writing the file.
1332
1333 *'breakat'* *'brk'*
1334'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1335 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001336 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 feature}
1338 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001339 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1340 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001342 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001343'breakindent' 'bri' boolean (default off)
1344 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001345 {not available when compiled without the |+linebreak|
1346 feature}
1347 Every wrapped line will continue visually indented (same amount of
1348 space as the beginning of that line), thus preserving horizontal blocks
1349 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001350 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001351
1352 *'breakindentopt'* *'briopt'*
1353'breakindentopt' 'briopt' string (default empty)
1354 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001355 {not available when compiled without the |+linebreak|
1356 feature}
1357 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001358 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001359 min:{n} Minimum text width that will be kept after
1360 applying 'breakindent', even if the resulting
1361 text should normally be narrower. This prevents
1362 text indented almost to the right window border
1363 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001364 shift:{n} After applying 'breakindent', the wrapped line's
1365 beginning will be shifted by the given number of
1366 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001367 indentation (negative) or emphasizing the line
1368 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001369 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001370 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001371 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001372 numbered or bulleted list (using the
1373 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001374 list:-1 Uses the length of a match with 'formatlistpat'
1375 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001376 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001377
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001379'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001381 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001383 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001384 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385 buffer Use the directory of the related buffer.
1386 current Use the current directory.
1387 {path} Use the specified directory
1388
1389 *'bufhidden'* *'bh'*
1390'bufhidden' 'bh' string (default: "")
1391 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 This option specifies what happens when a buffer is no longer
1393 displayed in a window:
1394 <empty> follow the global 'hidden' option
1395 hide hide the buffer (don't unload it), also when 'hidden'
1396 is not set
1397 unload unload the buffer, also when 'hidden' is set or using
1398 |:hide|
1399 delete delete the buffer from the buffer list, also when
1400 'hidden' is set or using |:hide|, like using
1401 |:bdelete|
1402 wipe wipe out the buffer from the buffer list, also when
1403 'hidden' is set or using |:hide|, like using
1404 |:bwipeout|
1405
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001406 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001407 are lost without a warning. Also, these values may break autocommands
1408 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409 This option is used together with 'buftype' and 'swapfile' to specify
1410 special kinds of buffers. See |special-buffers|.
1411
1412 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1413'buflisted' 'bl' boolean (default: on)
1414 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415 When this option is set, the buffer shows up in the buffer list. If
1416 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1417 This option is reset by Vim for buffers that are only used to remember
1418 a file name or marks. Vim sets it when starting to edit a buffer.
1419 But not when moving to a buffer with ":buffer".
1420
1421 *'buftype'* *'bt'* *E382*
1422'buftype' 'bt' string (default: "")
1423 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 The value of this option specifies the type of a buffer:
1425 <empty> normal buffer
1426 nofile buffer which is not related to a file and will not be
1427 written
1428 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001429 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001430 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001432 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 help help buffer (you are not supposed to set this
1434 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001435 terminal buffer for a |terminal| (you are not supposed to set
1436 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001437 prompt buffer where only the last line can be edited, meant
1438 to be used by a plugin, see |prompt-buffer|
1439 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001440 popup buffer used in a popup window, see |popup|.
1441 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442
1443 This option is used together with 'bufhidden' and 'swapfile' to
1444 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001445 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446
1447 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001448 One such effect is that Vim will not check the timestamp of the file,
1449 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450
Bram Moolenaar280f1262006-01-30 00:14:18 +00001451 A "quickfix" buffer is only used for the error list and the location
1452 list. This value is set by the |:cwindow| and |:lwindow| commands and
1453 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 "nofile" and "nowrite" buffers are similar:
1456 both: The buffer is not to be written to disk, ":w" doesn't
1457 work (":w filename" does work though).
1458 both: The buffer is never considered to be |'modified'|.
1459 There is no warning when the changes will be lost, for
1460 example when you quit Vim.
1461 both: A swap file is only created when using too much memory
1462 (when 'swapfile' has been reset there is never a swap
1463 file).
1464 nofile only: The buffer name is fixed, it is not handled like a
1465 file name. It is not modified in response to a |:cd|
1466 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001467 both: When using ":e bufname" and already editing "bufname"
1468 the buffer is made empty and autocommands are
1469 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001470 *E676*
1471 "acwrite" implies that the buffer name is not related to a file, like
1472 "nofile", but it will be written. Thus, in contrast to "nofile" and
1473 "nowrite", ":w" does work and a modified buffer can't be abandoned
1474 without saving. For writing there must be matching |BufWriteCmd|,
1475 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476
1477 *'casemap'* *'cmp'*
1478'casemap' 'cmp' string (default: "internal,keepascii")
1479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480 Specifies details about changing the case of letters. It may contain
1481 these words, separated by a comma:
1482 internal Use internal case mapping functions, the current
1483 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001484 matters when 'encoding' is a Unicode encoding,
1485 "latin1" or "iso-8859-15". When "internal" is
1486 omitted, the towupper() and towlower() system library
1487 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1489 case mapping, the current locale is not effective.
1490 This probably only matters for Turkish.
1491
1492 *'cdpath'* *'cd'* *E344* *E346*
1493'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1494 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495 {not available when compiled without the
1496 |+file_in_path| feature}
1497 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001498 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1499 searched for has a relative path, not an absolute part starting with
1500 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 The 'cdpath' option's value has the same form and semantics as
1502 |'path'|. Also see |file-searching|.
1503 The default value is taken from $CDPATH, with a "," prepended to look
1504 in the current directory first.
1505 If the default value taken from $CDPATH is not what you want, include
1506 a modified version of the following command in your vimrc file to
1507 override it: >
1508 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1509< This option cannot be set from a |modeline| or in the |sandbox|, for
1510 security reasons.
1511 (parts of 'cdpath' can be passed to the shell to expand file names).
1512
1513 *'cedit'*
1514'cedit' string (Vi default: "", Vim default: CTRL-F)
1515 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 The key used in Command-line Mode to open the command-line window.
1517 The default is CTRL-F when 'compatible' is off.
1518 Only non-printable keys are allowed.
1519 The key can be specified as a single character, but it is difficult to
1520 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001521 :exe "set cedit=\<C-Y>"
1522 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001523< |Nvi| also has this option, but it only uses the first character.
1524 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001525 NOTE: This option is set to the Vim default value when 'compatible'
1526 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527
1528 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1529'charconvert' 'ccv' string (default "")
1530 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001531 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 An expression that is used for character encoding conversion. It is
1533 evaluated when a file that is to be read or has been written has a
1534 different encoding from what is desired.
1535 'charconvert' is not used when the internal iconv() function is
1536 supported and is able to do the conversion. Using iconv() is
1537 preferred, because it is much faster.
1538 'charconvert' is not used when reading stdin |--|, because there is no
1539 file to convert from. You will have to save the text in a file first.
1540 The expression must return zero or an empty string for success,
1541 non-zero for failure.
1542 The possible encoding names encountered are in 'encoding'.
1543 Additionally, names given in 'fileencodings' and 'fileencoding' are
1544 used.
1545 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1546 is done internally by Vim, 'charconvert' is not used for this.
1547 'charconvert' is also used to convert the viminfo file, if the 'c'
1548 flag is present in 'viminfo'. Also used for Unicode conversion.
1549 Example: >
1550 set charconvert=CharConvert()
1551 fun CharConvert()
1552 system("recode "
1553 \ . v:charconvert_from . ".." . v:charconvert_to
1554 \ . " <" . v:fname_in . " >" v:fname_out)
1555 return v:shell_error
1556 endfun
1557< The related Vim variables are:
1558 v:charconvert_from name of the current encoding
1559 v:charconvert_to name of the desired encoding
1560 v:fname_in name of the input file
1561 v:fname_out name of the output file
1562 Note that v:fname_in and v:fname_out will never be the same.
1563 Note that v:charconvert_from and v:charconvert_to may be different
1564 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1565 Encryption is not done by Vim when using 'charconvert'. If you want
1566 to encrypt the file after conversion, 'charconvert' should take care
1567 of this.
1568 This option cannot be set from a |modeline| or in the |sandbox|, for
1569 security reasons.
1570
1571 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1572'cindent' 'cin' boolean (default off)
1573 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574 {not available when compiled without the |+cindent|
1575 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001576 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 that trigger reindenting in insert mode and 'cinoptions' to set your
1578 preferred indent style.
1579 If 'indentexpr' is not empty, it overrules 'cindent'.
1580 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1581 the "=" operator indents using this algorithm rather than calling an
1582 external program.
1583 See |C-indenting|.
1584 When you don't like the way 'cindent' works, try the 'smartindent'
1585 option or 'indentexpr'.
1586 This option is not used when 'paste' is set.
1587 NOTE: This option is reset when 'compatible' is set.
1588
1589 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001590'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 {not available when compiled without the |+cindent|
1593 feature}
1594 A list of keys that, when typed in Insert mode, cause reindenting of
1595 the current line. Only used if 'cindent' is on and 'indentexpr' is
1596 empty.
1597 For the format of this option see |cinkeys-format|.
1598 See |C-indenting|.
1599
1600 *'cinoptions'* *'cino'*
1601'cinoptions' 'cino' string (default "")
1602 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 {not available when compiled without the |+cindent|
1604 feature}
1605 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1606 program. See |cinoptions-values| for the values of this option, and
1607 |C-indenting| for info on C indenting in general.
1608
1609
1610 *'cinwords'* *'cinw'*
1611'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1612 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 {not available when compiled without both the
1614 |+cindent| and the |+smartindent| features}
1615 These keywords start an extra indent in the next line when
1616 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1617 an appropriate place (inside {}).
1618 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1619 matter, include the keyword both the uppercase and lowercase:
1620 "if,If,IF".
1621
1622 *'clipboard'* *'cb'*
1623'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1624 for X-windows, "" otherwise)
1625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 {only in GUI versions or when the |+xterm_clipboard|
1627 feature is included}
1628 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001629 Note: if one of the items is "exclude:", then you can't add an item
1630 after that. Therefore do append an item with += but use ^= to
1631 prepend, e.g.: >
1632 set clipboard^=unnamed
1633< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001635 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 unnamed When included, Vim will use the clipboard register '*'
1637 for all yank, delete, change and put operations which
1638 would normally go to the unnamed register. When a
1639 register is explicitly specified, it will always be
1640 used regardless of whether "unnamed" is in 'clipboard'
1641 or not. The clipboard register can always be
1642 explicitly accessed using the "* notation. Also see
1643 |gui-clipboard|.
1644
Bram Moolenaar30b65812012-07-12 22:01:11 +02001645 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001646 unnamedplus A variant of the "unnamed" flag which uses the
1647 clipboard register '+' (|quoteplus|) instead of
1648 register '*' for all yank, delete, change and put
1649 operations which would normally go to the unnamed
1650 register. When "unnamed" is also included to the
1651 option, yank operations (but not delete, change or
1652 put) will additionally copy the text into register
1653 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001654 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001655 Availability can be checked with: >
1656 if has('unnamedplus')
1657<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001658 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 autoselect Works like the 'a' flag in 'guioptions': If present,
1660 then whenever Visual mode is started, or the Visual
1661 area extended, Vim tries to become the owner of the
1662 windowing system's global selection or put the
1663 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001664 register "*. See |'go-a'| and |quotestar| for details.
1665 When the GUI is active, the 'a' flag in 'guioptions'
1666 is used, when the GUI is not active, this "autoselect"
1667 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 Also applies to the modeless selection.
1669
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001670 *clipboard-autoselectplus*
1671 autoselectplus Like "autoselect" but using the + register instead of
1672 the * register. Compare to the 'P' flag in
1673 'guioptions'.
1674
1675 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 autoselectml Like "autoselect", but for the modeless selection
1677 only. Compare to the 'A' flag in 'guioptions'.
1678
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001679 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001680 html When the clipboard contains HTML, use this when
1681 pasting. When putting text on the clipboard, mark it
1682 as HTML. This works to copy rendered HTML from
1683 Firefox, paste it as raw HTML in Vim, select the HTML
1684 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001685 You probably want to add this only temporarily,
1686 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001687 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001688
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001689 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690 exclude:{pattern}
1691 Defines a pattern that is matched against the name of
1692 the terminal 'term'. If there is a match, no
1693 connection will be made to the X server. This is
1694 useful in this situation:
1695 - Running Vim in a console.
1696 - $DISPLAY is set to start applications on another
1697 display.
1698 - You do not want to connect to the X server in the
1699 console, but do want this in a terminal emulator.
1700 To never connect to the X server use: >
1701 exclude:.*
1702< This has the same effect as using the |-X| argument.
1703 Note that when there is no connection to the X server
1704 the window title won't be restored and the clipboard
1705 cannot be accessed.
1706 The value of 'magic' is ignored, {pattern} is
1707 interpreted as if 'magic' was on.
1708 The rest of the option value will be used for
1709 {pattern}, this must be the last entry.
1710
1711 *'cmdheight'* *'ch'*
1712'cmdheight' 'ch' number (default 1)
1713 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 Number of screen lines to use for the command-line. Helps avoiding
1715 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001716 The value of this option is stored with the tab page, so that each tab
1717 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718
1719 *'cmdwinheight'* *'cwh'*
1720'cmdwinheight' 'cwh' number (default 7)
1721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 Number of screen lines to use for the command-line window. |cmdwin|
1723
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001724 *'colorcolumn'* *'cc'*
1725'colorcolumn' 'cc' string (default "")
1726 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001727 {not available when compiled without the |+syntax|
1728 feature}
1729 'colorcolumn' is a comma separated list of screen columns that are
1730 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1731 text. Will make screen redrawing slower.
1732 The screen column can be an absolute number, or a number preceded with
1733 '+' or '-', which is added to or subtracted from 'textwidth'. >
1734
1735 :set cc=+1 " highlight column after 'textwidth'
1736 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1737 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1738<
1739 When 'textwidth' is zero then the items with '-' and '+' are not used.
1740 A maximum of 256 columns are highlighted.
1741
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 *'columns'* *'co'* *E594*
1743'columns' 'co' number (default 80 or terminal width)
1744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001746 initialization and does not have to be set by hand. Also see
1747 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 When Vim is running in the GUI or in a resizable window, setting this
1749 option will cause the window size to be changed. When you only want
1750 to use the size for the GUI, put the command in your |gvimrc| file.
1751 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001752 number of columns of the display, the display may be messed up. For
1753 the GUI it is always possible and Vim limits the number of columns to
1754 what fits on the screen. You can use this command to get the widest
1755 window possible: >
1756 :set columns=9999
1757< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758
1759 *'comments'* *'com'* *E524* *E525*
1760'comments' 'com' string (default
1761 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1762 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 A comma separated list of strings that can start a comment line. See
1764 |format-comments|. See |option-backslash| about using backslashes to
1765 insert a space.
1766
1767 *'commentstring'* *'cms'* *E537*
1768'commentstring' 'cms' string (default "/*%s*/")
1769 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770 {not available when compiled without the |+folding|
1771 feature}
1772 A template for a comment. The "%s" in the value is replaced with the
1773 comment text. Currently only used to add markers for folding, see
1774 |fold-marker|.
1775
1776 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001777'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001778 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 This option has the effect of making Vim either more Vi-compatible, or
1781 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001782
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001784 other options are also changed as a side effect.
1785 NOTE: Setting or resetting this option can have a lot of unexpected
1786 effects: Mappings are interpreted in another way, undo behaves
1787 differently, etc. If you set this option in your vimrc file, you
1788 should probably put it at the very start.
1789
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 By default this option is on and the Vi defaults are used for the
1791 options. This default was chosen for those people who want to use Vim
1792 just like Vi, and don't even (want to) know about the 'compatible'
1793 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001794 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001795 this option is switched off, and all options that have not been
1796 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001797 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001798 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001799 happen for the system-wide vimrc or gvimrc file, nor for a file given
1800 with the |-u| argument). Also see |compatible-default| and
1801 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 You can also set this option with the "-C" argument, and reset it with
1803 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001804 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805
Bram Moolenaar214641f2017-03-05 17:04:09 +01001806 When this option is set, numerous other options are set to make Vim as
1807 Vi-compatible as possible. When this option is unset, various options
1808 are set to make Vim more useful. The table below lists all the
1809 options affected.
1810 The {?} column indicates when the options are affected:
1811 + Means that the option is set to the value given in {set value} when
1812 'compatible' is set.
1813 & Means that the option is set to the value given in {set value} when
1814 'compatible' is set AND is set to its Vim default value when
1815 'compatible' is unset.
1816 - Means the option is NOT changed when setting 'compatible' but IS
1817 set to its Vim default when 'compatible' is unset.
1818 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819
Bram Moolenaar036986f2017-03-16 17:41:02 +01001820 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001821
1822 'allowrevins' + off no CTRL-_ command
1823 'antialias' + off don't use antialiased fonts
1824 'arabic' + off reset arabic-related options
1825 'arabicshape' + on correct character shapes
1826 'backspace' + "" normal backspace
1827 'backup' + off no backup file
1828 'backupcopy' & Unix: "yes" backup file is a copy
1829 else: "auto" copy or rename backup file
1830 'balloonexpr' + "" text to show in evaluation balloon
1831 'breakindent' + off don't indent when wrapping lines
1832 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1833 'cindent' + off no C code indentation
1834 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1835 'copyindent' + off don't copy indent structure
1836 'cpoptions' & (all flags) Vi-compatible flags
1837 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001838 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001839 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001840 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001841 'cscopeverbose' + off see |cscopeverbose|
1842 'delcombine' + off unicode: delete whole char combination
1843 'digraph' + off no digraphs
1844 'esckeys' & off no <Esc>-keys in Insert mode
1845 'expandtab' + off tabs not expanded to spaces
1846 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001847 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001848 'formatexpr' + "" use 'formatprg' for auto-formatting
1849 'formatoptions' & "vt" Vi compatible formatting
1850 'gdefault' + off no default 'g' flag for ":s"
1851 'history' & 0 no commandline history
1852 'hkmap' + off no Hebrew keyboard mapping
1853 'hkmapp' + off no phonetic Hebrew keyboard mapping
1854 'hlsearch' + off no highlighting of search matches
1855 'incsearch' + off no incremental searching
1856 'indentexpr' + "" no indenting by expression
1857 'insertmode' + off do not start in Insert mode
1858 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001860 'joinspaces' + on insert 2 spaces after period
1861 'modeline' & off no modelines
1862 'more' & off no pauses in listings
1863 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1864 'numberwidth' & 8 min number of columns for line number
1865 'preserveindent'+ off don't preserve current indent structure
1866 when changing it
1867 'revins' + off no reverse insert
1868 'ruler' + off no ruler
1869 'scrolljump' + 1 no jump scroll
1870 'scrolloff' + 0 no scroll offset
1871 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1872 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001873 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001874 'showcmd' & off command characters not shown
1875 'showmode' & off current mode not shown
1876 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1877 'smartcase' + off no automatic ignore case switch
1878 'smartindent' + off no smart indentation
1879 'smarttab' + off no smart tab size
1880 'softtabstop' + 0 tabs are always 'tabstop' positions
1881 'startofline' + on goto startofline with some commands
1882 'tagcase' & "followic" 'ignorecase' when searching tags file
1883 'tagrelative' & off tag file names are not relative
1884 'termguicolors' + off don't use highlight-(guifg|guibg)
1885 'textauto' & off no automatic textmode detection
1886 'textwidth' + 0 no automatic line wrap
1887 'tildeop' + off tilde is not an operator
1888 'ttimeout' + off no terminal timeout
1889 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001890 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001891 'virtualedit' + "" cursor can only be placed on characters
1892 'whichwrap' & "" left-right movements don't wrap
1893 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001895 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896
1897 *'complete'* *'cpt'* *E535*
1898'complete' 'cpt' string (default: ".,w,b,u,t,i")
1899 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 This option specifies how keyword completion |ins-completion| works
1901 when CTRL-P or CTRL-N are used. It is also used for whole-line
1902 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1903 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001904 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 w scan buffers from other windows
1906 b scan other loaded buffers that are in the buffer list
1907 u scan the unloaded buffers that are in the buffer list
1908 U scan the buffers that are not in the buffer list
1909 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001910 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 k{dict} scan the file {dict}. Several "k" flags can be given,
1912 patterns are valid too. For example: >
1913 :set cpt=k/usr/dict/*,k~/spanish
1914< s scan the files given with the 'thesaurus' option
1915 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1916 are valid too.
1917 i scan current and included files
1918 d scan current and included files for defined name or macro
1919 |i_CTRL-X_CTRL-D|
1920 ] tag completion
1921 t same as "]"
1922
1923 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1924 not executed, this may lead to unexpected completions from some files
1925 (gzipped files for example). Unloaded buffers are not scanned for
1926 whole-line completion.
1927
1928 The default is ".,w,b,u,t,i", which means to scan:
1929 1. the current buffer
1930 2. buffers in other windows
1931 3. other loaded buffers
1932 4. unloaded buffers
1933 5. tags
1934 6. included files
1935
1936 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001937 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1938 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001939
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001940 *'completefunc'* *'cfu'*
1941'completefunc' 'cfu' string (default: empty)
1942 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001943 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001944 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001945 This option specifies a function to be used for Insert mode completion
1946 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001947 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00001948 invoked and what it should return. The value can be the name of a
1949 function, a |lambda| or a |Funcref|. See |option-value-function| for
1950 more information.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001951 This option cannot be set from a |modeline| or in the |sandbox|, for
1952 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001953
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001954 *'completeslash'* *'csl'*
1955'completeslash' 'csl' string (default: "")
1956 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001957 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001958 When this option is set it overrules 'shellslash' for completion:
1959 - When this option is set to "slash", a forward slash is used for path
1960 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001961 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001962 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001963 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001964 - When this option is empty, same character is used as for
1965 'shellslash'.
1966 For Insert mode completion the buffer-local value is used. For
1967 command line completion the global value is used.
1968
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001969 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001970'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001971 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001972 A comma separated list of options for Insert mode completion
1973 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001974
1975 menu Use a popup menu to show the possible completions. The
1976 menu is only shown when there is more than one match and
1977 sufficient colors are available. |ins-completion-menu|
1978
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001979 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001980 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001981 match, e.g., what file it comes from.
1982
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001983 longest Only insert the longest common text of the matches. If
1984 the menu is displayed you can use CTRL-L to add more
1985 characters. Whether case is ignored depends on the kind
1986 of completion. For buffer text the 'ignorecase' option is
1987 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001988
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001989 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001990 completion in the preview window. Only works in
1991 combination with "menu" or "menuone".
1992
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001993 popup Show extra information about the currently selected
1994 completion in a popup window. Only works in combination
1995 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001996 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001997 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001998
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001999 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01002000 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02002001 |CompleteChanged| autocommand to fetch the info and call
2002 |popup_show()| once the popup has been filled.
2003 See the example at |complete-popuphidden|.
2004 {only works when compiled with the |+textprop| feature}
2005
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02002006 noinsert Do not insert any text for a match until the user selects
2007 a match from the menu. Only works in combination with
2008 "menu" or "menuone". No effect if "longest" is present.
2009
2010 noselect Do not select a match in the menu, force the user to
2011 select one from the menu. Only works in combination with
2012 "menu" or "menuone".
2013
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00002014
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002015 *'completepopup'* *'cpp'*
2016'completepopup' 'cpp' string (default empty)
2017 global
2018 {not available when compiled without the |+textprop|
2019 or |+quickfix| feature}
2020 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002021 properties of the info popup when it is created. If an info popup
2022 window already exists it is closed, so that the option value is
2023 applied when it is created again.
2024 You can also use |popup_findinfo()| and then set properties for an
2025 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002026
2027
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002028 *'concealcursor'* *'cocu'*
2029'concealcursor' 'cocu' string (default: "")
2030 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002031 {not available when compiled without the |+conceal|
2032 feature}
2033 Sets the modes in which text in the cursor line can also be concealed.
2034 When the current mode is listed then concealing happens just like in
2035 other lines.
2036 n Normal mode
2037 v Visual mode
2038 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002039 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002040
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002041 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002042 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002043 are moving around text is concealed, but when starting to insert text
2044 or selecting a Visual area the concealed text is displayed, so that
2045 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002046 Keep in mind that the cursor position is not always where it's
2047 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002048
2049
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002050 *'conceallevel'* *'cole'*
2051'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002052 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002053 {not available when compiled without the |+conceal|
2054 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002055 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2056 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002057
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002058 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002059 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002060 1 Each block of concealed text is replaced with one
2061 character. If the syntax item does not have a custom
2062 replacement character defined (see |:syn-cchar|) the
2063 character defined in 'listchars' is used (default is a
2064 space).
2065 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002066 2 Concealed text is completely hidden unless it has a
2067 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002068 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002069 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002070
Bram Moolenaara7781e02010-07-19 20:13:22 +02002071 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002072 edit and copy the text. This can be changed with the 'concealcursor'
2073 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002074
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2076'confirm' 'cf' boolean (default off)
2077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 When 'confirm' is on, certain operations that would normally
2079 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2080 instead raise a |dialog| asking if you wish to save the current
2081 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2082 If 'confirm' is off you can still activate confirmation for one
2083 command only (this is most useful in mappings) with the |:confirm|
2084 command.
2085 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2086
2087 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2088'conskey' 'consk' boolean (default off)
2089 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002090 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091
2092 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2093'copyindent' 'ci' boolean (default off)
2094 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 Copy the structure of the existing lines indent when autoindenting a
2096 new line. Normally the new indent is reconstructed by a series of
2097 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2098 in which case only spaces are used). Enabling this option makes the
2099 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002100 existing line. 'expandtab' has no effect on these characters, a Tab
2101 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002103 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 Also see 'preserveindent'.
2105
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002106 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107'cpoptions' 'cpo' string (Vim default: "aABceFs",
2108 Vi default: all flags)
2109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002111 this indicates Vi-compatible behavior. This is used for things where
2112 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113 'cpoptions' stands for "compatible-options".
2114 Commas can be added for readability.
2115 To avoid problems with flags that are added in the future, use the
2116 "+=" and "-=" feature of ":set" |add-option-flags|.
2117 NOTE: This option is set to the Vi default value when 'compatible' is
2118 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002119 NOTE: This option is set to the POSIX default value at startup when
2120 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002121 variable exists |posix|. This means Vim tries to behave like the
2122 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123
2124 contains behavior ~
2125 *cpo-a*
2126 a When included, a ":read" command with a file name
2127 argument will set the alternate file name for the
2128 current window.
2129 *cpo-A*
2130 A When included, a ":write" command with a file name
2131 argument will set the alternate file name for the
2132 current window.
2133 *cpo-b*
2134 b "\|" in a ":map" command is recognized as the end of
2135 the map command. The '\' is included in the mapping,
2136 the text after the '|' is interpreted as the next
2137 command. Use a CTRL-V instead of a backslash to
2138 include the '|' in the mapping. Applies to all
2139 mapping, abbreviation, menu and autocmd commands.
2140 See also |map_bar|.
2141 *cpo-B*
2142 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002143 abbreviations, user commands and the "to" part of the
2144 menu commands. Remove this flag to be able to use a
2145 backslash like a CTRL-V. For example, the command
2146 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 'B' included: "\^[" (^[ is a real <Esc>)
2148 'B' excluded: "<Esc>" (5 characters)
2149 ('<' excluded in both cases)
2150 *cpo-c*
2151 c Searching continues at the end of any match at the
2152 cursor position, but not further than the start of the
2153 next line. When not present searching continues
2154 one character from the cursor position. With 'c'
2155 "abababababab" only gets three matches when repeating
2156 "/abab", without 'c' there are five matches.
2157 *cpo-C*
2158 C Do not concatenate sourced lines that start with a
2159 backslash. See |line-continuation|.
2160 *cpo-d*
2161 d Using "./" in the 'tags' option doesn't mean to use
2162 the tags file relative to the current file, but the
2163 tags file in the current directory.
2164 *cpo-D*
2165 D Can't use CTRL-K to enter a digraph after Normal mode
2166 commands with a character argument, like |r|, |f| and
2167 |t|.
2168 *cpo-e*
2169 e When executing a register with ":@r", always add a
2170 <CR> to the last line, also when the register is not
2171 linewise. If this flag is not present, the register
2172 is not linewise and the last line does not end in a
2173 <CR>, then the last line is put on the command-line
2174 and can be edited before hitting <CR>.
2175 *cpo-E*
2176 E It is an error when using "y", "d", "c", "g~", "gu" or
2177 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002178 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 This makes "y0" fail in the first column.
2180 *cpo-f*
2181 f When included, a ":read" command with a file name
2182 argument will set the file name for the current buffer,
2183 if the current buffer doesn't have a file name yet.
2184 *cpo-F*
2185 F When included, a ":write" command with a file name
2186 argument will set the file name for the current
2187 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002188 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 *cpo-g*
2190 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002191 *cpo-H*
2192 H When using "I" on a line with only blanks, insert
2193 before the last blank. Without this flag insert after
2194 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 *cpo-i*
2196 i When included, interrupting the reading of a file will
2197 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002198 *cpo-I*
2199 I When moving the cursor up or down just after inserting
2200 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 *cpo-j*
2202 j When joining lines, only add two spaces after a '.',
2203 not after '!' or '?'. Also see 'joinspaces'.
2204 *cpo-J*
2205 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002206 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 white space.
2208 *cpo-k*
2209 k Disable the recognition of raw key codes in
2210 mappings, abbreviations, and the "to" part of menu
2211 commands. For example, if <Key> sends ^[OA (where ^[
2212 is <Esc>), the command ":map X ^[OA" results in X
2213 being mapped to:
2214 'k' included: "^[OA" (3 characters)
2215 'k' excluded: "<Key>" (one key code)
2216 Also see the '<' flag below.
2217 *cpo-K*
2218 K Don't wait for a key code to complete when it is
2219 halfway a mapping. This breaks mapping <F1><F1> when
2220 only part of the second <F1> has been read. It
2221 enables cancelling the mapping by typing <F1><Esc>.
2222 *cpo-l*
2223 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002224 literally, only "\]", "\^", "\-" and "\\" are special.
2225 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2227 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002228 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 *cpo-L*
2230 L When the 'list' option is set, 'wrapmargin',
2231 'textwidth', 'softtabstop' and Virtual Replace mode
2232 (see |gR|) count a <Tab> as two characters, instead of
2233 the normal behavior of a <Tab>.
2234 *cpo-m*
2235 m When included, a showmatch will always wait half a
2236 second. When not included, a showmatch will wait half
2237 a second or until a character is typed. |'showmatch'|
2238 *cpo-M*
2239 M When excluded, "%" matching will take backslashes into
2240 account. Thus in "( \( )" and "\( ( \)" the outer
2241 parenthesis match. When included "%" ignores
2242 backslashes, which is Vi compatible.
2243 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002244 n When included, the column used for 'number' and
2245 'relativenumber' will also be used for text of wrapped
2246 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 *cpo-o*
2248 o Line offset to search command is not remembered for
2249 next search.
2250 *cpo-O*
2251 O Don't complain if a file is being overwritten, even
2252 when it didn't exist when editing it. This is a
2253 protection against a file unexpectedly created by
2254 someone else. Vi didn't complain about this.
2255 *cpo-p*
2256 p Vi compatible Lisp indenting. When not present, a
2257 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002258 *cpo-P*
2259 P When included, a ":write" command that appends to a
2260 file will set the file name for the current buffer, if
2261 the current buffer doesn't have a file name yet and
2262 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002263 *cpo-q*
2264 q When joining multiple lines leave the cursor at the
2265 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 *cpo-r*
2267 r Redo ("." command) uses "/" to repeat a search
2268 command, instead of the actually used search string.
2269 *cpo-R*
2270 R Remove marks from filtered lines. Without this flag
2271 marks are kept like |:keepmarks| was used.
2272 *cpo-s*
2273 s Set buffer options when entering the buffer for the
2274 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002275 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276 set when the buffer is created.
2277 *cpo-S*
2278 S Set buffer options always when entering a buffer
2279 (except 'readonly', 'fileformat', 'filetype' and
2280 'syntax'). This is the (most) Vi compatible setting.
2281 The options are set to the values in the current
2282 buffer. When you change an option and go to another
2283 buffer, the value is copied. Effectively makes the
2284 buffer options global to all buffers.
2285
2286 's' 'S' copy buffer options
2287 no no when buffer created
2288 yes no when buffer first entered (default)
2289 X yes each time when buffer entered (vi comp.)
2290 *cpo-t*
2291 t Search pattern for the tag command is remembered for
2292 "n" command. Otherwise Vim only puts the pattern in
2293 the history for search pattern, but doesn't change the
2294 last used search pattern.
2295 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002296 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 *cpo-v*
2298 v Backspaced characters remain visible on the screen in
2299 Insert mode. Without this flag the characters are
2300 erased from the screen right away. With this flag the
2301 screen newly typed text overwrites backspaced
2302 characters.
2303 *cpo-w*
2304 w When using "cw" on a blank character, only change one
2305 character and not all blanks until the start of the
2306 next word.
2307 *cpo-W*
2308 W Don't overwrite a readonly file. When omitted, ":w!"
2309 overwrites a readonly file, if possible.
2310 *cpo-x*
2311 x <Esc> on the command-line executes the command-line.
2312 The default in Vim is to abandon the command-line,
2313 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002314 *cpo-X*
2315 X When using a count with "R" the replaced text is
2316 deleted only once. Also when repeating "R" with "."
2317 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002319 y A yank command can be redone with ".". Think twice if
2320 you really want to use this, it may break some
2321 plugins, since most people expect "." to only repeat a
2322 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002323 *cpo-Z*
2324 Z When using "w!" while the 'readonly' option is set,
2325 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 *cpo-!*
2327 ! When redoing a filter command, use the last used
2328 external command, whatever it was. Otherwise the last
2329 used -filter- command is used.
2330 *cpo-$*
2331 $ When making a change to one line, don't redisplay the
2332 line, but put a '$' at the end of the changed text.
2333 The changed text will be overwritten when you type the
2334 new text. The line is redisplayed if you type any
2335 command that moves the cursor from the insertion
2336 point.
2337 *cpo-%*
2338 % Vi-compatible matching is done for the "%" command.
2339 Does not recognize "#if", "#endif", etc.
2340 Does not recognize "/*" and "*/".
2341 Parens inside single and double quotes are also
2342 counted, causing a string that contains a paren to
2343 disturb the matching. For example, in a line like
2344 "if (strcmp("foo(", s))" the first paren does not
2345 match the last one. When this flag is not included,
2346 parens inside single and double quotes are treated
2347 specially. When matching a paren outside of quotes,
2348 everything inside quotes is ignored. When matching a
2349 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002350 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002351 This flag is also used for other features, such as
2352 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002353 *cpo--*
2354 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002355 it would go above the first line or below the last
2356 line. Without it the cursor moves to the first or
2357 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002358 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002359 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002360 *cpo-+*
2361 + When included, a ":write file" command will reset the
2362 'modified' flag of the buffer, even though the buffer
2363 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002364 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 * Use ":*" in the same way as ":@". When not included,
2366 ":*" is an alias for ":'<,'>", select the Visual area.
2367 *cpo-<*
2368 < Disable the recognition of special key codes in |<>|
2369 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002370 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 ":map X <Tab>" results in X being mapped to:
2372 '<' included: "<Tab>" (5 characters)
2373 '<' excluded: "^I" (^I is a real <Tab>)
2374 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002375 *cpo->*
2376 > When appending to a register, put a line break before
2377 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002378 *cpo-;*
2379 ; When using |,| or |;| to repeat the last |t| search
2380 and the cursor is right in front of the searched
2381 character, the cursor won't move. When not included,
2382 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002383 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002384
2385 POSIX flags. These are not included in the Vi default value, except
2386 when $VIM_POSIX was set on startup. |posix|
2387
2388 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002389 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002390 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002391 *cpo-&*
2392 & When ":preserve" was used keep the swap file when
2393 exiting normally while this buffer is still loaded.
2394 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002395 *cpo-\*
2396 \ Backslash in a [] range in a search pattern is taken
2397 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002398 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2399 '\' excluded: "/[ \-]" finds <Space> and '-'
2400 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002401 *cpo-/*
2402 / When "%" is used as the replacement string in a |:s|
2403 command, use the previous replacement string. |:s%|
2404 *cpo-{*
2405 { The |{| and |}| commands also stop at a "{" character
2406 at the start of a line.
2407 *cpo-.*
2408 . The ":chdir" and ":cd" commands fail if the current
2409 buffer is modified, unless ! is used. Vim doesn't
2410 need this, since it remembers the full path of an
2411 opened file.
2412 *cpo-bar*
2413 | The value of the $LINES and $COLUMNS environment
2414 variables overrule the terminal size values obtained
2415 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002416
Bram Moolenaar071d4272004-06-13 20:20:40 +00002417
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002418 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002419'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002420 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002421 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002422 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002423 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002424 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002425 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002426 blowfish Blowfish method. Medium strong encryption but it has
2427 an implementation flaw. Requires Vim 7.3 or later,
2428 files can NOT be read by Vim 7.2 and older. This adds
2429 a "seed" to the file, every time you write the file
2430 the encrypted bytes will be different.
2431 *blowfish2*
2432 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002433 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002434 and older. This adds a "seed" to the file, every time
2435 you write the file the encrypted bytes will be
2436 different. The whole undo file is encrypted, not just
2437 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002438 *E1193* *E1194* *E1195* *E1196*
2439 *E1197* *E1198* *E1199* *E1200* *E1201*
2440 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2441 Code. Medium strong till strong encryption.
2442 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002443 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002444 It adds a seed and a message authentication code (MAC)
2445 to the file. This needs at least a Vim 8.2.3022 to
2446 read the encrypted file.
2447 Encryption of swap files is not supported, therefore
2448 no swap file will be used when xchacha20 encryption is
2449 enabled.
2450 Encryption of undo files is not yet supported,
2451 therefore no undo file will currently be written.
2452 CURRENTLY EXPERIMENTAL: Files written with this method
2453 might have to be read back with the same version of
2454 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002455
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002456 You should use "blowfish2", also to re-encrypt older files.
2457
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002458 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002459 to the detected method of the file being read. Thus if you write it
2460 without changing 'cryptmethod' the same method will be used.
2461 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002462 explicitly write it, you don't get a warning unless there are other
2463 modifications. Also see |:X|.
2464
2465 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002466 the value "blowfish2". When setting the local value to an empty
2467 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002468
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002469 When a new encryption method is added in a later version of Vim, and
2470 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002471 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002472
2473
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 *'cscopepathcomp'* *'cspc'*
2475'cscopepathcomp' 'cspc' number (default 0)
2476 global
2477 {not available when compiled without the |+cscope|
2478 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 Determines how many components of the path to show in a list of tags.
2480 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002481 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482
2483 *'cscopeprg'* *'csprg'*
2484'cscopeprg' 'csprg' string (default "cscope")
2485 global
2486 {not available when compiled without the |+cscope|
2487 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 Specifies the command to execute cscope. See |cscopeprg|.
2489 This option cannot be set from a |modeline| or in the |sandbox|, for
2490 security reasons.
2491
2492 *'cscopequickfix'* *'csqf'*
2493'cscopequickfix' 'csqf' string (default "")
2494 global
2495 {not available when compiled without the |+cscope|
2496 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 Specifies whether to use quickfix window to show cscope results.
2498 See |cscopequickfix|.
2499
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002500 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002501'cscoperelative' 'csre' boolean (default off)
2502 global
2503 {not available when compiled without the |+cscope|
2504 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002505 In the absence of a prefix (-P) for cscope. setting this option enables
2506 to use the basename of cscope.out path as the prefix.
2507 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002508 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002509
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2511'cscopetag' 'cst' boolean (default off)
2512 global
2513 {not available when compiled without the |+cscope|
2514 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 Use cscope for tag commands. See |cscope-options|.
2516 NOTE: This option is reset when 'compatible' is set.
2517
2518 *'cscopetagorder'* *'csto'*
2519'cscopetagorder' 'csto' number (default 0)
2520 global
2521 {not available when compiled without the |+cscope|
2522 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 Determines the order in which ":cstag" performs a search. See
2524 |cscopetagorder|.
2525 NOTE: This option is set to 0 when 'compatible' is set.
2526
2527 *'cscopeverbose'* *'csverb'*
2528 *'nocscopeverbose'* *'nocsverb'*
2529'cscopeverbose' 'csverb' boolean (default off)
2530 global
2531 {not available when compiled without the |+cscope|
2532 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 Give messages when adding a cscope database. See |cscopeverbose|.
2534 NOTE: This option is reset when 'compatible' is set.
2535
Bram Moolenaar860cae12010-06-05 23:22:07 +02002536 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2537'cursorbind' 'crb' boolean (default off)
2538 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002539 When this option is set, as the cursor in the current
2540 window moves other cursorbound windows (windows that also have
2541 this option set) move their cursors to the corresponding line and
2542 column. This option is useful for viewing the
2543 differences between two versions of a file (see 'diff'); in diff mode,
2544 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002545 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002546
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002547
2548 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2549'cursorcolumn' 'cuc' boolean (default off)
2550 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002551 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002552 feature}
2553 Highlight the screen column of the cursor with CursorColumn
2554 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2555 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002556 If you only want the highlighting in the current window you can use
2557 these autocommands: >
2558 au WinLeave * set nocursorline nocursorcolumn
2559 au WinEnter * set cursorline cursorcolumn
2560<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002561
2562 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2563'cursorline' 'cul' boolean (default off)
2564 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002565 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002566 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002567 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2568 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002569 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002570 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002571
2572
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002573 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002574'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002575 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002576 {not available when compiled without the |+syntax|
2577 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002578 Comma separated list of settings for how 'cursorline' is displayed.
2579 Valid values:
2580 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002581 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002582 "screenline" Highlight only the screen line of the cursor with
2583 CursorLine |hl-CursorLine|.
2584 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002585 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002586
2587 Special value:
2588 "both" Alias for the values "line,number".
2589
2590 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002591
2592
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 *'debug'*
2594'debug' string (default "")
2595 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002596 These values can be used:
2597 msg Error messages that would otherwise be omitted will be given
2598 anyway.
2599 throw Error messages that would otherwise be omitted will be given
2600 anyway and also throw an exception and set |v:errmsg|.
2601 beep A message will be given when otherwise only a beep would be
2602 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002603 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002604 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2605 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002606
2607 *'define'* *'def'*
2608'define' 'def' string (default "^\s*#\s*define")
2609 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002610 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 pattern, just like for the "/" command. This option is used for the
2612 commands like "[i" and "[d" |include-search|. The 'isident' option is
2613 used to recognize the defined name after the match:
2614 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2615 See |option-backslash| about inserting backslashes to include a space
2616 or backslash.
2617 The default value is for C programs. For C++ this value would be
2618 useful, to include const type declarations: >
2619 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002620< You can also use "\ze" just before the name and continue the pattern
2621 to check what is following. E.g. for Javascript, if a function is
2622 defined with "func_name = function(args)": >
2623 ^\s*\ze\i\+\s*=\s*function(
2624< If the function is defined with "func_name : function() {...": >
2625 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002627 To avoid that use `:let` with a single quote string: >
2628 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002629<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630
2631 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2632'delcombine' 'deco' boolean (default off)
2633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 If editing Unicode and this option is set, backspace and Normal mode
2635 "x" delete each combining character on its own. When it is off (the
2636 default) the character along with its combining characters are
2637 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002638 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639
2640 This is useful for Arabic, Hebrew and many other languages where one
2641 may have combining characters overtop of base characters, and want
2642 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002643 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644
2645 *'dictionary'* *'dict'*
2646'dictionary' 'dict' string (default "")
2647 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 List of file names, separated by commas, that are used to lookup words
2649 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2650 contain a list of words. This can be one word per line, or several
2651 words per line, separated by non-keyword characters (white space is
2652 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002653
2654 When this option is empty or an entry "spell" is present, and spell
2655 checking is enabled, words in the word lists for the currently active
2656 'spelllang' are used. See |spell|.
2657
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002658 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 after a comma are ignored, otherwise spaces are included in the file
2660 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002661 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 Where to find a list of words?
2663 - On FreeBSD, there is the file "/usr/share/dict/words".
2664 - In the Simtel archive, look in the "msdos/linguist" directory.
2665 - In "miscfiles" of the GNU collection.
2666 The use of |:set+=| and |:set-=| is preferred when adding or removing
2667 directories from the list. This avoids problems when a future version
2668 uses another default.
2669 Backticks cannot be used in this option for security reasons.
2670
2671 *'diff'* *'nodiff'*
2672'diff' boolean (default off)
2673 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 {not available when compiled without the |+diff|
2675 feature}
2676 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002677 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678
2679 *'dex'* *'diffexpr'*
2680'diffexpr' 'dex' string (default "")
2681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 {not available when compiled without the |+diff|
2683 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002684 Expression which is evaluated to obtain a diff file (either ed-style
2685 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 This option cannot be set from a |modeline| or in the |sandbox|, for
2687 security reasons.
2688
2689 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002690'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 {not available when compiled without the |+diff|
2693 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002694 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 All are optional. Items must be separated by a comma.
2696
2697 filler Show filler lines, to keep the text
2698 synchronized with a window that has inserted
2699 lines at the same position. Mostly useful
2700 when windows are side-by-side and 'scrollbind'
2701 is set.
2702
2703 context:{n} Use a context of {n} lines between a change
2704 and a fold that contains unchanged lines.
2705 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002706 When using zero the context is actually one,
2707 since folds require a line in between, also
2708 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 See |fold-diff|.
2710
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002711 iblank Ignore changes where lines are all blank. Adds
2712 the "-B" flag to the "diff" command if
2713 'diffexpr' is empty. Check the documentation
2714 of the "diff" command for what this does
2715 exactly.
2716 NOTE: the diff windows will get out of sync,
2717 because no differences between blank lines are
2718 taken into account.
2719
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 icase Ignore changes in case of text. "a" and "A"
2721 are considered the same. Adds the "-i" flag
2722 to the "diff" command if 'diffexpr' is empty.
2723
2724 iwhite Ignore changes in amount of white space. Adds
2725 the "-b" flag to the "diff" command if
2726 'diffexpr' is empty. Check the documentation
2727 of the "diff" command for what this does
2728 exactly. It should ignore adding trailing
2729 white space, but not leading white space.
2730
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002731 iwhiteall Ignore all white space changes. Adds
2732 the "-w" flag to the "diff" command if
2733 'diffexpr' is empty. Check the documentation
2734 of the "diff" command for what this does
2735 exactly.
2736
2737 iwhiteeol Ignore white space changes at end of line.
2738 Adds the "-Z" flag to the "diff" command if
2739 'diffexpr' is empty. Check the documentation
2740 of the "diff" command for what this does
2741 exactly.
2742
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002743 horizontal Start diff mode with horizontal splits (unless
2744 explicitly specified otherwise).
2745
2746 vertical Start diff mode with vertical splits (unless
2747 explicitly specified otherwise).
2748
Bram Moolenaarc8234772019-11-10 21:00:27 +01002749 closeoff When a window is closed where 'diff' is set
2750 and there is only one window remaining in the
2751 same tab page with 'diff' set, execute
2752 `:diffoff` in that window. This undoes a
2753 `:diffsplit` command.
2754
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002755 hiddenoff Do not use diff mode for a buffer when it
2756 becomes hidden.
2757
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002758 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2759 starting diff mode. Without this 2 is used.
2760
Bram Moolenaar4223d432021-02-10 13:18:17 +01002761 followwrap Follow the 'wrap' option and leave as it is.
2762
Bram Moolenaare828b762018-09-10 17:51:58 +02002763 internal Use the internal diff library. This is
2764 ignored when 'diffexpr' is set. *E960*
2765 When running out of memory when writing a
2766 buffer this item will be ignored for diffs
2767 involving that buffer. Set the 'verbose'
2768 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769
Bram Moolenaare828b762018-09-10 17:51:58 +02002770 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002771 Use the indent heuristic for the internal
2772 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002773
2774 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002775 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002776 algorithms are:
2777 myers the default algorithm
2778 minimal spend extra time to generate the
2779 smallest possible diff
2780 patience patience diff algorithm
2781 histogram histogram diff algorithm
2782
2783 Examples: >
2784 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002786 :set diffopt=internal,filler,foldcolumn:3
2787 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788<
2789 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2790'digraph' 'dg' boolean (default off)
2791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 {not available when compiled without the |+digraphs|
2793 feature}
2794 Enable the entering of digraphs in Insert mode with {char1} <BS>
2795 {char2}. See |digraphs|.
2796 NOTE: This option is reset when 'compatible' is set.
2797
2798 *'directory'* *'dir'*
2799'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002800 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 for Unix: ".,~/tmp,/var/tmp,/tmp")
2802 global
2803 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002804 Recommended value: ".,~/vimswap//" - this will put the swap file next
2805 to the edited file if possible, and in your personal swap directory
2806 otherwise. Make sure "~/vimswap//" is only readable for you.
2807
2808 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 - The swap file will be created in the first directory where this is
2810 possible.
2811 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002812 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 - A directory "." means to put the swap file in the same directory as
2814 the edited file. On Unix, a dot is prepended to the file name, so
2815 it doesn't show in a directory listing. On MS-Windows the "hidden"
2816 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002817 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2818 the swap file relative to where the edited file is. The leading "."
2819 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002820 - For Unix and Win32, if a directory ends in two path separators "//",
2821 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002822 with all path separators replaced by percent '%' signs (including
2823 the colon following the drive letter on Win32). This will ensure
2824 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002825 On Win32, it is also possible to end with "\\". However, When a
2826 separating comma is following, you must use "//", since "\\" will
2827 include the comma in the file name. Therefore it is recommended to
2828 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 - Spaces after the comma are ignored, other spaces are considered part
2830 of the directory name. To have a space at the start of a directory
2831 name, precede it with a backslash.
2832 - To include a comma in a directory name precede it with a backslash.
2833 - A directory name may end in an ':' or '/'.
2834 - Environment variables are expanded |:set_env|.
2835 - Careful with '\' characters, type one before a space, type two to
2836 get one in the option (see |option-backslash|), for example: >
2837 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2838< - For backwards compatibility with Vim version 3.0 a '>' at the start
2839 of the option is removed.
2840 Using "." first in the list is recommended. This means that editing
2841 the same file twice will result in a warning. Using "/tmp" on Unix is
2842 discouraged: When the system crashes you lose the swap file.
2843 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002844 choice than "/tmp". But others on the computer may be able to see the
2845 files, and it can contain a lot of files, your swap files get lost in
2846 the crowd. That is why a "tmp" directory in your home directory is
2847 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 The use of |:set+=| and |:set-=| is preferred when adding or removing
2849 directories from the list. This avoids problems when a future version
2850 uses another default.
2851 This option cannot be set from a |modeline| or in the |sandbox|, for
2852 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
2854 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002855'display' 'dy' string (default "", set to "truncate" in
2856 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 Change the way text is displayed. This is comma separated list of
2859 flags:
2860 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002861 in a window will be displayed. "@@@" is put in the
2862 last columns of the last screen line to indicate the
2863 rest of the line is not displayed.
2864 truncate Like "lastline", but "@@@" is displayed in the first
2865 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 uhex Show unprintable characters hexadecimal as <xx>
2867 instead of using ^C and ~C.
2868
Bram Moolenaard0796902016-09-16 20:02:31 +02002869 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002870 doesn't fit is replaced with "@" lines.
2871
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 *'eadirection'* *'ead'*
2873'eadirection' 'ead' string (default "both")
2874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 Tells when the 'equalalways' option applies:
2876 ver vertically, width of windows is not affected
2877 hor horizontally, height of windows is not affected
2878 both width and height of windows is affected
2879
2880 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2881'edcompatible' 'ed' boolean (default off)
2882 global
2883 Makes the 'g' and 'c' flags of the ":substitute" command to be
2884 toggled each time the flag is given. See |complex-change|. See
2885 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002886 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002887 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888
Bram Moolenaar03413f42016-04-12 21:07:15 +02002889 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002890'emoji' 'emo' boolean (default: on)
2891 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002892 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002893 This excludes "text emoji" characters, which are normally displayed as
2894 single width. Unfortunately there is no good specification for this
2895 and it has been determined on trial-and-error basis. Use the
2896 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002897
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002899'encoding' 'enc' string (default for MS-Windows: "utf-8",
2900 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 Sets the character encoding used inside Vim. It applies to text in
2903 the buffers, registers, Strings in expressions, text stored in the
2904 viminfo file, etc. It sets the kind of characters which Vim can work
2905 with. See |encoding-names| for the possible values.
2906
2907 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002908 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002910 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911
Bram Moolenaar865242e2010-07-14 21:12:05 +02002912 This option cannot be set from a |modeline|. It would most likely
2913 corrupt the text.
2914
Bram Moolenaar3df01732017-02-17 22:47:16 +01002915 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2916 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 'encoding', "utf-8" is the natural choice for the environment and
2918 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002919 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 versions, and to avoid changing the encoding of newly created files
2921 without your knowledge (in case 'fileencodings' is empty).
2922
2923 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002924 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 iconv() or as specified with 'charconvert'.
2926
Bram Moolenaar207f0092020-08-30 17:20:20 +02002927 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002928 can use: >
2929 if has("multi_byte_encoding")
2930<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 Normally 'encoding' will be equal to your current locale. This will
2932 be the default if Vim recognizes your environment settings. If
2933 'encoding' is not set to the current locale, 'termencoding' must be
2934 set to convert typed and displayed text. See |encoding-table|.
2935
2936 When you set this option, it fires the |EncodingChanged| autocommand
2937 event so that you can set up fonts if necessary.
2938
2939 When the option is set, the value is converted to lowercase. Thus
2940 you can set it with uppercase values too. Underscores are translated
2941 to '-' signs.
2942 When the encoding is recognized, it is changed to the standard name.
2943 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2944 "iso-8859-2" and "utf8" becomes "utf-8".
2945
2946 Note: "latin1" is also used when the encoding could not be detected.
2947 This only works when editing files in the same encoding! When the
2948 actual character set is not latin1, make sure 'fileencoding' and
2949 'fileencodings' are empty. When conversion is needed, switch to using
2950 utf-8.
2951
2952 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2953 You don't notice this while editing, but it does matter for the
2954 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2955 setting 'encoding' to one of these values instead of utf-8 only has
2956 effect for encoding used for files when 'fileencoding' is empty.
2957
Bram Moolenaar661b1822005-07-28 22:36:45 +00002958 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2959 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960
2961 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2962'endofline' 'eol' boolean (default on)
2963 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002965 is on, or 'fixeol' option is off, no <EOL> will be written for the
2966 last line in the file. This option is automatically set or reset when
2967 starting to edit a new file, depending on whether file has an <EOL>
2968 for the last line in the file. Normally you don't have to set or
2969 reset this option.
2970 When 'binary' is off and 'fixeol' is on the value is not used when
2971 writing the file. When 'binary' is on or 'fixeol' is off it is used
2972 to remember the presence of a <EOL> for the last line in the file, so
2973 that when you write the file the situation from the original file can
2974 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975
2976 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2977'equalalways' 'ea' boolean (default on)
2978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002980 splitting or closing a window. This also happens the moment the
2981 option is switched on. When off, splitting a window will reduce the
2982 size of the current window and leave the other windows the same. When
2983 closing a window the extra lines are given to the window next to it
2984 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 When mixing vertically and horizontally split windows, a minimal size
2986 is computed and some windows may be larger if there is room. The
2987 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002988 Changing the height and width of a window can be avoided by setting
2989 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002990 If a window size is specified when creating a new window sizes are
2991 currently not equalized (it's complicated, but may be implemented in
2992 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993
2994 *'equalprg'* *'ep'*
2995'equalprg' 'ep' string (default "")
2996 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002998 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002999 or 'indentexpr'. When Vim was compiled without internal formatting,
3000 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003001 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 about including spaces and backslashes.
3003 This option cannot be set from a |modeline| or in the |sandbox|, for
3004 security reasons.
3005
3006 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
3007'errorbells' 'eb' boolean (default off)
3008 global
3009 Ring the bell (beep or screen flash) for error messages. This only
3010 makes a difference for error messages, the bell will be used always
3011 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003012 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02003013 screen flash or do nothing. See 'belloff' to finetune when to ring the
3014 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015
3016 *'errorfile'* *'ef'*
3017'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3018 others: "errors.err")
3019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 {not available when compiled without the |+quickfix|
3021 feature}
3022 Name of the errorfile for the QuickFix mode (see |:cf|).
3023 When the "-q" command-line argument is used, 'errorfile' is set to the
3024 following argument. See |-q|.
3025 NOT used for the ":make" command. See 'makeef' for that.
3026 Environment variables are expanded |:set_env|.
3027 See |option-backslash| about including spaces and backslashes.
3028 This option cannot be set from a |modeline| or in the |sandbox|, for
3029 security reasons.
3030
3031 *'errorformat'* *'efm'*
3032'errorformat' 'efm' string (default is very long)
3033 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 {not available when compiled without the |+quickfix|
3035 feature}
3036 Scanf-like description of the format for the lines in the error file
3037 (see |errorformat|).
3038
3039 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3040'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 Function keys that start with an <Esc> are recognized in Insert
3043 mode. When this option is off, the cursor and function keys cannot be
3044 used in Insert mode if they start with an <Esc>. The advantage of
3045 this is that the single <Esc> is recognized immediately, instead of
3046 after one second. Instead of resetting this option, you might want to
3047 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3048 when 'esckeys' is off, you can still map anything, but the cursor keys
3049 won't work by default.
3050 NOTE: This option is set to the Vi default value when 'compatible' is
3051 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003052 NOTE: when this option is off then the |modifyOtherKeys| functionality
3053 is disabled while in Insert mode to avoid ending Insert mode with any
3054 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055
3056 *'eventignore'* *'ei'*
3057'eventignore' 'ei' string (default "")
3058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003060 When set to "all" or when "all" is one of the items, all autocommand
3061 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 Otherwise this is a comma separated list of event names. Example: >
3063 :set ei=WinEnter,WinLeave
3064<
3065 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3066'expandtab' 'et' boolean (default off)
3067 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003069 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3071 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003072 This option is reset when the 'paste' option is set and restored when
3073 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 NOTE: This option is reset when 'compatible' is set.
3075
3076 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3077'exrc' 'ex' boolean (default off)
3078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003080 directory.
3081
3082 Setting this option is a potential security leak. E.g., consider
3083 unpacking a package or fetching files from github, a .vimrc in there
3084 might be a trojan horse. BETTER NOT SET THIS OPTION!
3085 Instead, define an autocommand in your .vimrc to set options for a
3086 matching directory.
3087
3088 If you do switch this option on you should also consider setting the
3089 'secure' option (see |initialization|).
3090 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 This option cannot be set from a |modeline| or in the |sandbox|, for
3092 security reasons.
3093
3094 *'fileencoding'* *'fenc'* *E213*
3095'fileencoding' 'fenc' string (default: "")
3096 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003098
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003100 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 When 'fileencoding' is empty, the same value as 'encoding' will be
3102 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003103 No error will be given when the value is set, only when it is used,
3104 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003105 Conversion will also be done when 'encoding' and 'fileencoding' are
3106 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3107 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003109 'encoding' is "utf-8" or another Unicode encoding, conversion
3110 is most likely done in a way that the reverse conversion
3111 results in the same text. When 'encoding' is not "utf-8" some
3112 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003113
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 See 'encoding' for the possible values. Additionally, values may be
3115 specified that can be handled by the converter, see
3116 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003117
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 When reading a file 'fileencoding' will be set from 'fileencodings'.
3119 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003120 'fileencoding', use the |++enc| argument. One exception: when
3121 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003122 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003123
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3125 When the option is set, the value is converted to lowercase. Thus
3126 you can set it with uppercase values too. '_' characters are
3127 replaced with '-'. If a name is recognized from the list for
3128 'encoding', it is replaced by the standard name. For example
3129 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003130
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 When this option is set, after starting to edit a file, the 'modified'
3132 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003133
3134 Keep in mind that changing 'fenc' from a modeline happens
3135 AFTER the text has been read, thus it applies to when the file will be
3136 written. If you do set 'fenc' in a modeline, you might want to set
3137 'nomodified' to avoid not being able to ":q".
3138
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 This option can not be changed when 'modifiable' is off.
3140
3141 *'fe'*
3142 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003143 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 old short name was 'fe', which is no longer used.
3145
3146 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003147'fileencodings' 'fencs' string (default: "ucs-bom",
3148 "ucs-bom,utf-8,default,latin1" when
3149 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 This is a list of character encodings considered when starting to edit
3152 an existing file. When a file is read, Vim tries to use the first
3153 mentioned character encoding. If an error is detected, the next one
3154 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003155 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 an empty string, which means the value of 'encoding' is used.
3157 WARNING: Conversion can cause loss of information! When
3158 'encoding' is "utf-8" (or one of the other Unicode variants)
3159 conversion is most likely done in a way that the reverse
3160 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003161 "utf-8" some non-ASCII characters may be lost! You can use
3162 the |++bad| argument to specify what is done with characters
3163 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 For an empty file or a file with only ASCII characters most encodings
3165 will work and the first entry of 'fileencodings' will be used (except
3166 "ucs-bom", which requires the BOM to be present). If you prefer
3167 another encoding use an BufReadPost autocommand event to test if your
3168 preferred encoding is to be used. Example: >
3169 au BufReadPost * if search('\S', 'w') == 0 |
3170 \ set fenc=iso-2022-jp | endif
3171< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3172 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003173 When the |++enc| argument is used then the value of 'fileencodings' is
3174 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003175 Note that 'fileencodings' is not used for a new file, the global value
3176 of 'fileencoding' is used instead. You can set it with: >
3177 :setglobal fenc=iso-8859-2
3178< This means that a non-existing file may get a different encoding than
3179 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 The special value "ucs-bom" can be used to check for a Unicode BOM
3181 (Byte Order Mark) at the start of the file. It must not be preceded
3182 by "utf-8" or another Unicode encoding for this to work properly.
3183 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3184 because Vim cannot detect an error, thus the encoding is always
3185 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003186 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003187 environment. On MS-Windows this is the system encoding. Otherwise
3188 this is the default value for 'encoding'. It is useful when
3189 'encoding' is set to "utf-8" and your environment uses a non-latin1
3190 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003191 When 'encoding' is "utf-8" and a file contains an illegal byte
3192 sequence it won't be recognized as UTF-8. You can use the |8g8|
3193 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 WRONG VALUES: WHAT'S WRONG:
3195 latin1,utf-8 "latin1" will always be used
3196 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3197 file
3198 cp1250,latin1 "cp1250" will always be used
3199 If 'fileencodings' is empty, 'fileencoding' is not modified.
3200 See 'fileencoding' for the possible values.
3201 Setting this option does not have an effect until the next time a file
3202 is read.
3203
3204 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003205'fileformat' 'ff' string (MS-Windows default: "dos",
3206 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 This gives the <EOL> of the current buffer, which is used for
3209 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003210 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 unix <NL>
3212 mac <CR>
3213 When "dos" is used, CTRL-Z at the end of a file is ignored.
3214 See |file-formats| and |file-read|.
3215 For the character encoding of the file see 'fileencoding'.
3216 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003217 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 This option is set automatically when starting to edit a file and
3219 'fileformats' is not empty and 'binary' is off.
3220 When this option is set, after starting to edit a file, the 'modified'
3221 option is set, because the file would be different when written.
3222 This option can not be changed when 'modifiable' is off.
3223 For backwards compatibility: When this option is set to "dos",
3224 'textmode' is set, otherwise 'textmode' is reset.
3225
3226 *'fileformats'* *'ffs'*
3227'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003228 Vim+Vi MS-Windows: "dos,unix",
3229 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 Vi Cygwin: "unix,dos",
3231 Vi others: "")
3232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 This gives the end-of-line (<EOL>) formats that will be tried when
3234 starting to edit a new buffer and when reading a file into an existing
3235 buffer:
3236 - When empty, the format defined with 'fileformat' will be used
3237 always. It is not set automatically.
3238 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003239 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 'fileformats' name will be used when a file is read into an existing
3241 buffer, no matter what 'fileformat' for that buffer is set to.
3242 - When more than one name is present, separated by commas, automatic
3243 <EOL> detection will be done when reading a file. When starting to
3244 edit a file, a check is done for the <EOL>:
3245 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3246 'fileformat' is set to "dos".
3247 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003248 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003250 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3251 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003252 This means that "mac" is only chosen when:
3253 "unix" is not present or no <NL> is found in the file, and
3254 "dos" is not present or no <CR><NL> is found in the file.
3255 Except: if "unix" was chosen, but there is a <CR> before
3256 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003257 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 4. If 'fileformat' is still not set, the first name from
3259 'fileformats' is used.
3260 When reading a file into an existing buffer, the same is done, but
3261 this happens like 'fileformat' has been set appropriately for that
3262 file only, the option is not changed.
3263 When 'binary' is set, the value of 'fileformats' is not used.
3264
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003265 When Vim starts up with an empty buffer the first item is used. You
3266 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003267
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3269 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3270 done:
3271 - When 'fileformats' is empty, there is no automatic detection. Dos
3272 format will be used.
3273 - When 'fileformats' is set to one or more names, automatic detection
3274 is done. This is based on the first <NL> in the file: If there is a
3275 <CR> in front of it, Dos format is used, otherwise Unix format is
3276 used.
3277 Also see |file-formats|.
3278 For backwards compatibility: When this option is set to an empty
3279 string or one format (no comma is included), 'textauto' is reset,
3280 otherwise 'textauto' is set.
3281 NOTE: This option is set to the Vi default value when 'compatible' is
3282 set and to the Vim default value when 'compatible' is reset.
3283
Bram Moolenaarbf884932013-04-05 22:26:15 +02003284 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3285'fileignorecase' 'fic' boolean (default on for systems where case in file
3286 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003287 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003288 When set case is ignored when using file names and directories.
3289 See 'wildignorecase' for only ignoring case when doing completion.
3290
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 *'filetype'* *'ft'*
3292'filetype' 'ft' string (default: "")
3293 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 When this option is set, the FileType autocommand event is triggered.
3295 All autocommands that match with the value of this option will be
3296 executed. Thus the value of 'filetype' is used in place of the file
3297 name.
3298 Otherwise this option does not always reflect the current file type.
3299 This option is normally set when the file type is detected. To enable
3300 this use the ":filetype on" command. |:filetype|
3301 Setting this option to a different value is most useful in a modeline,
3302 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003303 Example, for in an IDL file:
3304 /* vim: set filetype=idl : */ ~
3305 |FileType| |filetypes|
3306 When a dot appears in the value then this separates two filetype
3307 names. Example:
3308 /* vim: set filetype=c.doxygen : */ ~
3309 This will use the "c" filetype first, then the "doxygen" filetype.
3310 This works both for filetype plugins and for syntax files. More than
3311 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 This option is not copied to another buffer, independent of the 's' or
3313 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003314 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315
3316 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003317'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003319 {not available when compiled without the |+folding|
3320 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 Characters to fill the statuslines and vertical separators.
3322 It is a comma separated list of items:
3323
3324 item default Used for ~
3325 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003326 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 vert:c '|' vertical separators |:vsplit|
3328 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003329 foldopen:c '-' mark the beginning of a fold
3330 foldclose:c '+' show a closed fold
3331 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003333 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003335 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003336 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 otherwise.
3338
3339 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003340 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341< This is similar to the default, except that these characters will also
3342 be used when there is highlighting.
3343
Bram Moolenaar008bff92021-03-04 21:55:58 +01003344 For "stl" and "stlnc" single-byte and multibyte characters are
3345 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003346
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 The highlighting used for these items:
3348 item highlight group ~
3349 stl:c StatusLine |hl-StatusLine|
3350 stlnc:c StatusLineNC |hl-StatusLineNC|
3351 vert:c VertSplit |hl-VertSplit|
3352 fold:c Folded |hl-Folded|
3353 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003354 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003356 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3357'fixendofline' 'fixeol' boolean (default on)
3358 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003359 When writing a file and this option is on, <EOL> at the end of file
3360 will be restored if missing. Turn this option off if you want to
3361 preserve the situation from the original file.
3362 When the 'binary' option is set the value of this option doesn't
3363 matter.
3364 See the 'endofline' option.
3365
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003367'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 {only available when compiled with the |+rightleft|
3370 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003371 This option was for using Farsi, which has been removed. See
3372 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373
3374 *'foldclose'* *'fcl'*
3375'foldclose' 'fcl' string (default "")
3376 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 {not available when compiled without the |+folding|
3378 feature}
3379 When set to "all", a fold is closed when the cursor isn't in it and
3380 its level is higher than 'foldlevel'. Useful if you want folds to
3381 automatically close when moving out of them.
3382
3383 *'foldcolumn'* *'fdc'*
3384'foldcolumn' 'fdc' number (default 0)
3385 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 {not available when compiled without the |+folding|
3387 feature}
3388 When non-zero, a column with the specified width is shown at the side
3389 of the window which indicates open and closed folds. The maximum
3390 value is 12.
3391 See |folding|.
3392
3393 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3394'foldenable' 'fen' boolean (default on)
3395 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 {not available when compiled without the |+folding|
3397 feature}
3398 When off, all folds are open. This option can be used to quickly
3399 switch between showing all text unfolded and viewing the text with
3400 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003401 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 'foldenable' is off.
3403 This option is set by commands that create a new fold or close a fold.
3404 See |folding|.
3405
3406 *'foldexpr'* *'fde'*
3407'foldexpr' 'fde' string (default: "0")
3408 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003410 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003412 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003413
Bram Moolenaar30b65812012-07-12 22:01:11 +02003414 The expression will be evaluated in the |sandbox| if set from a
3415 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003416 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003417 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003418
3419 It is not allowed to change text or jump to another window while
3420 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421
3422 *'foldignore'* *'fdi'*
3423'foldignore' 'fdi' string (default: "#")
3424 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 {not available when compiled without the |+folding|
3426 feature}
3427 Used only when 'foldmethod' is "indent". Lines starting with
3428 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003429 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 The default "#" works well for C programs. See |fold-indent|.
3431
3432 *'foldlevel'* *'fdl'*
3433'foldlevel' 'fdl' number (default: 0)
3434 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 {not available when compiled without the |+folding|
3436 feature}
3437 Sets the fold level: Folds with a higher level will be closed.
3438 Setting this option to zero will close all folds. Higher numbers will
3439 close fewer folds.
3440 This option is set by commands like |zm|, |zM| and |zR|.
3441 See |fold-foldlevel|.
3442
3443 *'foldlevelstart'* *'fdls'*
3444'foldlevelstart' 'fdls' number (default: -1)
3445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 {not available when compiled without the |+folding|
3447 feature}
3448 Sets 'foldlevel' when starting to edit another buffer in a window.
3449 Useful to always start editing with all folds closed (value zero),
3450 some folds closed (one) or no folds closed (99).
3451 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003452 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 ignores this option and closes all folds.
3454 It is also done before BufReadPre autocommands, to allow an autocmd to
3455 overrule the 'foldlevel' value for specific files.
3456 When the value is negative, it is not used.
3457
3458 *'foldmarker'* *'fmr'* *E536*
3459'foldmarker' 'fmr' string (default: "{{{,}}}")
3460 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 {not available when compiled without the |+folding|
3462 feature}
3463 The start and end marker used when 'foldmethod' is "marker". There
3464 must be one comma, which separates the start and end marker. The
3465 marker is a literal string (a regular expression would be too slow).
3466 See |fold-marker|.
3467
3468 *'foldmethod'* *'fdm'*
3469'foldmethod' 'fdm' string (default: "manual")
3470 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 {not available when compiled without the |+folding|
3472 feature}
3473 The kind of folding used for the current window. Possible values:
3474 |fold-manual| manual Folds are created manually.
3475 |fold-indent| indent Lines with equal indent form a fold.
3476 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3477 |fold-marker| marker Markers are used to specify folds.
3478 |fold-syntax| syntax Syntax highlighting items specify folds.
3479 |fold-diff| diff Fold text that is not changed.
3480
3481 *'foldminlines'* *'fml'*
3482'foldminlines' 'fml' number (default: 1)
3483 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 {not available when compiled without the |+folding|
3485 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003486 Sets the number of screen lines above which a fold can be displayed
3487 closed. Also for manually closed folds. With the default value of
3488 one a fold can only be closed if it takes up two or more screen lines.
3489 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003490 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 "zc" to close a fold, which is displayed open because it's smaller
3492 than 'foldminlines', a following "zc" may close a containing fold.
3493
3494 *'foldnestmax'* *'fdn'*
3495'foldnestmax' 'fdn' number (default: 20)
3496 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 {not available when compiled without the |+folding|
3498 feature}
3499 Sets the maximum nesting of folds for the "indent" and "syntax"
3500 methods. This avoids that too many folds will be created. Using more
3501 than 20 doesn't work, because the internal limit is 20.
3502
3503 *'foldopen'* *'fdo'*
3504'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3505 search,tag,undo")
3506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 {not available when compiled without the |+folding|
3508 feature}
3509 Specifies for which type of commands folds will be opened, if the
3510 command moves the cursor into a closed fold. It is a comma separated
3511 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003512 NOTE: When the command is part of a mapping this option is not used.
3513 Add the |zv| command to the mapping to get the same effect.
3514 (rationale: the mapping may want to control opening folds itself)
3515
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 item commands ~
3517 all any
3518 block "(", "{", "[[", "[{", etc.
3519 hor horizontal movements: "l", "w", "fx", etc.
3520 insert any command in Insert mode
3521 jump far jumps: "G", "gg", etc.
3522 mark jumping to a mark: "'m", CTRL-O, etc.
3523 percent "%"
3524 quickfix ":cn", ":crew", ":make", etc.
3525 search search for a pattern: "/", "n", "*", "gd", etc.
3526 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003527 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 tag jumping to a tag: ":ta", CTRL-T, etc.
3529 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 When a movement command is used for an operator (e.g., "dl" or "y%")
3531 this option is not used. This means the operator will include the
3532 whole closed fold.
3533 Note that vertical movements are not here, because it would make it
3534 very difficult to move onto a closed fold.
3535 In insert mode the folds containing the cursor will always be open
3536 when text is inserted.
3537 To close folds you can re-apply 'foldlevel' with the |zx| command or
3538 set the 'foldclose' option to "all".
3539
3540 *'foldtext'* *'fdt'*
3541'foldtext' 'fdt' string (default: "foldtext()")
3542 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 {not available when compiled without the |+folding|
3544 feature}
3545 An expression which is used to specify the text displayed for a closed
3546 fold. See |fold-foldtext|.
3547
Bram Moolenaar30b65812012-07-12 22:01:11 +02003548 The expression will be evaluated in the |sandbox| if set from a
3549 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003550 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003551
3552 It is not allowed to change text or jump to another window while
3553 evaluating 'foldtext' |textlock|.
3554
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003555 *'formatexpr'* *'fex'*
3556'formatexpr' 'fex' string (default "")
3557 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003558 {not available when compiled without the |+eval|
3559 feature}
3560 Expression which is evaluated to format a range of lines for the |gq|
3561 operator or automatic formatting (see 'formatoptions'). When this
3562 option is empty 'formatprg' is used.
3563
3564 The |v:lnum| variable holds the first line to be formatted.
3565 The |v:count| variable holds the number of lines to be formatted.
3566 The |v:char| variable holds the character that is going to be
3567 inserted if the expression is being evaluated due to
3568 automatic formatting. This can be empty. Don't insert
3569 it yet!
3570
3571 Example: >
3572 :set formatexpr=mylang#Format()
3573< This will invoke the mylang#Format() function in the
3574 autoload/mylang.vim file in 'runtimepath'. |autoload|
3575
3576 The expression is also evaluated when 'textwidth' is set and adding
3577 text beyond that limit. This happens under the same conditions as
3578 when internal formatting is used. Make sure the cursor is kept in the
3579 same spot relative to the text then! The |mode()| function will
3580 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003581
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003582 When the expression evaluates to non-zero Vim will fall back to using
3583 the internal format mechanism.
3584
3585 The expression will be evaluated in the |sandbox| when set from a
3586 modeline, see |sandbox-option|. That stops the option from working,
3587 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003588 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003589 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003590
Bram Moolenaar86b68352004-12-27 21:59:20 +00003591 *'formatlistpat'* *'flp'*
3592'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3593 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003594 A pattern that is used to recognize a list header. This is used for
3595 the "n" flag in 'formatoptions'.
3596 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003597 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003598 while still checking more characters. There must be a character
3599 following the pattern, when it matches the whole line it is handled
3600 like there is no match.
3601 The default recognizes a number, followed by an optional punctuation
3602 character and white space.
3603
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003604 *'formatoptions'* *'fo'*
3605'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3606 local to buffer
3607 This is a sequence of letters which describes how automatic
3608 formatting is to be done. See |fo-table|. When the 'paste' option is
3609 on, no formatting is done (like 'formatoptions' is empty). Commas can
3610 be inserted for readability.
3611 To avoid problems with flags that are added in the future, use the
3612 "+=" and "-=" feature of ":set" |add-option-flags|.
3613 NOTE: This option is set to the Vi default value when 'compatible' is
3614 set and to the Vim default value when 'compatible' is reset.
3615
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 *'formatprg'* *'fp'*
3617'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003618 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003620 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003622 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003623 If the 'formatexpr' option is not empty it will be used instead.
3624 Otherwise, if 'formatprg' option is an empty string, the internal
3625 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003626 Environment variables are expanded |:set_env|. See |option-backslash|
3627 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003628 This option cannot be set from a |modeline| or in the |sandbox|, for
3629 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630
Bram Moolenaard94464e2015-11-02 15:28:18 +01003631 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003632'fsync' 'fs' boolean (default on)
3633 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003634 When on, the library function fsync() will be called after writing a
3635 file. This will flush a file to disk, ensuring that it is safely
3636 written even on filesystems which do metadata-only journaling. This
3637 will force the harddrive to spin up on Linux systems running in laptop
3638 mode, so it may be undesirable in some situations. Be warned that
3639 turning this off increases the chances of data loss after a crash. On
3640 systems without an fsync() implementation, this variable is always
3641 off.
3642 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003643 'fsync' also applies to |writefile()| (unless a flag is used to
3644 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003645 This option cannot be set from a |modeline| or in the |sandbox|, for
3646 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003647
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3649'gdefault' 'gd' boolean (default off)
3650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 When on, the ":substitute" flag 'g' is default on. This means that
3652 all matches in a line are substituted instead of one. When a 'g' flag
3653 is given to a ":substitute" command, this will toggle the substitution
3654 of all or one match. See |complex-change|.
3655
3656 command 'gdefault' on 'gdefault' off ~
3657 :s/// subst. all subst. one
3658 :s///g subst. one subst. all
3659 :s///gg subst. all subst. one
3660
3661 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003662 DEPRECATED: Setting this option may break plugins that are not aware
3663 of this option. Also, many users get confused that adding the /g flag
3664 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003665 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666
3667 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003668'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 Format to recognize for the ":grep" command output.
3671 This is a scanf-like string that uses the same format as the
3672 'errorformat' option: see |errorformat|.
3673
3674 *'grepprg'* *'gp'*
3675'grepprg' 'gp' string (default "grep -n ",
3676 Unix: "grep -n $* /dev/null",
3677 Win32: "findstr /n" or "grep -n",
3678 VMS: "SEARCH/NUMBERS ")
3679 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003680 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 and '#' characters, which are expanded like when used in a command-
3682 line. The placeholder "$*" is allowed to specify where the arguments
3683 will be included. Environment variables are expanded |:set_env|. See
3684 |option-backslash| about including spaces and backslashes.
3685 When your "grep" accepts the "-H" argument, use this to make ":grep"
3686 also work well with a single file: >
3687 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003688< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003689 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3690 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003691 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 apply equally to 'grepprg'.
3693 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3694 otherwise it's "grep -n".
3695 This option cannot be set from a |modeline| or in the |sandbox|, for
3696 security reasons.
3697
3698 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3699'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3700 ve:ver35-Cursor,
3701 o:hor50-Cursor,
3702 i-ci:ver25-Cursor/lCursor,
3703 r-cr:hor20-Cursor/lCursor,
3704 sm:block-Cursor
3705 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003706 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 "n-v-c:block,o:hor50,i-ci:hor15,
3708 r-cr:hor30,sm:block")
3709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003711 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003713 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003714 height of the cursor can be changed. This can be done by specifying a
3715 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003716 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3717 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003719 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 mode-list and an argument-list:
3721 mode-list:argument-list,mode-list:argument-list,..
3722 The mode-list is a dash separated list of these modes:
3723 n Normal mode
3724 v Visual mode
3725 ve Visual mode with 'selection' "exclusive" (same as 'v',
3726 if not specified)
3727 o Operator-pending mode
3728 i Insert mode
3729 r Replace mode
3730 c Command-line Normal (append) mode
3731 ci Command-line Insert mode
3732 cr Command-line Replace mode
3733 sm showmatch in Insert mode
3734 a all modes
3735 The argument-list is a dash separated list of these arguments:
3736 hor{N} horizontal bar, {N} percent of the character height
3737 ver{N} vertical bar, {N} percent of the character width
3738 block block cursor, fills the whole character
3739 [only one of the above three should be present]
3740 blinkwait{N} *cursor-blinking*
3741 blinkon{N}
3742 blinkoff{N}
3743 blink times for cursor: blinkwait is the delay before
3744 the cursor starts blinking, blinkon is the time that
3745 the cursor is shown and blinkoff is the time that the
3746 cursor is not shown. The times are in msec. When one
3747 of the numbers is zero, there is no blinking. The
3748 default is: "blinkwait700-blinkon400-blinkoff250".
3749 These numbers are used for a missing entry. This
3750 means that blinking is enabled by default. To switch
3751 blinking off you can use "blinkon0". The cursor only
3752 blinks when Vim is waiting for input, not while
3753 executing a command.
3754 To make the cursor blink in an xterm, see
3755 |xterm-blink|.
3756 {group-name}
3757 a highlight group name, that sets the color and font
3758 for the cursor
3759 {group-name}/{group-name}
3760 Two highlight group names, the first is used when
3761 no language mappings are used, the other when they
3762 are. |language-mapping|
3763
3764 Examples of parts:
3765 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3766 block cursor with colors from the "nCursor"
3767 highlight group
3768 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3769 In Insert and Command-line Insert mode, use a
3770 30% vertical bar cursor with colors from the
3771 "iCursor" highlight group. Blink a bit
3772 faster.
3773
3774 The 'a' mode is different. It will set the given argument-list for
3775 all modes. It does not reset anything to defaults. This can be used
3776 to do a common setting for all modes. For example, to switch off
3777 blinking: "a:blinkon0"
3778
3779 Examples of cursor highlighting: >
3780 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3781 :highlight Cursor gui=NONE guifg=bg guibg=fg
3782<
3783 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003784 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785'guifont' 'gfn' string (default "")
3786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 {only available when compiled with GUI enabled}
3788 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003789 In its simplest form the value is just one font name.
3790 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791
3792 *'guifontset'* *'gfs'*
3793 *E250* *E252* *E234* *E597* *E598*
3794'guifontset' 'gfs' string (default "")
3795 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 {only available when compiled with GUI enabled and
3797 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003798 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 When not empty, specifies two (or more) fonts to be used. The first
3800 one for normal English, the second one for your special language. See
3801 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003802
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3804'guifontwide' 'gfw' string (default "")
3805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 {only available when compiled with GUI enabled}
3807 When not empty, specifies a comma-separated list of fonts to be used
3808 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003809 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003810
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 *'guiheadroom'* *'ghr'*
3812'guiheadroom' 'ghr' number (default 50)
3813 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003814 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 The number of pixels subtracted from the screen height when fitting
3816 the GUI window on the screen. Set this before the GUI is started,
3817 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003818 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 lines will be left for window decorations and other items on the
3820 screen. Set it to a negative value to allow windows taller than the
3821 screen.
3822
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003823 *'guiligatures'* *'gli'* *E1243*
3824'guiligatures' 'gli' string (default "")
3825 global
3826 {only for GTK GUI}
3827 List of ASCII characters that, when combined together, can create more
3828 complex shapes. Each character must be a printable ASCII character
3829 with a value in the 32-127 range.
3830 Example: >
3831 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3832< Changing this option updates screen output immediately. Set it to an
3833 empty string to disable ligatures.
3834
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003836'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3837 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003838 "aegimrLtT" (GTK, Motif and Athena),
3839 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003842 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 sequence of letters which describes what components and options of the
3844 GUI should be used.
3845 To avoid problems with flags that are added in the future, use the
3846 "+=" and "-=" feature of ":set" |add-option-flags|.
3847
Bram Moolenaar13568252018-03-16 20:46:58 +01003848 Valid characters are as follows:
3849 *'go-!'*
3850 '!' External commands are executed in a terminal window. Without
3851 this flag the MS-Windows GUI will open a console window to
3852 execute the command. The Unix GUI will simulate a dumb
3853 terminal to list the command output.
3854 The terminal window will be positioned at the bottom, and grow
3855 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003856 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 'a' Autoselect: If present, then whenever VISUAL mode is started,
3858 or the Visual area extended, Vim tries to become the owner of
3859 the windowing system's global selection. This means that the
3860 Visually highlighted text is available for pasting into other
3861 applications as well as into Vim itself. When the Visual mode
3862 ends, possibly due to an operation on the text, or when an
3863 application wants to paste the selection, the highlighted text
3864 is automatically yanked into the "* selection register.
3865 Thus the selection is still available for pasting into other
3866 applications after the VISUAL mode has ended.
3867 If not present, then Vim won't become the owner of the
3868 windowing system's global selection unless explicitly told to
3869 by a yank or delete operation for the "* register.
3870 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003871 *'go-P'*
3872 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003873 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003874 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003875 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 applies to the modeless selection.
3877
3878 'guioptions' autoselect Visual autoselect modeless ~
3879 "" - -
3880 "a" yes yes
3881 "A" - yes
3882 "aA" yes yes
3883
Bram Moolenaar02467872007-05-06 13:22:01 +00003884 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 'c' Use console dialogs instead of popup dialogs for simple
3886 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003887 *'go-d'*
3888 'd' Use dark theme variant if available. Currently only works for
3889 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003890 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003891 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003892 'guitablabel' can be used to change the text in the labels.
3893 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003894 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003895 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003896 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 'f' Foreground: Don't use fork() to detach the GUI from the shell
3898 where it was started. Use this for programs that wait for the
3899 editor to finish (e.g., an e-mail program). Alternatively you
3900 can use "gvim -f" or ":gui -f" to start the GUI in the
3901 foreground. |gui-fork|
3902 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003903 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003904 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3906 corner of the window. It's black&white on non-GTK, because of
3907 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003908 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003910 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003911 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003913 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003915 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003916 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 'g' Grey menu items: Make menu items that are not active grey. If
3918 'g' is not included inactive menu items are not shown at all.
3919 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003920 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 't' Include tearoff menu items. Currently only works for Win32,
3922 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003923 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003924 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003925 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003926 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003928 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 'R' Right-hand scrollbar is present when there is a vertically
3930 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003931 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003933 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 'L' Left-hand scrollbar is present when there is a vertically
3935 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003936 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3938 the longest visible line, or on the cursor line if the 'h'
3939 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003940 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 'h' Limit horizontal scrollbar size to the length of the cursor
3942 line. Reduces computations. |gui-horiz-scroll|
3943
3944 And yes, you may even have scrollbars on the left AND the right if
3945 you really want to :-). See |gui-scrollbars| for more information.
3946
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003947 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 'v' Use a vertical button layout for dialogs. When not included,
3949 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003950 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003951 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 'p' Use Pointer callbacks for X11 GUI. This is required for some
3953 window managers. If the cursor is not blinking or hollow at
3954 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003955 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003957 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003958 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003959 *'go-k'*
3960 'k' Keep the GUI window size when adding/removing a scrollbar, or
3961 toolbar, tabline, etc. Instead, the behavior is similar to
3962 when the window is maximized and will adjust 'lines' and
3963 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003964 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003965 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003966
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 *'guipty'* *'noguipty'*
3968'guipty' boolean (default on)
3969 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 {only available when compiled with GUI enabled}
3971 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3972 I/O to/from shell commands. See |gui-pty|.
3973
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003974 *'guitablabel'* *'gtl'*
3975'guitablabel' 'gtl' string (default empty)
3976 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003977 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003978 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003979 pages line. When empty and when the result is empty Vim will use a
3980 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003981
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003982 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003983 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003984 The expression will be evaluated in the |sandbox| when set from a
3985 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003986 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003987
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003988 Only used when the GUI tab pages line is displayed. 'e' must be
3989 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3990 used.
3991
Bram Moolenaar57657d82006-04-21 22:12:41 +00003992 *'guitabtooltip'* *'gtt'*
3993'guitabtooltip' 'gtt' string (default empty)
3994 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003995 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003996 When nonempty describes the text to use in a tooltip for the GUI tab
3997 pages line. When empty Vim will use a default tooltip.
3998 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003999 You can include a line break. Simplest method is to use |:let|: >
4000 :let &guitabtooltip = "line one\nline two"
4001<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004002
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01004004'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 (others) "$VIMRUNTIME/doc/help.txt")
4006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 Name of the main help file. All distributed help files should be
4008 placed together in one directory. Additionally, all "doc" directories
4009 in 'runtimepath' will be used.
4010 Environment variables are expanded |:set_env|. For example:
4011 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004012 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 spaces and backslashes.
4014 This option cannot be set from a |modeline| or in the |sandbox|, for
4015 security reasons.
4016
4017 *'helpheight'* *'hh'*
4018'helpheight' 'hh' number (default 20)
4019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 Minimal initial height of the help window when it is opened with the
4021 ":help" command. The initial height of the help window is half of the
4022 current window, or (when the 'ea' option is on) the same as other
4023 windows. When the height is less than 'helpheight', the height is
4024 set to 'helpheight'. Set to zero to disable.
4025
4026 *'helplang'* *'hlg'*
4027'helplang' 'hlg' string (default: messages language or empty)
4028 global
4029 {only available when compiled with the |+multi_lang|
4030 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 Comma separated list of languages. Vim will use the first language
4032 for which the desired help can be found. The English help will always
4033 be used as a last resort. You can add "en" to prefer English over
4034 another language, but that will only find tags that exist in that
4035 language and not in the English help.
4036 Example: >
4037 :set helplang=de,it
4038< This will first search German, then Italian and finally English help
4039 files.
4040 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4041 try to find the tag in the current language before using this option.
4042 See |help-translated|.
4043
4044 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4045'hidden' 'hid' boolean (default off)
4046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 When off a buffer is unloaded when it is |abandon|ed. When on a
4048 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4049 displayed in another window, it does not become hidden, of course.
4050 The commands that move through the buffer list sometimes make a buffer
4051 hidden although the 'hidden' option is off: When the buffer is
4052 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004053 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004054 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 This option is set for one command with ":hide {command}" |:hide|.
4056 WARNING: It's easy to forget that you have changes in hidden buffers.
4057 Think twice when using ":q!" or ":qa!".
4058
4059 *'highlight'* *'hl'*
4060'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004061 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4062 d:Directory,e:ErrorMsg,i:IncSearch,
4063 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004064 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004065 N:CursorLineNr,r:Question,s:StatusLine,
4066 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004067 v:Visual,V:VisualNOS,w:WarningMsg,
4068 W:WildMenu,f:Folded,F:FoldColumn,
4069 A:DiffAdd,C:DiffChange,D:DiffDelete,
4070 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004071 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004072 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004073 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4074 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004075 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004076 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 This option can be used to set highlighting mode for various
4079 occasions. It is a comma separated list of character pairs. The
4080 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004081 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004083 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4084 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 characters from 'showbreak'
4086 |hl-Directory| d directories in CTRL-D listing and other special
4087 things in listings
4088 |hl-ErrorMsg| e error messages
4089 h (obsolete, ignored)
4090 |hl-IncSearch| i 'incsearch' highlighting
4091 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4092 |hl-MoreMsg| m |more-prompt|
4093 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004094 |hl-LineNr| n line number for ":number" and ":#" commands, and
4095 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004096 |hl-LineNrAbove| a line number above the cursor for when the
4097 'relativenumber' option is set.
4098 |hl-LineNrBelow| b line number below the cursor for when the
4099 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004100 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4101 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 |hl-Question| r |hit-enter| prompt and yes/no questions
4103 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004104 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4106 |hl-VertSplit| c column used to separate vertically split windows
4107 |hl-Visual| v Visual mode
4108 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4109 Selection" Only X11 Gui's |gui-x11| and
4110 |xterm-clipboard|.
4111 |hl-WarningMsg| w warning messages
4112 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4113 |hl-Folded| f line used for closed folds
4114 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004115 |hl-DiffAdd| A added line in diff mode
4116 |hl-DiffChange| C changed line in diff mode
4117 |hl-DiffDelete| D deleted line in diff mode
4118 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004120 |hl-Conceal| - the placeholders used for concealed characters
4121 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004122 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004123 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004124 |hl-SpellRare| R rare word |spell|
4125 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004126 |hl-Pmenu| + popup menu normal line
4127 |hl-PmenuSel| = popup menu selected line
4128 |hl-PmenuSbar| x popup menu scrollbar
4129 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130
4131 The display modes are:
4132 r reverse (termcap entry "mr" and "me")
4133 i italic (termcap entry "ZH" and "ZR")
4134 b bold (termcap entry "md" and "me")
4135 s standout (termcap entry "so" and "se")
4136 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004137 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004138 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 n no highlighting
4140 - no highlighting
4141 : use a highlight group
4142 The default is used for occasions that are not included.
4143 If you want to change what the display modes do, see |dos-colors|
4144 for an example.
4145 When using the ':' display mode, this must be followed by the name of
4146 a highlight group. A highlight group can be used to define any type
4147 of highlighting, including using color. See |:highlight| on how to
4148 define one. The default uses a different group for each occasion.
4149 See |highlight-default| for the default highlight groups.
4150
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004152'history' 'hi' number (Vim default: 50, Vi default: 0,
4153 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004156 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004158 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 NOTE: This option is set to the Vi default value when 'compatible' is
4160 set and to the Vim default value when 'compatible' is reset.
4161
4162 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4163'hkmap' 'hk' boolean (default off)
4164 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 {only available when compiled with the |+rightleft|
4166 feature}
4167 When on, the keyboard is mapped for the Hebrew character set.
4168 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4169 toggle this option. See |rileft.txt|.
4170 NOTE: This option is reset when 'compatible' is set.
4171
4172 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4173'hkmapp' 'hkp' boolean (default off)
4174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 {only available when compiled with the |+rightleft|
4176 feature}
4177 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4178 This is useful if you have a non-Hebrew keyboard.
4179 See |rileft.txt|.
4180 NOTE: This option is reset when 'compatible' is set.
4181
Bram Moolenaar036986f2017-03-16 17:41:02 +01004182 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4183'hlsearch' 'hls' boolean (default off)
4184 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004185 {not available when compiled without the
4186 |+extra_search| feature}
4187 When there is a previous search pattern, highlight all its matches.
4188 The type of highlighting used can be set with the 'l' occasion in the
4189 'highlight' option. This uses the "Search" highlight group by
4190 default. Note that only the matching text is highlighted, any offsets
4191 are not applied.
4192 See also: 'incsearch' and |:match|.
4193 When you get bored looking at the highlighted matches, you can turn it
4194 off with |:nohlsearch|. This does not change the option value, as
4195 soon as you use a search command, the highlighting comes back.
4196 'redrawtime' specifies the maximum time spent on finding matches.
4197 When the search pattern can match an end-of-line, Vim will try to
4198 highlight all of the matched text. However, this depends on where the
4199 search starts. This will be the first line in the window or the first
4200 line below a closed fold. A match in a previous line which is not
4201 drawn may not continue in a newly drawn line.
4202 You can specify whether the highlight status is restored on startup
4203 with the 'h' flag in 'viminfo' |viminfo-h|.
4204 NOTE: This option is reset when 'compatible' is set.
4205
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 *'icon'* *'noicon'*
4207'icon' boolean (default off, on when title can be restored)
4208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 When on, the icon text of the window will be set to the value of
4210 'iconstring' (if it is not empty), or to the name of the file
4211 currently being edited. Only the last part of the name is used.
4212 Overridden by the 'iconstring' option.
4213 Only works if the terminal supports setting window icons (currently
4214 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4215 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4216 builtin termcap).
4217 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004218 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004220 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221
4222 *'iconstring'*
4223'iconstring' string (default "")
4224 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 When this option is not empty, it will be used for the icon text of
4226 the window. This happens only when the 'icon' option is on.
4227 Only works if the terminal supports setting window icon text
4228 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004229 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 When Vim was compiled with HAVE_X11 defined, the original icon will be
4231 restored if possible |X11|.
4232 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004233 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004235 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 {not available when compiled without the |+statusline| feature}
4237
4238 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4239'ignorecase' 'ic' boolean (default off)
4240 global
4241 Ignore case in search patterns. Also used when searching in the tags
4242 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004243 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 Can be overruled by using "\c" or "\C" in the pattern, see
4245 |/ignorecase|.
4246
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004247 *'imactivatefunc'* *'imaf'*
4248'imactivatefunc' 'imaf' string (default "")
4249 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004250 This option specifies a function that will be called to
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004251 activate or deactivate the Input Method. The value can be the name of
4252 a function, a |lambda| or a |Funcref|. See |option-value-function| for
4253 more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004254 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004255 The expression will be evaluated in the |sandbox| when set from a
4256 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004257
4258 Example: >
4259 function ImActivateFunc(active)
4260 if a:active
4261 ... do something
4262 else
4263 ... do something
4264 endif
4265 " return value is not used
4266 endfunction
4267 set imactivatefunc=ImActivateFunc
4268<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 *'imactivatekey'* *'imak'*
4270'imactivatekey' 'imak' string (default "")
4271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004273 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 Specifies the key that your Input Method in X-Windows uses for
4275 activation. When this is specified correctly, vim can fully control
4276 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4277 You can't use this option to change the activation key, the option
4278 tells Vim what the key is.
4279 Format:
4280 [MODIFIER_FLAG-]KEY_STRING
4281
4282 These characters can be used for MODIFIER_FLAG (case is ignored):
4283 S Shift key
4284 L Lock key
4285 C Control key
4286 1 Mod1 key
4287 2 Mod2 key
4288 3 Mod3 key
4289 4 Mod4 key
4290 5 Mod5 key
4291 Combinations are allowed, for example "S-C-space" or "SC-space" are
4292 both shift+ctrl+space.
4293 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4294
4295 Example: >
4296 :set imactivatekey=S-space
4297< "S-space" means shift+space. This is the activation key for kinput2 +
4298 canna (Japanese), and ami (Korean).
4299
4300 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4301'imcmdline' 'imc' boolean (default off)
4302 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 When set the Input Method is always on when starting to edit a command
4304 line, unless entering a search pattern (see 'imsearch' for that).
4305 Setting this option is useful when your input method allows entering
4306 English characters directly, e.g., when it's used to type accented
4307 characters with dead keys.
4308
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004309 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 When set the Input Method is never used. This is useful to disable
4313 the IM when it doesn't work properly.
4314 Currently this option is on by default for SGI/IRIX machines. This
4315 may change in later releases.
4316
4317 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004318'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 Specifies whether :lmap or an Input Method (IM) is to be used in
4321 Insert mode. Valid values:
4322 0 :lmap is off and IM is off
4323 1 :lmap is ON and IM is off
4324 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 To always reset the option to zero when leaving Insert mode with <Esc>
4326 this can be used: >
4327 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4328< This makes :lmap and IM turn off automatically when leaving Insert
4329 mode.
4330 Note that this option changes when using CTRL-^ in Insert mode
4331 |i_CTRL-^|.
4332 The value is set to 1 when setting 'keymap' to a valid keymap name.
4333 It is also used for the argument of commands like "r" and "f".
4334 The value 0 may not work correctly with Athena and Motif with some XIM
4335 methods. Use 'imdisable' to disable XIM then.
4336
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004337 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004338 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004339 |+multi_byte_ime| or |global-ime|.
4340
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004342'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 Specifies whether :lmap or an Input Method (IM) is to be used when
4345 entering a search pattern. Valid values:
4346 -1 the value of 'iminsert' is used, makes it look like
4347 'iminsert' is also used when typing a search pattern
4348 0 :lmap is off and IM is off
4349 1 :lmap is ON and IM is off
4350 2 :lmap is off and IM is ON
4351 Note that this option changes when using CTRL-^ in Command-line mode
4352 |c_CTRL-^|.
4353 The value is set to 1 when it is not -1 and setting the 'keymap'
4354 option to a valid keymap name.
4355 The value 0 may not work correctly with Athena and Motif with some XIM
4356 methods. Use 'imdisable' to disable XIM then.
4357
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004358 *'imstatusfunc'* *'imsf'*
4359'imstatusfunc' 'imsf' string (default "")
4360 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004361 This option specifies a function that is called to obtain the status
4362 of Input Method. It must return a positive number when IME is active.
Yegappan Lakshmanan7645da52021-12-04 14:02:30 +00004363 The value can be the name of a function, a |lambda| or a |Funcref|.
4364 See |option-value-function| for more information.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004365 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004366
4367 Example: >
4368 function ImStatusFunc()
4369 let is_active = ...do something
4370 return is_active ? 1 : 0
4371 endfunction
4372 set imstatusfunc=ImStatusFunc
4373<
4374 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004375 The expression will be evaluated in the |sandbox| when set from a
4376 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004377
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004378 *'imstyle'* *'imst'*
4379'imstyle' 'imst' number (default 1)
4380 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004381 {only available when compiled with |+xim| and
4382 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004383 This option specifies the input style of Input Method:
4384 0 use on-the-spot style
4385 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004386 See: |xim-input-style|
4387
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004388 For a long time on-the-spot style had been used in the GTK version of
4389 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004390 |single-repeat|, etc. Therefore over-the-spot style becomes the
4391 default now. This should work fine for most people, however if you
4392 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004393 The expression will be evaluated in the |sandbox| when set from a
4394 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004395
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 *'include'* *'inc'*
4397'include' 'inc' string (default "^\s*#\s*include")
4398 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 {not available when compiled without the
4400 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004401 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 pattern, just like for the "/" command (See |pattern|). The default
4403 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004404 "]I", "[d", etc.
4405 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004406 comes after the matched pattern. But if "\zs" appears in the pattern
4407 then the text matched from "\zs" to the end, or until "\ze" if it
4408 appears, is used as the file name. Use this to include characters
4409 that are not in 'isfname', such as a space. You can then use
4410 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004411 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412
4413 *'includeexpr'* *'inex'*
4414'includeexpr' 'inex' string (default "")
4415 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004417 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004419 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 :set includeexpr=substitute(v:fname,'\\.','/','g')
4421< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004422
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004424 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 Also used for |<cfile>|.
4426
Bram Moolenaar30b65812012-07-12 22:01:11 +02004427 The expression will be evaluated in the |sandbox| when set from a
4428 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004429 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004430
4431 It is not allowed to change text or jump to another window while
4432 evaluating 'includeexpr' |textlock|.
4433
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004435'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4436 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004439 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004440 While typing a search command, show where the pattern, as it was typed
4441 so far, matches. The matched string is highlighted. If the pattern
4442 is invalid or not found, nothing is shown. The screen will be updated
4443 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004444 Also applies to the pattern in commands: >
4445 :global
4446 :lvimgrep
4447 :lvimgrepadd
4448 :smagic
4449 :snomagic
4450 :sort
4451 :substitute
4452 :vglobal
4453 :vimgrep
4454 :vimgrepadd
4455< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004456 original position when no match is found and when pressing <Esc>. You
4457 still need to finish the search command with <Enter> to move the
4458 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004459 You can use the CTRL-G and CTRL-T keys to move to the next and
4460 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004461 When compiled with the |+reltime| feature Vim only searches for about
4462 half a second. With a complicated pattern and/or a lot of text the
4463 match may not be found. This is to avoid that Vim hangs while you
4464 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004465 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004466 When 'hlsearch' is on, all matched strings are highlighted too while
4467 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004468 If you don't want to turn 'hlsearch' on, but want to highlight all
4469 matches while searching, you can turn on and off 'hlsearch' with
4470 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004471 augroup vimrc-incsearch-highlight
4472 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004473 autocmd CmdlineEnter /,\? :set hlsearch
4474 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004475 augroup END
4476<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004477 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004478 to the command line. If 'ignorecase' and 'smartcase' are set and the
4479 command line has no uppercase characters, the added character is
4480 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004481 CTRL-R CTRL-W can be used to add the word at the end of the current
4482 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 NOTE: This option is reset when 'compatible' is set.
4484
4485 *'indentexpr'* *'inde'*
4486'indentexpr' 'inde' string (default "")
4487 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 {not available when compiled without the |+cindent|
4489 or |+eval| features}
4490 Expression which is evaluated to obtain the proper indent for a line.
4491 It is used when a new line is created, for the |=| operator and
4492 in Insert mode as specified with the 'indentkeys' option.
4493 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004494 'smartindent' indenting. When 'lisp' is set, this option is
4495 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 When 'paste' is set this option is not used for indenting.
4497 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004498 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 when the expression is evaluated (but it may be moved around).
4500 The expression must return the number of spaces worth of indent. It
4501 can return "-1" to keep the current indent (this means 'autoindent' is
4502 used for the indent).
4503 Functions useful for computing the indent are |indent()|, |cindent()|
4504 and |lispindent()|.
4505 The evaluation of the expression must not have side effects! It must
4506 not change the text, jump to another window, etc. Afterwards the
4507 cursor position is always restored, thus the cursor may be moved.
4508 Normally this option would be set to call a function: >
4509 :set indentexpr=GetMyIndent()
4510< Error messages will be suppressed, unless the 'debug' option contains
4511 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004512 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004513 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514
Bram Moolenaar30b65812012-07-12 22:01:11 +02004515 The expression will be evaluated in the |sandbox| when set from a
4516 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004517 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004518
4519 It is not allowed to change text or jump to another window while
4520 evaluating 'indentexpr' |textlock|.
4521
4522
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004524'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 {not available when compiled without the |+cindent|
4527 feature}
4528 A list of keys that, when typed in Insert mode, cause reindenting of
4529 the current line. Only happens if 'indentexpr' isn't empty.
4530 The format is identical to 'cinkeys', see |indentkeys-format|.
4531 See |C-indenting| and |indent-expression|.
4532
4533 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4534'infercase' 'inf' boolean (default off)
4535 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004537 'ignorecase' is also on, the case of the match is adjusted depending
4538 on the typed text. If the typed text contains a lowercase letter
4539 where the match has an upper case letter, the completed part is made
4540 lowercase. If the typed text has no lowercase letters and the match
4541 has a lowercase letter where the typed text has an uppercase letter,
4542 and there is a letter before it, the completed part is made uppercase.
4543 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544
4545 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4546'insertmode' 'im' boolean (default off)
4547 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 Makes Vim work in a way that Insert mode is the default mode. Useful
4549 if you want to use Vim as a modeless editor. Used for |evim|.
4550 These Insert mode commands will be useful:
4551 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004552 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 this is a mapping, it is executed as if 'insertmode' was off.
4554 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004556 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4557 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558
4559 These items change when 'insertmode' is set:
4560 - when starting to edit of a file, Vim goes to Insert mode.
4561 - <Esc> in Insert mode is a no-op and beeps.
4562 - <Esc> in Normal mode makes Vim go to Insert mode.
4563 - CTRL-L in Insert mode is a command, it is not inserted.
4564 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4565 However, when <Esc> is used inside a mapping, it behaves like
4566 'insertmode' was not set. This was done to be able to use the same
4567 mappings with 'insertmode' set or not set.
4568 When executing commands with |:normal| 'insertmode' is not used.
4569
4570 NOTE: This option is reset when 'compatible' is set.
4571
4572 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004573'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4575 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4576 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4577 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4578 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 The characters specified by this option are included in file names and
4581 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004582 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 Multi-byte characters 256 and above are always included, only the
4584 characters up to 255 are specified with this option.
4585 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004586 Think twice before adding white space to this option. Although a
4587 space may appear inside a file name, the effect will be that Vim
4588 doesn't know where a file name starts or ends when doing completion.
4589 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590
4591 Note that on systems using a backslash as path separator, Vim tries to
4592 do its best to make it work as you would expect. That is a bit
4593 tricky, since Vi originally used the backslash to escape special
4594 characters. Vim will not remove a backslash in front of a normal file
4595 name character on these systems, but it will on Unix and alikes. The
4596 '&' and '^' are not included by default, because these are special for
4597 cmd.exe.
4598
4599 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004600 Each part can be a single character number or a range. A range is two
4601 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 decimal number between 0 and 255 or the ASCII character itself (does
4603 not work for digits). Example:
4604 "_,-,128-140,#-43" (include '_' and '-' and the range
4605 128 to 140 and '#' to 43)
4606 If a part starts with '^', the following character number or range
4607 will be excluded from the option. The option is interpreted from left
4608 to right. Put the excluded character after the range where it is
4609 included. To include '^' itself use it as the last character of the
4610 option or the end of a range. Example:
4611 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4612 If the character is '@', all characters where isalpha() returns TRUE
4613 are included. Normally these are the characters a to z and A to Z,
4614 plus accented characters. To include '@' itself use "@-@". Examples:
4615 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004616 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 "a-z,A-Z,@-@" All letters plus the '@' character.
4618 A comma can be included by using it where a character number is
4619 expected. Example:
4620 "48-57,,,_" Digits, comma and underscore.
4621 A comma can be excluded by prepending a '^'. Example:
4622 " -~,^,,9" All characters from space to '~', excluding
4623 comma, plus <Tab>.
4624 See |option-backslash| about including spaces and backslashes.
4625
4626 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004627'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 "@,48-57,_,128-167,224-235"
4629 otherwise: "@,48-57,_,192-255")
4630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 The characters given by this option are included in identifiers.
4632 Identifiers are used in recognizing environment variables and after a
4633 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004634 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004635 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004637 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4639
4640 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004641'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 "@,48-57,_,128-167,224-235"
4643 otherwise: "@,48-57,_,192-255"
4644 Vi default: "@,48-57,_")
4645 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004647 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004648 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004649 characters above 255 check the "word" character class (any character
4650 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004651 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 For a help file it is set to all non-blank printable characters except
4653 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4654 command).
4655 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004656 This option also influences syntax highlighting, unless the syntax
4657 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 NOTE: This option is set to the Vi default value when 'compatible' is
4659 set and to the Vim default value when 'compatible' is reset.
4660
4661 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004662'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 "@,~-255"; otherwise: "@,161-255")
4664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 The characters given by this option are displayed directly on the
4666 screen. It is also used for "\p" in a |pattern|. The characters from
4667 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4668 even when they are not included in 'isprint' or excluded. See
4669 'isfname' for a description of the format of this option.
4670
4671 Non-printable characters are displayed with two characters:
4672 0 - 31 "^@" - "^_"
4673 32 - 126 always single characters
4674 127 "^?"
4675 128 - 159 "~@" - "~_"
4676 160 - 254 "| " - "|~"
4677 255 "~?"
4678 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4679 displayed as <xx>, with the hexadecimal value of the byte.
4680 When 'display' contains "uhex" all unprintable characters are
4681 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004682 The SpecialKey highlighting will be used for unprintable characters.
4683 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684
4685 Multi-byte characters 256 and above are always included, only the
4686 characters up to 255 are specified with this option. When a character
4687 is printable but it is not available in the current font, a
4688 replacement character will be shown.
4689 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4690 There is no option to specify these characters.
4691
4692 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4693'joinspaces' 'js' boolean (default on)
4694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 Insert two spaces after a '.', '?' and '!' with a join command.
4696 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4697 Otherwise only one space is inserted.
4698 NOTE: This option is set when 'compatible' is set.
4699
4700 *'key'*
4701'key' string (default "")
4702 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004703 {only available when compiled with the |+cryptv|
4704 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004706 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 Careful: Do not set the key value by hand, someone might see the typed
4708 key. Use the |:X| command. But you can make 'key' empty: >
4709 :set key=
4710< It is not possible to get the value of this option with ":set key" or
4711 "echo &key". This is to avoid showing it to someone who shouldn't
4712 know. It also means you cannot see it yourself once you have set it,
4713 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004714 You can use "&key" in an expression to detect whether encryption is
4715 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716
4717 *'keymap'* *'kmp'* *E544*
4718'keymap' 'kmp' string (default "")
4719 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 {only available when compiled with the |+keymap|
4721 feature}
4722 Name of a keyboard mapping. See |mbyte-keymap|.
4723 Setting this option to a valid keymap name has the side effect of
4724 setting 'iminsert' to one, so that the keymap becomes effective.
4725 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004726 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727
4728 *'keymodel'* *'km'*
4729'keymodel' 'km' string (default "")
4730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 List of comma separated words, which enable special things that keys
4732 can do. These values can be used:
4733 startsel Using a shifted special key starts selection (either
4734 Select mode or Visual mode, depending on "key" being
4735 present in 'selectmode').
4736 stopsel Using a not-shifted special key stops selection.
4737 Special keys in this context are the cursor keys, <End>, <Home>,
4738 <PageUp> and <PageDown>.
4739 The 'keymodel' option is set by the |:behave| command.
4740
4741 *'keywordprg'* *'kp'*
4742'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004743 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 Program to use for the |K| command. Environment variables are
4746 expanded |:set_env|. ":help" may be used to access the Vim internal
4747 help. (Note that previously setting the global option to the empty
4748 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004749 When the first character is ":", the command is invoked as a Vim
4750 Ex command prefixed with [count].
4751 When "man", "man -s" or an Ex command is used, Vim will automatically
4752 translate a count for the "K" command and pass it as the first
4753 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 See |option-backslash| about including spaces and backslashes.
4755 Example: >
4756 :set keywordprg=man\ -s
4757< This option cannot be set from a |modeline| or in the |sandbox|, for
4758 security reasons.
4759
4760 *'langmap'* *'lmap'* *E357* *E358*
4761'langmap' 'lmap' string (default "")
4762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 {only available when compiled with the |+langmap|
4764 feature}
4765 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004766 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004767 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 care of translating these special characters to the original meaning
4769 of the key. This means you don't have to change the keyboard mode to
4770 be able to execute Normal mode commands.
4771 This is the opposite of the 'keymap' option, where characters are
4772 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004773 Also consider setting 'langremap' to off, to prevent 'langmap' from
4774 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004775 This option cannot be set from a |modeline| or in the |sandbox|, for
4776 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004778 Example (for Greek, in UTF-8): *greek* >
4779 :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 +00004780< Example (exchanges meaning of z and y for commands): >
4781 :set langmap=zy,yz,ZY,YZ
4782<
4783 The 'langmap' option is a list of parts, separated with commas. Each
4784 part can be in one of two forms:
4785 1. A list of pairs. Each pair is a "from" character immediately
4786 followed by the "to" character. Examples: "aA", "aAbBcC".
4787 2. A list of "from" characters, a semi-colon and a list of "to"
4788 characters. Example: "abc;ABC"
4789 Example: "aA,fgh;FGH,cCdDeE"
4790 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004791 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792
4793 This will allow you to activate vim actions without having to switch
4794 back and forth between the languages. Your language characters will
4795 be understood as normal vim English characters (according to the
4796 langmap mappings) in the following cases:
4797 o Normal/Visual mode (commands, buffer/register names, user mappings)
4798 o Insert/Replace Mode: Register names after CTRL-R
4799 o Insert/Replace Mode: Mappings
4800 Characters entered in Command-line mode will NOT be affected by
4801 this option. Note that this option can be changed at any time
4802 allowing to switch between mappings for different languages/encodings.
4803 Use a mapping to avoid having to type it each time!
4804
4805 *'langmenu'* *'lm'*
4806'langmenu' 'lm' string (default "")
4807 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 {only available when compiled with the |+menu| and
4809 |+multi_lang| features}
4810 Language to use for menu translation. Tells which file is loaded
4811 from the "lang" directory in 'runtimepath': >
4812 "lang/menu_" . &langmenu . ".vim"
4813< (without the spaces). For example, to always use the Dutch menus, no
4814 matter what $LANG is set to: >
4815 :set langmenu=nl_NL.ISO_8859-1
4816< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004817 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 If your $LANG is set to a non-English language but you do want to use
4819 the English menus: >
4820 :set langmenu=none
4821< This option must be set before loading menus, switching on filetype
4822 detection or syntax highlighting. Once the menus are defined setting
4823 this option has no effect. But you could do this: >
4824 :source $VIMRUNTIME/delmenu.vim
4825 :set langmenu=de_DE.ISO_8859-1
4826 :source $VIMRUNTIME/menu.vim
4827< Warning: This deletes all menus that you defined yourself!
4828
Bram Moolenaard94464e2015-11-02 15:28:18 +01004829 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004830'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004831 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004832 {only available when compiled with the |+langmap|
4833 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004834 This is just like 'langremap' but with the value inverted. It only
4835 exists for backwards compatibility. When setting 'langremap' then
4836 'langnoremap' is set to the inverted value, and the other way around.
4837
4838 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004839'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004840 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004841 {only available when compiled with the |+langmap|
4842 feature}
4843 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004844 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004845 'langmap' disables some of your mappings, try resetting this option.
4846 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004847 that works for you to avoid mappings to break.
4848
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 *'laststatus'* *'ls'*
4850'laststatus' 'ls' number (default 1)
4851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 The value of this option influences when the last window will have a
4853 status line:
4854 0: never
4855 1: only if there are at least two windows
4856 2: always
4857 The screen looks nicer with a status line if you have several
4858 windows, but it takes another screen line. |status-line|
4859
4860 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4861'lazyredraw' 'lz' boolean (default off)
4862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 When this option is set, the screen will not be redrawn while
4864 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004865 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 update use |:redraw|.
4867
4868 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4869'linebreak' 'lbr' boolean (default off)
4870 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004871 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004873 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 than at the last character that fits on the screen. Unlike
4875 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004876 it only affects the way the file is displayed, not its contents.
4877 If 'breakindent' is set, line is visually indented. Then, the value
4878 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004879 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 Note that <Tab> characters after an <EOL> are mostly not displayed
4881 with the right amount of white space.
4882
4883 *'lines'* *E593*
4884'lines' number (default 24 or terminal height)
4885 global
4886 Number of lines of the Vim window.
4887 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004888 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 When Vim is running in the GUI or in a resizable window, setting this
4890 option will cause the window size to be changed. When you only want
4891 to use the size for the GUI, put the command in your |gvimrc| file.
4892 Vim limits the number of lines to what fits on the screen. You can
4893 use this command to get the tallest window possible: >
4894 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004895< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004896 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 When you set this option and Vim is unable to change the physical
4898 number of lines of the display, the display may be messed up.
4899
4900 *'linespace'* *'lsp'*
4901'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4902 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 {only in the GUI}
4904 Number of pixel lines inserted between characters. Useful if the font
4905 uses the full character cell height, making lines touch each other.
4906 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004907 With some fonts there can be too much room between lines (to have
4908 space for ascents and descents). Then it makes sense to set
4909 'linespace' to a negative value. This may cause display problems
4910 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911
4912 *'lisp'* *'nolisp'*
4913'lisp' boolean (default off)
4914 local to buffer
4915 {not available when compiled without the |+lispindent|
4916 feature}
4917 Lisp mode: When <Enter> is typed in insert mode set the indent for
4918 the next line to Lisp standards (well, sort of). Also happens with
4919 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4920 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4921 better. Also see 'lispwords'.
4922 The '-' character is included in keyword characters. Redefines the
4923 "=" operator to use this same indentation algorithm rather than
4924 calling an external program if 'equalprg' is empty.
4925 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926
4927 *'lispwords'* *'lw'*
4928'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004929 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 {not available when compiled without the |+lispindent|
4931 feature}
4932 Comma separated list of words that influence the Lisp indenting.
4933 |'lisp'|
4934
4935 *'list'* *'nolist'*
4936'list' boolean (default off)
4937 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004938 List mode: By default show tabs as CTRL-I is displayed, display $
4939 after end of line. Useful to see the difference between tabs and
4940 spaces and for trailing blanks. Further changed by the 'listchars'
4941 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004942
4943 The cursor is displayed at the start of the space a Tab character
4944 occupies, not at the end as usual in Normal mode. To get this cursor
4945 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004946 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004947<
4948 Note that list mode will also affect formatting (set with 'textwidth'
4949 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 changing the way tabs are displayed.
4951
4952 *'listchars'* *'lcs'*
4953'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004954 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004955 Strings to use in 'list' mode and for the |:list| command. It is a
4956 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004957 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 eol:c Character to show at the end of each line. When
4959 omitted, there is no extra character at the end of the
4960 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004961 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004962 tab:xy[z] Two or three characters to be used to show a tab.
4963 The third character is optional.
4964
4965 tab:xy The 'x' is always used, then 'y' as many times as will
4966 fit. Thus "tab:>-" displays:
4967 >
4968 >-
4969 >--
4970 etc.
4971
4972 tab:xyz The 'z' is always used, then 'x' is prepended, and
4973 then 'y' is used as many times as will fit. Thus
4974 "tab:<->" displays:
4975 >
4976 <>
4977 <->
4978 <-->
4979 etc.
4980
4981 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004982 *lcs-space*
4983 space:c Character to show for a space. When omitted, spaces
4984 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004985 *lcs-multispace*
4986 multispace:c...
4987 One or more characters to use cyclically to show for
4988 multiple consecutive spaces. Overrides the "space"
4989 setting, except for single spaces. When omitted, the
4990 "space" setting is used. For example,
4991 `:set listchars=multispace:---+` shows ten consecutive
4992 spaces as:
4993 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004994 *lcs-lead*
4995 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004996 leading spaces are blank. Overrides the "space" and
4997 "multispace" settings for leading spaces. You can
4998 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01004999 :set listchars+=tab:>-,lead:.
5000< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005001 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02005002 trailing spaces are blank. Overrides the "space" and
5003 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02005004 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 extends:c Character to show in the last column, when 'wrap' is
5006 off and the line continues beyond the right of the
5007 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005008 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02005009 precedes:c Character to show in the first visible column of the
5010 physical line, when there is text preceding the
5011 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005012 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005013 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005014 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005015 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005016 nbsp:c Character to show for a non-breakable space character
5017 (0xA0 (160 decimal) and U+202F). Left blank when
5018 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005020 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005022 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005024 Each character can be specified as hex: >
5025 set listchars=eol:\\x24
5026 set listchars=eol:\\u21b5
5027 set listchars=eol:\\U000021b5
5028< Note that a double backslash is used. The number of hex characters
5029 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5030
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 Examples: >
5032 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005033 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034 :set lcs=extends:>,precedes:<
5035< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005036 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5037 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005038 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039
5040 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5041'loadplugins' 'lpl' boolean (default on)
5042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 When on the plugin scripts are loaded when starting up |load-plugins|.
5044 This option can be reset in your |vimrc| file to disable the loading
5045 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005046 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5047 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048
Bram Moolenaard94464e2015-11-02 15:28:18 +01005049 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005050'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005051 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005052 {only available when compiled with the |+lua/dyn|
5053 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005054 Specifies the name of the Lua shared library. The default is
5055 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005056 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005057 This option cannot be set from a |modeline| or in the |sandbox|, for
5058 security reasons.
5059
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005060 *'macatsui'* *'nomacatsui'*
5061'macatsui' boolean (default on)
5062 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005063 {not supported}
5064 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005065
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 *'magic'* *'nomagic'*
5067'magic' boolean (default on)
5068 global
5069 Changes the special characters that can be used in search patterns.
5070 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005071 WARNING: Switching this option off most likely breaks plugins! That
5072 is because many patterns assume it's on and will fail when it's off.
5073 Only switch it off when working with old Vi scripts. In any other
5074 situation write patterns that work when 'magic' is on. Include "\M"
5075 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005076 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5077 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078
5079 *'makeef'* *'mef'*
5080'makeef' 'mef' string (default: "")
5081 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 {not available when compiled without the |+quickfix|
5083 feature}
5084 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5085 and the |:grep| command.
5086 When it is empty, an internally generated temp file will be used.
5087 When "##" is included, it is replaced by a number to make the name
5088 unique. This makes sure that the ":make" command doesn't overwrite an
5089 existing file.
5090 NOT used for the ":cf" command. See 'errorfile' for that.
5091 Environment variables are expanded |:set_env|.
5092 See |option-backslash| about including spaces and backslashes.
5093 This option cannot be set from a |modeline| or in the |sandbox|, for
5094 security reasons.
5095
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005096 *'makeencoding'* *'menc'*
5097'makeencoding' 'menc' string (default "")
5098 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005099 Encoding used for reading the output of external commands. When empty,
5100 encoding is not converted.
5101 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5102 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5103 and `:laddfile`.
5104
5105 This would be mostly useful when you use MS-Windows and set 'encoding'
5106 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5107 'makeencoding' to "char" has the same effect as setting to the system
5108 locale encoding. Example: >
5109 :set encoding=utf-8
5110 :set makeencoding=char " system locale is used
5111<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 *'makeprg'* *'mp'*
5113'makeprg' 'mp' string (default "make", VMS: "MMS")
5114 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005115 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005116 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5117 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005118 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005119 Environment variables are expanded |:set_env|. See |option-backslash|
5120 about including spaces and backslashes.
5121 Note that a '|' must be escaped twice: once for ":set" and once for
5122 the interpretation of a command. When you use a filter called
5123 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 :set makeprg=gmake\ \\\|\ myfilter
5125< The placeholder "$*" can be given (even multiple times) to specify
5126 where the arguments will be included, for example: >
5127 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5128< This option cannot be set from a |modeline| or in the |sandbox|, for
5129 security reasons.
5130
5131 *'matchpairs'* *'mps'*
5132'matchpairs' 'mps' string (default "(:),{:},[:]")
5133 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005135 other.
5136 Only character pairs are allowed that are different, thus you cannot
5137 jump between two double quotes.
5138 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005139 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005140 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 :set mps+=<:>
5142
5143< A more exotic example, to jump between the '=' and ';' in an
5144 assignment, useful for languages like C and Java: >
5145 :au FileType c,cpp,java set mps+==:;
5146
5147< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005148 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149
5150 *'matchtime'* *'mat'*
5151'matchtime' 'mat' number (default 5)
5152 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 Tenths of a second to show the matching paren, when 'showmatch' is
5154 set. Note that this is not in milliseconds, like other options that
5155 set a time. This is to be compatible with Nvi.
5156
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005157 *'maxcombine'* *'mco'*
5158'maxcombine' 'mco' number (default 2)
5159 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005160 The maximum number of combining characters supported for displaying.
5161 Only used when 'encoding' is "utf-8".
5162 The default is OK for most languages. Hebrew may require 4.
5163 Maximum value is 6.
5164 Even when this option is set to 2 you can still edit text with more
5165 combining characters, you just can't see them. Use |g8| or |ga|.
5166 See |mbyte-combining|.
5167
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 *'maxfuncdepth'* *'mfd'*
5169'maxfuncdepth' 'mfd' number (default 100)
5170 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005171 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005172 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 Maximum depth of function calls for user functions. This normally
5174 catches endless recursion. When using a recursive function with
5175 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5176 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005177 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005178 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 See also |:function|.
5180
5181 *'maxmapdepth'* *'mmd'* *E223*
5182'maxmapdepth' 'mmd' number (default 1000)
5183 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 Maximum number of times a mapping is done without resulting in a
5185 character to be used. This normally catches endless mappings, like
5186 ":map x y" with ":map y x". It still does not catch ":map g wg",
5187 because the 'w' is used before the next mapping is done. See also
5188 |key-mapping|.
5189
5190 *'maxmem'* *'mm'*
5191'maxmem' 'mm' number (default between 256 to 5120 (system
5192 dependent) or half the amount of memory
5193 available)
5194 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5196 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005197 other memory to be freed.
5198 The maximum usable value is about 2000000. Use this to work without a
5199 limit.
5200 The value is ignored when 'swapfile' is off.
5201 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005203 *'maxmempattern'* *'mmp'*
5204'maxmempattern' 'mmp' number (default 1000)
5205 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005206 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005207 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005208 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005209 When Vim runs into the limit it gives an error message and mostly
5210 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005211 Running into the limit often means that the pattern is very
5212 inefficient or too complex. This may already happen with the pattern
5213 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005214 Might also happen on redraw, when syntax rules try to match a complex
5215 text structure.
5216 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5217 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005218
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219 *'maxmemtot'* *'mmt'*
5220'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5221 dependent) or half the amount of memory
5222 available)
5223 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005224 Maximum amount of memory in Kbyte to use for all buffers together.
5225 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005226 without a limit.
5227 On 64 bit machines higher values might work. But hey, do you really
5228 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005229 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005230 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005231 Buffers with 'swapfile' off still count to the total amount of memory
5232 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005233 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234
5235 *'menuitems'* *'mis'*
5236'menuitems' 'mis' number (default 25)
5237 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 {not available when compiled without the |+menu|
5239 feature}
5240 Maximum number of items to use in a menu. Used for menus that are
5241 generated from a list of items, e.g., the Buffers menu. Changing this
5242 option has no direct effect, the menu must be refreshed first.
5243
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005244 *'mkspellmem'* *'msm'*
5245'mkspellmem' 'msm' string (default "460000,2000,500")
5246 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005247 {not available when compiled without the |+syntax|
5248 feature}
5249 Parameters for |:mkspell|. This tunes when to start compressing the
5250 word tree. Compression can be slow when there are many words, but
5251 it's needed to avoid running out of memory. The amount of memory used
5252 per word depends very much on how similar the words are, that's why
5253 this tuning is complicated.
5254
5255 There are three numbers, separated by commas:
5256 {start},{inc},{added}
5257
5258 For most languages the uncompressed word tree fits in memory. {start}
5259 gives the amount of memory in Kbyte that can be used before any
5260 compression is done. It should be a bit smaller than the amount of
5261 memory that is available to Vim.
5262
5263 When going over the {start} limit the {inc} number specifies the
5264 amount of memory in Kbyte that can be allocated before another
5265 compression is done. A low number means compression is done after
5266 less words are added, which is slow. A high number means more memory
5267 will be allocated.
5268
5269 After doing compression, {added} times 1024 words can be added before
5270 the {inc} limit is ignored and compression is done when any extra
5271 amount of memory is needed. A low number means there is a smaller
5272 chance of hitting the {inc} limit, less memory is used but it's
5273 slower.
5274
5275 The languages for which these numbers are important are Italian and
5276 Hungarian. The default works for when you have about 512 Mbyte. If
5277 you have 1 Gbyte you could use: >
5278 :set mkspellmem=900000,3000,800
5279< If you have less than 512 Mbyte |:mkspell| may fail for some
5280 languages, no matter what you set 'mkspellmem' to.
5281
Bram Moolenaar07607392019-05-26 19:20:43 +02005282 This option cannot be set from a |modeline| or in the |sandbox|.
5283
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005285'modeline' 'ml' boolean (Vim default: on (off for root),
5286 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005288 If 'modeline' is on 'modelines' gives the number of lines that is
5289 checked for set commands. If 'modeline' is off or 'modelines' is zero
5290 no lines are checked. See |modeline|.
5291
5292 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5293'modelineexpr' 'mle' boolean (default: off)
5294 global
5295 When on allow some options that are an expression to be set in the
5296 modeline. Check the option for whether it is affected by
5297 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005298 This option cannot be set from a |modeline| or in the |sandbox|, for
5299 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005300
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 *'modelines'* *'mls'*
5302'modelines' 'mls' number (default 5)
5303 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 If 'modeline' is on 'modelines' gives the number of lines that is
5305 checked for set commands. If 'modeline' is off or 'modelines' is zero
5306 no lines are checked. See |modeline|.
5307 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5308 set and to the Vim default value when 'compatible' is reset.
5309
5310 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005311 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312'modifiable' 'ma' boolean (default on)
5313 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 When off the buffer contents cannot be changed. The 'fileformat' and
5315 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005316 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317
5318 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5319'modified' 'mod' boolean (default off)
5320 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 When on, the buffer is considered to be modified. This option is set
5322 when:
5323 1. A change was made to the text since it was last written. Using the
5324 |undo| command to go back to the original text will reset the
5325 option. But undoing changes that were made before writing the
5326 buffer will set the option again, since the text is different from
5327 when it was written.
5328 2. 'fileformat' or 'fileencoding' is different from its original
5329 value. The original value is set when the buffer is read or
5330 written. A ":set nomodified" command also resets the original
5331 values to the current values and the 'modified' option will be
5332 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005333 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005334 This option is not set when a change is made to the buffer as the
5335 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5336 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5337 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5339 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005340 Note that the text may actually be the same, e.g. 'modified' is set
5341 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342
5343 *'more'* *'nomore'*
5344'more' boolean (Vim default: on, Vi default: off)
5345 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 When on, listings pause when the whole screen is filled. You will get
5347 the |more-prompt|. When this option is off there are no pauses, the
5348 listing continues until finished.
5349 NOTE: This option is set to the Vi default value when 'compatible' is
5350 set and to the Vim default value when 'compatible' is reset.
5351
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005352 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005353'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005354 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005356 Enable the use of the mouse. Works for most terminals (xterm, Win32
5357 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5358 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5359 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005360 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005361 v Visual mode
5362 i Insert mode
5363 c Command-line mode
5364 h all previous modes when editing a help file
5365 a all previous modes
5366 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005367 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005369< If your terminal can't overrule the mouse events going to the
5370 application, use: >
5371 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005372< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005373 back to Vim using the mouse events.
5374 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5375 "xterm".
5376
5377 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 modeless selection. This doesn't move the text cursor.
5379
5380 See |mouse-using|. Also see |'clipboard'|.
5381
5382 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005383 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 the mouse buttons can still be used by keeping the shift key pressed.
5385 Also see the 'clipboard' option.
5386
5387 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5388'mousefocus' 'mousef' boolean (default off)
5389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 {only works in the GUI}
5391 The window that the mouse pointer is on is automatically activated.
5392 When changing the window layout or window focus in another way, the
5393 mouse pointer is moved to the window with keyboard focus. Off is the
5394 default because it makes using the pull down menus a little goofy, as
5395 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005396 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005397 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398
5399 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5400'mousehide' 'mh' boolean (default on)
5401 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402 {only works in the GUI}
5403 When on, the mouse pointer is hidden when characters are typed.
5404 The mouse pointer is restored when the mouse is moved.
5405
5406 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005407'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 Sets the model to use for the mouse. The name mostly specifies what
5410 the right mouse button is used for:
5411 extend Right mouse button extends a selection. This works
5412 like in an xterm.
5413 popup Right mouse button pops up a menu. The shifted left
5414 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005415 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 popup_setpos Like "popup", but the cursor will be moved to the
5417 position where the mouse was clicked, and thus the
5418 selected operation will act upon the clicked object.
5419 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005420 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 course, that right clicking outside a selection will
5422 end Visual mode.
5423 Overview of what button does what for each model:
5424 mouse extend popup(_setpos) ~
5425 left click place cursor place cursor
5426 left drag start selection start selection
5427 shift-left search word extend selection
5428 right click extend selection popup menu (place cursor)
5429 right drag extend selection -
5430 middle click paste paste
5431
5432 In the "popup" model the right mouse button produces a pop-up menu.
5433 You need to define this first, see |popup-menu|.
5434
5435 Note that you can further refine the meaning of buttons with mappings.
5436 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5437 selection (because that's handled in the GUI code directly).
5438
5439 The 'mousemodel' option is set by the |:behave| command.
5440
5441 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005442'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5443 vs:leftright,vd:lrsizing,m:no,
5444 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 {only available when compiled with the |+mouseshape|
5447 feature}
5448 This option tells Vim what the mouse pointer should look like in
5449 different modes. The option is a comma separated list of parts, much
5450 like used for 'guicursor'. Each part consist of a mode/location-list
5451 and an argument-list:
5452 mode-list:shape,mode-list:shape,..
5453 The mode-list is a dash separated list of these modes/locations:
5454 In a normal window: ~
5455 n Normal mode
5456 v Visual mode
5457 ve Visual mode with 'selection' "exclusive" (same as 'v',
5458 if not specified)
5459 o Operator-pending mode
5460 i Insert mode
5461 r Replace mode
5462
5463 Others: ~
5464 c appending to the command-line
5465 ci inserting in the command-line
5466 cr replacing in the command-line
5467 m at the 'Hit ENTER' or 'More' prompts
5468 ml idem, but cursor in the last line
5469 e any mode, pointer below last window
5470 s any mode, pointer on a status line
5471 sd any mode, while dragging a status line
5472 vs any mode, pointer on a vertical separator line
5473 vd any mode, while dragging a vertical separator line
5474 a everywhere
5475
5476 The shape is one of the following:
5477 avail name looks like ~
5478 w x arrow Normal mouse pointer
5479 w x blank no pointer at all (use with care!)
5480 w x beam I-beam
5481 w x updown up-down sizing arrows
5482 w x leftright left-right sizing arrows
5483 w x busy The system's usual busy pointer
5484 w x no The system's usual 'no input' pointer
5485 x udsizing indicates up-down resizing
5486 x lrsizing indicates left-right resizing
5487 x crosshair like a big thin +
5488 x hand1 black hand
5489 x hand2 white hand
5490 x pencil what you write with
5491 x question big ?
5492 x rightup-arrow arrow pointing right-up
5493 w x up-arrow arrow pointing up
5494 x <number> any X11 pointer number (see X11/cursorfont.h)
5495
5496 The "avail" column contains a 'w' if the shape is available for Win32,
5497 x for X11.
5498 Any modes not specified or shapes not available use the normal mouse
5499 pointer.
5500
5501 Example: >
5502 :set mouseshape=s:udsizing,m:no
5503< will make the mouse turn to a sizing arrow over the status lines and
5504 indicate no input when the hit-enter prompt is displayed (since
5505 clicking the mouse has no effect in this state.)
5506
5507 *'mousetime'* *'mouset'*
5508'mousetime' 'mouset' number (default 500)
5509 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005510 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 time in msec between two mouse clicks for the second click to be
5512 recognized as a multi click.
5513
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005514 *'mzschemedll'*
5515'mzschemedll' string (default depends on the build)
5516 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005517 {only available when compiled with the |+mzscheme/dyn|
5518 feature}
5519 Specifies the name of the MzScheme shared library. The default is
5520 DYNAMIC_MZSCH_DLL which was specified at compile time.
5521 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005522 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005523 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005524 This option cannot be set from a |modeline| or in the |sandbox|, for
5525 security reasons.
5526
5527 *'mzschemegcdll'*
5528'mzschemegcdll' string (default depends on the build)
5529 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005530 {only available when compiled with the |+mzscheme/dyn|
5531 feature}
5532 Specifies the name of the MzScheme GC shared library. The default is
5533 DYNAMIC_MZGC_DLL which was specified at compile time.
5534 The value can be equal to 'mzschemedll' if it includes the GC code.
5535 Environment variables are expanded |:set_env|.
5536 This option cannot be set from a |modeline| or in the |sandbox|, for
5537 security reasons.
5538
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005539 *'mzquantum'* *'mzq'*
5540'mzquantum' 'mzq' number (default 100)
5541 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005542 {not available when compiled without the |+mzscheme|
5543 feature}
5544 The number of milliseconds between polls for MzScheme threads.
5545 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005546 NOTE: This option is set to the Vim default value when 'compatible'
5547 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005548
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005550'nrformats' 'nf' string (default "bin,octal,hex",
5551 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 This defines what bases Vim will consider for numbers when using the
5554 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5555 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005556 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005558 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005559 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005561 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 considered to be hexadecimal. Example: Using CTRL-X on
5563 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005564 bin If included, numbers starting with "0b" or "0B" will be
5565 considered to be binary. Example: Using CTRL-X on
5566 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005567 unsigned If included, numbers are recognized as unsigned. Thus a
5568 leading dash or negative sign won't be considered as part of
5569 the number. Examples:
5570 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5571 (without "unsigned" it would become "9-2021").
5572 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5573 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005574 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5575 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 Numbers which simply begin with a digit in the range 1-9 are always
5577 considered decimal. This also happens for numbers that are not
5578 recognized as octal or hex.
5579
5580 *'number'* *'nu'* *'nonumber'* *'nonu'*
5581'number' 'nu' boolean (default off)
5582 local to window
5583 Print the line number in front of each line. When the 'n' option is
5584 excluded from 'cpoptions' a wrapped line will not use the column of
5585 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005586 The 'numberwidth' option can be used to set the room used for the line
5587 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 When a long, wrapped line doesn't start with the first character, '-'
5589 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005590 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5591 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005592 *number_relativenumber*
5593 The 'relativenumber' option changes the displayed number to be
5594 relative to the cursor. Together with 'number' there are these
5595 four combinations (cursor in line 3):
5596
Bram Moolenaar3848e002016-03-19 18:42:29 +01005597 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005598 'nornu' 'nornu' 'rnu' 'rnu'
5599
5600 |apple | 1 apple | 2 apple | 2 apple
5601 |pear | 2 pear | 1 pear | 1 pear
5602 |nobody | 3 nobody | 0 nobody |3 nobody
5603 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005605 *'numberwidth'* *'nuw'*
5606'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5607 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005608 {only available when compiled with the |+linebreak|
5609 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005610 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005611 when the 'number' or 'relativenumber' option is set or printing lines
5612 with a line number. Since one space is always between the number and
5613 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005614 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005615 fit the highest line number in the buffer respectively the number of
5616 rows in the window, depending on whether 'number' or 'relativenumber'
5617 is set. Thus with the Vim default of 4 there is room for a line number
5618 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005619 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005620 NOTE: This option is set to the Vi default value when 'compatible' is
5621 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005622
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005623 *'omnifunc'* *'ofu'*
5624'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005625 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005626 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005627 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005628 This option specifies a function to be used for Insert mode omni
5629 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005630 See |complete-functions| for an explanation of how the function is
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00005631 invoked and what it should return. The value can be the name of a
5632 function, a |lambda| or a |Funcref|. See |option-value-function| for
5633 more information.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005634 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005635 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005636 This option cannot be set from a |modeline| or in the |sandbox|, for
5637 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005638
5639
Bram Moolenaar02467872007-05-06 13:22:01 +00005640 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005641'opendevice' 'odev' boolean (default off)
5642 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005643 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005644 Enable reading and writing from devices. This may get Vim stuck on a
5645 device that can be opened but doesn't actually do the I/O. Therefore
5646 it is off by default.
5647 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5648 result in editing a device.
5649
5650
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005651 *'operatorfunc'* *'opfunc'*
5652'operatorfunc' 'opfunc' string (default: empty)
5653 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005654 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005655 See |:map-operator| for more info and an example. The value can be
5656 the name of a function, a |lambda| or a |Funcref|. See
5657 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005658
5659 This option cannot be set from a |modeline| or in the |sandbox|, for
5660 security reasons.
5661
5662
Bram Moolenaar251e1912011-06-19 05:09:16 +02005663 *'osfiletype'* *'oft'*
5664'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005666 This option was supported on RISC OS, which has been removed.
5667
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005669 *'packpath'* *'pp'*
5670'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005671 Directories used to find packages. See |packages|.
5672
5673
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005675'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 global
5677 Specifies the nroff macros that separate paragraphs. These are pairs
5678 of two letters (see |object-motions|).
5679
5680 *'paste'* *'nopaste'*
5681'paste' boolean (default off)
5682 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005683 Put Vim in Paste mode. This is useful if you want to cut or copy
5684 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 unexpected effects.
5686 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005687 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 knows about pasting and will mostly do the right thing without 'paste'
5689 being set. The same is true for a terminal where Vim handles the
5690 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005691 This option is reset when starting the GUI. Thus if you set it in
5692 your .vimrc it will work in a terminal, but not in the GUI. Setting
5693 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5694 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 When the 'paste' option is switched on (also when it was already on):
5696 - mapping in Insert mode and Command-line mode is disabled
5697 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005699 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005700 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 - 'revins' is reset
5702 - 'ruler' is reset
5703 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005704 - 'smarttab' is reset
5705 - 'softtabstop' is set to 0
5706 - 'textwidth' is set to 0
5707 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005708 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005711 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005712 - 'indentexpr'
5713 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005714 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 NOTE: When you start editing another file while the 'paste' option is
5716 on, settings from the modelines or autocommands may change the
5717 settings again, causing trouble when pasting text. You might want to
5718 set the 'paste' option again.
5719 When the 'paste' option is reset the mentioned options are restored to
5720 the value before the moment 'paste' was switched from off to on.
5721 Resetting 'paste' before ever setting it does not have any effect.
5722 Since mapping doesn't work while 'paste' is active, you need to use
5723 the 'pastetoggle' option to toggle the 'paste' option with some key.
5724
5725 *'pastetoggle'* *'pt'*
5726'pastetoggle' 'pt' string (default "")
5727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 When non-empty, specifies the key sequence that toggles the 'paste'
5729 option. This is like specifying a mapping: >
5730 :map {keys} :set invpaste<CR>
5731< Where {keys} is the value of 'pastetoggle'.
5732 The difference is that it will work even when 'paste' is set.
5733 'pastetoggle' works in Insert mode and Normal mode, but not in
5734 Command-line mode.
5735 Mappings are checked first, thus overrule 'pastetoggle'. However,
5736 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5737 this: >
5738 :map <F10> :set paste<CR>
5739 :map <F11> :set nopaste<CR>
5740 :imap <F10> <C-O>:set paste<CR>
5741 :imap <F11> <nop>
5742 :set pastetoggle=<F11>
5743< This will make <F10> start paste mode and <F11> stop paste mode.
5744 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5745 mode everything is inserted literally, except the 'pastetoggle' key
5746 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005747 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748
5749 *'pex'* *'patchexpr'*
5750'patchexpr' 'pex' string (default "")
5751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 {not available when compiled without the |+diff|
5753 feature}
5754 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005755 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756
Bram Moolenaardbc28022014-07-26 13:40:44 +02005757 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758'patchmode' 'pm' string (default "")
5759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 When non-empty the oldest version of a file is kept. This can be used
5761 to keep the original version of a file if you are changing files in a
5762 source distribution. Only the first time that a file is written a
5763 copy of the original file will be kept. The name of the copy is the
5764 name of the original file with the string in the 'patchmode' option
5765 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005766 ".orig" or ".org". 'backupdir' must not be empty for this to work
5767 (Detail: The backup file is renamed to the patchmode file after the
5768 new file has been successfully written, that's why it must be possible
5769 to write a backup file). If there was no file to be backed up, an
5770 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 When the 'backupskip' pattern matches, a patchmode file is not made.
5772 Using 'patchmode' for compressed files appends the extension at the
5773 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5774 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005775 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005777 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 other systems: ".,,")
5780 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005782 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5783 provided that the file being searched for has a relative path (not
5784 starting with "/", "./" or "../"). The directories in the 'path'
5785 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005786 - Use commas to separate directory names: >
5787 :set path=.,/usr/local/include,/usr/include
5788< - Spaces can also be used to separate directory names (for backwards
5789 compatibility with version 3.0). To have a space in a directory
5790 name, precede it with an extra backslash, and escape the space: >
5791 :set path=.,/dir/with\\\ space
5792< - To include a comma in a directory name precede it with an extra
5793 backslash: >
5794 :set path=.,/dir/with\\,comma
5795< - To search relative to the directory of the current file, use: >
5796 :set path=.
5797< - To search in the current directory use an empty string between two
5798 commas: >
5799 :set path=,,
5800< - A directory name may end in a ':' or '/'.
5801 - Environment variables are expanded |:set_env|.
5802 - When using |netrw.vim| URLs can be used. For example, adding
5803 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005804 - Search upwards and downwards in a directory tree using "*", "**" and
5805 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 {not available when compiled without the |+path_extra| feature}
5807 - Careful with '\' characters, type two to get one in the option: >
5808 :set path=.,c:\\include
5809< Or just use '/' instead: >
5810 :set path=.,c:/include
5811< Don't forget "." or files won't even be found in the same directory as
5812 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005813 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 it is something like 256 or 1024 characters.
5815 You can check if all the include files are found, using the value of
5816 'path', see |:checkpath|.
5817 The use of |:set+=| and |:set-=| is preferred when adding or removing
5818 directories from the list. This avoids problems when a future version
5819 uses another default. To remove the current directory use: >
5820 :set path-=
5821< To add the current directory use: >
5822 :set path+=
5823< To use an environment variable, you probably need to replace the
5824 separator. Here is an example to append $INCL, in which directory
5825 names are separated with a semi-colon: >
5826 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5827< Replace the ';' with a ':' or whatever separator is used. Note that
5828 this doesn't work when $INCL contains a comma or white space.
5829
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005830 *'perldll'*
5831'perldll' string (default depends on the build)
5832 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005833 {only available when compiled with the |+perl/dyn|
5834 feature}
5835 Specifies the name of the Perl shared library. The default is
5836 DYNAMIC_PERL_DLL, which was specified at compile time.
5837 Environment variables are expanded |:set_env|.
5838 This option cannot be set from a |modeline| or in the |sandbox|, for
5839 security reasons.
5840
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5842'preserveindent' 'pi' boolean (default off)
5843 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 When changing the indent of the current line, preserve as much of the
5845 indent structure as possible. Normally the indent is replaced by a
5846 series of tabs followed by spaces as required (unless |'expandtab'| is
5847 enabled, in which case only spaces are used). Enabling this option
5848 means the indent will preserve as many existing characters as possible
5849 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005850 'expandtab' does not apply to the preserved white space, a Tab remains
5851 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 NOTE: When using ">>" multiple times the resulting indent is a mix of
5853 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005854 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 Also see 'copyindent'.
5856 Use |:retab| to clean up white space.
5857
5858 *'previewheight'* *'pvh'*
5859'previewheight' 'pvh' number (default 12)
5860 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005861 {not available when compiled without the |+quickfix|
5862 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005864 commands. Used for |CTRL-W_}| when no count is given. Not used when
5865 'previewpopup' is set.
5866
5867 *'previewpopup'* *'pvp'*
5868'previewpopup' 'pvp' string (default empty)
5869 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005870 {not available when compiled without the |+textprop|
5871 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005872 When not empty a popup window is used for commands that would open a
5873 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005874 Not used for the insert completion info, add "popup" to
5875 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876
5877 *'previewwindow'* *'nopreviewwindow'*
5878 *'pvw'* *'nopvw'* *E590*
5879'previewwindow' 'pvw' boolean (default off)
5880 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005881 {not available when compiled without the |+quickfix|
5882 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005883 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 set. It's normally not set directly, but by using one of the commands
5885 |:ptag|, |:pedit|, etc.
5886
5887 *'printdevice'* *'pdev'*
5888'printdevice' 'pdev' string (default empty)
5889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 {only available when compiled with the |+printer|
5891 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005892 The name of the printer to be used for |:hardcopy|.
5893 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005894 This option cannot be set from a |modeline| or in the |sandbox|, for
5895 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896
Bram Moolenaar8299df92004-07-10 09:47:34 +00005897 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005898'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 {only available when compiled with the |+printer|
5901 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005902 Sets the character encoding used when printing.
5903 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904
5905 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005906'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 {only available when compiled with the |+printer|
5909 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005910 Expression used to print the PostScript produced with |:hardcopy|.
5911 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005912 This option cannot be set from a |modeline| or in the |sandbox|, for
5913 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914
Bram Moolenaar8299df92004-07-10 09:47:34 +00005915 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916'printfont' 'pfn' string (default "courier")
5917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 {only available when compiled with the |+printer|
5919 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005920 The name of the font that will be used for |:hardcopy|.
5921 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922
5923 *'printheader'* *'pheader'*
5924'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 {only available when compiled with the |+printer|
5927 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005928 The format of the header produced in |:hardcopy| output.
5929 See |pheader-option|.
5930
5931 *'printmbcharset'* *'pmbcs'*
5932'printmbcharset' 'pmbcs' string (default "")
5933 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005934 {only available when compiled with the |+printer|
5935 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005936 The CJK character set to be used for CJK output from |:hardcopy|.
5937 See |pmbcs-option|.
5938
5939 *'printmbfont'* *'pmbfn'*
5940'printmbfont' 'pmbfn' string (default "")
5941 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005942 {only available when compiled with the |+printer|
5943 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005944 List of font names to be used for CJK output from |:hardcopy|.
5945 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946
5947 *'printoptions'* *'popt'*
5948'printoptions' 'popt' string (default "")
5949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005951 List of items that control the format of the output of |:hardcopy|.
5952 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005953
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005954 *'prompt'* *'noprompt'*
5955'prompt' boolean (default on)
5956 global
5957 When on a ":" prompt is used in Ex mode.
5958
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005959 *'pumheight'* *'ph'*
5960'pumheight' 'ph' number (default 0)
5961 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005962 Determines the maximum number of items to show in the popup menu for
5963 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005964 |ins-completion-menu|.
5965
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005966 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005967'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005968 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005969 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005970 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005971
Bram Moolenaard94464e2015-11-02 15:28:18 +01005972 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005973'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005974 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005975 {only available when compiled with the |+python/dyn|
5976 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005977 Specifies the name of the Python 2.x shared library. The default is
5978 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005979 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005980 This option cannot be set from a |modeline| or in the |sandbox|, for
5981 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005982
Bram Moolenaar94073162018-01-31 21:49:05 +01005983 *'pythonhome'*
5984'pythonhome' string (default "")
5985 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005986 {only available when compiled with the |+python/dyn|
5987 feature}
5988 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5989 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5990 which was specified at compile time, will be used for the Python 2.x
5991 home directory.
5992 Environment variables are expanded |:set_env|.
5993 This option cannot be set from a |modeline| or in the |sandbox|, for
5994 security reasons.
5995
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005996 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005997'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005998 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005999 {only available when compiled with the |+python3/dyn|
6000 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006001 Specifies the name of the Python 3 shared library. The default is
6002 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006003 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006004 This option cannot be set from a |modeline| or in the |sandbox|, for
6005 security reasons.
6006
Bram Moolenaar94073162018-01-31 21:49:05 +01006007 *'pythonthreehome'*
6008'pythonthreehome' string (default "")
6009 global
Bram Moolenaar94073162018-01-31 21:49:05 +01006010 {only available when compiled with the |+python3/dyn|
6011 feature}
6012 Specifies the name of the Python 3 home directory. When
6013 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6014 PYTHON3_HOME, which was specified at compile time, will be used for
6015 the Python 3 home directory.
6016 Environment variables are expanded |:set_env|.
6017 This option cannot be set from a |modeline| or in the |sandbox|, for
6018 security reasons.
6019
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006020 *'pyxversion'* *'pyx'*
6021'pyxversion' 'pyx' number (default depends on the build)
6022 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006023 {only available when compiled with the |+python| or
6024 the |+python3| feature}
6025 Specifies the python version used for pyx* functions and commands
6026 |python_x|. The default value is as follows:
6027
6028 Compiled with Default ~
6029 |+python| and |+python3| 0
6030 only |+python| 2
6031 only |+python3| 3
6032
6033 Available values are 0, 2 and 3.
6034 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6035 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6036 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6037 to 2 if Python 2 is available.
6038 See also: |has-pythonx|
6039
6040 If Vim is compiled with only |+python| or |+python3| setting
6041 'pyxversion' has no effect. The pyx* functions and commands are
6042 always the same as the compiled version.
6043
6044 This option cannot be set from a |modeline| or in the |sandbox|, for
6045 security reasons.
6046
Bram Moolenaar858ba062020-05-31 23:11:59 +02006047 *'quickfixtextfunc'* *'qftf'*
6048'quickfixtextfunc' 'qftf' string (default "")
6049 global
6050 {only available when compiled with the |+quickfix|
6051 feature}
6052 This option specifies a function to be used to get the text to display
6053 in the quickfix and location list windows. This can be used to
6054 customize the information displayed in the quickfix or location window
6055 for each entry in the corresponding quickfix or location list. See
6056 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006057 function and an example. The value can be the name of a function, a
6058 |lambda| or a |Funcref|. See |option-value-function| for more
6059 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006060
6061 This option cannot be set from a |modeline| or in the |sandbox|, for
6062 security reasons.
6063
Bram Moolenaar677ee682005-01-27 14:41:15 +00006064 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006065'quoteescape' 'qe' string (default "\")
6066 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006067 The characters that are used to escape quotes in a string. Used for
6068 objects like a', a" and a` |a'|.
6069 When one of the characters in this option is found inside a string,
6070 the following character will be skipped. The default value makes the
6071 text "foo\"bar\\" considered to be one string.
6072
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6074'readonly' 'ro' boolean (default off)
6075 local to buffer
6076 If on, writes fail unless you use a '!'. Protects you from
6077 accidentally overwriting a file. Default on when Vim is started
6078 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006079 When using ":w!" the 'readonly' option is reset for the current
6080 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006081 When using the ":view" command the 'readonly' option is set for the
6082 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006083 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006085 *'redrawtime'* *'rdt'*
6086'redrawtime' 'rdt' number (default 2000)
6087 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006088 {only available when compiled with the |+reltime|
6089 feature}
6090 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006091 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006092 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006093 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006094 matches will be highlighted.
6095 For syntax highlighting the time applies per window. When over the
6096 limit syntax highlighting is disabled until |CTRL-L| is used.
6097 This is used to avoid that Vim hangs when using a very complicated
6098 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006099
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006100 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006101'regexpengine' 're' number (default 0)
6102 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006103 This selects the default regexp engine. |two-engines|
6104 The possible values are:
6105 0 automatic selection
6106 1 old engine
6107 2 NFA engine
6108 Note that when using the NFA engine and the pattern contains something
6109 that is not supported the pattern will not match. This is only useful
6110 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006111 Using automatic selection enables Vim to switch the engine, if the
6112 default engine becomes too costly. E.g., when the NFA engine uses too
6113 many states. This should prevent Vim from hanging on a combination of
6114 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006115
Bram Moolenaar64486672010-05-16 15:46:46 +02006116 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6117'relativenumber' 'rnu' boolean (default off)
6118 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006119 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006120 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006121 precede some vertical motion commands (e.g. j k + -) with, without
6122 having to calculate it yourself. Especially useful in combination with
6123 other commands (e.g. y d c < > gq gw =).
6124 When the 'n' option is excluded from 'cpoptions' a wrapped
6125 line will not use the column of line numbers (this is the default when
6126 'compatible' isn't set).
6127 The 'numberwidth' option can be used to set the room used for the line
6128 number.
6129 When a long, wrapped line doesn't start with the first character, '-'
6130 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006131 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6132 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006133
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006134 The number in front of the cursor line also depends on the value of
6135 'number', see |number_relativenumber| for all combinations of the two
6136 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006137
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 *'remap'* *'noremap'*
6139'remap' boolean (default on)
6140 global
6141 Allows for mappings to work recursively. If you do not want this for
6142 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006143 NOTE: To avoid portability problems with Vim scripts, always keep
6144 this option at the default "on". Only switch it off when working with
6145 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006147 *'renderoptions'* *'rop'*
6148'renderoptions' 'rop' string (default: empty)
6149 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006150 {only available when compiled with GUI and DIRECTX on
6151 MS-Windows}
6152 Select a text renderer and set its options. The options depend on the
6153 renderer.
6154
6155 Syntax: >
6156 set rop=type:{renderer}(,{name}:{value})*
6157<
6158 Currently, only one optional renderer is available.
6159
6160 render behavior ~
6161 directx Vim will draw text using DirectX (DirectWrite). It makes
6162 drawn glyphs more beautiful than default GDI.
6163 It requires 'encoding' is "utf-8", and only works on
6164 MS-Windows Vista or newer version.
6165
6166 Options:
6167 name meaning type value ~
6168 gamma gamma float 1.0 - 2.2 (maybe)
6169 contrast enhancedContrast float (unknown)
6170 level clearTypeLevel float (unknown)
6171 geom pixelGeometry int 0 - 2 (see below)
6172 renmode renderingMode int 0 - 6 (see below)
6173 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006174 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006175
Bram Moolenaar92467d32017-12-05 13:22:16 +01006176 See this URL for detail (except for scrlines):
6177 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006178
6179 For geom: structure of a device pixel.
6180 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6181 1 - DWRITE_PIXEL_GEOMETRY_RGB
6182 2 - DWRITE_PIXEL_GEOMETRY_BGR
6183
6184 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006185 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006186
6187 For renmode: method of rendering glyphs.
6188 0 - DWRITE_RENDERING_MODE_DEFAULT
6189 1 - DWRITE_RENDERING_MODE_ALIASED
6190 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6191 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6192 4 - DWRITE_RENDERING_MODE_NATURAL
6193 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6194 6 - DWRITE_RENDERING_MODE_OUTLINE
6195
6196 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006197 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006198
6199 For taamode: antialiasing mode used for drawing text.
6200 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6201 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6202 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6203 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6204
6205 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006206 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6207
Bram Moolenaara338adc2018-01-31 20:51:47 +01006208 For scrlines:
6209 This was used for optimizing scrolling behavior, however this
6210 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006211
6212 Example: >
6213 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006214 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006215 set rop=type:directx
6216<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006217 If select a raster font (Courier, Terminal or FixedSys which
6218 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006219 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006220
6221 NOTE: It is known that some fonts and options combination
6222 causes trouble on drawing glyphs.
6223
Bram Moolenaar92467d32017-12-05 13:22:16 +01006224 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006225 special made fonts (True-Type fonts which includes only
6226 bitmap glyphs).
6227 - 'taamode:3' will not work with some vector fonts.
6228
6229 NOTE: With this option, you can display colored emoji
6230 (emoticon) in Windows 8.1 or later. To display colored emoji,
6231 there are some conditions which you should notice.
6232
6233 - If your font includes non-colored emoji already, it will
6234 be used.
6235 - If your font doesn't have emoji, the system chooses an
6236 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6237 will be used.
6238 - When this alternative font didn't have fixed width glyph,
6239 emoji might be rendered beyond the bounding box of drawing
6240 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006241
6242 Other render types are currently not supported.
6243
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 *'report'*
6245'report' number (default 2)
6246 global
6247 Threshold for reporting number of lines changed. When the number of
6248 changed lines is more than 'report' a message will be given for most
6249 ":" commands. If you want it always, set 'report' to 0.
6250 For the ":substitute" command the number of substitutions is used
6251 instead of the number of lines.
6252
6253 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6254'restorescreen' 'rs' boolean (default on)
6255 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006256 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 When set, the screen contents is restored when exiting Vim. This also
6258 happens when executing external commands.
6259
6260 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6261 options in your .vimrc. To disable restoring:
6262 set t_ti= t_te=
6263 To enable restoring (for an xterm):
6264 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6265 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6266
6267 *'revins'* *'ri'* *'norevins'* *'nori'*
6268'revins' 'ri' boolean (default off)
6269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 {only available when compiled with the |+rightleft|
6271 feature}
6272 Inserting characters in Insert mode will work backwards. See "typing
6273 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6274 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006275 NOTE: This option is reset when 'compatible' is set.
6276 This option is reset when 'paste' is set and restored when 'paste' is
6277 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278
6279 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6280'rightleft' 'rl' boolean (default off)
6281 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 {only available when compiled with the |+rightleft|
6283 feature}
6284 When on, display orientation becomes right-to-left, i.e., characters
6285 that are stored in the file appear from the right to the left.
6286 Using this option, it is possible to edit files for languages that
6287 are written from the right to the left such as Hebrew and Arabic.
6288 This option is per window, so it is possible to edit mixed files
6289 simultaneously, or to view the same file in both ways (this is
6290 useful whenever you have a mixed text file with both right-to-left
6291 and left-to-right strings so that both sets are displayed properly
6292 in different windows). Also see |rileft.txt|.
6293
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006294 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295'rightleftcmd' 'rlc' string (default "search")
6296 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 {only available when compiled with the |+rightleft|
6298 feature}
6299 Each word in this option enables the command line editing to work in
6300 right-to-left mode for a group of commands:
6301
6302 search "/" and "?" commands
6303
6304 This is useful for languages such as Hebrew, Arabic and Farsi.
6305 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6306
Bram Moolenaard94464e2015-11-02 15:28:18 +01006307 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006308'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006309 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006310 {only available when compiled with the |+ruby/dyn|
6311 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006312 Specifies the name of the Ruby shared library. The default is
6313 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006314 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006315 This option cannot be set from a |modeline| or in the |sandbox|, for
6316 security reasons.
6317
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006319'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 {not available when compiled without the
6322 |+cmdline_info| feature}
6323 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006324 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 text in the file is shown on the far right:
6326 Top first line is visible
6327 Bot last line is visible
6328 All first and last line are visible
6329 45% relative position in the file
6330 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006331 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006333 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 this option takes precedence over 'ruler' and 'rulerformat'
6335 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006336 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 the text column (byte number) and the screen column are shown,
6338 separated with a dash.
6339 For an empty line "0-1" is shown.
6340 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006341 This option is reset when 'paste' is set and restored when 'paste' is
6342 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 If you don't want to see the ruler all the time but want to know where
6344 you are, use "g CTRL-G" |g_CTRL-G|.
6345 NOTE: This option is reset when 'compatible' is set.
6346
6347 *'rulerformat'* *'ruf'*
6348'rulerformat' 'ruf' string (default empty)
6349 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 {not available when compiled without the |+statusline|
6351 feature}
6352 When this option is not empty, it determines the content of the ruler
6353 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006354 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006355 This option cannot be set in a modeline when 'modelineexpr' is off.
6356
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 The default ruler width is 17 characters. To make the ruler 15
6358 characters wide, put "%15(" at the start and "%)" at the end.
6359 Example: >
6360 :set rulerformat=%15(%c%V\ %p%%%)
6361<
6362 *'runtimepath'* *'rtp'* *vimfiles*
6363'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006364 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 $VIM/vimfiles,
6366 $VIMRUNTIME,
6367 $VIM/vimfiles/after,
6368 $HOME/.vim/after"
6369 Amiga: "home:vimfiles,
6370 $VIM/vimfiles,
6371 $VIMRUNTIME,
6372 $VIM/vimfiles/after,
6373 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006374 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 $VIM/vimfiles,
6376 $VIMRUNTIME,
6377 $VIM/vimfiles/after,
6378 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006379 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 $VIMRUNTIME,
6381 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006382 Haiku: "$BE_USER_SETTINGS/vim,
6383 $VIM/vimfiles,
6384 $VIMRUNTIME,
6385 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006386 $BE_USER_SETTINGS/vim/after"
6387 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 $VIM/vimfiles,
6389 $VIMRUNTIME,
6390 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006391 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 This is a list of directories which will be searched for runtime
6394 files:
6395 filetype.vim filetypes by file name |new-filetype|
6396 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006397 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 colors/ color scheme files |:colorscheme|
6399 compiler/ compiler files |:compiler|
6400 doc/ documentation |write-local-help|
6401 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006402 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 indent/ indent scripts |indent-expression|
6404 keymap/ key mapping files |mbyte-keymap|
6405 lang/ menu translations |:menutrans|
6406 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006407 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 plugin/ plugin scripts |write-plugin|
6409 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006410 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 syntax/ syntax files |mysyntaxfile|
6412 tutor/ files for vimtutor |tutor|
6413
6414 And any other file searched for with the |:runtime| command.
6415
6416 The defaults for most systems are setup to search five locations:
6417 1. In your home directory, for your personal preferences.
6418 2. In a system-wide Vim directory, for preferences from the system
6419 administrator.
6420 3. In $VIMRUNTIME, for files distributed with Vim.
6421 *after-directory*
6422 4. In the "after" directory in the system-wide Vim directory. This is
6423 for the system administrator to overrule or add to the distributed
6424 defaults (rarely needed)
6425 5. In the "after" directory in your home directory. This is for
6426 personal preferences to overrule or add to the distributed defaults
6427 or system-wide settings (rarely needed).
6428
Bram Moolenaard0796902016-09-16 20:02:31 +02006429 More entries are added when using |packages|. If it gets very long
6430 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6431 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006432
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6434 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006435 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 wildcards.
6437 See |:runtime|.
6438 Example: >
6439 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6440< This will use the directory "~/vimruntime" first (containing your
6441 personal Vim runtime files), then "/mygroup/vim" (shared between a
6442 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6443 files).
6444 You probably should always include $VIMRUNTIME somewhere, to use the
6445 distributed runtime files. You can put a directory before $VIMRUNTIME
6446 to find files which replace a distributed runtime files. You can put
6447 a directory after $VIMRUNTIME to find files which add to distributed
6448 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006449 When Vim is started with |--clean| the home directory entries are not
6450 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 This option cannot be set from a |modeline| or in the |sandbox|, for
6452 security reasons.
6453
6454 *'scroll'* *'scr'*
6455'scroll' 'scr' number (default: half the window height)
6456 local to window
6457 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6458 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006459 changes. This may happen when enabling the |status-line| or
6460 'tabline' option after setting the 'scroll' option.
6461 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006462 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006463 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464
6465 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6466'scrollbind' 'scb' boolean (default off)
6467 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 See also |scroll-binding|. When this option is set, the current
6469 window scrolls as other scrollbind windows (windows that also have
6470 this option set) scroll. This option is useful for viewing the
6471 differences between two versions of a file, see 'diff'.
6472 See |'scrollopt'| for options that determine how this option should be
6473 interpreted.
6474 This option is mostly reset when splitting a window to edit another
6475 file. This means that ":split | edit file" results in two windows
6476 with scroll-binding, but ":split file" does not.
6477
Bram Moolenaarae20f342019-11-05 21:09:23 +01006478 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6479'scrollfocus' 'scf' boolean (default off)
6480 global
6481 {only for MS-Windows GUI}
6482 When using the scroll wheel and this option is set, the window under
6483 the mouse pointer is scrolled. With this option off the current
6484 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006485 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006486
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 *'scrolljump'* *'sj'*
6488'scrolljump' 'sj' number (default 1)
6489 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 Minimal number of lines to scroll when the cursor gets off the
6491 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6492 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006493 When set to a negative number from -1 to -100 this is used as the
6494 percentage of the window height. Thus -50 scrolls half the window
6495 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 NOTE: This option is set to 1 when 'compatible' is set.
6497
6498 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006499'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006500 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 Minimal number of screen lines to keep above and below the cursor.
6502 This will make some context visible around where you are working. If
6503 you set it to a very large value (999) the cursor line will always be
6504 in the middle of the window (except at the start or end of the file or
6505 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006506 After using the local value, go back the global value with one of
6507 these two: >
6508 setlocal scrolloff<
6509 setlocal scrolloff=-1
6510< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 NOTE: This option is set to 0 when 'compatible' is set.
6512
6513 *'scrollopt'* *'sbo'*
6514'scrollopt' 'sbo' string (default "ver,jump")
6515 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006517 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6518 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 The following words are available:
6520 ver Bind vertical scrolling for 'scrollbind' windows
6521 hor Bind horizontal scrolling for 'scrollbind' windows
6522 jump Applies to the offset between two windows for vertical
6523 scrolling. This offset is the difference in the first
6524 displayed line of the bound windows. When moving
6525 around in a window, another 'scrollbind' window may
6526 reach a position before the start or after the end of
6527 the buffer. The offset is not changed though, when
6528 moving back the 'scrollbind' window will try to scroll
6529 to the desired position when possible.
6530 When now making that window the current one, two
6531 things can be done with the relative offset:
6532 1. When "jump" is not included, the relative offset is
6533 adjusted for the scroll position in the new current
6534 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006535 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 2. When "jump" is included, the other windows are
6537 scrolled to keep the same relative offset. When
6538 going back to the other window, it still uses the
6539 same relative offset.
6540 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006541 When 'diff' mode is active there always is vertical scroll binding,
6542 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543
6544 *'sections'* *'sect'*
6545'sections' 'sect' string (default "SHNHH HUnhsh")
6546 global
6547 Specifies the nroff macros that separate sections. These are pairs of
6548 two letters (See |object-motions|). The default makes a section start
6549 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6550
6551 *'secure'* *'nosecure'* *E523*
6552'secure' boolean (default off)
6553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 When on, ":autocmd", shell and write commands are not allowed in
6555 ".vimrc" and ".exrc" in the current directory and map commands are
6556 displayed. Switch it off only if you know that you will not run into
6557 problems, or when the 'exrc' option is off. On Unix this option is
6558 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006559 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 'secure' at the end of your ~/.vimrc then.
6561 This option cannot be set from a |modeline| or in the |sandbox|, for
6562 security reasons.
6563
6564 *'selection'* *'sel'*
6565'selection' 'sel' string (default "inclusive")
6566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 This option defines the behavior of the selection. It is only used
6568 in Visual and Select mode.
6569 Possible values:
6570 value past line inclusive ~
6571 old no yes
6572 inclusive yes yes
6573 exclusive yes no
6574 "past line" means that the cursor is allowed to be positioned one
6575 character past the line.
6576 "inclusive" means that the last character of the selection is included
6577 in an operation. For example, when "x" is used to delete the
6578 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006579 When "old" is used and 'virtualedit' allows the cursor to move past
6580 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 Note that when "exclusive" is used and selecting from the end
6582 backwards, you cannot include the last character of a line, when
6583 starting in Normal mode and 'virtualedit' empty.
6584
6585 The 'selection' option is set by the |:behave| command.
6586
6587 *'selectmode'* *'slm'*
6588'selectmode' 'slm' string (default "")
6589 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 This is a comma separated list of words, which specifies when to start
6591 Select mode instead of Visual mode, when a selection is started.
6592 Possible values:
6593 mouse when using the mouse
6594 key when using shifted special keys
6595 cmd when using "v", "V" or CTRL-V
6596 See |Select-mode|.
6597 The 'selectmode' option is set by the |:behave| command.
6598
6599 *'sessionoptions'* *'ssop'*
6600'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006601 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006603 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 feature}
6605 Changes the effect of the |:mksession| command. It is a comma
6606 separated list of words. Each word enables saving and restoring
6607 something:
6608 word save and restore ~
6609 blank empty windows
6610 buffers hidden and unloaded buffers, not just those in windows
6611 curdir the current directory
6612 folds manually created folds, opened/closed folds and local
6613 fold options
6614 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006615 and contain at least one lowercase letter. Only
6616 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 help the help window
6618 localoptions options and mappings local to a window or buffer (not
6619 global values for local options)
6620 options all options and mappings (also global values for local
6621 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006622 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 resize size of the Vim window: 'lines' and 'columns'
6624 sesdir the directory in which the session file is located
6625 will become the current directory (useful with
6626 projects accessed over a network from different
6627 systems)
6628 slash backslashes in file names replaced with forward
6629 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006630 tabpages all tab pages; without this only the current tab page
6631 is restored, so that you can make a session for each
6632 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006633 terminal include terminal windows where the command can be
6634 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 unix with Unix end-of-line format (single <NL>), even when
6636 on Windows or DOS
6637 winpos position of the whole Vim window
6638 winsize window sizes
6639
6640 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006641 When neither "curdir" nor "sesdir" is included, file names are stored
6642 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 "slash" and "unix" are useful on Windows when sharing session files
6644 with Unix. The Unix version of Vim cannot source dos format scripts,
6645 but the Windows version of Vim can source unix format scripts.
6646
6647 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006648'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 global
6650 Name of the shell to use for ! and :! commands. When changing the
6651 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6652 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006653 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 See |option-backslash| about including spaces and backslashes.
6655 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006656
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006657 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006658 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6660< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006661 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006663 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006665 Example with escaped space (Vim will do this when initializing the
6666 option from $SHELL): >
6667 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006668< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006669 backslashes are consumed by `:set`.
6670
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 Under MS-Windows, when the executable ends in ".com" it must be
6672 included. Thus setting the shell to "command.com" or "4dos.com"
6673 works, but "command" and "4dos" do not work for all commands (e.g.,
6674 filtering).
6675 For unknown reasons, when using "4dos.com" the current directory is
6676 changed to "C:\". To avoid this set 'shell' like this: >
6677 :set shell=command.com\ /c\ 4dos
6678< This option cannot be set from a |modeline| or in the |sandbox|, for
6679 security reasons.
6680
6681 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006682'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006683 Win32, when 'shell' contains "powershell":
6684 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006685 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006688 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6689 For MS-Windows, the default is set according to the value of 'shell',
6690 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006691 On Unix it can have more than one flag. Each white space separated
6692 part is passed as an argument to the shell command.
6693 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006694 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 This option cannot be set from a |modeline| or in the |sandbox|, for
6696 security reasons.
6697
6698 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006699'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6700 "2>&1| tee", or
6701 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 {not available when compiled without the |+quickfix|
6704 feature}
6705 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006706 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 including spaces and backslashes.
6708 The name of the temporary file can be represented by "%s" if necessary
6709 (the file name is appended automatically if no %s appears in the value
6710 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006711 For the Amiga the default is ">". For MS-Windows using powershell the
6712 default is "2>&1 | Out-File -Encoding default", otherwise the default
6713 is ">%s 2>&1". The output is directly saved in a file and not echoed
6714 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006715 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 in a file and echoed to the screen. If the 'shell' option is "csh" or
6717 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006718 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006719 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6720 means that stderr is also included. Before using the 'shell' option a
6721 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006722 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6723 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 The initialization of this option is done after reading the ".vimrc"
6725 and the other initializations, so that when the 'shell' option is set
6726 there, the 'shellpipe' option changes automatically, unless it was
6727 explicitly set before.
6728 When 'shellpipe' is set to an empty string, no redirection of the
6729 ":make" output will be done. This is useful if you use a 'makeprg'
6730 that writes to 'makeef' by itself. If you want no piping, but do
6731 want to include the 'makeef', set 'shellpipe' to a single space.
6732 Don't forget to precede the space with a backslash: ":set sp=\ ".
6733 In the future pipes may be used for filtering and this option will
6734 become obsolete (at least for Unix).
6735 This option cannot be set from a |modeline| or in the |sandbox|, for
6736 security reasons.
6737
6738 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006739'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 Quoting character(s), put around the command passed to the shell, for
6742 the "!" and ":!" commands. The redirection is kept outside of the
6743 quoting. See 'shellxquote' to include the redirection. It's
6744 probably not useful to set both options.
6745 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006746 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006747 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 This option cannot be set from a |modeline| or in the |sandbox|, for
6749 security reasons.
6750
6751 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006752'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6753 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 String to be used to put the output of a filter command in a temporary
6756 file. See also |:!|. See |option-backslash| about including spaces
6757 and backslashes.
6758 The name of the temporary file can be represented by "%s" if necessary
6759 (the file name is appended automatically if no %s appears in the value
6760 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006761 The default is ">". For Unix, if the 'shell' option is "csh" or
6762 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006763 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006764 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6765 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006766 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6767 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006768 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6769 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006770 The initialization of this option is done after reading the ".vimrc"
6771 and the other initializations, so that when the 'shell' option is set
6772 there, the 'shellredir' option changes automatically unless it was
6773 explicitly set before.
6774 In the future pipes may be used for filtering and this option will
6775 become obsolete (at least for Unix).
6776 This option cannot be set from a |modeline| or in the |sandbox|, for
6777 security reasons.
6778
6779 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6780'shellslash' 'ssl' boolean (default off)
6781 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006782 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006784 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006785 powershell.exe. Backward slashes can still be typed, but they are
6786 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 Note that setting or resetting this option has no effect for some
6788 existing file names, thus this option needs to be set before opening
6789 any file for best results. This might change in the future.
6790 'shellslash' only works when a backslash can be used as a path
6791 separator. To test if this is so use: >
6792 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006793< Also see 'completeslash'.
6794
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006795 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6796'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6797 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006798 When on, use temp files for shell commands. When off use a pipe.
6799 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006800 Currently a pipe is only supported on Unix and MS-Windows 2K and
6801 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006802 :if has("filterpipe")
6803< The advantage of using a pipe is that nobody can read the temp file
6804 and the 'shell' command does not need to support redirection.
6805 The advantage of using a temp file is that the file type and encoding
6806 can be detected.
6807 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6808 |FilterWritePost| autocommands event are not triggered when
6809 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006810 The `system()` function does not respect this option and always uses
6811 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006812 NOTE: This option is set to the Vim default value when 'compatible'
6813 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006814
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 *'shelltype'* *'st'*
6816'shelltype' 'st' number (default 0)
6817 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006818 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 On the Amiga this option influences the way how the commands work
6820 which use a shell.
6821 0 and 1: always use the shell
6822 2 and 3: use the shell only to filter lines
6823 4 and 5: use shell only for ':sh' command
6824 When not using the shell, the command is executed directly.
6825
6826 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6827 1 and 3: use "shell cmd" to start external commands
6828
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006829 *'shellxescape'* *'sxe'*
6830'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006831 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006832 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006833 When 'shellxquote' is set to "(" then the characters listed in this
6834 option will be escaped with a '^' character. This makes it possible
6835 to execute most external commands with cmd.exe.
6836
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 *'shellxquote'* *'sxq'*
6838'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006839 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006840 for Win32, when 'shell' is
6841 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006842 for Win32, when 'shell' contains "sh"
6843 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 for Unix, when using system(): "\"")
6845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 Quoting character(s), put around the command passed to the shell, for
6847 the "!" and ":!" commands. Includes the redirection. See
6848 'shellquote' to exclude the redirection. It's probably not useful
6849 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006850 When the value is '(' then ')' is appended. When the value is '"('
6851 then ')"' is appended.
6852 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006853 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006854 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6855 pwsh.exe which automatically strips off the first and last quote on a
6856 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6857 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006858 'shell', to reduce the need to set this option by the user. See
6859 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 This option cannot be set from a |modeline| or in the |sandbox|, for
6861 security reasons.
6862
6863 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6864'shiftround' 'sr' boolean (default off)
6865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 Round indent to multiple of 'shiftwidth'. Applies to > and <
6867 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6868 a multiple of 'shiftwidth' (this is Vi compatible).
6869 NOTE: This option is reset when 'compatible' is set.
6870
6871 *'shiftwidth'* *'sw'*
6872'shiftwidth' 'sw' number (default 8)
6873 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006874 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006876 When zero the 'ts' value will be used. Use the |shiftwidth()|
6877 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878
6879 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006880'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6881 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 This option helps to avoid all the |hit-enter| prompts caused by file
6884 messages, for example with CTRL-G, and to avoid some other messages.
6885 It is a list of flags:
6886 flag meaning when present ~
6887 f use "(3 of 5)" instead of "(file 3 of 5)"
6888 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006889 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 m use "[+]" instead of "[Modified]"
6891 n use "[New]" instead of "[New File]"
6892 r use "[RO]" instead of "[readonly]"
6893 w use "[w]" instead of "written" for file write message
6894 and "[a]" instead of "appended" for ':w >> file' command
6895 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6896 "[unix format]" and "[mac]" instead of "[mac format]".
6897 a all of the above abbreviations
6898
6899 o overwrite message for writing a file with subsequent message
6900 for reading a file (useful for ":wn" or when 'autowrite' on)
6901 O message for reading a file overwrites any previous message.
6902 Also for quickfix message (e.g., ":cn").
6903 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006904 hit TOP, continuing at BOTTOM" messages; when using the search
6905 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 t truncate file message at the start if it is too long to fit
6907 on the command-line, "<" will appear in the left most column.
6908 Ignored in Ex mode.
6909 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006910 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 Ignored in Ex mode.
6912 W don't give "written" or "[w]" when writing a file
6913 A don't give the "ATTENTION" message when an existing swap file
6914 is found.
6915 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006916 c don't give |ins-completion-menu| messages. For example,
6917 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6918 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006919 q use "recording" instead of "recording @a"
6920 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006921 was used for the command; note that this also affects messages
6922 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006923 S do not show search count message when searching, e.g.
6924 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925
6926 This gives you the opportunity to avoid that a change between buffers
6927 requires you to hit <Enter>, but still gives as useful a message as
6928 possible for the space available. To get the whole message that you
6929 would have got with 'shm' empty, use ":file!"
6930 Useful values:
6931 shm= No abbreviation of message.
6932 shm=a Abbreviation, but no loss of information.
6933 shm=at Abbreviation, and truncate message when necessary.
6934
6935 NOTE: This option is set to the Vi default value when 'compatible' is
6936 set and to the Vim default value when 'compatible' is reset.
6937
6938 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6939'shortname' 'sn' boolean (default off)
6940 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 Filenames are assumed to be 8 characters plus one extension of 3
6942 characters. Multiple dots in file names are not allowed. When this
6943 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006944 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006946 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947
6948 *'showbreak'* *'sbr'* *E595*
6949'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006950 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006951 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 feature}
6953 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006954 values are "> " or "+++ ": >
6955 :set showbreak=>\
6956< Note the backslash to escape the trailing space. It's easier like
6957 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006958 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006959< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 comma (in a future version the comma might be used to separate the
6961 part that is shown at the end and at the start of a line).
6962 The characters are highlighted according to the '@' flag in
6963 'highlight'.
6964 Note that tabs after the showbreak will be displayed differently.
6965 If you want the 'showbreak' to appear in between line numbers, add the
6966 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006967 A window-local value overrules a global value. If the global value is
6968 set and you want no value in the current window use NONE: >
6969 :setlocal showbreak=NONE
6970<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006972'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6973 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 {not available when compiled without the
6976 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006977 Show (partial) command in the last line of the screen. Set this
6978 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 In Visual mode the size of the selected area is shown:
6980 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006981 If the number of bytes is different it is also displayed: "2-6"
6982 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006984 - When selecting a block, the size in screen characters:
6985 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 NOTE: This option is set to the Vi default value when 'compatible' is
6987 set and to the Vim default value when 'compatible' is reset.
6988
6989 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6990'showfulltag' 'sft' boolean (default off)
6991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 When completing a word in insert mode (see |ins-completion|) from the
6993 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006994 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006995 matched a C function, you can see a template for what arguments are
6996 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006997 Note that this doesn't work well together with having "longest" in
6998 'completeopt', because the completion from the search pattern may not
6999 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000
7001 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7002'showmatch' 'sm' boolean (default off)
7003 global
7004 When a bracket is inserted, briefly jump to the matching one. The
7005 jump is only done if the match can be seen on the screen. The time to
7006 show the match can be set with 'matchtime'.
7007 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007008 seen or not).
7009 This option is reset when 'paste' is set and restored when 'paste' is
7010 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 When the 'm' flag is not included in 'cpoptions', typing a character
7012 will immediately move the cursor back to where it belongs.
7013 See the "sm" field in 'guicursor' for setting the cursor shape and
7014 blinking when showing the match.
7015 The 'matchpairs' option can be used to specify the characters to show
7016 matches for. 'rightleft' and 'revins' are used to look for opposite
7017 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007018 Also see the matchparen plugin for highlighting the match when moving
7019 around |pi_paren.txt|.
7020 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021
7022 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7023'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7024 global
7025 If in Insert, Replace or Visual mode put a message on the last line.
7026 Use the 'M' flag in 'highlight' to set the type of highlighting for
7027 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007028 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 doesn't mean XIM is really active, especially when 'imactivatekey' is
7030 not set.
7031 NOTE: This option is set to the Vi default value when 'compatible' is
7032 set and to the Vim default value when 'compatible' is reset.
7033
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007034 *'showtabline'* *'stal'*
7035'showtabline' 'stal' number (default 1)
7036 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007037 The value of this option specifies when the line with tab page labels
7038 will be displayed:
7039 0: never
7040 1: only if there are at least two tab pages
7041 2: always
7042 This is both for the GUI and non-GUI implementation of the tab pages
7043 line.
7044 See |tab-page| for more information about tab pages.
7045
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 *'sidescroll'* *'ss'*
7047'sidescroll' 'ss' number (default 0)
7048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 The minimal number of columns to scroll horizontally. Used only when
7050 the 'wrap' option is off and the cursor is moved off of the screen.
7051 When it is zero the cursor will be put in the middle of the screen.
7052 When using a slow terminal set it to a large number or 0. When using
7053 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7054 commands.
7055
7056 *'sidescrolloff'* *'siso'*
7057'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007058 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007060 right of the cursor if 'nowrap' is set. Setting this option to a
7061 value greater than 0 while having |'sidescroll'| also at a non-zero
7062 value makes some context visible in the line you are scrolling in
7063 horizontally (except at beginning of the line). Setting this option
7064 to a large value (like 999) has the effect of keeping the cursor
7065 horizontally centered in the window, as long as one does not come too
7066 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007067 After using the local value, go back the global value with one of
7068 these two: >
7069 setlocal sidescrolloff<
7070 setlocal sidescrolloff=-1
7071< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072
7073 Example: Try this together with 'sidescroll' and 'listchars' as
7074 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007075 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076
7077 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7078 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007079<
7080 *'signcolumn'* *'scl'*
7081'signcolumn' 'scl' string (default "auto")
7082 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007083 {not available when compiled without the |+signs|
7084 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007085 Whether or not to draw the signcolumn. Valid values are:
7086 "auto" only when there is a sign to display
7087 "no" never
7088 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007089 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007090 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091
7092
7093 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7094'smartcase' 'scs' boolean (default off)
7095 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 Override the 'ignorecase' option if the search pattern contains upper
7097 case characters. Only used when the search pattern is typed and
7098 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007099 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7101 recalling the search pattern from history and hitting <Enter>.
7102 NOTE: This option is reset when 'compatible' is set.
7103
7104 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7105'smartindent' 'si' boolean (default off)
7106 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 {not available when compiled without the
7108 |+smartindent| feature}
7109 Do smart autoindenting when starting a new line. Works for C-like
7110 programs, but can also be used for other languages. 'cindent' does
7111 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007112 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007113 setting 'si' has no effect. 'indentexpr' is a more advanced
7114 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 Normally 'autoindent' should also be on when using 'smartindent'.
7116 An indent is automatically inserted:
7117 - After a line ending in '{'.
7118 - After a line starting with a keyword from 'cinwords'.
7119 - Before a line starting with '}' (only with the "O" command).
7120 When typing '}' as the first character in a new line, that line is
7121 given the same indent as the matching '{'.
7122 When typing '#' as the first character in a new line, the indent for
7123 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007124 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7126 When using the ">>" command, lines starting with '#' are not shifted
7127 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007128 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007129 This option is reset when 'paste' is set and restored when 'paste' is
7130 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131
7132 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7133'smarttab' 'sta' boolean (default off)
7134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007136 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7137 <BS> will delete a 'shiftwidth' worth of space at the start of the
7138 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007139 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007140 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7141 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007142 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007144 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007145 This option is reset when 'paste' is set and restored when 'paste' is
7146 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 NOTE: This option is reset when 'compatible' is set.
7148
7149 *'softtabstop'* *'sts'*
7150'softtabstop' 'sts' number (default 0)
7151 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 Number of spaces that a <Tab> counts for while performing editing
7153 operations, like inserting a <Tab> or using <BS>. It "feels" like
7154 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7155 used. This is useful to keep the 'ts' setting at its standard value
7156 of 8, while being able to edit like it is set to 'sts'. However,
7157 commands like "x" still work on the actual characters.
7158 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007159 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007160 'softtabstop' is set to 0 when the 'paste' option is set and restored
7161 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7163 spaces is minimized by using <Tab>s.
7164 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7165 set.
7166 NOTE: This option is set to 0 when 'compatible' is set.
7167
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007168 If Vim is compiled with the |+vartabs| feature then the value of
7169 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7170 anything other than an empty string.
7171
Bram Moolenaar217ad922005-03-20 22:37:15 +00007172 *'spell'* *'nospell'*
7173'spell' boolean (default off)
7174 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007175 {not available when compiled without the |+syntax|
7176 feature}
7177 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007178 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007179
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007180 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007181'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007182 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007183 {not available when compiled without the |+syntax|
7184 feature}
7185 Pattern to locate the end of a sentence. The following word will be
7186 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007187 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007188 When this check is not wanted make this option empty.
7189 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007190 Be careful with special characters, see |option-backslash| about
7191 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007192 To set this option automatically depending on the language, see
7193 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007194
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007195 *'spellfile'* *'spf'*
7196'spellfile' 'spf' string (default empty)
7197 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007198 {not available when compiled without the |+syntax|
7199 feature}
7200 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007201 commands. It must end in ".{encoding}.add". You need to include the
7202 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007203 *E765*
7204 It may also be a comma separated list of names. A count before the
7205 |zg| and |zw| commands can be used to access each. This allows using
7206 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007207 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007208 you: Using the first directory in 'runtimepath' that is writable. If
7209 there is no "spell" directory yet it will be created. For the file
7210 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007211 ignoring the region.
7212 The resulting ".spl" file will be used for spell checking, it does not
7213 have to appear in 'spelllang'.
7214 Normally one file is used for all regions, but you can add the region
7215 name if you want to. However, it will then only be used when
7216 'spellfile' is set to it, for entries in 'spelllang' only files
7217 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007218 This option cannot be set from a |modeline| or in the |sandbox|, for
7219 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007220
Bram Moolenaar217ad922005-03-20 22:37:15 +00007221 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007222'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007223 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007224 {not available when compiled without the |+syntax|
7225 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007226 A comma separated list of word list names. When the 'spell' option is
7227 on spellchecking will be done for these languages. Example: >
7228 set spelllang=en_us,nl,medical
7229< This means US English, Dutch and medical words are recognized. Words
7230 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007231 The word list name must consist of alphanumeric characters, a dash or
7232 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007233 recommended to separate the two letter language name from a
7234 specification. Thus "en-rare" is used for rare English words.
7235 A region name must come last and have the form "_xx", where "xx" is
7236 the two-letter, lower case region name. You can use more than one
7237 region by listing them: "en_us,en_ca" supports both US and Canadian
7238 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007239 Britain. (Note: currently en_au and en_nz dictionaries are older than
7240 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007241 If the name "cjk" is included East Asian characters are excluded from
7242 spell checking. This is useful when editing text that also has Asian
7243 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007244 Note that the "medical" dictionary does not exist, it is just an
7245 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007246 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007247 As a special case the name of a .spl file can be given as-is. The
7248 first "_xx" in the name is removed and used as the region name
7249 (_xx is an underscore, two letters and followed by a non-letter).
7250 This is mainly for testing purposes. You must make sure the correct
7251 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007252 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007253 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7254 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007255 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007256
Bram Moolenaar98692072006-02-04 00:57:42 +00007257 If the |spellfile.vim| plugin is active and you use a language name
7258 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7259 will ask you if you want to download the file.
7260
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007261 After this option has been set successfully, Vim will source the files
7262 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007263 up to the first character that is not an ASCII letter or number and
7264 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007265
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007266 *'spelloptions'* *'spo'*
7267'spelloptions' 'spo' string (default "")
7268 local to buffer
7269 {not available when compiled without the |+syntax|
7270 feature}
7271 A comma separated list of options for spell checking:
7272 camel When a word is CamelCased, assume "Cased" is a
7273 separate word: every upper-case character in a word
7274 that comes after a lower case character indicates the
7275 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007276
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007277 *'spellsuggest'* *'sps'*
7278'spellsuggest' 'sps' string (default "best")
7279 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007280 {not available when compiled without the |+syntax|
7281 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007282 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007283 the |spellsuggest()| function. This is a comma-separated list of
7284 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007285
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007286 best Internal method that works best for English. Finds
7287 changes like "fast" and uses a bit of sound-a-like
7288 scoring to improve the ordering.
7289
7290 double Internal method that uses two methods and mixes the
7291 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007292 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007293 word. That only works when the language specifies
7294 sound folding. Can be slow and doesn't always give
7295 better results.
7296
7297 fast Internal method that only checks for simple changes:
7298 character inserts/deletes/swaps. Works well for
7299 simple typing mistakes.
7300
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007301 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007302 Not used for |spellsuggest()|. The number of
7303 suggestions is never more than the value of 'lines'
7304 minus two.
7305
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007306 file:{filename} Read file {filename}, which must have two columns,
7307 separated by a slash. The first column contains the
7308 bad word, the second column the suggested good word.
7309 Example:
7310 theribal/terrible ~
7311 Use this for common mistakes that do not appear at the
7312 top of the suggestion list with the internal methods.
7313 Lines without a slash are ignored, use this for
7314 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007315 The word in the second column must be correct,
7316 otherwise it will not be used. Add the word to an
7317 ".add" file if it is currently flagged as a spelling
7318 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007319 The file is used for all languages.
7320
7321 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7322 trouble with spaces. |v:val| holds the badly spelled
7323 word. The expression must evaluate to a List of
7324 Lists, each with a suggestion and a score.
7325 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007326 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007327 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007328 internal methods use. A lower score is better.
7329 This may invoke |spellsuggest()| if you temporarily
7330 set 'spellsuggest' to exclude the "expr:" part.
7331 Errors are silently ignored, unless you set the
7332 'verbose' option to a non-zero value.
7333
7334 Only one of "best", "double" or "fast" may be used. The others may
7335 appear several times in any order. Example: >
7336 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7337<
7338 This option cannot be set from a |modeline| or in the |sandbox|, for
7339 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007340
7341
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7343'splitbelow' 'sb' boolean (default off)
7344 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 When on, splitting a window will put the new window below the current
7346 one. |:split|
7347
7348 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7349'splitright' 'spr' boolean (default off)
7350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 When on, splitting a window will put the new window right of the
7352 current one. |:vsplit|
7353
7354 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7355'startofline' 'sol' boolean (default on)
7356 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007358 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007359 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007360 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 with a linewise operator, with "%" with a count and to buffer changing
7362 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7363 only has a line number, e.g., ":25" or ":+".
7364 In case of buffer changing commands the cursor is placed at the column
7365 where it was the last time the buffer was edited.
7366 NOTE: This option is set when 'compatible' is set.
7367
Bram Moolenaar00654022011-02-25 14:42:19 +01007368 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007370 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 {not available when compiled without the |+statusline|
7372 feature}
7373 When nonempty, this option determines the content of the status line.
7374 Also see |status-line|.
7375
7376 The option consists of printf style '%' items interspersed with
7377 normal text. Each status line item is of the form:
7378 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007379 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007380 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381
Bram Moolenaar238a5642006-02-21 22:12:05 +00007382 When the option starts with "%!" then it is used as an expression,
7383 evaluated and the result is used as the option value. Example: >
7384 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007385< The *g:statusline_winid* variable will be set to the |window-ID| of the
7386 window that the status line belongs to.
7387 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007388 Note that the "%!" expression is evaluated in the context of the
7389 current window and buffer, while %{} items are evaluated in the
7390 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007391
7392 When there is error while evaluating the option then it will be made
7393 empty to avoid further errors. Otherwise screen updating would loop.
7394
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 Note that the only effect of 'ruler' when this option is set (and
7396 'laststatus' is 2) is controlling the output of |CTRL-G|.
7397
7398 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007399 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007401 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 minwid Minimum width of the item, padding as set by '-' & '0'.
7403 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007404 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 on the left for text items. Numeric items will be
7406 shifted down to maxwid-2 digits followed by '>'number
7407 where number is the amount of missing digits, much like
7408 an exponential notation.
7409 item A one letter code as described below.
7410
7411 Following is a description of the possible statusline items. The
7412 second character in "item" is the type:
7413 N for number
7414 S for string
7415 F for flags as described below
7416 - not applicable
7417
7418 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007419 f S Path to the file in the buffer, as typed or relative to current
7420 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421 F S Full path to the file in the buffer.
7422 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007423 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007425 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007427 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007429 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007431 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007433 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7435 being used: "<keymap>"
7436 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007437 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 B N As above, in hexadecimal.
7439 o N Byte number in file of byte under cursor, first byte is 1.
7440 Mnemonic: Offset from start of file (with one added)
7441 {not available when compiled without |+byte_offset| feature}
7442 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007443 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 l N Line number.
7445 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007446 c N Column number (byte index).
7447 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007448 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 p N Percentage through file in lines as in |CTRL-G|.
7450 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007451 percentage described for 'ruler'. Always 3 in length, unless
7452 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007453 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007455 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007456 Note that there is no '%' before the closing '}'. The
7457 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007458 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007459 {% - This is almost same as { except the result of the expression is
7460 re-evaluated as a statusline format string. Thus if the
7461 return value of expr contains % items they will get expanded.
7462 The expression can contain the } character, the end of
7463 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007464 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007465 func! Stl_filename() abort
7466 return "%t"
7467 endfunc
7468< `stl=%{Stl_filename()}` results in `"%t"`
7469 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007470 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 ( - Start of item group. Can be used for setting the width and
7472 alignment of a section. Must be followed by %) somewhere.
7473 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007474 T N For 'tabline': start of tab page N label. Use %T after the last
7475 label. This information is used for mouse clicks.
7476 X N For 'tabline': start of close tab N label. Use %X after the
7477 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7478 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 < - Where to truncate line if too long. Default is at the start.
7480 No width fields allowed.
7481 = - Separation point between left and right aligned items.
7482 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007483 # - Set highlight group. The name must follow and then a # again.
7484 Thus use %#HLname# for highlight group HLname. The same
7485 highlighting is used, also for the statusline of non-current
7486 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007488 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 The difference between User{N} and StatusLine will be applied
7490 to StatusLineNC for the statusline of non-current windows.
7491 The number N must be between 1 and 9. See |hl-User1..9|
7492
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007493 When displaying a flag, Vim removes the leading comma, if any, when
7494 that flag comes right after plaintext. This will make a nice display
7495 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496
Bram Moolenaar582fd852005-03-28 20:58:01 +00007497 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 not set) and a minwid is not set for the group, the whole group will
7499 become empty. This will make a group like the following disappear
7500 completely from the statusline when none of the flags are set. >
7501 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007502< Beware that an expression is evaluated each and every time the status
7503 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007504 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007505 While evaluating %{} the current buffer and current window will be set
7506 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007507 currently being drawn. The expression will evaluate in this context.
7508 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7509 real current buffer and "g:actual_curwin" to the |window-ID| of the
7510 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007511
Bram Moolenaar30b65812012-07-12 22:01:11 +02007512 The 'statusline' option will be evaluated in the |sandbox| if set from
7513 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007514 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007515
7516 It is not allowed to change text or jump to another window while
7517 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518
7519 If the statusline is not updated when you want it (e.g., after setting
7520 a variable that's used in an expression), you can force an update by
7521 setting an option without changing its value. Example: >
7522 :let &ro = &ro
7523
7524< A result of all digits is regarded a number for display purposes.
7525 Otherwise the result is taken as flag text and applied to the rules
7526 described above.
7527
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007528 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007530 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531
7532 Examples:
7533 Emulate standard status line with 'ruler' set >
7534 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7535< Similar, but add ASCII value of char under the cursor (like "ga") >
7536 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7537< Display byte count and byte value, modified flag in red. >
7538 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7539 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7540< Display a ,GZ flag if a compressed file is loaded >
7541 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7542< In the |:autocmd|'s: >
7543 :let b:gzflag = 1
7544< And: >
7545 :unlet b:gzflag
7546< And define this function: >
7547 :function VarExists(var, val)
7548 : if exists(a:var) | return a:val | else | return '' | endif
7549 :endfunction
7550<
7551 *'suffixes'* *'su'*
7552'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 Files with these suffixes get a lower priority when multiple files
7555 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007556 suffixes. Spaces after the comma are ignored. A dot is also seen as
7557 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 separator, precede it with a backslash (see |option-backslash| about
7559 including spaces and backslashes).
7560 See 'wildignore' for completely ignoring files.
7561 The use of |:set+=| and |:set-=| is preferred when adding or removing
7562 suffixes from the list. This avoids problems when a future version
7563 uses another default.
7564
7565 *'suffixesadd'* *'sua'*
7566'suffixesadd' 'sua' string (default "")
7567 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 {not available when compiled without the
7569 |+file_in_path| feature}
7570 Comma separated list of suffixes, which are used when searching for a
7571 file for the "gf", "[I", etc. commands. Example: >
7572 :set suffixesadd=.java
7573<
7574 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7575'swapfile' 'swf' boolean (default on)
7576 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007577 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 swapfile is not wanted for a specific buffer. For example, with
7579 confidential information that even root must not be able to access.
7580 Careful: All text will be in memory:
7581 - Don't use this for big files.
7582 - Recovery will be impossible!
7583 A swapfile will only be present when |'updatecount'| is non-zero and
7584 'swapfile' is set.
7585 When 'swapfile' is reset, the swap file for the current buffer is
7586 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7587 non-zero, a swap file is immediately created.
7588 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007589 If you want to open a new buffer without creating a swap file for it,
7590 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007591 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592
7593 This option is used together with 'bufhidden' and 'buftype' to
7594 specify special kinds of buffers. See |special-buffers|.
7595
7596 *'swapsync'* *'sws'*
7597'swapsync' 'sws' string (default "fsync")
7598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007600 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 When this option is empty parts of the swap file may be in memory and
7602 not written to disk. When the system crashes you may lose more work.
7603 On Unix the system does a sync now and then without Vim asking for it,
7604 so the disadvantage of setting this option off is small. On some
7605 systems the swap file will not be written at all. For a unix system
7606 setting it to "sync" will use the sync() call instead of the default
7607 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007608 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609
7610 *'switchbuf'* *'swb'*
7611'switchbuf' 'swb' string (default "")
7612 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007614 Mostly for |quickfix| commands some values are also used for other
7615 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 Possible values (comma separated list):
7617 useopen If included, jump to the first open window that
7618 contains the specified buffer (if there is one).
7619 Otherwise: Do not examine other windows.
7620 This setting is checked with |quickfix| commands, when
7621 jumping to errors (":cc", ":cn", "cp", etc.). It is
7622 also used in all buffer related split commands, for
7623 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007624 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007625 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007627 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007628 Otherwise: do not split, use current window (when used
7629 in the quickfix window: the previously used window or
7630 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007631 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007632 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007633 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007634 uselast If included, jump to the previously used window when
7635 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007637 *'synmaxcol'* *'smc'*
7638'synmaxcol' 'smc' number (default 3000)
7639 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007640 {not available when compiled without the |+syntax|
7641 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007642 Maximum column in which to search for syntax items. In long lines the
7643 text after this column is not highlighted and following lines may not
7644 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007645 This helps to avoid very slow redrawing for an XML file that is one
7646 long line.
7647 Set to zero to remove the limit.
7648
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 *'syntax'* *'syn'*
7650'syntax' 'syn' string (default empty)
7651 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 {not available when compiled without the |+syntax|
7653 feature}
7654 When this option is set, the syntax with this name is loaded, unless
7655 syntax highlighting has been switched off with ":syntax off".
7656 Otherwise this option does not always reflect the current syntax (the
7657 b:current_syntax variable does).
7658 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007659 not automatically recognized. Example, in an IDL file:
7660 /* vim: set syntax=idl : */ ~
7661 When a dot appears in the value then this separates two filetype
7662 names. Example:
7663 /* vim: set syntax=c.doxygen : */ ~
7664 This will use the "c" syntax first, then the "doxygen" syntax.
7665 Note that the second one must be prepared to be loaded as an addition,
7666 otherwise it will be skipped. More than one dot may appear.
7667 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 :set syntax=OFF
7669< To switch syntax highlighting on according to the current value of the
7670 'filetype' option: >
7671 :set syntax=ON
7672< What actually happens when setting the 'syntax' option is that the
7673 Syntax autocommand event is triggered with the value as argument.
7674 This option is not copied to another buffer, independent of the 's' or
7675 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007676 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007678 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007679'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007680 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007681 When nonempty, this option determines the content of the tab pages
7682 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007683 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007684
7685 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007686 option and only when there is no GUI tab line. When 'e' is in
7687 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007688 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007689
7690 The value is evaluated like with 'statusline'. You can use
7691 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007692 the text to be displayed. Use "%1T" for the first label, "%2T" for
7693 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007694
Bram Moolenaare12bab32019-01-08 22:02:56 +01007695 When changing something that is used in 'tabline' that does not
7696 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007697 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007698
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007699 Keep in mind that only one of the tab pages is the current one, others
7700 are invisible and you can't jump to their windows.
7701
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007702
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007703 *'tabpagemax'* *'tpm'*
7704'tabpagemax' 'tpm' number (default 10)
7705 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007706 Maximum number of tab pages to be opened by the |-p| command line
7707 argument or the ":tab all" command. |tabpage|
7708
7709
7710 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711'tabstop' 'ts' number (default 8)
7712 local to buffer
7713 Number of spaces that a <Tab> in the file counts for. Also see
7714 |:retab| command, and 'softtabstop' option.
7715
7716 Note: Setting 'tabstop' to any other value than 8 can make your file
7717 appear wrong in many places (e.g., when printing it).
7718
7719 There are four main ways to use tabs in Vim:
7720 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7721 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007722 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 behave like a tab appears every 4 (or 3) characters.
7724 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7725 'expandtab'. This way you will always insert spaces. The
7726 formatting will never be messed up when 'tabstop' is changed.
7727 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007728 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 works when using Vim to edit the file.
7730 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7731 'noexpandtab'. This should then work (for initial indents only)
7732 for any tabstop setting that people use. It might be nice to have
7733 tabs after the first non-blank inserted as spaces if you do this
7734 though. Otherwise aligned comments will be wrong when 'tabstop' is
7735 changed.
7736
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007737 If Vim is compiled with the |+vartabs| feature then the value of
7738 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7739 than an empty string.
7740
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7742'tagbsearch' 'tbs' boolean (default on)
7743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007745 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746 searching makes searching for a tag a LOT faster, but a linear search
7747 will find more tags if the tags file wasn't properly sorted.
7748 Vim normally assumes that your tags files are sorted, or indicate that
7749 they are not sorted. Only when this is not the case does the
7750 'tagbsearch' option need to be switched off.
7751
7752 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007753 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007754 certain files, or retry all files with a linear search. When
7755 'tagbsearch' is off, only a linear search is done.
7756
7757 Linear searching is done anyway, for one file, when Vim finds a line
7758 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007759 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760< [The whitespace before and after the '0' must be a single <Tab>]
7761
7762 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007763 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007764 instead of a normal tag name, a retry is done with a linear search.
7765 Tags in unsorted tags files, and matches with different case will only
7766 be found in the retry.
7767
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007768 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007769 linear search can be avoided when case is ignored. Use a value of '2'
7770 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7771 sorted with the -f switch to "sort" in most unices, as in the command:
7772 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7773 (at least 5.5) the --sort=foldcase switch can be used for this as
7774 well. Note that case must be folded to uppercase for this to work.
7775
7776 By default, tag searches are case-sensitive. Case is ignored when
7777 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7778 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007779 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7780 'tagcase' is "smart", and the pattern contains only lowercase
7781 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782
7783 When 'tagbsearch' is off, tags searching is slower when a full match
7784 exists, but faster when no full match exists. Tags in unsorted tags
7785 files may only be found with 'tagbsearch' off.
7786 When the tags file is not sorted, or sorted in a wrong way (not on
7787 ASCII byte value), 'tagbsearch' should be off, or the line given above
7788 must be included in the tags file.
7789 This option doesn't affect commands that find all matching tags (e.g.,
7790 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007792 *'tagcase'* *'tc'*
7793'tagcase' 'tc' string (default "followic")
7794 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007795 This option specifies how case is handled when searching the tags
7796 file:
7797 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007798 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007799 ignore Ignore case
7800 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007801 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007802 NOTE: This option is set to the Vi default value when 'compatible' is
7803 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007804
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007805 *'tagfunc'* *'tfu'*
7806'tagfunc' 'tfu' string (default: empty)
7807 local to buffer
7808 {not available when compiled without the |+eval|
7809 feature}
7810 This option specifies a function to be used to perform tag searches.
7811 The function gets the tag pattern and should return a List of matching
7812 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007813 function and an example. The value can be the name of a function, a
7814 |lambda| or a |Funcref|. See |option-value-function| for more
7815 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007816
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 *'taglength'* *'tl'*
7818'taglength' 'tl' number (default 0)
7819 global
7820 If non-zero, tags are significant up to this number of characters.
7821
7822 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7823'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7824 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007825 If on and using a tags file in another directory, file names in that
7826 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 NOTE: This option is set to the Vi default value when 'compatible' is
7828 set and to the Vim default value when 'compatible' is reset.
7829
7830 *'tags'* *'tag'* *E433*
7831'tags' 'tag' string (default "./tags,tags", when compiled with
7832 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7833 global or local to buffer |global-local|
7834 Filenames for the tag command, separated by spaces or commas. To
7835 include a space or comma in a file name, precede it with a backslash
7836 (see |option-backslash| about including spaces and backslashes).
7837 When a file name starts with "./", the '.' is replaced with the path
7838 of the current file. But only when the 'd' flag is not included in
7839 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7840 |tags-option|.
7841 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007842 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7843 find all files named "tags" below "/lib". The filename itself cannot
7844 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7845 files called "tags?". {not available when compiled without the
7846 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007847 The |tagfiles()| function can be used to get a list of the file names
7848 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7850 files are also supported. They are automatically recognized. The
7851 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7852 differences are ignored (MS-Windows). |emacs-tags|
7853 The use of |:set+=| and |:set-=| is preferred when adding or removing
7854 file names from the list. This avoids problems when a future version
7855 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007856
7857 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7858'tagstack' 'tgst' boolean (default on)
7859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860 When on, the |tagstack| is used normally. When off, a ":tag" or
7861 ":tselect" command with an argument will not push the tag onto the
7862 tagstack. A following ":tag" without an argument, a ":pop" command or
7863 any other command that uses the tagstack will use the unmodified
7864 tagstack, but does change the pointer to the active entry.
7865 Resetting this option is useful when using a ":tag" command in a
7866 mapping which should not change the tagstack.
7867
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007868 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007869'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007870 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007871 {only available when compiled with the |+tcl/dyn|
7872 feature}
7873 Specifies the name of the Tcl shared library. The default is
7874 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007875 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007876 This option cannot be set from a |modeline| or in the |sandbox|, for
7877 security reasons.
7878
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 *'term'* *E529* *E530* *E531*
7880'term' string (default is $TERM, if that fails:
7881 in the GUI: "builtin_gui"
7882 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007883 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 on Unix: "ansi"
7886 on VMS: "ansi"
7887 on Win 32: "win32")
7888 global
7889 Name of the terminal. Used for choosing the terminal control
7890 characters. Environment variables are expanded |:set_env|.
7891 For example: >
7892 :set term=$TERM
7893< See |termcap|.
7894
7895 *'termbidi'* *'tbidi'*
7896 *'notermbidi'* *'notbidi'*
7897'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 {only available when compiled with the |+arabic|
7900 feature}
7901 The terminal is in charge of Bi-directionality of text (as specified
7902 by Unicode). The terminal is also expected to do the required shaping
7903 that some languages (such as Arabic) require.
7904 Setting this option implies that 'rightleft' will not be set when
7905 'arabic' is set and the value of 'arabicshape' will be ignored.
7906 Note that setting 'termbidi' has the immediate effect that
7907 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7908 This option is reset when the GUI is started.
7909 For further details see |arabic.txt|.
7910
7911 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007912'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 Encoding used for the terminal. This specifies what character
7915 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007916 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007917 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007918 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007919 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7921 Any attempts to set a different value will be rejected, and an error
7922 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007923 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 because the Win32 system always passes Unicode characters.
7925 When empty, the same encoding is used as for the 'encoding' option.
7926 This is the normal value.
7927 Not all combinations for 'termencoding' and 'encoding' are valid. See
7928 |encoding-table|.
7929 The value for this option must be supported by internal conversions or
7930 iconv(). When this is not possible no conversion will be done and you
7931 will probably experience problems with non-ASCII characters.
7932 Example: You are working with the locale set to euc-jp (Japanese) and
7933 want to edit a UTF-8 file: >
7934 :let &termencoding = &encoding
7935 :set encoding=utf-8
7936< You need to do this when your system has no locale support for UTF-8.
7937
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007938 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007939'termguicolors' 'tgc' boolean (default off)
7940 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007941 {not available when compiled without the
7942 |+termguicolors| feature}
7943 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007944 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007945
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007946 Requires a ISO-8613-3 compatible terminal. If setting this option
7947 does not work (produces a colorless UI) reading |xterm-true-color|
7948 might help.
7949
7950 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7951 is required. Use this check to find out: >
7952 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007953< This requires Vim to be built with the |+vtp| feature.
7954
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007955 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007956 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007957
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007958 *'termwinkey'* *'twk'*
7959'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007960 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007961 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007962 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007963 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007964 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007965< The string must be one key stroke but can be multiple bytes.
7966 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007967 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007968 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007969
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007970 *'termwinscroll'* *'twsl'*
7971'termwinscroll' 'twsl' number (default 10000)
7972 local to buffer
7973 {not available when compiled without the
7974 |+terminal| feature}
7975 Number of scrollback lines to keep. When going over this limit the
7976 first 10% of the scrollback lines are deleted. This is just to reduce
7977 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00007978 Also used as a limit for text sent to the terminal in one write,
7979 multiplied by the number of columns times 3 (average number of bytes
7980 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007981
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007982 *'termwinsize'* *'tws'*
7983'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007984 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007985 Size used when opening the |terminal| window. Format:
7986 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007987 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007988 - When set with a "x" (e.g., "24x80") the terminal size is not
7989 adjusted to the window size. If the window is smaller only the
7990 top-left part is displayed.
7991 - When set with a "*" (e.g., "10*50") the terminal size follows the
7992 window size, but will not be smaller than the specified rows and/or
7993 columns.
7994 - When rows is zero then use the height of the window.
7995 - When columns is zero then use the width of the window.
7996 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007997 - Can be overruled in the |term_start()| options with "term_rows" and
7998 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007999
8000 Examples:
8001 "30x0" uses 30 rows and the current window width.
8002 "20*0" uses at least 20 rows and the current window width.
8003 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008004 Note that the command running in the terminal window may still change
8005 the size of the terminal. In that case the Vim window will be
8006 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008007
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008008 *'termwintype'* *'twt'*
8009'termwintype' 'twt' string (default "")
8010 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008011 {only available when compiled with the |terminal|
8012 feature on MS-Windows}
8013 Specify the virtual console (pty) used when opening the terminal
8014 window.
8015
8016 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008017 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008018 "winpty" use winpty, fail if not supported
8019 "conpty" use |ConPTY|, fail if not supported
8020
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008021 |ConPTY| support depends on the platform. Windows 10 October 2018
8022 Update is the first version that supports ConPTY, however it is still
8023 considered unstable. ConPTY might become stable in the next release
8024 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008025 supported then you cannot open a terminal window.
8026
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 *'terse'* *'noterse'*
8028'terse' boolean (default off)
8029 global
8030 When set: Add 's' flag to 'shortmess' option (this makes the message
8031 for a search that hits the start or end of the file not being
8032 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8033 shortens a lot of messages}
8034
8035 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8036'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 This option is obsolete. Use 'fileformats'.
8039 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8040 set to the default value for the current system. When 'textauto' is
8041 reset, 'fileformats' is made empty.
8042 NOTE: This option is set to the Vi default value when 'compatible' is
8043 set and to the Vim default value when 'compatible' is reset.
8044
8045 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008046'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 others: default off)
8048 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 This option is obsolete. Use 'fileformat'.
8050 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8051 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8052 "unix".
8053
8054 *'textwidth'* *'tw'*
8055'textwidth' 'tw' number (default 0)
8056 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057 Maximum width of text that is being inserted. A longer line will be
8058 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008059 this.
8060 'textwidth' is set to 0 when the 'paste' option is set and restored
8061 when 'paste' is reset.
8062 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008064 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 NOTE: This option is set to 0 when 'compatible' is set.
8066
8067 *'thesaurus'* *'tsr'*
8068'thesaurus' 'tsr' string (default "")
8069 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008071 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8072 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008073
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008074 This option is not used if 'thesaurusfunc' is set, either for the
8075 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008076
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008077 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008079 name. See |option-backslash| about using backslashes. The use of
8080 |:set+=| and |:set-=| is preferred when adding or removing directories
8081 from the list. This avoids problems when a future version uses
8082 another default. Backticks cannot be used in this option for security
8083 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008084
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008085 *'thesaurusfunc'* *tsrfu'*
8086'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008087 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008088 {not available when compiled without the |+eval|
8089 feature}
8090 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008091 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00008092 The value can be the name of a function, a |lambda| or a |Funcref|.
8093 See |option-value-function| for more information.
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008094
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008095 This option cannot be set from a |modeline| or in the |sandbox|, for
8096 security reasons.
8097
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8099'tildeop' 'top' boolean (default off)
8100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008101 When on: The tilde command "~" behaves like an operator.
8102 NOTE: This option is reset when 'compatible' is set.
8103
8104 *'timeout'* *'to'* *'notimeout'* *'noto'*
8105'timeout' 'to' boolean (default on)
8106 global
8107 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008108'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110 These two options together determine the behavior when part of a
8111 mapped key sequence or keyboard code has been received:
8112
8113 'timeout' 'ttimeout' action ~
8114 off off do not time out
8115 on on or off time out on :mappings and key codes
8116 off on time out on key codes
8117
8118 If both options are off, Vim will wait until either the complete
8119 mapping or key sequence has been received, or it is clear that there
8120 is no mapping or key sequence for the received characters. For
8121 example: if you have mapped "vl" and Vim has received 'v', the next
8122 character is needed to see if the 'v' is followed by an 'l'.
8123 When one of the options is on, Vim will wait for about 1 second for
8124 the next character to arrive. After that the already received
8125 characters are interpreted as single characters. The waiting time can
8126 be changed with the 'timeoutlen' option.
8127 On slow terminals or very busy systems timing out may cause
8128 malfunctioning cursor keys. If both options are off, Vim waits
8129 forever after an entered <Esc> if there are key codes that start
8130 with <Esc>. You will have to type <Esc> twice. If you do not have
8131 problems with key codes, but would like to have :mapped key
8132 sequences not timing out in 1 second, set the 'ttimeout' option and
8133 reset the 'timeout' option.
8134
8135 NOTE: 'ttimeout' is reset when 'compatible' is set.
8136
8137 *'timeoutlen'* *'tm'*
8138'timeoutlen' 'tm' number (default 1000)
8139 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008140
Bram Moolenaar071d4272004-06-13 20:20:40 +00008141 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008142'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 The time in milliseconds that is waited for a key code or mapped key
8145 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8146 when part of a command has been typed.
8147 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8148 different timeout value for key codes is desired set 'ttimeoutlen' to
8149 a non-negative number.
8150
8151 ttimeoutlen mapping delay key code delay ~
8152 < 0 'timeoutlen' 'timeoutlen'
8153 >= 0 'timeoutlen' 'ttimeoutlen'
8154
8155 The timeout only happens when the 'timeout' and 'ttimeout' options
8156 tell so. A useful setting would be >
8157 :set timeout timeoutlen=3000 ttimeoutlen=100
8158< (time out on mapping after three seconds, time out on key codes after
8159 a tenth of a second).
8160
8161 *'title'* *'notitle'*
8162'title' boolean (default off, on when title can be restored)
8163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 When on, the title of the window will be set to the value of
8165 'titlestring' (if it is not empty), or to:
8166 filename [+=-] (path) - VIM
8167 Where:
8168 filename the name of the file being edited
8169 - indicates the file cannot be modified, 'ma' off
8170 + indicates the file was modified
8171 = indicates the file is read-only
8172 =+ indicates the file is read-only and modified
8173 (path) is the path of the file being edited
8174 - VIM the server name |v:servername| or "VIM"
8175 Only works if the terminal supports setting window titles
8176 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008177 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8179 *X11*
8180 When Vim was compiled with HAVE_X11 defined, the original title will
8181 be restored if possible. The output of ":version" will include "+X11"
8182 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8183 works for the icon name |'icon'|.
8184 But: When Vim was started with the |-X| argument, restoring the title
8185 will not work (except in the GUI).
8186 If the title cannot be restored, it is set to the value of 'titleold'.
8187 You might want to restore the title outside of Vim then.
8188 When using an xterm from a remote machine you can use this command:
8189 rsh machine_name xterm -display $DISPLAY &
8190 then the WINDOWID environment variable should be inherited and the
8191 title of the window should change back to what it should be after
8192 exiting Vim.
8193
8194 *'titlelen'*
8195'titlelen' number (default 85)
8196 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008198 title. When the title is longer, only the end of the path name is
8199 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008200 Using a percentage makes this adapt to the width of the window. But
8201 it won't work perfectly, because the actual number of characters
8202 available also depends on the font used and other things in the title
8203 bar. When 'titlelen' is zero the full path is used. Otherwise,
8204 values from 1 to 30000 percent can be used.
8205 'titlelen' is also used for the 'titlestring' option.
8206
8207 *'titleold'*
8208'titleold' string (default "Thanks for flying Vim")
8209 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210 This option will be used for the window title when exiting Vim if the
8211 original title cannot be restored. Only happens if 'title' is on or
8212 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008213 This option cannot be set from a |modeline| or in the |sandbox|, for
8214 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215 *'titlestring'*
8216'titlestring' string (default "")
8217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008218 When this option is not empty, it will be used for the title of the
8219 window. This happens only when the 'title' option is on.
8220 Only works if the terminal supports setting window titles (currently
8221 Amiga console, Win32 console, all GUI versions and terminals with a
8222 non-empty 't_ts' option).
8223 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008224 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008225
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 When this option contains printf-style '%' items, they will be
8227 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008228 This option cannot be set in a modeline when 'modelineexpr' is off.
8229
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 Example: >
8231 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8232 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8233< The value of 'titlelen' is used to align items in the middle or right
8234 of the available space.
8235 Some people prefer to have the file name first: >
8236 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8237< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008238 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 separating space only when needed.
8240 NOTE: Use of special characters in 'titlestring' may cause the display
8241 to be garbled (e.g., when it contains a CR or NL character).
8242 {not available when compiled without the |+statusline| feature}
8243
8244 *'toolbar'* *'tb'*
8245'toolbar' 'tb' string (default "icons,tooltips")
8246 global
8247 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8248 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008249 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 possible values are:
8251 icons Toolbar buttons are shown with icons.
8252 text Toolbar buttons shown with text.
8253 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008254 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255 tooltips Tooltips are active for toolbar buttons.
8256 Tooltips refer to the popup help text which appears after the mouse
8257 cursor is placed over a toolbar button for a brief moment.
8258
8259 If you want the toolbar to be shown with icons as well as text, do the
8260 following: >
8261 :set tb=icons,text
8262< Motif and Athena cannot display icons and text at the same time. They
8263 will show icons if both are requested.
8264
8265 If none of the strings specified in 'toolbar' are valid or if
8266 'toolbar' is empty, this option is ignored. If you want to disable
8267 the toolbar, you need to set the 'guioptions' option. For example: >
8268 :set guioptions-=T
8269< Also see |gui-toolbar|.
8270
8271 *'toolbariconsize'* *'tbis'*
8272'toolbariconsize' 'tbis' string (default "small")
8273 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008274 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008276 tiny Use tiny icons.
8277 small Use small icons (default).
8278 medium Use medium-sized icons.
8279 large Use large icons.
8280 huge Use even larger icons.
8281 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008282 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008283 the current theme. Common dimensions are giant=48x48, huge=32x32,
8284 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285
8286 If 'toolbariconsize' is empty, the global default size as determined
8287 by user preferences or the current theme is used.
8288
8289 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8290'ttybuiltin' 'tbi' boolean (default on)
8291 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008292 When on, the builtin termcaps are searched before the external ones.
8293 When off the builtin termcaps are searched after the external ones.
8294 When this option is changed, you should set the 'term' option next for
8295 the change to take effect, for example: >
8296 :set notbi term=$TERM
8297< See also |termcap|.
8298 Rationale: The default for this option is "on", because the builtin
8299 termcap entries are generally better (many systems contain faulty
8300 xterm entries...).
8301
8302 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8303'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8304 sun-cmd, screen, rxvt, dtterm or
8305 iris-ansi; also on when running Vim in
8306 a DOS console)
8307 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 Indicates a fast terminal connection. More characters will be sent to
8309 the screen for redrawing, instead of using insert/delete line
8310 commands. Improves smoothness of redrawing when there are multiple
8311 windows and the terminal does not support a scrolling region.
8312 Also enables the extra writing of characters at the end of each screen
8313 line for lines that wrap. This helps when using copy/paste with the
8314 mouse in an xterm and other terminals.
8315
8316 *'ttymouse'* *'ttym'*
8317'ttymouse' 'ttym' string (default depends on 'term')
8318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 {only in Unix and VMS, doesn't work in the GUI; not
8320 available when compiled without |+mouse|}
8321 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008322 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 *xterm-mouse*
8324 xterm xterm-like mouse handling. The mouse generates
8325 "<Esc>[Mscr", where "scr" is three bytes:
8326 "s" = button state
8327 "c" = column plus 33
8328 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008329 This only works up to 223 columns! See "dec",
8330 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 xterm2 Works like "xterm", but with the xterm reporting the
8332 mouse position while the mouse is dragged. This works
8333 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008334 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 work. See below for how Vim detects this
8336 automatically.
8337 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008338 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008339 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008340 for the row and column. No other mouse events are
8341 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 *dec-mouse*
8343 dec DEC terminal mouse handling. The mouse generates a
8344 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008345 This is also available for an Xterm, if it was
8346 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 *jsbterm-mouse*
8348 jsbterm JSB term mouse handling.
8349 *pterm-mouse*
8350 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008351 *urxvt-mouse*
8352 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008353 The mouse works only if the terminal supports this
8354 encoding style, but it does not have 223 columns limit
8355 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008356 *sgr-mouse*
8357 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008358 mouse reporting. The mouse works even in columns
8359 beyond 223. This option is backward compatible with
8360 "xterm2" because it can also decode "xterm2" style
8361 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362
8363 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008364 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8365 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8367 recognized, if enabled at compile time. DEC terminal mouse codes
8368 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008369 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8370 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008372 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8373 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8374 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008375 Additionally, if vim is compiled with the |+termresponse| feature and
8376 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008377 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008379 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8380 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8381 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008382 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8383 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 :set t_RV=
8385<
8386 *'ttyscroll'* *'tsl'*
8387'ttyscroll' 'tsl' number (default 999)
8388 global
8389 Maximum number of lines to scroll the screen. If there are more lines
8390 to scroll the window is redrawn. For terminals where scrolling is
8391 very slow and redrawing is not slow this can be set to a small number,
8392 e.g., 3, to speed up displaying.
8393
8394 *'ttytype'* *'tty'*
8395'ttytype' 'tty' string (default from $TERM)
8396 global
8397 Alias for 'term', see above.
8398
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008399 *'undodir'* *'udir'*
8400'undodir' 'udir' string (default ".")
8401 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008402 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008403 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008404 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008405 "." means using the directory of the file. The undo file name for
8406 "file.txt" is ".file.txt.un~".
8407 For other directories the file name is the full path of the edited
8408 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008409 When writing: The first directory that exists is used. "." always
8410 works, no directories after "." will be used for writing.
8411 When reading all entries are tried to find an undo file. The first
8412 undo file that exists is used. When it cannot be read an error is
8413 given, no further entry is used.
8414 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008415 This option cannot be set from a |modeline| or in the |sandbox|, for
8416 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008417
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008418 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008419'undofile' 'udf' boolean (default off)
8420 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008421 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008422 When on, Vim automatically saves undo history to an undo file when
8423 writing a buffer to a file, and restores undo history from the same
8424 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008425 The directory where the undo file is stored is specified by 'undodir'.
8426 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008427 The undo file is not read when 'undoreload' causes the buffer from
8428 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008429 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008430 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008431
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008433'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008434 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008436 is kept in memory, higher numbers will cause more memory to be used.
8437 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8439 itself: >
8440 set ul=0
8441< But you can also get Vi compatibility by including the 'u' flag in
8442 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008443 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008444 Set to -1 for no undo at all. You might want to do this only for the
8445 current buffer: >
8446 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008448
8449 The local value is set to -123456 when the global value is to be used.
8450
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008451 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008453 *'undoreload'* *'ur'*
8454'undoreload' 'ur' number (default 10000)
8455 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008456 Save the whole buffer for undo when reloading it. This applies to the
8457 ":e!" command and reloading for when the buffer changed outside of
8458 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008459 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008460 of lines is smaller than the value of this option.
8461 Set this option to zero to disable undo for a reload.
8462
8463 When saving undo for a reload, any undo file is not read.
8464
8465 Note that this causes the whole buffer to be stored in memory. Set
8466 this option to a lower value if you run out of memory.
8467
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 *'updatecount'* *'uc'*
8469'updatecount' 'uc' number (default: 200)
8470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 After typing this many characters the swap file will be written to
8472 disk. When zero, no swap file will be created at all (see chapter on
8473 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8474 Vim with the "-n" option, see |startup|. When editing in readonly
8475 mode this option will be initialized to 10000.
8476 The swapfile can be disabled per buffer with |'swapfile'|.
8477 When 'updatecount' is set from zero to non-zero, swap files are
8478 created for all buffers that have 'swapfile' set. When 'updatecount'
8479 is set to zero, existing swap files are not deleted.
8480 Also see |'swapsync'|.
8481 This option has no meaning in buffers where |'buftype'| is "nofile"
8482 or "nowrite".
8483
8484 *'updatetime'* *'ut'*
8485'updatetime' 'ut' number (default 4000)
8486 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 If this many milliseconds nothing is typed the swap file will be
8488 written to disk (see |crash-recovery|). Also used for the
8489 |CursorHold| autocommand event.
8490
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008491 *'varsofttabstop'* *'vsts'*
8492'varsofttabstop' 'vsts' string (default "")
8493 local to buffer
8494 {only available when compiled with the |+vartabs|
8495 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008496 A list of the number of spaces that a <Tab> counts for while editing,
8497 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8498 width <Tab>s are being inserted, while in fact a mixture of spaces
8499 and <Tab>s is used. Tab widths are separated with commas, with the
8500 final value applying to all subsequent tabs.
8501
8502 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008503 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008504 to use the following: >
8505 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008506< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8507 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008508
8509 Note that the value of |'softtabstop'| will be ignored while
8510 'varsofttabstop' is set.
8511
8512 *'vartabstop'* *'vts'*
8513'vartabstop' 'vts' string (default "")
8514 local to buffer
8515 {only available when compiled with the |+vartabs|
8516 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008517 A list of the number of spaces that a <Tab> in the file counts for,
8518 separated by commas. Each value corresponds to one tab, with the
8519 final value applying to all subsequent tabs. For example: >
8520 :set vartabstop=4,20,10,8
8521< This will make the first tab 4 spaces wide, the second 20 spaces,
8522 the third 10 spaces, and all following tabs 8 spaces.
8523
8524 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8525 is set.
8526
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527 *'verbose'* *'vbs'*
8528'verbose' 'vbs' number (default 0)
8529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008530 When bigger than zero, Vim will give messages about what it is doing.
8531 Currently, these messages are given:
8532 >= 1 When the viminfo file is read or written.
8533 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008534 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008535 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008536 >= 8 Files for which a group of autocommands is executed.
8537 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008538 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539 >= 12 Every executed function.
8540 >= 13 When an exception is thrown, caught, finished, or discarded.
8541 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008542 >= 15 Every executed Ex command from a script (truncated at 200
8543 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008544 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545
8546 This option can also be set with the "-V" argument. See |-V|.
8547 This option is also set by the |:verbose| command.
8548
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008549 When the 'verbosefile' option is set then the verbose messages are not
8550 displayed.
8551
8552 *'verbosefile'* *'vfile'*
8553'verbosefile' 'vfile' string (default empty)
8554 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008555 When not empty all messages are written in a file with this name.
8556 When the file exists messages are appended.
8557 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008558 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008559 Setting 'verbosefile' to a new value is like making it empty first.
8560 The difference with |:redir| is that verbose messages are not
8561 displayed when 'verbosefile' is set.
8562
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008564'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 "$VIM/vimfiles/view",
8566 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008567 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008568 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008570 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008571 feature}
8572 Name of the directory where to store files for |:mkview|.
8573 This option cannot be set from a |modeline| or in the |sandbox|, for
8574 security reasons.
8575
8576 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008577'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008578 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008579 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 feature}
8581 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008582 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 word save and restore ~
8584 cursor cursor position in file and in window
8585 folds manually created folds, opened/closed folds and local
8586 fold options
8587 options options and mappings local to a window or buffer (not
8588 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008589 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008590 slash backslashes in file names replaced with forward
8591 slashes
8592 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008593 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008594 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008595
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008596 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008598 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599
8600 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008601'viminfo' 'vi' string (Vi default: "", Vim default for
8602 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008603 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8604 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008606 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 feature}
8608 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008609 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8610 "NONE".
8611 The string should be a comma separated list of parameters, each
8612 consisting of a single character identifying the particular parameter,
8613 followed by a number or string which specifies the value of that
8614 parameter. If a particular character is left out, then the default
8615 value is used for that parameter. The following is a list of the
8616 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008618 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 ! When included, save and restore global variables that start
8620 with an uppercase letter, and don't contain a lowercase
8621 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008622 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008623 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008624 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 " Maximum number of lines saved for each register. Old name of
8626 the '<' item, with the disadvantage that you need to put a
8627 backslash before the ", otherwise it will be recognized as the
8628 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008629 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 % When included, save and restore the buffer list. If Vim is
8631 started with a file name argument, the buffer list is not
8632 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008633 buffer list is restored from the viminfo file. Quickfix
8634 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8635 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008636 When followed by a number, the number specifies the maximum
8637 number of buffers that are stored. Without a number all
8638 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008639 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 ' Maximum number of previously edited files for which the marks
8641 are remembered. This parameter must always be included when
8642 'viminfo' is non-empty.
8643 Including this item also means that the |jumplist| and the
8644 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008645 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008647 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008648 patterns are also saved. When not included, the value of
8649 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008650 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008652 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008653 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008654 < Maximum number of lines saved for each register. If zero then
8655 registers are not saved. When not included, all lines are
8656 saved. '"' is the old name for this item.
8657 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008658 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008660 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008661 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 c When included, convert the text in the viminfo file from the
8663 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008664 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008665 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 f Whether file marks need to be stored. If zero, file marks ('0
8667 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008668 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008670 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 h Disable the effect of 'hlsearch' when loading the viminfo
8672 file. When not included, it depends on whether ":nohlsearch"
8673 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008674 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008676 the 'n'. Must be at the end of the option! If the
8677 'viminfofile' option is set, that file name overrides the one
8678 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008679 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008680 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 r Removable media. The argument is a string (up to the next
8682 ','). This parameter can be given several times. Each
8683 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008684 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8686 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8687 ignored. Maximum length of each 'r' argument is 50
8688 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008689 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690 s Maximum size of an item in Kbyte. If zero then registers are
8691 not saved. Currently only applies to registers. The default
8692 "s10" will exclude registers with more than 10 Kbyte of text.
8693 Also see the '<' item above: line count limit.
8694
8695 Example: >
8696 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8697<
8698 '50 Marks will be remembered for the last 50 files you
8699 edited.
8700 <1000 Contents of registers (up to 1000 lines each) will be
8701 remembered.
8702 s100 Registers with more than 100 Kbyte text are skipped.
8703 :0 Command-line history will not be saved.
8704 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8705 no / Since '/' is not specified, the default will be used,
8706 that is, save all of the search history, and also the
8707 previous search and substitute patterns.
8708 no % The buffer list will not be saved nor read back.
8709 no h 'hlsearch' highlighting will be restored.
8710
8711 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8712 load the contents of the file, this is not done automatically.
8713
8714 This option cannot be set from a |modeline| or in the |sandbox|, for
8715 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008716 NOTE: This option is set to the Vim default value when 'compatible'
8717 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008719 *'viminfofile'* *'vif'*
8720'viminfofile' 'vif' string (default: "")
8721 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008722 {not available when compiled without the |+viminfo|
8723 feature}
8724 When non-empty, overrides the file name used for viminfo.
8725 When equal to "NONE" no viminfo file will be read or written.
8726 This option can be set with the |-i| command line flag. The |--clean|
8727 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008728 This option cannot be set from a |modeline| or in the |sandbox|, for
8729 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008730
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 *'virtualedit'* *'ve'*
8732'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008733 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008734 A comma separated list of these words:
8735 block Allow virtual editing in Visual block mode.
8736 insert Allow virtual editing in Insert mode.
8737 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008738 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008739 none When used as the local value, do not allow virtual
8740 editing even when the global value is set. When used
8741 as the global value, "none" is the same as "".
8742 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008743
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008745 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 of the line. Useful for selecting a rectangle in Visual mode and
8747 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008748 "onemore" is not the same, it will only allow moving the cursor just
8749 after the last character of the line. This makes some commands more
8750 consistent. Previously the cursor was always past the end of the line
8751 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008752 break some plugins or Vim scripts. For example because |l| can move
8753 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008754 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008755 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008756 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008757 It doesn't make sense to combine "all" with "onemore", but you will
8758 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008759 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008760 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761
8762 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8763'visualbell' 'vb' boolean (default off)
8764 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008765 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008767 use: >
8768 :set vb t_vb=
8769< If you want a short flash, you can use this on many terminals: >
8770 :set vb t_vb=[?5h$<100>[?5l
8771< Here $<100> specifies the time, you can use a smaller or bigger value
8772 to get a shorter or longer flash.
8773
8774 Note: Vim will limit the bell to once per half a second. This avoids
8775 having to wait for the flashing to finish when there are lots of
8776 bells, e.g. on key repeat. This also happens without 'visualbell'
8777 set.
8778
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8780 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8781 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008782
8783 Note: When the GUI starts, 't_vb' is reset to its default value. You
8784 might want to set it again in your |gvimrc|.
8785
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 Does not work on the Amiga, you always get a screen flash.
8787 Also see 'errorbells'.
8788
8789 *'warn'* *'nowarn'*
8790'warn' boolean (default on)
8791 global
8792 Give a warning message when a shell command is used while the buffer
8793 has been changed.
8794
8795 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8796'weirdinvert' 'wiv' boolean (default off)
8797 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008798 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 It is provided for backwards compatibility with version 4.x.
8800 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8801 vice versa. Has no effect when the GUI is running.
8802
8803 *'whichwrap'* *'ww'*
8804'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 Allow specified keys that move the cursor left/right to move to the
8807 previous/next line when the cursor is on the first/last character in
8808 the line. Concatenate characters to allow this for these keys:
8809 char key mode ~
8810 b <BS> Normal and Visual
8811 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008812 h "h" Normal and Visual (not recommended)
8813 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 < <Left> Normal and Visual
8815 > <Right> Normal and Visual
8816 ~ "~" Normal
8817 [ <Left> Insert and Replace
8818 ] <Right> Insert and Replace
8819 For example: >
8820 :set ww=<,>,[,]
8821< allows wrap only when cursor keys are used.
8822 When the movement keys are used in combination with a delete or change
8823 operator, the <EOL> also counts for a character. This makes "3h"
8824 different from "3dh" when the cursor crosses the end of a line. This
8825 is also true for "x" and "X", because they do the same as "dl" and
8826 "dh". If you use this, you may also want to use the mapping
8827 ":map <BS> X" to make backspace delete the character in front of the
8828 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008829 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008830 line (not an empty line) then it will not move to the next line. This
8831 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008832 NOTE: This option is set to the Vi default value when 'compatible' is
8833 set and to the Vim default value when 'compatible' is reset.
8834
8835 *'wildchar'* *'wc'*
8836'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 Character you have to type to start wildcard expansion in the
8839 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008840 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008841 The character is not recognized when used inside a macro. See
8842 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008843 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008844 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008845 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846< NOTE: This option is set to the Vi default value when 'compatible' is
8847 set and to the Vim default value when 'compatible' is reset.
8848
8849 *'wildcharm'* *'wcm'*
8850'wildcharm' 'wcm' number (default: none (0))
8851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008853 recognized when used inside a macro. You can find "spare" command-line
8854 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008855 you'll never actually type 'wildcharm', just use it in mappings that
8856 automatically invoke completion mode, e.g.: >
8857 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008858 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859< Then after typing :ss you can use CTRL-P & CTRL-N.
8860
8861 *'wildignore'* *'wig'*
8862'wildignore' 'wig' string (default "")
8863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 {not available when compiled without the |+wildignore|
8865 feature}
8866 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008867 patterns is ignored when expanding |wildcards|, completing file or
8868 directory names, and influences the result of |expand()|, |glob()| and
8869 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8871 Also see 'suffixes'.
8872 Example: >
8873 :set wildignore=*.o,*.obj
8874< The use of |:set+=| and |:set-=| is preferred when adding or removing
8875 a pattern from the list. This avoids problems when a future version
8876 uses another default.
8877
Bram Moolenaar94950a92010-12-02 16:01:29 +01008878
Bram Moolenaar81af9252010-12-10 20:35:50 +01008879 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008880'wildignorecase' 'wic' boolean (default off)
8881 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008882 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008883 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008884 Does not apply when the shell is used to expand wildcards, which
8885 happens when there are special characters.
8886
8887
Bram Moolenaar071d4272004-06-13 20:20:40 +00008888 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008889'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 {not available if compiled without the |+wildmenu|
8892 feature}
8893 When 'wildmenu' is on, command-line completion operates in an enhanced
8894 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8895 the possible matches are shown just above the command line, with the
8896 first match highlighted (overwriting the status line, if there is
8897 one). Keys that show the previous/next match, such as <Tab> or
8898 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8899 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8900 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008901 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008902 If there are more matches than can fit in the line, a ">" is shown on
8903 the right and/or a "<" is shown on the left. The status line scrolls
8904 as needed.
8905 The "wildmenu" mode is abandoned when a key is hit that is not used
8906 for selecting a completion.
8907 While the "wildmenu" is active the following keys have special
8908 meanings:
8909
8910 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8911 <Down> - in filename/menu name completion: move into a
8912 subdirectory or submenu.
8913 <CR> - in menu completion, when the cursor is just after a
8914 dot: move into a submenu.
8915 <Up> - in filename/menu name completion: move up into
8916 parent directory or parent menu.
8917
8918 This makes the menus accessible from the console |console-menus|.
8919
8920 If you prefer the <Left> and <Right> keys to move the cursor instead
8921 of selecting a different match, use this: >
8922 :cnoremap <Left> <Space><BS><Left>
8923 :cnoremap <Right> <Space><BS><Right>
8924<
8925 The "WildMenu" highlighting is used for displaying the current match
8926 |hl-WildMenu|.
8927
8928 *'wildmode'* *'wim'*
8929'wildmode' 'wim' string (Vim default: "full")
8930 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008932 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008933 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 first part specifies the behavior for the first use of 'wildchar',
8935 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008936
8937 Each part consists of a colon separated list consisting of the
8938 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 "" Complete only the first match.
8940 "full" Complete the next full match. After the last match,
8941 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008942 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008943 "longest" Complete till longest common string. If this doesn't
8944 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008945 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008946 "lastused" When completing buffer names and more than one buffer
8947 matches, sort buffers by time last used (other than
8948 the current buffer).
8949 When there is only a single match, it is fully completed in all cases.
8950
8951 Examples of useful colon-separated values:
8952 "longest:full" Like "longest", but also start 'wildmenu' if it is
8953 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954 "list:full" When more than one match, list all matches and
8955 complete first match.
8956 "list:longest" When more than one match, list all matches and
8957 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008958 "list:lastused" When more than one buffer matches, list all matches
8959 and sort buffers by time last used (other than the
8960 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961
8962 Examples: >
8963 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008964< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 :set wildmode=longest,full
8966< Complete longest common string, then each full match >
8967 :set wildmode=list:full
8968< List all matches and complete each full match >
8969 :set wildmode=list,full
8970< List all matches without completing, then each full match >
8971 :set wildmode=longest,list
8972< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008973 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008974
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008975 *'wildoptions'* *'wop'*
8976'wildoptions' 'wop' string (default "")
8977 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008978 {not available when compiled without the |+wildignore|
8979 feature}
8980 A list of words that change how command line completion is done.
8981 Currently only one word is allowed:
8982 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008983 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008984 is displayed per line. Often used tag kinds are:
8985 d #define
8986 f function
8987 Also see |cmdline-completion|.
8988
Bram Moolenaar071d4272004-06-13 20:20:40 +00008989 *'winaltkeys'* *'wak'*
8990'winaltkeys' 'wak' string (default "menu")
8991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008992 {only used in Win32, Motif, GTK and Photon GUI}
8993 Some GUI versions allow the access to menu entries by using the ALT
8994 key in combination with a character that appears underlined in the
8995 menu. This conflicts with the use of the ALT key for mappings and
8996 entering special characters. This option tells what to do:
8997 no Don't use ALT keys for menus. ALT key combinations can be
8998 mapped, but there is no automatic handling. This can then be
8999 done with the |:simalt| command.
9000 yes ALT key handling is done by the windowing system. ALT key
9001 combinations cannot be mapped.
9002 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009003 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 keys can be mapped.
9005 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9006 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009007 This option is not used for <F10>; on Win32 and with GTK <F10> will
9008 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009009
Bram Moolenaar4d784b22019-05-25 19:51:39 +02009010 *'wincolor'* *'wcr'*
9011'wincolor' 'wcr' string (default empty)
9012 local to window
9013 Highlight group name to use for this window instead of the Normal
9014 color |hl-Normal|.
9015
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009016 *'window'* *'wi'*
9017'window' 'wi' number (default screen height - 1)
9018 global
Bram Moolenaardad44732021-03-31 20:07:33 +02009019 Window height used for |CTRL-F| and |CTRL-B| when there is only one
9020 window and the value is smaller than 'lines' minus one. The screen
9021 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009022 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9023 in a much smarter way, taking care of wrapping lines.
9024 When resizing the Vim window, the value is smaller than 1 or more than
9025 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009026 Note: Do not confuse this with the height of the Vim window, use
9027 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009028
Bram Moolenaar071d4272004-06-13 20:20:40 +00009029 *'winheight'* *'wh'* *E591*
9030'winheight' 'wh' number (default 1)
9031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009033 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009034 focus goes to a window that is smaller, its size is increased, at the
9035 cost of the height of other windows.
9036 Set 'winheight' to a small number for normal editing.
9037 Set it to 999 to make the current window fill most of the screen.
9038 Other windows will be only 'winminheight' high. This has the drawback
9039 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9040 to create only two windows, set the option after startup is done,
9041 using the |VimEnter| event: >
9042 au VimEnter * set winheight=999
9043< Minimum value is 1.
9044 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009045 height of the current window.
9046 'winheight' applies to the current window. Use 'winminheight' to set
9047 the minimal height for other windows.
9048
9049 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9050'winfixheight' 'wfh' boolean (default off)
9051 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009053 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9054 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009055 The height may be changed anyway when running out of room.
9056
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009057 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9058'winfixwidth' 'wfw' boolean (default off)
9059 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009060 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009061 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009062 The width may be changed anyway when running out of room.
9063
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 *'winminheight'* *'wmh'*
9065'winminheight' 'wmh' number (default 1)
9066 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009067 The minimal height of a window, when it's not the current window.
9068 This is a hard minimum, windows will never become smaller.
9069 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9070 status bar) if necessary. They will return to at least one line when
9071 they become active (since the cursor has to have somewhere to go.)
9072 Use 'winheight' to set the minimal height of the current window.
9073 This option is only checked when making a window smaller. Don't use a
9074 large number, it will cause errors when opening more than a few
9075 windows. A value of 0 to 3 is reasonable.
9076
9077 *'winminwidth'* *'wmw'*
9078'winminwidth' 'wmw' number (default 1)
9079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 The minimal width of a window, when it's not the current window.
9081 This is a hard minimum, windows will never become smaller.
9082 When set to zero, windows may be "squashed" to zero columns (i.e. just
9083 a vertical separator) if necessary. They will return to at least one
9084 line when they become active (since the cursor has to have somewhere
9085 to go.)
9086 Use 'winwidth' to set the minimal width of the current window.
9087 This option is only checked when making a window smaller. Don't use a
9088 large number, it will cause errors when opening more than a few
9089 windows. A value of 0 to 12 is reasonable.
9090
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009091 *'winptydll'*
9092'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9093 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009094 {only available when compiled with the |terminal|
9095 feature on MS-Windows}
9096 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009097 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009098 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009099 a fallback.
9100 Environment variables are expanded |:set_env|.
9101 This option cannot be set from a |modeline| or in the |sandbox|, for
9102 security reasons.
9103
Bram Moolenaar071d4272004-06-13 20:20:40 +00009104 *'winwidth'* *'wiw'* *E592*
9105'winwidth' 'wiw' number (default 20)
9106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009107 Minimal number of columns for the current window. This is not a hard
9108 minimum, Vim will use fewer columns if there is not enough room. If
9109 the current window is smaller, its size is increased, at the cost of
9110 the width of other windows. Set it to 999 to make the current window
9111 always fill the screen. Set it to a small number for normal editing.
9112 The width is not adjusted after one of the commands to change the
9113 width of the current window.
9114 'winwidth' applies to the current window. Use 'winminwidth' to set
9115 the minimal width for other windows.
9116
9117 *'wrap'* *'nowrap'*
9118'wrap' boolean (default on)
9119 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120 This option changes how text is displayed. It doesn't change the text
9121 in the buffer, see 'textwidth' for that.
9122 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009123 displaying continues on the next line. When off lines will not wrap
9124 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009125 moved to a part that is not shown, the screen will scroll
9126 horizontally.
9127 The line will be broken in the middle of a word if necessary. See
9128 'linebreak' to get the break at a word boundary.
9129 To make scrolling horizontally a bit more useful, try this: >
9130 :set sidescroll=5
9131 :set listchars+=precedes:<,extends:>
9132< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009133 This option can't be set from a |modeline| when the 'diff' option is
9134 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009135
9136 *'wrapmargin'* *'wm'*
9137'wrapmargin' 'wm' number (default 0)
9138 local to buffer
9139 Number of characters from the right window border where wrapping
9140 starts. When typing text beyond this limit, an <EOL> will be inserted
9141 and inserting continues on the next line.
9142 Options that add a margin, such as 'number' and 'foldcolumn', cause
9143 the text width to be further reduced. This is Vi compatible.
9144 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009145 This option is set to 0 when 'paste' is set and restored when 'paste'
9146 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009147 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148
9149 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9150'wrapscan' 'ws' boolean (default on) *E384* *E385*
9151 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009152 Searches wrap around the end of the file. Also applies to |]s| and
9153 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009154
9155 *'write'* *'nowrite'*
9156'write' boolean (default on)
9157 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009158 Allows writing files. When not set, writing a file is not allowed.
9159 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009160 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161 argument. Filtering text is still possible, even though this requires
9162 writing a temporary file.
9163
9164 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9165'writeany' 'wa' boolean (default off)
9166 global
9167 Allows writing to any file with no need for "!" override.
9168
9169 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9170'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9171 otherwise)
9172 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 Make a backup before overwriting a file. The backup is removed after
9174 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009175 also on.
9176 WARNING: Switching this option off means that when Vim fails to write
9177 your buffer correctly and then, for whatever reason, Vim exits, you
9178 lose both the original file and what you were writing. Only reset
9179 this option if your file system is almost full and it makes the write
9180 fail (and make sure not to exit Vim until the write was successful).
9181 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009182 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009183 Depending on 'backupcopy' the backup is a new file or the original
9184 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009185 NOTE: This option is set to the default value when 'compatible' is
9186 set.
9187
9188 *'writedelay'* *'wd'*
9189'writedelay' 'wd' number (default 0)
9190 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009191 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009192 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009193 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009194
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009195 vim:tw=78:ts=8:noet:ft=help:norl: