blob: 6c589d14298aa37b04f75e4d2f51e9e568d5b2dc [file] [log] [blame]
Bram Moolenaar6304be62021-11-27 10:57:26 +00001*options.txt* For Vim version 8.2. Last change: 2021 Nov 24
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
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200198Similarly, in legacy script the double quote character starts a comment. To
199include the '"' in the option value, use '\"' instead. This example sets the
200'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000201 :set titlestring=hi\ \"there\"
202
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200203In |Vim9| script it's simpler, comments start with a '#' character, and only
204when preceded by white space. A backslash is needed less often: >
205 vim9script
206 set titlestring=hi\ "there"
207 set titlestring=hi#there#
208 set titlestring=hi\ \#there#
209
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100210For Win32 backslashes in file names are mostly not removed. More precise: For
211options that expect a file name (those where environment variables are
212expanded) a backslash before a normal file name character is not removed. But
213a backslash before a special character (space, backslash, comma, etc.) is used
214like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215There is one special situation, when the value starts with "\\": >
216 :set dir=\\machine\path results in "\\machine\path"
217 :set dir=\\\\machine\\path results in "\\machine\path"
218 :set dir=\\path\\file results in "\\path\file" (wrong!)
219For the first one the start is kept, but for the second one the backslashes
220are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222result which is probably not what you want. Avoid it.
223
224 *add-option-flags* *remove-option-flags*
225 *E539* *E550* *E551* *E552*
226Some options are a list of flags. When you want to add a flag to such an
227option, without changing the existing ones, you can do it like this: >
228 :set guioptions+=a
229Remove a flag from an option like this: >
230 :set guioptions-=a
231This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000232Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
234doesn't appear.
235
236 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000237Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000238environment variable exists the '$' and the following environment variable
239name is replaced with its value. If it does not exist the '$' and the name
240are not modified. Any non-id character (not a letter, digit or '_') may
241follow the environment variable name. That character and what follows is
242appended to the value of the environment variable. Examples: >
243 :set term=$TERM.new
244 :set path=/usr/$INCLUDE,$HOME/include,.
245When adding or removing a string from an option with ":set opt-=val" or ":set
246opt+=val" the expansion is done before the adding or removing.
247
248
249Handling of local options *local-options*
250
251Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100252has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253allows you to set 'list' in one window but not in another. And set
254'shiftwidth' to 3 in one buffer and 4 in another.
255
256The following explains what happens to these local options in specific
257situations. You don't really need to know all of this, since Vim mostly uses
258the option values you would expect. Unfortunately, doing what the user
259expects is a bit complicated...
260
261When splitting a window, the local options are copied to the new window. Thus
262right after the split the contents of the two windows look the same.
263
264When editing a new buffer, its local option values must be initialized. Since
265the local options of the current buffer might be specifically for that buffer,
266these are not used. Instead, for each buffer-local option there also is a
267global value, which is used for new buffers. With ":set" both the local and
268global value is changed. With "setlocal" only the local value is changed,
269thus this value is not used when editing a new buffer.
270
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200271When editing a buffer that has been edited before, the options from the window
272that was last closed are used again. If this buffer has been edited in this
273window, the values from back then are used. Otherwise the values from the
274last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275
276It's possible to set a local window option specifically for a type of buffer.
277When you edit another buffer in the same window, you don't want to keep
278using these local window options. Therefore Vim keeps a global value of the
279local window options, which is used when editing another buffer. Each window
280has its own copy of these values. Thus these are local to the window, but
281global to all buffers in the window. With this you can do: >
282 :e one
283 :set list
284 :e two
285Now the 'list' option will also be set in "two", since with the ":set list"
286command you have also set the global value. >
287 :set nolist
288 :e one
289 :setlocal list
290 :e two
291Now the 'list' option is not set, because ":set nolist" resets the global
292value, ":setlocal list" only changes the local value and ":e two" gets the
293global value. Note that if you do this next: >
294 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200295You will get back the 'list' value as it was the last time you edited "one".
296The options local to a window are remembered for each buffer. This also
297happens when the buffer is not loaded, but they are lost when the buffer is
298wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299
300 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100301:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 current buffer or window. Not all options have a
303 local value. If the option does not have a local
304 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200305 With the "all" argument: display local values for all
306 local options.
307 Without argument: Display local values for all local
308 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000310 local value. For a global/local boolean option, when
311 the global value is being used, "--" is displayed
312 before the option name.
313 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000315
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000316:setl[ocal] {option}< Set the local value of {option} to its global value by
317 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100319:se[t] {option}< For |global-local| options: Remove the local value of
320 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000321
322 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100323:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324 option without changing the local value.
325 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200326 With the "all" argument: display global values for all
327 local options.
328 Without argument: display global values for all local
329 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330
331For buffer-local and window-local options:
332 Command global value local value ~
333 :set option=value set set
334 :setlocal option=value - set
335:setglobal option=value set -
336 :set option? - display
337 :setlocal option? - display
338:setglobal option? display -
339
340
341Global options with a local value *global-local*
342
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000343Options are global when you mostly use one value for all buffers and windows.
344For some global options it's useful to sometimes have a different local value.
345You can set the local value with ":setlocal". That buffer or window will then
346use the local value, while other buffers and windows continue using the global
347value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348
349For example, you have two windows, both on C source code. They use the global
350'makeprg' option. If you do this in one of the two windows: >
351 :set makeprg=gmake
352then the other window will switch to the same value. There is no need to set
353the 'makeprg' option in the other C source window too.
354However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000355another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000356files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357 :setlocal makeprg=perlmake
358You can switch back to using the global value by making the local value empty: >
359 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100360This only works for a string option. For a number or boolean option you need
361to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100363Note that for non-boolean and non-number options using "<" copies the global
364value to the local value, it doesn't switch back to using the global value
365(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000366 :set path<
367This will make the local value of 'path' empty, so that the global value is
368used. Thus it does the same as: >
369 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370Note: In the future more global options can be made global-local. Using
371":setlocal" on a global option might work differently then.
372
373
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000374 *option-value-function*
375Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
376'operatorfunc', 'quickfixtextfunc' and 'tagfunc') are set to a function name
377or a function reference or a lambda function. Examples:
378>
379 set opfunc=MyOpFunc
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +0000380 set opfunc=function('MyOpFunc')
381 set opfunc=funcref('MyOpFunc')
382 let &opfunc = "{t -> MyOpFunc(t)}"
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +0000383<
384
Bram Moolenaar071d4272004-06-13 20:20:40 +0000385Setting the filetype
386
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200387:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388 Set the 'filetype' option to {filetype}, but only if
389 not done yet in a sequence of (nested) autocommands.
390 This is short for: >
391 :if !did_filetype()
392 : setlocal filetype={filetype}
393 :endif
394< This command is used in a filetype.vim file to avoid
395 setting the 'filetype' option twice, causing different
396 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200397
398 When the optional FALLBACK argument is present, a
399 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100400 'filetype'. This is to be used for filetype
401 detections that are just a guess. |did_filetype()|
402 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200403
Bram Moolenaard58e9292011-02-09 17:07:58 +0100404 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
406:opt[ions] Open a window for viewing and setting all options.
407 Options are grouped by function.
408 Offers short help for each option. Hit <CR> on the
409 short help to open a help window with more help for
410 the option.
411 Modify the value of the option and hit <CR> on the
412 "set" line to set the new value. For window and
413 buffer specific options, the last accessed window is
414 used to set the option value in, unless this is a help
415 window, in which case the window below help window is
416 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100417 {not available when compiled without the |+eval|
418 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419
420 *$HOME*
421Using "~" is like using "$HOME", but it is only recognized at the start of an
422option and after a space or comma.
423
424On Unix systems "~user" can be used too. It is replaced by the home directory
425of user "user". Example: >
426 :set path=~mool/include,/usr/include,.
427
428On Unix systems the form "${HOME}" can be used too. The name between {} can
429contain non-id characters then. Note that if you want to use this for the
430"gf" command, you need to add the '{' and '}' characters to 'isfname'.
431
432NOTE: expanding environment variables and "~/" is only done with the ":set"
433command, not when assigning a value to an option with ":let".
434
Bram Moolenaarc572da52017-08-27 16:52:01 +0200435 *$HOME-windows*
436On MS-Windows, if $HOME is not defined as an environment variable, then
437at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200438If $HOMEDRIVE is not set then $USERPROFILE is used.
439
440This expanded value is not exported to the environment, this matters when
441running an external command: >
442 :echo system('set | findstr ^HOME=')
443and >
444 :echo luaeval('os.getenv("HOME")')
445should echo nothing (an empty string) despite exists('$HOME') being true.
446When setting $HOME to a non-empty string it will be exported to the
447subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200448
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449
450Note the maximum length of an expanded option is limited. How much depends on
451the system, mostly it is something like 256 or 1024 characters.
452
453 *:fix* *:fixdel*
454:fix[del] Set the value of 't_kD':
455 't_kb' is 't_kD' becomes ~
456 CTRL-? CTRL-H
457 not CTRL-? CTRL-?
458
Bram Moolenaar82be4842021-01-11 19:40:15 +0100459 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460
461 If your delete key terminal code is wrong, but the
462 code for backspace is alright, you can put this in
463 your .vimrc: >
464 :fixdel
465< This works no matter what the actual code for
466 backspace is.
467
468 If the backspace key terminal code is wrong you can
469 use this: >
470 :if &term == "termname"
471 : set t_kb=^V<BS>
472 : fixdel
473 :endif
474< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000475 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476 with your terminal name.
477
478 If your <Delete> key sends a strange key sequence (not
479 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
480 :if &term == "termname"
481 : set t_kD=^V<Delete>
482 :endif
483< Where "^V" is CTRL-V and "<Delete>" is the delete key
484 (don't type eight characters!). Replace "termname"
485 with your terminal name.
486
487 *Linux-backspace*
488 Note about Linux: By default the backspace key
489 produces CTRL-?, which is wrong. You can fix it by
490 putting this line in your rc.local: >
491 echo "keycode 14 = BackSpace" | loadkeys
492<
493 *NetBSD-backspace*
494 Note about NetBSD: If your backspace doesn't produce
495 the right code, try this: >
496 xmodmap -e "keycode 22 = BackSpace"
497< If this works, add this in your .Xmodmap file: >
498 keysym 22 = BackSpace
499< You need to restart for this to take effect.
500
501==============================================================================
5022. Automatically setting options *auto-setting*
503
504Besides changing options with the ":set" command, there are three alternatives
505to set options automatically for one or more files:
506
5071. When starting Vim initializations are read from various places. See
508 |initialization|. Most of them are performed for all editing sessions,
509 and some of them depend on the directory where Vim is started.
510 You can create an initialization file with |:mkvimrc|, |:mkview| and
511 |:mksession|.
5122. If you start editing a new file, the automatic commands are executed.
513 This can be used to set options for files matching a particular pattern and
514 many other things. See |autocommand|.
5153. If you start editing a new file, and the 'modeline' option is on, a
516 number of lines at the beginning and end of the file are checked for
517 modelines. This is explained here.
518
519 *modeline* *vim:* *vi:* *ex:* *E520*
520There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100521 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100523[text{white}] empty or any text followed by at least one blank
524 character (<Space> or <Tab>); "ex:" always requires at
525 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200526{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200527[white] optional white space
528{options} a list of option settings, separated with white space
529 or ':', where each part between ':' is the argument
530 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaar14b69452013-06-29 23:05:20 +0200532Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535
536The second form (this is compatible with some versions of Vi):
537
Bram Moolenaarade0d392020-01-21 22:33:58 +0100538 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539
Bram Moolenaarade0d392020-01-21 22:33:58 +0100540[text{white}] empty or any text followed by at least one blank
541 character (<Space> or <Tab>); "ex:" always requires at
542 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200543{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
544[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200545se[t] the string "set " or "se " (note the space); When
546 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200547{options} a list of options, separated with white space, which
548 is the argument for a ":set" command
549: a colon
550[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551
Bram Moolenaar14b69452013-06-29 23:05:20 +0200552Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000553 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200554 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200556The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
557chance that a normal word like "lex:" is caught. There is one exception:
558"vi:" and "vim:" can also be at the start of the line (for compatibility with
559version 3.0). Using "ex:" at the start of the line will be ignored (this
560could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561
Hu Jialun9dcd3492021-08-28 20:42:50 +0200562If the modeline is disabled within a modeline, subsequent modelines will be
563ignored. This is to allow turning off modeline on a per-file basis. This is
564useful when a line looks like a modeline but isn't. For example, it would be
565good to start a YAML file containing strings like "vim:" with
566 # vim: nomodeline ~
567so as to avoid modeline misdetection. Following options on the same line
568after modeline deactivation, if any, are still evaluated (but you would
569normally not have any).
570
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571 *modeline-local*
572The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000573buffer and window that contain the file. Although it's possible to set global
574options from a modeline, this is unusual. If you have two windows open and
575the files in it set the same global option to a different value, the result
576depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000578When editing a file that was already loaded, only the window-local options
579from the modeline are used. Thus if you manually changed a buffer-local
580option after opening the file, it won't be changed if you edit the same buffer
581in another window. But window-local options will be set.
582
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583 *modeline-version*
584If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200585number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586 vim{vers}: version {vers} or later
587 vim<{vers}: version before {vers}
588 vim={vers}: version {vers}
589 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100590{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
591For example, to use a modeline only for Vim 7.0:
592 /* vim700: set foldmethod=marker */ ~
593To use a modeline for Vim after version 7.2:
594 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595There can be no blanks between "vim" and the ":".
596
597
598The number of lines that are checked can be set with the 'modelines' option.
599If 'modeline' is off or 'modelines' is 0 no lines are checked.
600
601Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000602like:
603 /* vi:ts=4: */ ~
604will give an error message for the trailing "*/". This line is OK:
605 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606
607If an error is detected the rest of the line is skipped.
608
609If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000610backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100611 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
612This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
613before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200614 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000616might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200617can be set. For some options a flag is set, so that when the value is used
618the |sandbox| is effective. Some options can only be set from the modeline
619when 'modelineexpr' is set (the default is off).
620
621Still, there is always a small risk that a modeline causes trouble. E.g.,
622when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
623So disable modelines before editing untrusted text. The mail ftplugin does
624this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625
626Hint: If you would like to do something else than setting an option, you could
627define an autocommand that checks the file for a specific string. For
628example: >
629 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
630And define a function SetVar() that does something with the line containing
631"VAR".
632
633==============================================================================
6343. Options summary *option-summary*
635
636In the list below all the options are mentioned with their full name and with
637an abbreviation if there is one. Both forms may be used.
638
639In this document when a boolean option is "set" that means that ":set option"
640is entered. When an option is "reset", ":set nooption" is used.
641
642For some options there are two default values: The "Vim default", which is
643used when 'compatible' is not set, and the "Vi default", which is used when
644'compatible' is set.
645
646Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000647are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648different value in each window. For example the 'list' option can be set in
649one window and reset in another for the same text, giving both types of view
650at the same time. There are a few options that are specific to a certain
651file. These can have a different value for each file or buffer. For example
652the 'textwidth' option can be 78 for a normal text file and 0 for a C
653program.
654
655 global one option for all buffers and windows
656 local to window each window has its own copy of this option
657 local to buffer each buffer has its own copy of this option
658
659When creating a new window the option values from the currently active window
660are used as a default value for the window-specific options. For the
661buffer-specific options this depends on the 's' and 'S' flags in the
662'cpoptions' option. If 's' is included (which is the default) the values for
663buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000664first entered. If 'S' is present the options are copied each time the buffer
665is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666present, the options are copied from the currently active buffer when the
667buffer is created.
668
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000669Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000671Not all options are supported in all versions. This depends on the supported
672features and sometimes on the system. A remark about this is in curly braces
673below. When an option is not supported it may still be set without getting an
674error, this is called a hidden option. You can't get the value of a hidden
675option though, it is not stored.
676
677To test if option "foo" can be used with ":set" use something like this: >
678 if exists('&foo')
679This also returns true for a hidden option. To test if option "foo" is really
680supported use something like this: >
681 if exists('+foo')
682<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683 *E355*
684A jump table for the options with a short description can be found at |Q_op|.
685
686 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100687'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689 {only available when compiled with the |+rightleft|
690 feature}
691 The ASCII code for the first letter of the Hebrew alphabet. The
692 routine that maps the keyboard in Hebrew mode, both in Insert mode
693 (when hkmap is set) and on the command-line (when hitting CTRL-_)
694 outputs the Hebrew characters in the range [aleph..aleph+26].
695 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
696 See |rileft.txt|.
697
698 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
699'allowrevins' 'ari' boolean (default off)
700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701 {only available when compiled with the |+rightleft|
702 feature}
703 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
704 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
705 into reverse Insert mode, and don't know how to get out. See
706 'revins'.
707 NOTE: This option is reset when 'compatible' is set.
708
709 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
710'altkeymap' 'akm' boolean (default off)
711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 {only available when compiled with the |+farsi|
713 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100714 This option was for using Farsi, which has been removed. See
715 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716
717 *'ambiwidth'* *'ambw'*
718'ambiwidth' 'ambw' string (default: "single")
719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
721 Tells Vim what to do with characters with East Asian Width Class
722 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
723 letters, Cyrillic letters).
724
725 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000726 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727 expected by most users.
728 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200729 *E834* *E835*
730 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100731 contains a character that would be double width. These errors may
732 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200733
734 The values are overruled for characters specified with
735 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736
737 There are a number of CJK fonts for which the width of glyphs for
738 those characters are solely based on how many octets they take in
739 legacy/traditional CJK encodings. In those encodings, Euro,
740 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000741 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000743 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744 Vim is running inside a terminal (emulators) that uses a CJK font
745 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
746 this option should be set to "double" to match the width perceived
747 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100748 to be set to "double" under CJK MS-Windows when the system locale is
749 set to one of CJK locales. See Unicode Standard Annex #11
750 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100752 Vim may set this option automatically at startup time when Vim is
753 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200754 escape sequence to request cursor position report. The response can
755 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100756
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
758'antialias' 'anti' boolean (default: off)
759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200761 on macOS}
762 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
764 which can be easier to read at certain sizes on certain displays.
765 Setting this option can sometimes cause problems if 'guifont' is set
766 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100767 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768
769 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
770'autochdir' 'acd' boolean (default off)
771 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200772 {only available when compiled with it, use
773 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000774 When on, Vim will change the current working directory whenever you
775 open a file, switch buffers, delete a buffer or open/close a window.
776 It will change to the directory containing the file which was opened
777 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000778 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200780 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
781'autoshelldir' 'asd' boolean (default off)
782 global
783 When on, Vim will change the current working directory whenever you
784 change the directory of the shell running in a terminal window. You
785 need proper setting-up, so whenever the shell's pwd changes an OSC 7
786 escape sequence will be emitted. For example, on Linux, you can source
787 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
788
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
790'arabic' 'arab' boolean (default off)
791 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 {only available when compiled with the |+arabic|
793 feature}
794 This option can be set to start editing Arabic text.
795 Setting this option will:
796 - Set the 'rightleft' option, unless 'termbidi' is set.
797 - Set the 'arabicshape' option, unless 'termbidi' is set.
798 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
799 between typing English and Arabic key mapping.
800 - Set the 'delcombine' option
801 Note that 'encoding' must be "utf-8" for working with Arabic text.
802
803 Resetting this option will:
804 - Reset the 'rightleft' option.
805 - Disable the use of 'keymap' (without changing its value).
806 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200807 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100808 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809 Also see |arabic.txt|.
810
811 *'arabicshape'* *'arshape'*
812 *'noarabicshape'* *'noarshape'*
813'arabicshape' 'arshape' boolean (default on)
814 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 {only available when compiled with the |+arabic|
816 feature}
817 When on and 'termbidi' is off, the required visual character
818 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200819 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 one which encompasses:
821 a) the changing/morphing of characters based on their location
822 within a word (initial, medial, final and stand-alone).
823 b) the enabling of the ability to compose characters
824 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100825 When disabled the display shows each character's true stand-alone
826 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827 Arabic is a complex language which requires other settings, for
828 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100829 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830
831 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
832'autoindent' 'ai' boolean (default off)
833 local to buffer
834 Copy indent from current line when starting a new line (typing <CR>
835 in Insert mode or when using the "o" or "O" command). If you do not
836 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000837 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
838 to another line has the same effect, unless the 'I' flag is included
839 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000840 When autoindent is on, formatting (with the "gq" command or when you
841 reach 'textwidth' in Insert mode) uses the indentation of the first
842 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 When 'smartindent' or 'cindent' is on the indent is changed in
844 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200845 The 'autoindent' option is reset when the 'paste' option is set and
846 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847
848 *'autoread'* *'ar'* *'noautoread'* *'noar'*
849'autoread' 'ar' boolean (default off)
850 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 When a file has been detected to have been changed outside of Vim and
852 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200853 When the file has been deleted this is not done, so you have the text
854 from before it was deleted. When it appears again then it is read.
855 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 If this option has a local value, use this command to switch back to
857 using the global value: >
858 :set autoread<
859<
860 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
861'autowrite' 'aw' boolean (default off)
862 global
863 Write the contents of the file, if it has been modified, on each
864 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000865 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
867 Note that for some commands the 'autowrite' option is not used, see
868 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200869 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200870 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871
872 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
873'autowriteall' 'awa' boolean (default off)
874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
876 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
877 Setting this option also implies that Vim behaves like 'autowrite' has
878 been set.
879
880 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200881'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 When set to "dark", Vim will try to use colors that look good on a
884 dark background. When set to "light", Vim will try to use colors that
885 look good on a light background. Any other value is illegal.
886 Vim tries to set the default value according to the terminal used.
887 This will not always be correct.
888 Setting this option does not change the background color, it tells Vim
889 what the background color looks like. For changing the background
890 color, see |:hi-normal|.
891
892 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000893 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000894 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100895 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 setting 'background' will cause the color scheme to be reloaded. If
897 the color scheme adjusts to the value of 'background' this will work.
898 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100899 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
901 When setting 'background' to the default value with: >
902 :set background&
903< Vim will guess the value. In the GUI this should work correctly,
904 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200905 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200906 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200908 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200909 color from the terminal. If the returned RGB value is dark/light and
910 'background' is not dark/light, 'background' will be set and the
911 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200912 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100913 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200914
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 When starting the GUI, the default value for 'background' will be
916 "light". When the value is not set in the .gvimrc, and Vim detects
917 that the background is actually quite dark, 'background' is set to
918 "dark". But this happens only AFTER the .gvimrc file has been read
919 (because the window needs to be opened to find the actual background
920 color). To get around this, force the GUI window to be opened by
921 putting a ":gui" command in the .gvimrc file, before where the value
922 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200923
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100924 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200925 For other systems "dark" is used when 'term' is "linux",
926 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
927 background. Otherwise the default is "light".
928
Bram Moolenaarc572da52017-08-27 16:52:01 +0200929 The |:terminal| command and the |term_start()| function use the
930 'background' value to decide whether the terminal window will start
931 with a white or black background.
932
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 Normally this option would be set in the .vimrc file. Possibly
934 depending on the terminal name. Example: >
935 :if &term == "pcterm"
936 : set background=dark
937 :endif
938< When this option is set, the default settings for the highlight groups
939 will change. To use other settings, place ":highlight" commands AFTER
940 the setting of the 'background' option.
941 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
942 to select the colors for syntax highlighting. After changing this
943 option, you must load syntax.vim again to see the result. This can be
944 done with ":syntax on".
945
946 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200947'backspace' 'bs' string (default "", set to "indent,eol,start"
948 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
951 mode. This is a list of items, separated by commas. Each item allows
952 a way to backspace over something:
953 value effect ~
954 indent allow backspacing over autoindent
955 eol allow backspacing over line breaks (join lines)
956 start allow backspacing over the start of insert; CTRL-W and CTRL-U
957 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200958 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
959 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960
961 When the value is empty, Vi compatible backspacing is used.
962
963 For backwards compatibility with version 5.4 and earlier:
964 value effect ~
965 0 same as ":set backspace=" (Vi compatible)
966 1 same as ":set backspace=indent,eol"
967 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200968 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969
970 See |:fixdel| if your <BS> or <Del> key does not do what you want.
971 NOTE: This option is set to "" when 'compatible' is set.
972
973 *'backup'* *'bk'* *'nobackup'* *'nobk'*
974'backup' 'bk' boolean (default off)
975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976 Make a backup before overwriting a file. Leave it around after the
977 file has been successfully written. If you do not want to keep the
978 backup file, but you do want a backup while the file is being
979 written, reset this option and set the 'writebackup' option (this is
980 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000981 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 |backup-table| for more explanations.
983 When the 'backupskip' pattern matches, a backup is not made anyway.
984 When 'patchmode' is set, the backup may be renamed to become the
985 oldest version of a file.
986 NOTE: This option is reset when 'compatible' is set.
987
988 *'backupcopy'* *'bkc'*
989'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200990 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 When writing a file and a backup is made, this option tells how it's
992 done. This is a comma separated list of words.
993
994 The main values are:
995 "yes" make a copy of the file and overwrite the original one
996 "no" rename the file and write a new one
997 "auto" one of the previous, what works best
998
999 Extra values that can be combined with the ones above are:
1000 "breaksymlink" always break symlinks when writing
1001 "breakhardlink" always break hardlinks when writing
1002
1003 Making a copy and overwriting the original file:
1004 - Takes extra time to copy the file.
1005 + When the file has special attributes, is a (hard/symbolic) link or
1006 has a resource fork, all this is preserved.
1007 - When the file is a link the backup will have the name of the link,
1008 not of the real file.
1009
1010 Renaming the file and writing a new one:
1011 + It's fast.
1012 - Sometimes not all attributes of the file can be copied to the new
1013 file.
1014 - When the file is a link the new file will not be a link.
1015
1016 The "auto" value is the middle way: When Vim sees that renaming file
1017 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001018 the file is not a link) that is used. When problems are expected, a
1019 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020
1021 The "breaksymlink" and "breakhardlink" values can be used in
1022 combination with any of "yes", "no" and "auto". When included, they
1023 force Vim to always break either symbolic or hard links by doing
1024 exactly what the "no" option does, renaming the original file to
1025 become the backup and writing a new file in its place. This can be
1026 useful for example in source trees where all the files are symbolic or
1027 hard links and any changes should stay in the local source tree, not
1028 be propagated back to the original source.
1029 *crontab*
1030 One situation where "no" and "auto" will cause problems: A program
1031 that opens a file, invokes Vim to edit that file, and then tests if
1032 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001033 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034 example.
1035
1036 When a copy is made, the original file is truncated and then filled
1037 with the new text. This means that protection bits, owner and
1038 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001039 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 group of the backup is set to the group of the original file. If this
1041 fails, the protection bits for the group are made the same as for
1042 others.
1043
1044 When the file is renamed this is the other way around: The backup has
1045 the same attributes of the original file, and the newly written file
1046 is owned by the current user. When the file was a (hard/symbolic)
1047 link, the new file will not! That's why the "auto" value doesn't
1048 rename when the file is a link. The owner and group of the newly
1049 written file will be set to the same ones as the original file, but
1050 the system may refuse to do this. In that case the "auto" value will
1051 again not rename the file.
1052
Bram Moolenaar036986f2017-03-16 17:41:02 +01001053 NOTE: This option is set to the Vi default value when 'compatible' is
1054 set and to the Vim default value when 'compatible' is reset.
1055
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056 *'backupdir'* *'bdir'*
1057'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001058 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059 for Unix: ".,~/tmp,~/")
1060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 List of directories for the backup file, separated with commas.
1062 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001063 where this is possible. The directory must exist, Vim will not
1064 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001065 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 impossible!). Writing may fail because of this.
1067 - A directory "." means to put the backup file in the same directory
1068 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001069 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1070 the backup file relative to where the edited file is. The leading
1071 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 ("." inside a directory name has no special meaning).
1073 - Spaces after the comma are ignored, other spaces are considered part
1074 of the directory name. To have a space at the start of a directory
1075 name, precede it with a backslash.
1076 - To include a comma in a directory name precede it with a backslash.
1077 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001078 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001079 the backup file name will be built from the complete path to the
1080 file with all path separators changed to percent '%' signs. This
1081 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001082 On Win32, it is also possible to end with "\\". However, When a
1083 separating comma is following, you must use "//", since "\\" will
1084 include the comma in the file name. Therefore it is recommended to
1085 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 - Environment variables are expanded |:set_env|.
1087 - Careful with '\' characters, type one before a space, type two to
1088 get one in the option (see |option-backslash|), for example: >
1089 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1090< - For backwards compatibility with Vim version 3.0 a '>' at the start
1091 of the option is removed.
1092 See also 'backup' and 'writebackup' options.
1093 If you want to hide your backup files on Unix, consider this value: >
1094 :set backupdir=./.backup,~/.backup,.,/tmp
1095< You must create a ".backup" directory in each directory and in your
1096 home directory for this to work properly.
1097 The use of |:set+=| and |:set-=| is preferred when adding or removing
1098 directories from the list. This avoids problems when a future version
1099 uses another default.
1100 This option cannot be set from a |modeline| or in the |sandbox|, for
1101 security reasons.
1102
1103 *'backupext'* *'bex'* *E589*
1104'backupext' 'bex' string (default "~", for VMS: "_")
1105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 String which is appended to a file name to make the name of the
1107 backup file. The default is quite unusual, because this avoids
1108 accidentally overwriting existing files with a backup file. You might
1109 prefer using ".bak", but make sure that you don't have files with
1110 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001111 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001113 If you like to keep a lot of backups, you could use a BufWritePre
1114 autocommand to change 'backupext' just before writing the file to
1115 include a timestamp. >
1116 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1117< Use 'backupdir' to put the backup in a different directory.
1118
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001120'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1121 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1122 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124 {not available when compiled without the |+wildignore|
1125 feature}
1126 A list of file patterns. When one of the patterns matches with the
1127 name of the file which is written, no backup file is created. Both
1128 the specified file name and the full path name of the file are used.
1129 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1130 Watch out for special characters, see |option-backslash|.
1131 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001132 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001133
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001134 WARNING: Not having a backup file means that when Vim fails to write
1135 your buffer correctly and then, for whatever reason, Vim exits, you
1136 lose both the original file and what you were writing. Only disable
1137 backups if you don't care about losing the file.
1138
Bram Moolenaar02467872007-05-06 13:22:01 +00001139 Note that environment variables are not expanded. If you want to use
1140 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001141 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001142
1143< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001144 backup would be made by renaming the original file crontab won't see
1145 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146
1147 *'balloondelay'* *'bdlay'*
1148'balloondelay' 'bdlay' number (default: 600)
1149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 {only available when compiled with the |+balloon_eval|
1151 feature}
1152 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1153
1154 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1155'ballooneval' 'beval' boolean (default off)
1156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001158 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001159 Switch on the |balloon-eval| functionality for the GUI.
1160
1161 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1162 *'nobevalterm'*
1163'balloonevalterm' 'bevalterm' boolean (default off)
1164 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001165 {only available when compiled with the
1166 |+balloon_eval_term| feature}
1167 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001169 *'balloonexpr'* *'bexpr'*
1170'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001171 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001172 {only available when compiled with the |+balloon_eval|
1173 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001174 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001175 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1176 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001177
1178 v:beval_bufnr number of the buffer in which balloon is going to show
1179 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001180 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001181 v:beval_lnum line number
1182 v:beval_col column number (byte index)
1183 v:beval_text word under or after the mouse pointer
1184
Bram Moolenaar54775062019-07-31 21:07:14 +02001185 Instead of showing a balloon, which is limited to plain text, consider
1186 using a popup window, see |popup_beval_example|. A popup window can
1187 use highlighting and show a border.
1188
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001189 The evaluation of the expression must not have side effects!
1190 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001191 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001192 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001193 \', column ' . v:beval_col .
1194 \ ' of file ' . bufname(v:beval_bufnr) .
1195 \ ' on word "' . v:beval_text . '"'
1196 endfunction
1197 set bexpr=MyBalloonExpr()
1198 set ballooneval
1199<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001200 Also see |balloon_show()|, it can be used if the content of the balloon
1201 is to be fetched asynchronously. In that case evaluating
1202 'balloonexpr' should result in an empty string. If you get a balloon
1203 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001204
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001205 NOTE: The balloon is displayed only if the cursor is on a text
1206 character. If the result of evaluating 'balloonexpr' is not empty,
1207 Vim does not try to send a message to an external debugger (Netbeans
1208 or Sun Workshop).
1209
Bram Moolenaar30b65812012-07-12 22:01:11 +02001210 The expression will be evaluated in the |sandbox| when set from a
1211 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001212 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001213
1214 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001215 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001216
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001217 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001218 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001219< When they are supported "\n" characters will start a new line. If the
1220 expression evaluates to a |List| this is equal to using each List item
1221 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001222 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001223
Bram Moolenaar165bc692015-07-21 17:53:25 +02001224 *'belloff'* *'bo'*
1225'belloff' 'bo' string (default "")
1226 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001227 Specifies for which events the bell will not be rung. It is a comma
1228 separated list of items. For each item that is present, the bell
1229 will be silenced. This is most useful to specify specific events in
1230 insert mode to be silenced.
1231
1232 item meaning when present ~
1233 all All events.
1234 backspace When hitting <BS> or <Del> and deleting results in an
1235 error.
1236 cursor Fail to move around using the cursor keys or
1237 <PageUp>/<PageDown> in |Insert-mode|.
1238 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1239 |i_CTRL-X_CTRL-T|.
1240 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1241 |i_CTRL-E|.
1242 ctrlg Unknown Char after <C-G> in Insert mode.
1243 error Other Error occurred (e.g. try to join last line)
1244 (mostly used in |Normal-mode| or |Cmdline-mode|).
1245 esc hitting <Esc> in |Normal-mode|.
1246 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001247 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001248 insertmode Pressing <Esc> in 'insertmode'.
1249 lang Calling the beep module for Lua/Mzscheme/TCL.
1250 mess No output available for |g<|.
1251 showmatch Error occurred for 'showmatch' function.
1252 operator Empty region error |cpo-E|.
1253 register Unknown register after <C-R> in |Insert-mode|.
1254 shell Bell from shell output |:!|.
1255 spell Error happened on spell suggest.
1256 wildmode More matches in |cmdline-completion| available
1257 (depends on the 'wildmode' setting).
1258
Bram Moolenaar036986f2017-03-16 17:41:02 +01001259 This is most useful to fine tune when in Insert mode the bell should
1260 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001261 indicate that an error occurred. It can be silenced by adding the
1262 "error" keyword.
1263
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1265'binary' 'bin' boolean (default off)
1266 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267 This option should be set before editing a binary file. You can also
1268 use the |-b| Vim argument. When this option is switched on a few
1269 options will be changed (also when it already was on):
1270 'textwidth' will be set to 0
1271 'wrapmargin' will be set to 0
1272 'modeline' will be off
1273 'expandtab' will be off
1274 Also, 'fileformat' and 'fileformats' options will not be used, the
1275 file is read and written like 'fileformat' was "unix" (a single <NL>
1276 separates lines).
1277 The 'fileencoding' and 'fileencodings' options will not be used, the
1278 file is read without conversion.
1279 NOTE: When you start editing a(nother) file while the 'bin' option is
1280 on, settings from autocommands may change the settings again (e.g.,
1281 'textwidth'), causing trouble when editing. You might want to set
1282 'bin' again when the file has been loaded.
1283 The previous values of these options are remembered and restored when
1284 'bin' is switched from on to off. Each buffer has its own set of
1285 saved option values.
1286 To edit a file with 'binary' set you can use the |++bin| argument.
1287 This avoids you have to do ":set bin", which would have effect for all
1288 files you edit.
1289 When writing a file the <EOL> for the last line is only written if
1290 there was one in the original file (normally Vim appends an <EOL> to
1291 the last line if there is none; this would make the file longer). See
1292 the 'endofline' option.
1293
1294 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1295'bioskey' 'biosk' boolean (default on)
1296 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001297 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001298 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299
1300 *'bomb'* *'nobomb'*
1301'bomb' boolean (default off)
1302 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 When writing a file and the following conditions are met, a BOM (Byte
1304 Order Mark) is prepended to the file:
1305 - this option is on
1306 - the 'binary' option is off
1307 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1308 endian variants.
1309 Some applications use the BOM to recognize the encoding of the file.
1310 Often used for UCS-2 files on MS-Windows. For other applications it
1311 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001312 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1314 check for the presence of the BOM is done and 'bomb' set accordingly.
1315 Unless 'binary' is set, it is removed from the first line, so that you
1316 don't see it when editing. When you don't change the options, the BOM
1317 will be restored when writing the file.
1318
1319 *'breakat'* *'brk'*
1320'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1321 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001322 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 feature}
1324 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001325 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1326 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001328 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001329'breakindent' 'bri' boolean (default off)
1330 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001331 {not available when compiled without the |+linebreak|
1332 feature}
1333 Every wrapped line will continue visually indented (same amount of
1334 space as the beginning of that line), thus preserving horizontal blocks
1335 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001336 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001337
1338 *'breakindentopt'* *'briopt'*
1339'breakindentopt' 'briopt' string (default empty)
1340 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001341 {not available when compiled without the |+linebreak|
1342 feature}
1343 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001344 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001345 min:{n} Minimum text width that will be kept after
1346 applying 'breakindent', even if the resulting
1347 text should normally be narrower. This prevents
1348 text indented almost to the right window border
1349 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001350 shift:{n} After applying 'breakindent', the wrapped line's
1351 beginning will be shifted by the given number of
1352 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001353 indentation (negative) or emphasizing the line
1354 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001355 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001356 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001357 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001358 numbered or bulleted list (using the
1359 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001360 list:-1 Uses the length of a match with 'formatlistpat'
1361 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001362 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001363
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001365'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001367 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001369 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001370 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 buffer Use the directory of the related buffer.
1372 current Use the current directory.
1373 {path} Use the specified directory
1374
1375 *'bufhidden'* *'bh'*
1376'bufhidden' 'bh' string (default: "")
1377 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 This option specifies what happens when a buffer is no longer
1379 displayed in a window:
1380 <empty> follow the global 'hidden' option
1381 hide hide the buffer (don't unload it), also when 'hidden'
1382 is not set
1383 unload unload the buffer, also when 'hidden' is set or using
1384 |:hide|
1385 delete delete the buffer from the buffer list, also when
1386 'hidden' is set or using |:hide|, like using
1387 |:bdelete|
1388 wipe wipe out the buffer from the buffer list, also when
1389 'hidden' is set or using |:hide|, like using
1390 |:bwipeout|
1391
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001392 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001393 are lost without a warning. Also, these values may break autocommands
1394 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 This option is used together with 'buftype' and 'swapfile' to specify
1396 special kinds of buffers. See |special-buffers|.
1397
1398 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1399'buflisted' 'bl' boolean (default: on)
1400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 When this option is set, the buffer shows up in the buffer list. If
1402 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1403 This option is reset by Vim for buffers that are only used to remember
1404 a file name or marks. Vim sets it when starting to edit a buffer.
1405 But not when moving to a buffer with ":buffer".
1406
1407 *'buftype'* *'bt'* *E382*
1408'buftype' 'bt' string (default: "")
1409 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 The value of this option specifies the type of a buffer:
1411 <empty> normal buffer
1412 nofile buffer which is not related to a file and will not be
1413 written
1414 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001415 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001416 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001418 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 help help buffer (you are not supposed to set this
1420 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001421 terminal buffer for a |terminal| (you are not supposed to set
1422 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001423 prompt buffer where only the last line can be edited, meant
1424 to be used by a plugin, see |prompt-buffer|
1425 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001426 popup buffer used in a popup window, see |popup|.
1427 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428
1429 This option is used together with 'bufhidden' and 'swapfile' to
1430 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001431 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432
1433 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001434 One such effect is that Vim will not check the timestamp of the file,
1435 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436
Bram Moolenaar280f1262006-01-30 00:14:18 +00001437 A "quickfix" buffer is only used for the error list and the location
1438 list. This value is set by the |:cwindow| and |:lwindow| commands and
1439 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440
1441 "nofile" and "nowrite" buffers are similar:
1442 both: The buffer is not to be written to disk, ":w" doesn't
1443 work (":w filename" does work though).
1444 both: The buffer is never considered to be |'modified'|.
1445 There is no warning when the changes will be lost, for
1446 example when you quit Vim.
1447 both: A swap file is only created when using too much memory
1448 (when 'swapfile' has been reset there is never a swap
1449 file).
1450 nofile only: The buffer name is fixed, it is not handled like a
1451 file name. It is not modified in response to a |:cd|
1452 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001453 both: When using ":e bufname" and already editing "bufname"
1454 the buffer is made empty and autocommands are
1455 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001456 *E676*
1457 "acwrite" implies that the buffer name is not related to a file, like
1458 "nofile", but it will be written. Thus, in contrast to "nofile" and
1459 "nowrite", ":w" does work and a modified buffer can't be abandoned
1460 without saving. For writing there must be matching |BufWriteCmd|,
1461 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462
1463 *'casemap'* *'cmp'*
1464'casemap' 'cmp' string (default: "internal,keepascii")
1465 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 Specifies details about changing the case of letters. It may contain
1467 these words, separated by a comma:
1468 internal Use internal case mapping functions, the current
1469 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001470 matters when 'encoding' is a Unicode encoding,
1471 "latin1" or "iso-8859-15". When "internal" is
1472 omitted, the towupper() and towlower() system library
1473 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1475 case mapping, the current locale is not effective.
1476 This probably only matters for Turkish.
1477
1478 *'cdpath'* *'cd'* *E344* *E346*
1479'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 {not available when compiled without the
1482 |+file_in_path| feature}
1483 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001484 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1485 searched for has a relative path, not an absolute part starting with
1486 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 The 'cdpath' option's value has the same form and semantics as
1488 |'path'|. Also see |file-searching|.
1489 The default value is taken from $CDPATH, with a "," prepended to look
1490 in the current directory first.
1491 If the default value taken from $CDPATH is not what you want, include
1492 a modified version of the following command in your vimrc file to
1493 override it: >
1494 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1495< This option cannot be set from a |modeline| or in the |sandbox|, for
1496 security reasons.
1497 (parts of 'cdpath' can be passed to the shell to expand file names).
1498
1499 *'cedit'*
1500'cedit' string (Vi default: "", Vim default: CTRL-F)
1501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 The key used in Command-line Mode to open the command-line window.
1503 The default is CTRL-F when 'compatible' is off.
1504 Only non-printable keys are allowed.
1505 The key can be specified as a single character, but it is difficult to
1506 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001507 :exe "set cedit=\<C-Y>"
1508 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509< |Nvi| also has this option, but it only uses the first character.
1510 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001511 NOTE: This option is set to the Vim default value when 'compatible'
1512 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513
1514 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1515'charconvert' 'ccv' string (default "")
1516 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001517 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 An expression that is used for character encoding conversion. It is
1519 evaluated when a file that is to be read or has been written has a
1520 different encoding from what is desired.
1521 'charconvert' is not used when the internal iconv() function is
1522 supported and is able to do the conversion. Using iconv() is
1523 preferred, because it is much faster.
1524 'charconvert' is not used when reading stdin |--|, because there is no
1525 file to convert from. You will have to save the text in a file first.
1526 The expression must return zero or an empty string for success,
1527 non-zero for failure.
1528 The possible encoding names encountered are in 'encoding'.
1529 Additionally, names given in 'fileencodings' and 'fileencoding' are
1530 used.
1531 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1532 is done internally by Vim, 'charconvert' is not used for this.
1533 'charconvert' is also used to convert the viminfo file, if the 'c'
1534 flag is present in 'viminfo'. Also used for Unicode conversion.
1535 Example: >
1536 set charconvert=CharConvert()
1537 fun CharConvert()
1538 system("recode "
1539 \ . v:charconvert_from . ".." . v:charconvert_to
1540 \ . " <" . v:fname_in . " >" v:fname_out)
1541 return v:shell_error
1542 endfun
1543< The related Vim variables are:
1544 v:charconvert_from name of the current encoding
1545 v:charconvert_to name of the desired encoding
1546 v:fname_in name of the input file
1547 v:fname_out name of the output file
1548 Note that v:fname_in and v:fname_out will never be the same.
1549 Note that v:charconvert_from and v:charconvert_to may be different
1550 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1551 Encryption is not done by Vim when using 'charconvert'. If you want
1552 to encrypt the file after conversion, 'charconvert' should take care
1553 of this.
1554 This option cannot be set from a |modeline| or in the |sandbox|, for
1555 security reasons.
1556
1557 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1558'cindent' 'cin' boolean (default off)
1559 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 {not available when compiled without the |+cindent|
1561 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001562 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563 that trigger reindenting in insert mode and 'cinoptions' to set your
1564 preferred indent style.
1565 If 'indentexpr' is not empty, it overrules 'cindent'.
1566 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1567 the "=" operator indents using this algorithm rather than calling an
1568 external program.
1569 See |C-indenting|.
1570 When you don't like the way 'cindent' works, try the 'smartindent'
1571 option or 'indentexpr'.
1572 This option is not used when 'paste' is set.
1573 NOTE: This option is reset when 'compatible' is set.
1574
1575 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001576'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 {not available when compiled without the |+cindent|
1579 feature}
1580 A list of keys that, when typed in Insert mode, cause reindenting of
1581 the current line. Only used if 'cindent' is on and 'indentexpr' is
1582 empty.
1583 For the format of this option see |cinkeys-format|.
1584 See |C-indenting|.
1585
1586 *'cinoptions'* *'cino'*
1587'cinoptions' 'cino' string (default "")
1588 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 {not available when compiled without the |+cindent|
1590 feature}
1591 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1592 program. See |cinoptions-values| for the values of this option, and
1593 |C-indenting| for info on C indenting in general.
1594
1595
1596 *'cinwords'* *'cinw'*
1597'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1598 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 {not available when compiled without both the
1600 |+cindent| and the |+smartindent| features}
1601 These keywords start an extra indent in the next line when
1602 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1603 an appropriate place (inside {}).
1604 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1605 matter, include the keyword both the uppercase and lowercase:
1606 "if,If,IF".
1607
1608 *'clipboard'* *'cb'*
1609'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1610 for X-windows, "" otherwise)
1611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 {only in GUI versions or when the |+xterm_clipboard|
1613 feature is included}
1614 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001615 Note: if one of the items is "exclude:", then you can't add an item
1616 after that. Therefore do append an item with += but use ^= to
1617 prepend, e.g.: >
1618 set clipboard^=unnamed
1619< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001621 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 unnamed When included, Vim will use the clipboard register '*'
1623 for all yank, delete, change and put operations which
1624 would normally go to the unnamed register. When a
1625 register is explicitly specified, it will always be
1626 used regardless of whether "unnamed" is in 'clipboard'
1627 or not. The clipboard register can always be
1628 explicitly accessed using the "* notation. Also see
1629 |gui-clipboard|.
1630
Bram Moolenaar30b65812012-07-12 22:01:11 +02001631 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001632 unnamedplus A variant of the "unnamed" flag which uses the
1633 clipboard register '+' (|quoteplus|) instead of
1634 register '*' for all yank, delete, change and put
1635 operations which would normally go to the unnamed
1636 register. When "unnamed" is also included to the
1637 option, yank operations (but not delete, change or
1638 put) will additionally copy the text into register
1639 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001640 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001641 Availability can be checked with: >
1642 if has('unnamedplus')
1643<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001644 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 autoselect Works like the 'a' flag in 'guioptions': If present,
1646 then whenever Visual mode is started, or the Visual
1647 area extended, Vim tries to become the owner of the
1648 windowing system's global selection or put the
1649 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001650 register "*. See |'go-a'| and |quotestar| for details.
1651 When the GUI is active, the 'a' flag in 'guioptions'
1652 is used, when the GUI is not active, this "autoselect"
1653 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654 Also applies to the modeless selection.
1655
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001656 *clipboard-autoselectplus*
1657 autoselectplus Like "autoselect" but using the + register instead of
1658 the * register. Compare to the 'P' flag in
1659 'guioptions'.
1660
1661 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 autoselectml Like "autoselect", but for the modeless selection
1663 only. Compare to the 'A' flag in 'guioptions'.
1664
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001665 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001666 html When the clipboard contains HTML, use this when
1667 pasting. When putting text on the clipboard, mark it
1668 as HTML. This works to copy rendered HTML from
1669 Firefox, paste it as raw HTML in Vim, select the HTML
1670 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001671 You probably want to add this only temporarily,
1672 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001673 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001674
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001675 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 exclude:{pattern}
1677 Defines a pattern that is matched against the name of
1678 the terminal 'term'. If there is a match, no
1679 connection will be made to the X server. This is
1680 useful in this situation:
1681 - Running Vim in a console.
1682 - $DISPLAY is set to start applications on another
1683 display.
1684 - You do not want to connect to the X server in the
1685 console, but do want this in a terminal emulator.
1686 To never connect to the X server use: >
1687 exclude:.*
1688< This has the same effect as using the |-X| argument.
1689 Note that when there is no connection to the X server
1690 the window title won't be restored and the clipboard
1691 cannot be accessed.
1692 The value of 'magic' is ignored, {pattern} is
1693 interpreted as if 'magic' was on.
1694 The rest of the option value will be used for
1695 {pattern}, this must be the last entry.
1696
1697 *'cmdheight'* *'ch'*
1698'cmdheight' 'ch' number (default 1)
1699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 Number of screen lines to use for the command-line. Helps avoiding
1701 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001702 The value of this option is stored with the tab page, so that each tab
1703 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704
1705 *'cmdwinheight'* *'cwh'*
1706'cmdwinheight' 'cwh' number (default 7)
1707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 Number of screen lines to use for the command-line window. |cmdwin|
1709
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001710 *'colorcolumn'* *'cc'*
1711'colorcolumn' 'cc' string (default "")
1712 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001713 {not available when compiled without the |+syntax|
1714 feature}
1715 'colorcolumn' is a comma separated list of screen columns that are
1716 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1717 text. Will make screen redrawing slower.
1718 The screen column can be an absolute number, or a number preceded with
1719 '+' or '-', which is added to or subtracted from 'textwidth'. >
1720
1721 :set cc=+1 " highlight column after 'textwidth'
1722 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1723 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1724<
1725 When 'textwidth' is zero then the items with '-' and '+' are not used.
1726 A maximum of 256 columns are highlighted.
1727
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 *'columns'* *'co'* *E594*
1729'columns' 'co' number (default 80 or terminal width)
1730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001732 initialization and does not have to be set by hand. Also see
1733 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 When Vim is running in the GUI or in a resizable window, setting this
1735 option will cause the window size to be changed. When you only want
1736 to use the size for the GUI, put the command in your |gvimrc| file.
1737 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001738 number of columns of the display, the display may be messed up. For
1739 the GUI it is always possible and Vim limits the number of columns to
1740 what fits on the screen. You can use this command to get the widest
1741 window possible: >
1742 :set columns=9999
1743< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744
1745 *'comments'* *'com'* *E524* *E525*
1746'comments' 'com' string (default
1747 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1748 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 A comma separated list of strings that can start a comment line. See
1750 |format-comments|. See |option-backslash| about using backslashes to
1751 insert a space.
1752
1753 *'commentstring'* *'cms'* *E537*
1754'commentstring' 'cms' string (default "/*%s*/")
1755 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756 {not available when compiled without the |+folding|
1757 feature}
1758 A template for a comment. The "%s" in the value is replaced with the
1759 comment text. Currently only used to add markers for folding, see
1760 |fold-marker|.
1761
1762 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001763'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001764 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 This option has the effect of making Vim either more Vi-compatible, or
1767 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001768
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001770 other options are also changed as a side effect.
1771 NOTE: Setting or resetting this option can have a lot of unexpected
1772 effects: Mappings are interpreted in another way, undo behaves
1773 differently, etc. If you set this option in your vimrc file, you
1774 should probably put it at the very start.
1775
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 By default this option is on and the Vi defaults are used for the
1777 options. This default was chosen for those people who want to use Vim
1778 just like Vi, and don't even (want to) know about the 'compatible'
1779 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001780 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001781 this option is switched off, and all options that have not been
1782 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001783 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001784 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001785 happen for the system-wide vimrc or gvimrc file, nor for a file given
1786 with the |-u| argument). Also see |compatible-default| and
1787 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 You can also set this option with the "-C" argument, and reset it with
1789 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001790 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791
Bram Moolenaar214641f2017-03-05 17:04:09 +01001792 When this option is set, numerous other options are set to make Vim as
1793 Vi-compatible as possible. When this option is unset, various options
1794 are set to make Vim more useful. The table below lists all the
1795 options affected.
1796 The {?} column indicates when the options are affected:
1797 + Means that the option is set to the value given in {set value} when
1798 'compatible' is set.
1799 & Means that the option is set to the value given in {set value} when
1800 'compatible' is set AND is set to its Vim default value when
1801 'compatible' is unset.
1802 - Means the option is NOT changed when setting 'compatible' but IS
1803 set to its Vim default when 'compatible' is unset.
1804 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805
Bram Moolenaar036986f2017-03-16 17:41:02 +01001806 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001807
1808 'allowrevins' + off no CTRL-_ command
1809 'antialias' + off don't use antialiased fonts
1810 'arabic' + off reset arabic-related options
1811 'arabicshape' + on correct character shapes
1812 'backspace' + "" normal backspace
1813 'backup' + off no backup file
1814 'backupcopy' & Unix: "yes" backup file is a copy
1815 else: "auto" copy or rename backup file
1816 'balloonexpr' + "" text to show in evaluation balloon
1817 'breakindent' + off don't indent when wrapping lines
1818 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1819 'cindent' + off no C code indentation
1820 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1821 'copyindent' + off don't copy indent structure
1822 'cpoptions' & (all flags) Vi-compatible flags
1823 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001824 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001825 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001826 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001827 'cscopeverbose' + off see |cscopeverbose|
1828 'delcombine' + off unicode: delete whole char combination
1829 'digraph' + off no digraphs
1830 'esckeys' & off no <Esc>-keys in Insert mode
1831 'expandtab' + off tabs not expanded to spaces
1832 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001833 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001834 'formatexpr' + "" use 'formatprg' for auto-formatting
1835 'formatoptions' & "vt" Vi compatible formatting
1836 'gdefault' + off no default 'g' flag for ":s"
1837 'history' & 0 no commandline history
1838 'hkmap' + off no Hebrew keyboard mapping
1839 'hkmapp' + off no phonetic Hebrew keyboard mapping
1840 'hlsearch' + off no highlighting of search matches
1841 'incsearch' + off no incremental searching
1842 'indentexpr' + "" no indenting by expression
1843 'insertmode' + off do not start in Insert mode
1844 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001846 'joinspaces' + on insert 2 spaces after period
1847 'modeline' & off no modelines
1848 'more' & off no pauses in listings
1849 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1850 'numberwidth' & 8 min number of columns for line number
1851 'preserveindent'+ off don't preserve current indent structure
1852 when changing it
1853 'revins' + off no reverse insert
1854 'ruler' + off no ruler
1855 'scrolljump' + 1 no jump scroll
1856 'scrolloff' + 0 no scroll offset
1857 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1858 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001859 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001860 'showcmd' & off command characters not shown
1861 'showmode' & off current mode not shown
1862 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1863 'smartcase' + off no automatic ignore case switch
1864 'smartindent' + off no smart indentation
1865 'smarttab' + off no smart tab size
1866 'softtabstop' + 0 tabs are always 'tabstop' positions
1867 'startofline' + on goto startofline with some commands
1868 'tagcase' & "followic" 'ignorecase' when searching tags file
1869 'tagrelative' & off tag file names are not relative
1870 'termguicolors' + off don't use highlight-(guifg|guibg)
1871 'textauto' & off no automatic textmode detection
1872 'textwidth' + 0 no automatic line wrap
1873 'tildeop' + off tilde is not an operator
1874 'ttimeout' + off no terminal timeout
1875 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001876 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001877 'virtualedit' + "" cursor can only be placed on characters
1878 'whichwrap' & "" left-right movements don't wrap
1879 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001881 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882
1883 *'complete'* *'cpt'* *E535*
1884'complete' 'cpt' string (default: ".,w,b,u,t,i")
1885 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 This option specifies how keyword completion |ins-completion| works
1887 when CTRL-P or CTRL-N are used. It is also used for whole-line
1888 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1889 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001890 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 w scan buffers from other windows
1892 b scan other loaded buffers that are in the buffer list
1893 u scan the unloaded buffers that are in the buffer list
1894 U scan the buffers that are not in the buffer list
1895 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001896 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 k{dict} scan the file {dict}. Several "k" flags can be given,
1898 patterns are valid too. For example: >
1899 :set cpt=k/usr/dict/*,k~/spanish
1900< s scan the files given with the 'thesaurus' option
1901 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1902 are valid too.
1903 i scan current and included files
1904 d scan current and included files for defined name or macro
1905 |i_CTRL-X_CTRL-D|
1906 ] tag completion
1907 t same as "]"
1908
1909 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1910 not executed, this may lead to unexpected completions from some files
1911 (gzipped files for example). Unloaded buffers are not scanned for
1912 whole-line completion.
1913
1914 The default is ".,w,b,u,t,i", which means to scan:
1915 1. the current buffer
1916 2. buffers in other windows
1917 3. other loaded buffers
1918 4. unloaded buffers
1919 5. tags
1920 6. included files
1921
1922 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001923 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1924 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001926 *'completefunc'* *'cfu'*
1927'completefunc' 'cfu' string (default: empty)
1928 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001929 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001930 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001931 This option specifies a function to be used for Insert mode completion
1932 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001933 See |complete-functions| for an explanation of how the function is
1934 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001935 This option cannot be set from a |modeline| or in the |sandbox|, for
1936 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001937
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001938 *'completeslash'* *'csl'*
1939'completeslash' 'csl' string (default: "")
1940 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001941 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001942 When this option is set it overrules 'shellslash' for completion:
1943 - When this option is set to "slash", a forward slash is used for path
1944 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001945 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001946 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001947 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001948 - When this option is empty, same character is used as for
1949 'shellslash'.
1950 For Insert mode completion the buffer-local value is used. For
1951 command line completion the global value is used.
1952
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001953 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001954'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001955 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001956 A comma separated list of options for Insert mode completion
1957 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001958
1959 menu Use a popup menu to show the possible completions. The
1960 menu is only shown when there is more than one match and
1961 sufficient colors are available. |ins-completion-menu|
1962
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001963 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001964 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001965 match, e.g., what file it comes from.
1966
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001967 longest Only insert the longest common text of the matches. If
1968 the menu is displayed you can use CTRL-L to add more
1969 characters. Whether case is ignored depends on the kind
1970 of completion. For buffer text the 'ignorecase' option is
1971 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001972
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001973 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001974 completion in the preview window. Only works in
1975 combination with "menu" or "menuone".
1976
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001977 popup Show extra information about the currently selected
1978 completion in a popup window. Only works in combination
1979 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001980 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001981 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001982
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001983 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001984 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001985 |CompleteChanged| autocommand to fetch the info and call
1986 |popup_show()| once the popup has been filled.
1987 See the example at |complete-popuphidden|.
1988 {only works when compiled with the |+textprop| feature}
1989
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001990 noinsert Do not insert any text for a match until the user selects
1991 a match from the menu. Only works in combination with
1992 "menu" or "menuone". No effect if "longest" is present.
1993
1994 noselect Do not select a match in the menu, force the user to
1995 select one from the menu. Only works in combination with
1996 "menu" or "menuone".
1997
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001998
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001999 *'completepopup'* *'cpp'*
2000'completepopup' 'cpp' string (default empty)
2001 global
2002 {not available when compiled without the |+textprop|
2003 or |+quickfix| feature}
2004 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02002005 properties of the info popup when it is created. If an info popup
2006 window already exists it is closed, so that the option value is
2007 applied when it is created again.
2008 You can also use |popup_findinfo()| and then set properties for an
2009 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02002010
2011
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002012 *'concealcursor'* *'cocu'*
2013'concealcursor' 'cocu' string (default: "")
2014 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002015 {not available when compiled without the |+conceal|
2016 feature}
2017 Sets the modes in which text in the cursor line can also be concealed.
2018 When the current mode is listed then concealing happens just like in
2019 other lines.
2020 n Normal mode
2021 v Visual mode
2022 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002023 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002024
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002025 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002026 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002027 are moving around text is concealed, but when starting to insert text
2028 or selecting a Visual area the concealed text is displayed, so that
2029 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002030 Keep in mind that the cursor position is not always where it's
2031 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002032
2033
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002034 *'conceallevel'* *'cole'*
2035'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002036 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002037 {not available when compiled without the |+conceal|
2038 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002039 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2040 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002041
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002042 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002043 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002044 1 Each block of concealed text is replaced with one
2045 character. If the syntax item does not have a custom
2046 replacement character defined (see |:syn-cchar|) the
2047 character defined in 'listchars' is used (default is a
2048 space).
2049 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002050 2 Concealed text is completely hidden unless it has a
2051 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002052 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002053 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002054
Bram Moolenaara7781e02010-07-19 20:13:22 +02002055 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002056 edit and copy the text. This can be changed with the 'concealcursor'
2057 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002058
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2060'confirm' 'cf' boolean (default off)
2061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 When 'confirm' is on, certain operations that would normally
2063 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2064 instead raise a |dialog| asking if you wish to save the current
2065 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2066 If 'confirm' is off you can still activate confirmation for one
2067 command only (this is most useful in mappings) with the |:confirm|
2068 command.
2069 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2070
2071 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2072'conskey' 'consk' boolean (default off)
2073 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002074 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075
2076 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2077'copyindent' 'ci' boolean (default off)
2078 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 Copy the structure of the existing lines indent when autoindenting a
2080 new line. Normally the new indent is reconstructed by a series of
2081 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2082 in which case only spaces are used). Enabling this option makes the
2083 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002084 existing line. 'expandtab' has no effect on these characters, a Tab
2085 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002087 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 Also see 'preserveindent'.
2089
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002090 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091'cpoptions' 'cpo' string (Vim default: "aABceFs",
2092 Vi default: all flags)
2093 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002095 this indicates Vi-compatible behavior. This is used for things where
2096 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002097 'cpoptions' stands for "compatible-options".
2098 Commas can be added for readability.
2099 To avoid problems with flags that are added in the future, use the
2100 "+=" and "-=" feature of ":set" |add-option-flags|.
2101 NOTE: This option is set to the Vi default value when 'compatible' is
2102 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002103 NOTE: This option is set to the POSIX default value at startup when
2104 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002105 variable exists |posix|. This means Vim tries to behave like the
2106 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107
2108 contains behavior ~
2109 *cpo-a*
2110 a When included, a ":read" command with a file name
2111 argument will set the alternate file name for the
2112 current window.
2113 *cpo-A*
2114 A When included, a ":write" command with a file name
2115 argument will set the alternate file name for the
2116 current window.
2117 *cpo-b*
2118 b "\|" in a ":map" command is recognized as the end of
2119 the map command. The '\' is included in the mapping,
2120 the text after the '|' is interpreted as the next
2121 command. Use a CTRL-V instead of a backslash to
2122 include the '|' in the mapping. Applies to all
2123 mapping, abbreviation, menu and autocmd commands.
2124 See also |map_bar|.
2125 *cpo-B*
2126 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002127 abbreviations, user commands and the "to" part of the
2128 menu commands. Remove this flag to be able to use a
2129 backslash like a CTRL-V. For example, the command
2130 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 'B' included: "\^[" (^[ is a real <Esc>)
2132 'B' excluded: "<Esc>" (5 characters)
2133 ('<' excluded in both cases)
2134 *cpo-c*
2135 c Searching continues at the end of any match at the
2136 cursor position, but not further than the start of the
2137 next line. When not present searching continues
2138 one character from the cursor position. With 'c'
2139 "abababababab" only gets three matches when repeating
2140 "/abab", without 'c' there are five matches.
2141 *cpo-C*
2142 C Do not concatenate sourced lines that start with a
2143 backslash. See |line-continuation|.
2144 *cpo-d*
2145 d Using "./" in the 'tags' option doesn't mean to use
2146 the tags file relative to the current file, but the
2147 tags file in the current directory.
2148 *cpo-D*
2149 D Can't use CTRL-K to enter a digraph after Normal mode
2150 commands with a character argument, like |r|, |f| and
2151 |t|.
2152 *cpo-e*
2153 e When executing a register with ":@r", always add a
2154 <CR> to the last line, also when the register is not
2155 linewise. If this flag is not present, the register
2156 is not linewise and the last line does not end in a
2157 <CR>, then the last line is put on the command-line
2158 and can be edited before hitting <CR>.
2159 *cpo-E*
2160 E It is an error when using "y", "d", "c", "g~", "gu" or
2161 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002162 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 This makes "y0" fail in the first column.
2164 *cpo-f*
2165 f When included, a ":read" command with a file name
2166 argument will set the file name for the current buffer,
2167 if the current buffer doesn't have a file name yet.
2168 *cpo-F*
2169 F When included, a ":write" command with a file name
2170 argument will set the file name for the current
2171 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002172 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 *cpo-g*
2174 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002175 *cpo-H*
2176 H When using "I" on a line with only blanks, insert
2177 before the last blank. Without this flag insert after
2178 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 *cpo-i*
2180 i When included, interrupting the reading of a file will
2181 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002182 *cpo-I*
2183 I When moving the cursor up or down just after inserting
2184 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 *cpo-j*
2186 j When joining lines, only add two spaces after a '.',
2187 not after '!' or '?'. Also see 'joinspaces'.
2188 *cpo-J*
2189 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002190 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 white space.
2192 *cpo-k*
2193 k Disable the recognition of raw key codes in
2194 mappings, abbreviations, and the "to" part of menu
2195 commands. For example, if <Key> sends ^[OA (where ^[
2196 is <Esc>), the command ":map X ^[OA" results in X
2197 being mapped to:
2198 'k' included: "^[OA" (3 characters)
2199 'k' excluded: "<Key>" (one key code)
2200 Also see the '<' flag below.
2201 *cpo-K*
2202 K Don't wait for a key code to complete when it is
2203 halfway a mapping. This breaks mapping <F1><F1> when
2204 only part of the second <F1> has been read. It
2205 enables cancelling the mapping by typing <F1><Esc>.
2206 *cpo-l*
2207 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002208 literally, only "\]", "\^", "\-" and "\\" are special.
2209 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2211 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002212 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 *cpo-L*
2214 L When the 'list' option is set, 'wrapmargin',
2215 'textwidth', 'softtabstop' and Virtual Replace mode
2216 (see |gR|) count a <Tab> as two characters, instead of
2217 the normal behavior of a <Tab>.
2218 *cpo-m*
2219 m When included, a showmatch will always wait half a
2220 second. When not included, a showmatch will wait half
2221 a second or until a character is typed. |'showmatch'|
2222 *cpo-M*
2223 M When excluded, "%" matching will take backslashes into
2224 account. Thus in "( \( )" and "\( ( \)" the outer
2225 parenthesis match. When included "%" ignores
2226 backslashes, which is Vi compatible.
2227 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002228 n When included, the column used for 'number' and
2229 'relativenumber' will also be used for text of wrapped
2230 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 *cpo-o*
2232 o Line offset to search command is not remembered for
2233 next search.
2234 *cpo-O*
2235 O Don't complain if a file is being overwritten, even
2236 when it didn't exist when editing it. This is a
2237 protection against a file unexpectedly created by
2238 someone else. Vi didn't complain about this.
2239 *cpo-p*
2240 p Vi compatible Lisp indenting. When not present, a
2241 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002242 *cpo-P*
2243 P When included, a ":write" command that appends to a
2244 file will set the file name for the current buffer, if
2245 the current buffer doesn't have a file name yet and
2246 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002247 *cpo-q*
2248 q When joining multiple lines leave the cursor at the
2249 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 *cpo-r*
2251 r Redo ("." command) uses "/" to repeat a search
2252 command, instead of the actually used search string.
2253 *cpo-R*
2254 R Remove marks from filtered lines. Without this flag
2255 marks are kept like |:keepmarks| was used.
2256 *cpo-s*
2257 s Set buffer options when entering the buffer for the
2258 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002259 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 set when the buffer is created.
2261 *cpo-S*
2262 S Set buffer options always when entering a buffer
2263 (except 'readonly', 'fileformat', 'filetype' and
2264 'syntax'). This is the (most) Vi compatible setting.
2265 The options are set to the values in the current
2266 buffer. When you change an option and go to another
2267 buffer, the value is copied. Effectively makes the
2268 buffer options global to all buffers.
2269
2270 's' 'S' copy buffer options
2271 no no when buffer created
2272 yes no when buffer first entered (default)
2273 X yes each time when buffer entered (vi comp.)
2274 *cpo-t*
2275 t Search pattern for the tag command is remembered for
2276 "n" command. Otherwise Vim only puts the pattern in
2277 the history for search pattern, but doesn't change the
2278 last used search pattern.
2279 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002280 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 *cpo-v*
2282 v Backspaced characters remain visible on the screen in
2283 Insert mode. Without this flag the characters are
2284 erased from the screen right away. With this flag the
2285 screen newly typed text overwrites backspaced
2286 characters.
2287 *cpo-w*
2288 w When using "cw" on a blank character, only change one
2289 character and not all blanks until the start of the
2290 next word.
2291 *cpo-W*
2292 W Don't overwrite a readonly file. When omitted, ":w!"
2293 overwrites a readonly file, if possible.
2294 *cpo-x*
2295 x <Esc> on the command-line executes the command-line.
2296 The default in Vim is to abandon the command-line,
2297 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002298 *cpo-X*
2299 X When using a count with "R" the replaced text is
2300 deleted only once. Also when repeating "R" with "."
2301 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002303 y A yank command can be redone with ".". Think twice if
2304 you really want to use this, it may break some
2305 plugins, since most people expect "." to only repeat a
2306 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002307 *cpo-Z*
2308 Z When using "w!" while the 'readonly' option is set,
2309 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 *cpo-!*
2311 ! When redoing a filter command, use the last used
2312 external command, whatever it was. Otherwise the last
2313 used -filter- command is used.
2314 *cpo-$*
2315 $ When making a change to one line, don't redisplay the
2316 line, but put a '$' at the end of the changed text.
2317 The changed text will be overwritten when you type the
2318 new text. The line is redisplayed if you type any
2319 command that moves the cursor from the insertion
2320 point.
2321 *cpo-%*
2322 % Vi-compatible matching is done for the "%" command.
2323 Does not recognize "#if", "#endif", etc.
2324 Does not recognize "/*" and "*/".
2325 Parens inside single and double quotes are also
2326 counted, causing a string that contains a paren to
2327 disturb the matching. For example, in a line like
2328 "if (strcmp("foo(", s))" the first paren does not
2329 match the last one. When this flag is not included,
2330 parens inside single and double quotes are treated
2331 specially. When matching a paren outside of quotes,
2332 everything inside quotes is ignored. When matching a
2333 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002334 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002335 This flag is also used for other features, such as
2336 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002337 *cpo--*
2338 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002339 it would go above the first line or below the last
2340 line. Without it the cursor moves to the first or
2341 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002342 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002343 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002344 *cpo-+*
2345 + When included, a ":write file" command will reset the
2346 'modified' flag of the buffer, even though the buffer
2347 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002348 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 * Use ":*" in the same way as ":@". When not included,
2350 ":*" is an alias for ":'<,'>", select the Visual area.
2351 *cpo-<*
2352 < Disable the recognition of special key codes in |<>|
2353 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002354 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355 ":map X <Tab>" results in X being mapped to:
2356 '<' included: "<Tab>" (5 characters)
2357 '<' excluded: "^I" (^I is a real <Tab>)
2358 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002359 *cpo->*
2360 > When appending to a register, put a line break before
2361 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002362 *cpo-;*
2363 ; When using |,| or |;| to repeat the last |t| search
2364 and the cursor is right in front of the searched
2365 character, the cursor won't move. When not included,
2366 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002367 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002368
2369 POSIX flags. These are not included in the Vi default value, except
2370 when $VIM_POSIX was set on startup. |posix|
2371
2372 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002373 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002374 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002375 *cpo-&*
2376 & When ":preserve" was used keep the swap file when
2377 exiting normally while this buffer is still loaded.
2378 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002379 *cpo-\*
2380 \ Backslash in a [] range in a search pattern is taken
2381 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002382 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2383 '\' excluded: "/[ \-]" finds <Space> and '-'
2384 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002385 *cpo-/*
2386 / When "%" is used as the replacement string in a |:s|
2387 command, use the previous replacement string. |:s%|
2388 *cpo-{*
2389 { The |{| and |}| commands also stop at a "{" character
2390 at the start of a line.
2391 *cpo-.*
2392 . The ":chdir" and ":cd" commands fail if the current
2393 buffer is modified, unless ! is used. Vim doesn't
2394 need this, since it remembers the full path of an
2395 opened file.
2396 *cpo-bar*
2397 | The value of the $LINES and $COLUMNS environment
2398 variables overrule the terminal size values obtained
2399 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002400
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002402 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002403'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002404 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002405 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002406 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002407 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002408 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002409 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002410 blowfish Blowfish method. Medium strong encryption but it has
2411 an implementation flaw. Requires Vim 7.3 or later,
2412 files can NOT be read by Vim 7.2 and older. This adds
2413 a "seed" to the file, every time you write the file
2414 the encrypted bytes will be different.
2415 *blowfish2*
2416 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002417 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002418 and older. This adds a "seed" to the file, every time
2419 you write the file the encrypted bytes will be
2420 different. The whole undo file is encrypted, not just
2421 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002422 *E1193* *E1194* *E1195* *E1196*
2423 *E1197* *E1198* *E1199* *E1200* *E1201*
2424 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2425 Code. Medium strong till strong encryption.
2426 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002427 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002428 It adds a seed and a message authentication code (MAC)
2429 to the file. This needs at least a Vim 8.2.3022 to
2430 read the encrypted file.
2431 Encryption of swap files is not supported, therefore
2432 no swap file will be used when xchacha20 encryption is
2433 enabled.
2434 Encryption of undo files is not yet supported,
2435 therefore no undo file will currently be written.
2436 CURRENTLY EXPERIMENTAL: Files written with this method
2437 might have to be read back with the same version of
2438 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002439
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002440 You should use "blowfish2", also to re-encrypt older files.
2441
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002442 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002443 to the detected method of the file being read. Thus if you write it
2444 without changing 'cryptmethod' the same method will be used.
2445 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002446 explicitly write it, you don't get a warning unless there are other
2447 modifications. Also see |:X|.
2448
2449 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002450 the value "blowfish2". When setting the local value to an empty
2451 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002452
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002453 When a new encryption method is added in a later version of Vim, and
2454 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002455 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002456
2457
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 *'cscopepathcomp'* *'cspc'*
2459'cscopepathcomp' 'cspc' number (default 0)
2460 global
2461 {not available when compiled without the |+cscope|
2462 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463 Determines how many components of the path to show in a list of tags.
2464 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002465 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466
2467 *'cscopeprg'* *'csprg'*
2468'cscopeprg' 'csprg' string (default "cscope")
2469 global
2470 {not available when compiled without the |+cscope|
2471 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 Specifies the command to execute cscope. See |cscopeprg|.
2473 This option cannot be set from a |modeline| or in the |sandbox|, for
2474 security reasons.
2475
2476 *'cscopequickfix'* *'csqf'*
2477'cscopequickfix' 'csqf' string (default "")
2478 global
2479 {not available when compiled without the |+cscope|
2480 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 Specifies whether to use quickfix window to show cscope results.
2482 See |cscopequickfix|.
2483
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002484 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002485'cscoperelative' 'csre' boolean (default off)
2486 global
2487 {not available when compiled without the |+cscope|
2488 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002489 In the absence of a prefix (-P) for cscope. setting this option enables
2490 to use the basename of cscope.out path as the prefix.
2491 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002492 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002493
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2495'cscopetag' 'cst' boolean (default off)
2496 global
2497 {not available when compiled without the |+cscope|
2498 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499 Use cscope for tag commands. See |cscope-options|.
2500 NOTE: This option is reset when 'compatible' is set.
2501
2502 *'cscopetagorder'* *'csto'*
2503'cscopetagorder' 'csto' number (default 0)
2504 global
2505 {not available when compiled without the |+cscope|
2506 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 Determines the order in which ":cstag" performs a search. See
2508 |cscopetagorder|.
2509 NOTE: This option is set to 0 when 'compatible' is set.
2510
2511 *'cscopeverbose'* *'csverb'*
2512 *'nocscopeverbose'* *'nocsverb'*
2513'cscopeverbose' 'csverb' boolean (default off)
2514 global
2515 {not available when compiled without the |+cscope|
2516 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 Give messages when adding a cscope database. See |cscopeverbose|.
2518 NOTE: This option is reset when 'compatible' is set.
2519
Bram Moolenaar860cae12010-06-05 23:22:07 +02002520 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2521'cursorbind' 'crb' boolean (default off)
2522 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002523 When this option is set, as the cursor in the current
2524 window moves other cursorbound windows (windows that also have
2525 this option set) move their cursors to the corresponding line and
2526 column. This option is useful for viewing the
2527 differences between two versions of a file (see 'diff'); in diff mode,
2528 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002529 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002530
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002531
2532 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2533'cursorcolumn' 'cuc' boolean (default off)
2534 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002535 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002536 feature}
2537 Highlight the screen column of the cursor with CursorColumn
2538 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2539 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002540 If you only want the highlighting in the current window you can use
2541 these autocommands: >
2542 au WinLeave * set nocursorline nocursorcolumn
2543 au WinEnter * set cursorline cursorcolumn
2544<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002545
2546 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2547'cursorline' 'cul' boolean (default off)
2548 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002549 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002550 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002551 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2552 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002553 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002554 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002555
2556
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002557 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002558'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002559 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002560 {not available when compiled without the |+syntax|
2561 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002562 Comma separated list of settings for how 'cursorline' is displayed.
2563 Valid values:
2564 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002565 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002566 "screenline" Highlight only the screen line of the cursor with
2567 CursorLine |hl-CursorLine|.
2568 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002569 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002570
2571 Special value:
2572 "both" Alias for the values "line,number".
2573
2574 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002575
2576
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 *'debug'*
2578'debug' string (default "")
2579 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002580 These values can be used:
2581 msg Error messages that would otherwise be omitted will be given
2582 anyway.
2583 throw Error messages that would otherwise be omitted will be given
2584 anyway and also throw an exception and set |v:errmsg|.
2585 beep A message will be given when otherwise only a beep would be
2586 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002587 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002588 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2589 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590
2591 *'define'* *'def'*
2592'define' 'def' string (default "^\s*#\s*define")
2593 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002594 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 pattern, just like for the "/" command. This option is used for the
2596 commands like "[i" and "[d" |include-search|. The 'isident' option is
2597 used to recognize the defined name after the match:
2598 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2599 See |option-backslash| about inserting backslashes to include a space
2600 or backslash.
2601 The default value is for C programs. For C++ this value would be
2602 useful, to include const type declarations: >
2603 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002604< You can also use "\ze" just before the name and continue the pattern
2605 to check what is following. E.g. for Javascript, if a function is
2606 defined with "func_name = function(args)": >
2607 ^\s*\ze\i\+\s*=\s*function(
2608< If the function is defined with "func_name : function() {...": >
2609 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002611 To avoid that use `:let` with a single quote string: >
2612 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002613<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614
2615 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2616'delcombine' 'deco' boolean (default off)
2617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 If editing Unicode and this option is set, backspace and Normal mode
2619 "x" delete each combining character on its own. When it is off (the
2620 default) the character along with its combining characters are
2621 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002622 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623
2624 This is useful for Arabic, Hebrew and many other languages where one
2625 may have combining characters overtop of base characters, and want
2626 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002627 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628
2629 *'dictionary'* *'dict'*
2630'dictionary' 'dict' string (default "")
2631 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 List of file names, separated by commas, that are used to lookup words
2633 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2634 contain a list of words. This can be one word per line, or several
2635 words per line, separated by non-keyword characters (white space is
2636 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002637
2638 When this option is empty or an entry "spell" is present, and spell
2639 checking is enabled, words in the word lists for the currently active
2640 'spelllang' are used. See |spell|.
2641
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002642 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 after a comma are ignored, otherwise spaces are included in the file
2644 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002645 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 Where to find a list of words?
2647 - On FreeBSD, there is the file "/usr/share/dict/words".
2648 - In the Simtel archive, look in the "msdos/linguist" directory.
2649 - In "miscfiles" of the GNU collection.
2650 The use of |:set+=| and |:set-=| is preferred when adding or removing
2651 directories from the list. This avoids problems when a future version
2652 uses another default.
2653 Backticks cannot be used in this option for security reasons.
2654
2655 *'diff'* *'nodiff'*
2656'diff' boolean (default off)
2657 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 {not available when compiled without the |+diff|
2659 feature}
2660 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002661 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662
2663 *'dex'* *'diffexpr'*
2664'diffexpr' 'dex' string (default "")
2665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 {not available when compiled without the |+diff|
2667 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002668 Expression which is evaluated to obtain a diff file (either ed-style
2669 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 This option cannot be set from a |modeline| or in the |sandbox|, for
2671 security reasons.
2672
2673 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002674'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 {not available when compiled without the |+diff|
2677 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002678 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 All are optional. Items must be separated by a comma.
2680
2681 filler Show filler lines, to keep the text
2682 synchronized with a window that has inserted
2683 lines at the same position. Mostly useful
2684 when windows are side-by-side and 'scrollbind'
2685 is set.
2686
2687 context:{n} Use a context of {n} lines between a change
2688 and a fold that contains unchanged lines.
2689 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002690 When using zero the context is actually one,
2691 since folds require a line in between, also
2692 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 See |fold-diff|.
2694
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002695 iblank Ignore changes where lines are all blank. Adds
2696 the "-B" flag to the "diff" command if
2697 'diffexpr' is empty. Check the documentation
2698 of the "diff" command for what this does
2699 exactly.
2700 NOTE: the diff windows will get out of sync,
2701 because no differences between blank lines are
2702 taken into account.
2703
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 icase Ignore changes in case of text. "a" and "A"
2705 are considered the same. Adds the "-i" flag
2706 to the "diff" command if 'diffexpr' is empty.
2707
2708 iwhite Ignore changes in amount of white space. Adds
2709 the "-b" flag to the "diff" command if
2710 'diffexpr' is empty. Check the documentation
2711 of the "diff" command for what this does
2712 exactly. It should ignore adding trailing
2713 white space, but not leading white space.
2714
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002715 iwhiteall Ignore all white space changes. Adds
2716 the "-w" flag to the "diff" command if
2717 'diffexpr' is empty. Check the documentation
2718 of the "diff" command for what this does
2719 exactly.
2720
2721 iwhiteeol Ignore white space changes at end of line.
2722 Adds the "-Z" flag to the "diff" command if
2723 'diffexpr' is empty. Check the documentation
2724 of the "diff" command for what this does
2725 exactly.
2726
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002727 horizontal Start diff mode with horizontal splits (unless
2728 explicitly specified otherwise).
2729
2730 vertical Start diff mode with vertical splits (unless
2731 explicitly specified otherwise).
2732
Bram Moolenaarc8234772019-11-10 21:00:27 +01002733 closeoff When a window is closed where 'diff' is set
2734 and there is only one window remaining in the
2735 same tab page with 'diff' set, execute
2736 `:diffoff` in that window. This undoes a
2737 `:diffsplit` command.
2738
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002739 hiddenoff Do not use diff mode for a buffer when it
2740 becomes hidden.
2741
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002742 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2743 starting diff mode. Without this 2 is used.
2744
Bram Moolenaar4223d432021-02-10 13:18:17 +01002745 followwrap Follow the 'wrap' option and leave as it is.
2746
Bram Moolenaare828b762018-09-10 17:51:58 +02002747 internal Use the internal diff library. This is
2748 ignored when 'diffexpr' is set. *E960*
2749 When running out of memory when writing a
2750 buffer this item will be ignored for diffs
2751 involving that buffer. Set the 'verbose'
2752 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753
Bram Moolenaare828b762018-09-10 17:51:58 +02002754 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002755 Use the indent heuristic for the internal
2756 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002757
2758 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002759 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002760 algorithms are:
2761 myers the default algorithm
2762 minimal spend extra time to generate the
2763 smallest possible diff
2764 patience patience diff algorithm
2765 histogram histogram diff algorithm
2766
2767 Examples: >
2768 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002770 :set diffopt=internal,filler,foldcolumn:3
2771 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772<
2773 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2774'digraph' 'dg' boolean (default off)
2775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 {not available when compiled without the |+digraphs|
2777 feature}
2778 Enable the entering of digraphs in Insert mode with {char1} <BS>
2779 {char2}. See |digraphs|.
2780 NOTE: This option is reset when 'compatible' is set.
2781
2782 *'directory'* *'dir'*
2783'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002784 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 for Unix: ".,~/tmp,/var/tmp,/tmp")
2786 global
2787 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002788 Recommended value: ".,~/vimswap//" - this will put the swap file next
2789 to the edited file if possible, and in your personal swap directory
2790 otherwise. Make sure "~/vimswap//" is only readable for you.
2791
2792 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 - The swap file will be created in the first directory where this is
2794 possible.
2795 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002796 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 - A directory "." means to put the swap file in the same directory as
2798 the edited file. On Unix, a dot is prepended to the file name, so
2799 it doesn't show in a directory listing. On MS-Windows the "hidden"
2800 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002801 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2802 the swap file relative to where the edited file is. The leading "."
2803 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002804 - For Unix and Win32, if a directory ends in two path separators "//",
2805 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002806 with all path separators replaced by percent '%' signs (including
2807 the colon following the drive letter on Win32). This will ensure
2808 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002809 On Win32, it is also possible to end with "\\". However, When a
2810 separating comma is following, you must use "//", since "\\" will
2811 include the comma in the file name. Therefore it is recommended to
2812 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 - Spaces after the comma are ignored, other spaces are considered part
2814 of the directory name. To have a space at the start of a directory
2815 name, precede it with a backslash.
2816 - To include a comma in a directory name precede it with a backslash.
2817 - A directory name may end in an ':' or '/'.
2818 - Environment variables are expanded |:set_env|.
2819 - Careful with '\' characters, type one before a space, type two to
2820 get one in the option (see |option-backslash|), for example: >
2821 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2822< - For backwards compatibility with Vim version 3.0 a '>' at the start
2823 of the option is removed.
2824 Using "." first in the list is recommended. This means that editing
2825 the same file twice will result in a warning. Using "/tmp" on Unix is
2826 discouraged: When the system crashes you lose the swap file.
2827 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002828 choice than "/tmp". But others on the computer may be able to see the
2829 files, and it can contain a lot of files, your swap files get lost in
2830 the crowd. That is why a "tmp" directory in your home directory is
2831 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832 The use of |:set+=| and |:set-=| is preferred when adding or removing
2833 directories from the list. This avoids problems when a future version
2834 uses another default.
2835 This option cannot be set from a |modeline| or in the |sandbox|, for
2836 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837
2838 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002839'display' 'dy' string (default "", set to "truncate" in
2840 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 Change the way text is displayed. This is comma separated list of
2843 flags:
2844 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002845 in a window will be displayed. "@@@" is put in the
2846 last columns of the last screen line to indicate the
2847 rest of the line is not displayed.
2848 truncate Like "lastline", but "@@@" is displayed in the first
2849 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 uhex Show unprintable characters hexadecimal as <xx>
2851 instead of using ^C and ~C.
2852
Bram Moolenaard0796902016-09-16 20:02:31 +02002853 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002854 doesn't fit is replaced with "@" lines.
2855
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 *'eadirection'* *'ead'*
2857'eadirection' 'ead' string (default "both")
2858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 Tells when the 'equalalways' option applies:
2860 ver vertically, width of windows is not affected
2861 hor horizontally, height of windows is not affected
2862 both width and height of windows is affected
2863
2864 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2865'edcompatible' 'ed' boolean (default off)
2866 global
2867 Makes the 'g' and 'c' flags of the ":substitute" command to be
2868 toggled each time the flag is given. See |complex-change|. See
2869 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002870 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002871 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872
Bram Moolenaar03413f42016-04-12 21:07:15 +02002873 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002874'emoji' 'emo' boolean (default: on)
2875 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002876 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002877 This excludes "text emoji" characters, which are normally displayed as
2878 single width. Unfortunately there is no good specification for this
2879 and it has been determined on trial-and-error basis. Use the
2880 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002881
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002883'encoding' 'enc' string (default for MS-Windows: "utf-8",
2884 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 Sets the character encoding used inside Vim. It applies to text in
2887 the buffers, registers, Strings in expressions, text stored in the
2888 viminfo file, etc. It sets the kind of characters which Vim can work
2889 with. See |encoding-names| for the possible values.
2890
2891 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002892 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002894 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895
Bram Moolenaar865242e2010-07-14 21:12:05 +02002896 This option cannot be set from a |modeline|. It would most likely
2897 corrupt the text.
2898
Bram Moolenaar3df01732017-02-17 22:47:16 +01002899 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2900 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 'encoding', "utf-8" is the natural choice for the environment and
2902 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002903 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 versions, and to avoid changing the encoding of newly created files
2905 without your knowledge (in case 'fileencodings' is empty).
2906
2907 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002908 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 iconv() or as specified with 'charconvert'.
2910
Bram Moolenaar207f0092020-08-30 17:20:20 +02002911 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002912 can use: >
2913 if has("multi_byte_encoding")
2914<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 Normally 'encoding' will be equal to your current locale. This will
2916 be the default if Vim recognizes your environment settings. If
2917 'encoding' is not set to the current locale, 'termencoding' must be
2918 set to convert typed and displayed text. See |encoding-table|.
2919
2920 When you set this option, it fires the |EncodingChanged| autocommand
2921 event so that you can set up fonts if necessary.
2922
2923 When the option is set, the value is converted to lowercase. Thus
2924 you can set it with uppercase values too. Underscores are translated
2925 to '-' signs.
2926 When the encoding is recognized, it is changed to the standard name.
2927 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2928 "iso-8859-2" and "utf8" becomes "utf-8".
2929
2930 Note: "latin1" is also used when the encoding could not be detected.
2931 This only works when editing files in the same encoding! When the
2932 actual character set is not latin1, make sure 'fileencoding' and
2933 'fileencodings' are empty. When conversion is needed, switch to using
2934 utf-8.
2935
2936 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2937 You don't notice this while editing, but it does matter for the
2938 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2939 setting 'encoding' to one of these values instead of utf-8 only has
2940 effect for encoding used for files when 'fileencoding' is empty.
2941
Bram Moolenaar661b1822005-07-28 22:36:45 +00002942 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2943 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944
2945 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2946'endofline' 'eol' boolean (default on)
2947 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002949 is on, or 'fixeol' option is off, no <EOL> will be written for the
2950 last line in the file. This option is automatically set or reset when
2951 starting to edit a new file, depending on whether file has an <EOL>
2952 for the last line in the file. Normally you don't have to set or
2953 reset this option.
2954 When 'binary' is off and 'fixeol' is on the value is not used when
2955 writing the file. When 'binary' is on or 'fixeol' is off it is used
2956 to remember the presence of a <EOL> for the last line in the file, so
2957 that when you write the file the situation from the original file can
2958 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959
2960 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2961'equalalways' 'ea' boolean (default on)
2962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002964 splitting or closing a window. This also happens the moment the
2965 option is switched on. When off, splitting a window will reduce the
2966 size of the current window and leave the other windows the same. When
2967 closing a window the extra lines are given to the window next to it
2968 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 When mixing vertically and horizontally split windows, a minimal size
2970 is computed and some windows may be larger if there is room. The
2971 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002972 Changing the height and width of a window can be avoided by setting
2973 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002974 If a window size is specified when creating a new window sizes are
2975 currently not equalized (it's complicated, but may be implemented in
2976 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977
2978 *'equalprg'* *'ep'*
2979'equalprg' 'ep' string (default "")
2980 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002982 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002983 or 'indentexpr'. When Vim was compiled without internal formatting,
2984 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002985 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 about including spaces and backslashes.
2987 This option cannot be set from a |modeline| or in the |sandbox|, for
2988 security reasons.
2989
2990 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2991'errorbells' 'eb' boolean (default off)
2992 global
2993 Ring the bell (beep or screen flash) for error messages. This only
2994 makes a difference for error messages, the bell will be used always
2995 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002996 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002997 screen flash or do nothing. See 'belloff' to finetune when to ring the
2998 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999
3000 *'errorfile'* *'ef'*
3001'errorfile' 'ef' string (Amiga default: "AztecC.Err",
3002 others: "errors.err")
3003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 {not available when compiled without the |+quickfix|
3005 feature}
3006 Name of the errorfile for the QuickFix mode (see |:cf|).
3007 When the "-q" command-line argument is used, 'errorfile' is set to the
3008 following argument. See |-q|.
3009 NOT used for the ":make" command. See 'makeef' for that.
3010 Environment variables are expanded |:set_env|.
3011 See |option-backslash| about including spaces and backslashes.
3012 This option cannot be set from a |modeline| or in the |sandbox|, for
3013 security reasons.
3014
3015 *'errorformat'* *'efm'*
3016'errorformat' 'efm' string (default is very long)
3017 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 {not available when compiled without the |+quickfix|
3019 feature}
3020 Scanf-like description of the format for the lines in the error file
3021 (see |errorformat|).
3022
3023 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3024'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 Function keys that start with an <Esc> are recognized in Insert
3027 mode. When this option is off, the cursor and function keys cannot be
3028 used in Insert mode if they start with an <Esc>. The advantage of
3029 this is that the single <Esc> is recognized immediately, instead of
3030 after one second. Instead of resetting this option, you might want to
3031 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3032 when 'esckeys' is off, you can still map anything, but the cursor keys
3033 won't work by default.
3034 NOTE: This option is set to the Vi default value when 'compatible' is
3035 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003036 NOTE: when this option is off then the |modifyOtherKeys| functionality
3037 is disabled while in Insert mode to avoid ending Insert mode with any
3038 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039
3040 *'eventignore'* *'ei'*
3041'eventignore' 'ei' string (default "")
3042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003044 When set to "all" or when "all" is one of the items, all autocommand
3045 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 Otherwise this is a comma separated list of event names. Example: >
3047 :set ei=WinEnter,WinLeave
3048<
3049 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3050'expandtab' 'et' boolean (default off)
3051 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003053 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3055 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003056 This option is reset when the 'paste' option is set and restored when
3057 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 NOTE: This option is reset when 'compatible' is set.
3059
3060 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3061'exrc' 'ex' boolean (default off)
3062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003064 directory.
3065
3066 Setting this option is a potential security leak. E.g., consider
3067 unpacking a package or fetching files from github, a .vimrc in there
3068 might be a trojan horse. BETTER NOT SET THIS OPTION!
3069 Instead, define an autocommand in your .vimrc to set options for a
3070 matching directory.
3071
3072 If you do switch this option on you should also consider setting the
3073 'secure' option (see |initialization|).
3074 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 This option cannot be set from a |modeline| or in the |sandbox|, for
3076 security reasons.
3077
3078 *'fileencoding'* *'fenc'* *E213*
3079'fileencoding' 'fenc' string (default: "")
3080 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003082
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003084 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 When 'fileencoding' is empty, the same value as 'encoding' will be
3086 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003087 No error will be given when the value is set, only when it is used,
3088 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003089 Conversion will also be done when 'encoding' and 'fileencoding' are
3090 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3091 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003093 'encoding' is "utf-8" or another Unicode encoding, conversion
3094 is most likely done in a way that the reverse conversion
3095 results in the same text. When 'encoding' is not "utf-8" some
3096 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003097
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 See 'encoding' for the possible values. Additionally, values may be
3099 specified that can be handled by the converter, see
3100 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003101
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 When reading a file 'fileencoding' will be set from 'fileencodings'.
3103 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003104 'fileencoding', use the |++enc| argument. One exception: when
3105 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003106 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003107
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3109 When the option is set, the value is converted to lowercase. Thus
3110 you can set it with uppercase values too. '_' characters are
3111 replaced with '-'. If a name is recognized from the list for
3112 'encoding', it is replaced by the standard name. For example
3113 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003114
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 When this option is set, after starting to edit a file, the 'modified'
3116 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003117
3118 Keep in mind that changing 'fenc' from a modeline happens
3119 AFTER the text has been read, thus it applies to when the file will be
3120 written. If you do set 'fenc' in a modeline, you might want to set
3121 'nomodified' to avoid not being able to ":q".
3122
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 This option can not be changed when 'modifiable' is off.
3124
3125 *'fe'*
3126 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003127 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 old short name was 'fe', which is no longer used.
3129
3130 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003131'fileencodings' 'fencs' string (default: "ucs-bom",
3132 "ucs-bom,utf-8,default,latin1" when
3133 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 This is a list of character encodings considered when starting to edit
3136 an existing file. When a file is read, Vim tries to use the first
3137 mentioned character encoding. If an error is detected, the next one
3138 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003139 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 an empty string, which means the value of 'encoding' is used.
3141 WARNING: Conversion can cause loss of information! When
3142 'encoding' is "utf-8" (or one of the other Unicode variants)
3143 conversion is most likely done in a way that the reverse
3144 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003145 "utf-8" some non-ASCII characters may be lost! You can use
3146 the |++bad| argument to specify what is done with characters
3147 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 For an empty file or a file with only ASCII characters most encodings
3149 will work and the first entry of 'fileencodings' will be used (except
3150 "ucs-bom", which requires the BOM to be present). If you prefer
3151 another encoding use an BufReadPost autocommand event to test if your
3152 preferred encoding is to be used. Example: >
3153 au BufReadPost * if search('\S', 'w') == 0 |
3154 \ set fenc=iso-2022-jp | endif
3155< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3156 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003157 When the |++enc| argument is used then the value of 'fileencodings' is
3158 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003159 Note that 'fileencodings' is not used for a new file, the global value
3160 of 'fileencoding' is used instead. You can set it with: >
3161 :setglobal fenc=iso-8859-2
3162< This means that a non-existing file may get a different encoding than
3163 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 The special value "ucs-bom" can be used to check for a Unicode BOM
3165 (Byte Order Mark) at the start of the file. It must not be preceded
3166 by "utf-8" or another Unicode encoding for this to work properly.
3167 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3168 because Vim cannot detect an error, thus the encoding is always
3169 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003170 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003171 environment. On MS-Windows this is the system encoding. Otherwise
3172 this is the default value for 'encoding'. It is useful when
3173 'encoding' is set to "utf-8" and your environment uses a non-latin1
3174 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003175 When 'encoding' is "utf-8" and a file contains an illegal byte
3176 sequence it won't be recognized as UTF-8. You can use the |8g8|
3177 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 WRONG VALUES: WHAT'S WRONG:
3179 latin1,utf-8 "latin1" will always be used
3180 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3181 file
3182 cp1250,latin1 "cp1250" will always be used
3183 If 'fileencodings' is empty, 'fileencoding' is not modified.
3184 See 'fileencoding' for the possible values.
3185 Setting this option does not have an effect until the next time a file
3186 is read.
3187
3188 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003189'fileformat' 'ff' string (MS-Windows default: "dos",
3190 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 This gives the <EOL> of the current buffer, which is used for
3193 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003194 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 unix <NL>
3196 mac <CR>
3197 When "dos" is used, CTRL-Z at the end of a file is ignored.
3198 See |file-formats| and |file-read|.
3199 For the character encoding of the file see 'fileencoding'.
3200 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003201 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 This option is set automatically when starting to edit a file and
3203 'fileformats' is not empty and 'binary' is off.
3204 When this option is set, after starting to edit a file, the 'modified'
3205 option is set, because the file would be different when written.
3206 This option can not be changed when 'modifiable' is off.
3207 For backwards compatibility: When this option is set to "dos",
3208 'textmode' is set, otherwise 'textmode' is reset.
3209
3210 *'fileformats'* *'ffs'*
3211'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003212 Vim+Vi MS-Windows: "dos,unix",
3213 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 Vi Cygwin: "unix,dos",
3215 Vi others: "")
3216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 This gives the end-of-line (<EOL>) formats that will be tried when
3218 starting to edit a new buffer and when reading a file into an existing
3219 buffer:
3220 - When empty, the format defined with 'fileformat' will be used
3221 always. It is not set automatically.
3222 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003223 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 'fileformats' name will be used when a file is read into an existing
3225 buffer, no matter what 'fileformat' for that buffer is set to.
3226 - When more than one name is present, separated by commas, automatic
3227 <EOL> detection will be done when reading a file. When starting to
3228 edit a file, a check is done for the <EOL>:
3229 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3230 'fileformat' is set to "dos".
3231 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003232 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003234 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3235 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003236 This means that "mac" is only chosen when:
3237 "unix" is not present or no <NL> is found in the file, and
3238 "dos" is not present or no <CR><NL> is found in the file.
3239 Except: if "unix" was chosen, but there is a <CR> before
3240 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003241 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 4. If 'fileformat' is still not set, the first name from
3243 'fileformats' is used.
3244 When reading a file into an existing buffer, the same is done, but
3245 this happens like 'fileformat' has been set appropriately for that
3246 file only, the option is not changed.
3247 When 'binary' is set, the value of 'fileformats' is not used.
3248
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003249 When Vim starts up with an empty buffer the first item is used. You
3250 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003251
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3253 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3254 done:
3255 - When 'fileformats' is empty, there is no automatic detection. Dos
3256 format will be used.
3257 - When 'fileformats' is set to one or more names, automatic detection
3258 is done. This is based on the first <NL> in the file: If there is a
3259 <CR> in front of it, Dos format is used, otherwise Unix format is
3260 used.
3261 Also see |file-formats|.
3262 For backwards compatibility: When this option is set to an empty
3263 string or one format (no comma is included), 'textauto' is reset,
3264 otherwise 'textauto' is set.
3265 NOTE: This option is set to the Vi default value when 'compatible' is
3266 set and to the Vim default value when 'compatible' is reset.
3267
Bram Moolenaarbf884932013-04-05 22:26:15 +02003268 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3269'fileignorecase' 'fic' boolean (default on for systems where case in file
3270 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003271 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003272 When set case is ignored when using file names and directories.
3273 See 'wildignorecase' for only ignoring case when doing completion.
3274
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 *'filetype'* *'ft'*
3276'filetype' 'ft' string (default: "")
3277 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 When this option is set, the FileType autocommand event is triggered.
3279 All autocommands that match with the value of this option will be
3280 executed. Thus the value of 'filetype' is used in place of the file
3281 name.
3282 Otherwise this option does not always reflect the current file type.
3283 This option is normally set when the file type is detected. To enable
3284 this use the ":filetype on" command. |:filetype|
3285 Setting this option to a different value is most useful in a modeline,
3286 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003287 Example, for in an IDL file:
3288 /* vim: set filetype=idl : */ ~
3289 |FileType| |filetypes|
3290 When a dot appears in the value then this separates two filetype
3291 names. Example:
3292 /* vim: set filetype=c.doxygen : */ ~
3293 This will use the "c" filetype first, then the "doxygen" filetype.
3294 This works both for filetype plugins and for syntax files. More than
3295 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 This option is not copied to another buffer, independent of the 's' or
3297 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003298 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299
3300 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003301'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003303 {not available when compiled without the |+folding|
3304 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 Characters to fill the statuslines and vertical separators.
3306 It is a comma separated list of items:
3307
3308 item default Used for ~
3309 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003310 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 vert:c '|' vertical separators |:vsplit|
3312 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003313 foldopen:c '-' mark the beginning of a fold
3314 foldclose:c '+' show a closed fold
3315 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003317 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003319 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003320 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 otherwise.
3322
3323 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003324 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325< This is similar to the default, except that these characters will also
3326 be used when there is highlighting.
3327
Bram Moolenaar008bff92021-03-04 21:55:58 +01003328 For "stl" and "stlnc" single-byte and multibyte characters are
3329 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003330
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 The highlighting used for these items:
3332 item highlight group ~
3333 stl:c StatusLine |hl-StatusLine|
3334 stlnc:c StatusLineNC |hl-StatusLineNC|
3335 vert:c VertSplit |hl-VertSplit|
3336 fold:c Folded |hl-Folded|
3337 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003338 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003340 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3341'fixendofline' 'fixeol' boolean (default on)
3342 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003343 When writing a file and this option is on, <EOL> at the end of file
3344 will be restored if missing. Turn this option off if you want to
3345 preserve the situation from the original file.
3346 When the 'binary' option is set the value of this option doesn't
3347 matter.
3348 See the 'endofline' option.
3349
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003351'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 {only available when compiled with the |+rightleft|
3354 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003355 This option was for using Farsi, which has been removed. See
3356 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357
3358 *'foldclose'* *'fcl'*
3359'foldclose' 'fcl' string (default "")
3360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 {not available when compiled without the |+folding|
3362 feature}
3363 When set to "all", a fold is closed when the cursor isn't in it and
3364 its level is higher than 'foldlevel'. Useful if you want folds to
3365 automatically close when moving out of them.
3366
3367 *'foldcolumn'* *'fdc'*
3368'foldcolumn' 'fdc' number (default 0)
3369 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 {not available when compiled without the |+folding|
3371 feature}
3372 When non-zero, a column with the specified width is shown at the side
3373 of the window which indicates open and closed folds. The maximum
3374 value is 12.
3375 See |folding|.
3376
3377 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3378'foldenable' 'fen' boolean (default on)
3379 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 {not available when compiled without the |+folding|
3381 feature}
3382 When off, all folds are open. This option can be used to quickly
3383 switch between showing all text unfolded and viewing the text with
3384 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003385 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 'foldenable' is off.
3387 This option is set by commands that create a new fold or close a fold.
3388 See |folding|.
3389
3390 *'foldexpr'* *'fde'*
3391'foldexpr' 'fde' string (default: "0")
3392 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003394 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003396 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003397
Bram Moolenaar30b65812012-07-12 22:01:11 +02003398 The expression will be evaluated in the |sandbox| if set from a
3399 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003400 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003401 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003402
3403 It is not allowed to change text or jump to another window while
3404 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405
3406 *'foldignore'* *'fdi'*
3407'foldignore' 'fdi' string (default: "#")
3408 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 {not available when compiled without the |+folding|
3410 feature}
3411 Used only when 'foldmethod' is "indent". Lines starting with
3412 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003413 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 The default "#" works well for C programs. See |fold-indent|.
3415
3416 *'foldlevel'* *'fdl'*
3417'foldlevel' 'fdl' number (default: 0)
3418 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 {not available when compiled without the |+folding|
3420 feature}
3421 Sets the fold level: Folds with a higher level will be closed.
3422 Setting this option to zero will close all folds. Higher numbers will
3423 close fewer folds.
3424 This option is set by commands like |zm|, |zM| and |zR|.
3425 See |fold-foldlevel|.
3426
3427 *'foldlevelstart'* *'fdls'*
3428'foldlevelstart' 'fdls' number (default: -1)
3429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 {not available when compiled without the |+folding|
3431 feature}
3432 Sets 'foldlevel' when starting to edit another buffer in a window.
3433 Useful to always start editing with all folds closed (value zero),
3434 some folds closed (one) or no folds closed (99).
3435 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003436 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 ignores this option and closes all folds.
3438 It is also done before BufReadPre autocommands, to allow an autocmd to
3439 overrule the 'foldlevel' value for specific files.
3440 When the value is negative, it is not used.
3441
3442 *'foldmarker'* *'fmr'* *E536*
3443'foldmarker' 'fmr' string (default: "{{{,}}}")
3444 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 {not available when compiled without the |+folding|
3446 feature}
3447 The start and end marker used when 'foldmethod' is "marker". There
3448 must be one comma, which separates the start and end marker. The
3449 marker is a literal string (a regular expression would be too slow).
3450 See |fold-marker|.
3451
3452 *'foldmethod'* *'fdm'*
3453'foldmethod' 'fdm' string (default: "manual")
3454 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 {not available when compiled without the |+folding|
3456 feature}
3457 The kind of folding used for the current window. Possible values:
3458 |fold-manual| manual Folds are created manually.
3459 |fold-indent| indent Lines with equal indent form a fold.
3460 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3461 |fold-marker| marker Markers are used to specify folds.
3462 |fold-syntax| syntax Syntax highlighting items specify folds.
3463 |fold-diff| diff Fold text that is not changed.
3464
3465 *'foldminlines'* *'fml'*
3466'foldminlines' 'fml' number (default: 1)
3467 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 {not available when compiled without the |+folding|
3469 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003470 Sets the number of screen lines above which a fold can be displayed
3471 closed. Also for manually closed folds. With the default value of
3472 one a fold can only be closed if it takes up two or more screen lines.
3473 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003474 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 "zc" to close a fold, which is displayed open because it's smaller
3476 than 'foldminlines', a following "zc" may close a containing fold.
3477
3478 *'foldnestmax'* *'fdn'*
3479'foldnestmax' 'fdn' number (default: 20)
3480 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 {not available when compiled without the |+folding|
3482 feature}
3483 Sets the maximum nesting of folds for the "indent" and "syntax"
3484 methods. This avoids that too many folds will be created. Using more
3485 than 20 doesn't work, because the internal limit is 20.
3486
3487 *'foldopen'* *'fdo'*
3488'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3489 search,tag,undo")
3490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 {not available when compiled without the |+folding|
3492 feature}
3493 Specifies for which type of commands folds will be opened, if the
3494 command moves the cursor into a closed fold. It is a comma separated
3495 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003496 NOTE: When the command is part of a mapping this option is not used.
3497 Add the |zv| command to the mapping to get the same effect.
3498 (rationale: the mapping may want to control opening folds itself)
3499
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 item commands ~
3501 all any
3502 block "(", "{", "[[", "[{", etc.
3503 hor horizontal movements: "l", "w", "fx", etc.
3504 insert any command in Insert mode
3505 jump far jumps: "G", "gg", etc.
3506 mark jumping to a mark: "'m", CTRL-O, etc.
3507 percent "%"
3508 quickfix ":cn", ":crew", ":make", etc.
3509 search search for a pattern: "/", "n", "*", "gd", etc.
3510 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003511 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 tag jumping to a tag: ":ta", CTRL-T, etc.
3513 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 When a movement command is used for an operator (e.g., "dl" or "y%")
3515 this option is not used. This means the operator will include the
3516 whole closed fold.
3517 Note that vertical movements are not here, because it would make it
3518 very difficult to move onto a closed fold.
3519 In insert mode the folds containing the cursor will always be open
3520 when text is inserted.
3521 To close folds you can re-apply 'foldlevel' with the |zx| command or
3522 set the 'foldclose' option to "all".
3523
3524 *'foldtext'* *'fdt'*
3525'foldtext' 'fdt' string (default: "foldtext()")
3526 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 {not available when compiled without the |+folding|
3528 feature}
3529 An expression which is used to specify the text displayed for a closed
3530 fold. See |fold-foldtext|.
3531
Bram Moolenaar30b65812012-07-12 22:01:11 +02003532 The expression will be evaluated in the |sandbox| if set from a
3533 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003534 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003535
3536 It is not allowed to change text or jump to another window while
3537 evaluating 'foldtext' |textlock|.
3538
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003539 *'formatexpr'* *'fex'*
3540'formatexpr' 'fex' string (default "")
3541 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003542 {not available when compiled without the |+eval|
3543 feature}
3544 Expression which is evaluated to format a range of lines for the |gq|
3545 operator or automatic formatting (see 'formatoptions'). When this
3546 option is empty 'formatprg' is used.
3547
3548 The |v:lnum| variable holds the first line to be formatted.
3549 The |v:count| variable holds the number of lines to be formatted.
3550 The |v:char| variable holds the character that is going to be
3551 inserted if the expression is being evaluated due to
3552 automatic formatting. This can be empty. Don't insert
3553 it yet!
3554
3555 Example: >
3556 :set formatexpr=mylang#Format()
3557< This will invoke the mylang#Format() function in the
3558 autoload/mylang.vim file in 'runtimepath'. |autoload|
3559
3560 The expression is also evaluated when 'textwidth' is set and adding
3561 text beyond that limit. This happens under the same conditions as
3562 when internal formatting is used. Make sure the cursor is kept in the
3563 same spot relative to the text then! The |mode()| function will
3564 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003565
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003566 When the expression evaluates to non-zero Vim will fall back to using
3567 the internal format mechanism.
3568
3569 The expression will be evaluated in the |sandbox| when set from a
3570 modeline, see |sandbox-option|. That stops the option from working,
3571 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003572 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003573 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003574
Bram Moolenaar86b68352004-12-27 21:59:20 +00003575 *'formatlistpat'* *'flp'*
3576'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3577 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003578 A pattern that is used to recognize a list header. This is used for
3579 the "n" flag in 'formatoptions'.
3580 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003581 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003582 while still checking more characters. There must be a character
3583 following the pattern, when it matches the whole line it is handled
3584 like there is no match.
3585 The default recognizes a number, followed by an optional punctuation
3586 character and white space.
3587
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003588 *'formatoptions'* *'fo'*
3589'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3590 local to buffer
3591 This is a sequence of letters which describes how automatic
3592 formatting is to be done. See |fo-table|. When the 'paste' option is
3593 on, no formatting is done (like 'formatoptions' is empty). Commas can
3594 be inserted for readability.
3595 To avoid problems with flags that are added in the future, use the
3596 "+=" and "-=" feature of ":set" |add-option-flags|.
3597 NOTE: This option is set to the Vi default value when 'compatible' is
3598 set and to the Vim default value when 'compatible' is reset.
3599
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 *'formatprg'* *'fp'*
3601'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003602 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003604 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003606 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003607 If the 'formatexpr' option is not empty it will be used instead.
3608 Otherwise, if 'formatprg' option is an empty string, the internal
3609 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003610 Environment variables are expanded |:set_env|. See |option-backslash|
3611 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003612 This option cannot be set from a |modeline| or in the |sandbox|, for
3613 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614
Bram Moolenaard94464e2015-11-02 15:28:18 +01003615 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003616'fsync' 'fs' boolean (default on)
3617 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003618 When on, the library function fsync() will be called after writing a
3619 file. This will flush a file to disk, ensuring that it is safely
3620 written even on filesystems which do metadata-only journaling. This
3621 will force the harddrive to spin up on Linux systems running in laptop
3622 mode, so it may be undesirable in some situations. Be warned that
3623 turning this off increases the chances of data loss after a crash. On
3624 systems without an fsync() implementation, this variable is always
3625 off.
3626 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003627 'fsync' also applies to |writefile()| (unless a flag is used to
3628 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003629 This option cannot be set from a |modeline| or in the |sandbox|, for
3630 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003631
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3633'gdefault' 'gd' boolean (default off)
3634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 When on, the ":substitute" flag 'g' is default on. This means that
3636 all matches in a line are substituted instead of one. When a 'g' flag
3637 is given to a ":substitute" command, this will toggle the substitution
3638 of all or one match. See |complex-change|.
3639
3640 command 'gdefault' on 'gdefault' off ~
3641 :s/// subst. all subst. one
3642 :s///g subst. one subst. all
3643 :s///gg subst. all subst. one
3644
3645 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003646 DEPRECATED: Setting this option may break plugins that are not aware
3647 of this option. Also, many users get confused that adding the /g flag
3648 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003649 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650
3651 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003652'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 Format to recognize for the ":grep" command output.
3655 This is a scanf-like string that uses the same format as the
3656 'errorformat' option: see |errorformat|.
3657
3658 *'grepprg'* *'gp'*
3659'grepprg' 'gp' string (default "grep -n ",
3660 Unix: "grep -n $* /dev/null",
3661 Win32: "findstr /n" or "grep -n",
3662 VMS: "SEARCH/NUMBERS ")
3663 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003664 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 and '#' characters, which are expanded like when used in a command-
3666 line. The placeholder "$*" is allowed to specify where the arguments
3667 will be included. Environment variables are expanded |:set_env|. See
3668 |option-backslash| about including spaces and backslashes.
3669 When your "grep" accepts the "-H" argument, use this to make ":grep"
3670 also work well with a single file: >
3671 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003672< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003673 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3674 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003675 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 apply equally to 'grepprg'.
3677 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3678 otherwise it's "grep -n".
3679 This option cannot be set from a |modeline| or in the |sandbox|, for
3680 security reasons.
3681
3682 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3683'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3684 ve:ver35-Cursor,
3685 o:hor50-Cursor,
3686 i-ci:ver25-Cursor/lCursor,
3687 r-cr:hor20-Cursor/lCursor,
3688 sm:block-Cursor
3689 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003690 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 "n-v-c:block,o:hor50,i-ci:hor15,
3692 r-cr:hor30,sm:block")
3693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003695 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003697 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003698 height of the cursor can be changed. This can be done by specifying a
3699 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003700 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3701 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003703 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 mode-list and an argument-list:
3705 mode-list:argument-list,mode-list:argument-list,..
3706 The mode-list is a dash separated list of these modes:
3707 n Normal mode
3708 v Visual mode
3709 ve Visual mode with 'selection' "exclusive" (same as 'v',
3710 if not specified)
3711 o Operator-pending mode
3712 i Insert mode
3713 r Replace mode
3714 c Command-line Normal (append) mode
3715 ci Command-line Insert mode
3716 cr Command-line Replace mode
3717 sm showmatch in Insert mode
3718 a all modes
3719 The argument-list is a dash separated list of these arguments:
3720 hor{N} horizontal bar, {N} percent of the character height
3721 ver{N} vertical bar, {N} percent of the character width
3722 block block cursor, fills the whole character
3723 [only one of the above three should be present]
3724 blinkwait{N} *cursor-blinking*
3725 blinkon{N}
3726 blinkoff{N}
3727 blink times for cursor: blinkwait is the delay before
3728 the cursor starts blinking, blinkon is the time that
3729 the cursor is shown and blinkoff is the time that the
3730 cursor is not shown. The times are in msec. When one
3731 of the numbers is zero, there is no blinking. The
3732 default is: "blinkwait700-blinkon400-blinkoff250".
3733 These numbers are used for a missing entry. This
3734 means that blinking is enabled by default. To switch
3735 blinking off you can use "blinkon0". The cursor only
3736 blinks when Vim is waiting for input, not while
3737 executing a command.
3738 To make the cursor blink in an xterm, see
3739 |xterm-blink|.
3740 {group-name}
3741 a highlight group name, that sets the color and font
3742 for the cursor
3743 {group-name}/{group-name}
3744 Two highlight group names, the first is used when
3745 no language mappings are used, the other when they
3746 are. |language-mapping|
3747
3748 Examples of parts:
3749 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3750 block cursor with colors from the "nCursor"
3751 highlight group
3752 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3753 In Insert and Command-line Insert mode, use a
3754 30% vertical bar cursor with colors from the
3755 "iCursor" highlight group. Blink a bit
3756 faster.
3757
3758 The 'a' mode is different. It will set the given argument-list for
3759 all modes. It does not reset anything to defaults. This can be used
3760 to do a common setting for all modes. For example, to switch off
3761 blinking: "a:blinkon0"
3762
3763 Examples of cursor highlighting: >
3764 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3765 :highlight Cursor gui=NONE guifg=bg guibg=fg
3766<
3767 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003768 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769'guifont' 'gfn' string (default "")
3770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 {only available when compiled with GUI enabled}
3772 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003773 In its simplest form the value is just one font name.
3774 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775
3776 *'guifontset'* *'gfs'*
3777 *E250* *E252* *E234* *E597* *E598*
3778'guifontset' 'gfs' string (default "")
3779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 {only available when compiled with GUI enabled and
3781 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003782 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 When not empty, specifies two (or more) fonts to be used. The first
3784 one for normal English, the second one for your special language. See
3785 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003786
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3788'guifontwide' 'gfw' string (default "")
3789 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 {only available when compiled with GUI enabled}
3791 When not empty, specifies a comma-separated list of fonts to be used
3792 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003793 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003794
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 *'guiheadroom'* *'ghr'*
3796'guiheadroom' 'ghr' number (default 50)
3797 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003798 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 The number of pixels subtracted from the screen height when fitting
3800 the GUI window on the screen. Set this before the GUI is started,
3801 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003802 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 lines will be left for window decorations and other items on the
3804 screen. Set it to a negative value to allow windows taller than the
3805 screen.
3806
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003807 *'guiligatures'* *'gli'* *E1243*
3808'guiligatures' 'gli' string (default "")
3809 global
3810 {only for GTK GUI}
3811 List of ASCII characters that, when combined together, can create more
3812 complex shapes. Each character must be a printable ASCII character
3813 with a value in the 32-127 range.
3814 Example: >
3815 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3816< Changing this option updates screen output immediately. Set it to an
3817 empty string to disable ligatures.
3818
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003820'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3821 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003822 "aegimrLtT" (GTK, Motif and Athena),
3823 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003826 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 sequence of letters which describes what components and options of the
3828 GUI should be used.
3829 To avoid problems with flags that are added in the future, use the
3830 "+=" and "-=" feature of ":set" |add-option-flags|.
3831
Bram Moolenaar13568252018-03-16 20:46:58 +01003832 Valid characters are as follows:
3833 *'go-!'*
3834 '!' External commands are executed in a terminal window. Without
3835 this flag the MS-Windows GUI will open a console window to
3836 execute the command. The Unix GUI will simulate a dumb
3837 terminal to list the command output.
3838 The terminal window will be positioned at the bottom, and grow
3839 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003840 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 'a' Autoselect: If present, then whenever VISUAL mode is started,
3842 or the Visual area extended, Vim tries to become the owner of
3843 the windowing system's global selection. This means that the
3844 Visually highlighted text is available for pasting into other
3845 applications as well as into Vim itself. When the Visual mode
3846 ends, possibly due to an operation on the text, or when an
3847 application wants to paste the selection, the highlighted text
3848 is automatically yanked into the "* selection register.
3849 Thus the selection is still available for pasting into other
3850 applications after the VISUAL mode has ended.
3851 If not present, then Vim won't become the owner of the
3852 windowing system's global selection unless explicitly told to
3853 by a yank or delete operation for the "* register.
3854 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003855 *'go-P'*
3856 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003857 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003858 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003859 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 applies to the modeless selection.
3861
3862 'guioptions' autoselect Visual autoselect modeless ~
3863 "" - -
3864 "a" yes yes
3865 "A" - yes
3866 "aA" yes yes
3867
Bram Moolenaar02467872007-05-06 13:22:01 +00003868 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 'c' Use console dialogs instead of popup dialogs for simple
3870 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003871 *'go-d'*
3872 'd' Use dark theme variant if available. Currently only works for
3873 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003874 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003875 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003876 'guitablabel' can be used to change the text in the labels.
3877 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003878 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003879 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003880 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 'f' Foreground: Don't use fork() to detach the GUI from the shell
3882 where it was started. Use this for programs that wait for the
3883 editor to finish (e.g., an e-mail program). Alternatively you
3884 can use "gvim -f" or ":gui -f" to start the GUI in the
3885 foreground. |gui-fork|
3886 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003887 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003888 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3890 corner of the window. It's black&white on non-GTK, because of
3891 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003892 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003894 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003895 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003897 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003899 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003900 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 'g' Grey menu items: Make menu items that are not active grey. If
3902 'g' is not included inactive menu items are not shown at all.
3903 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003904 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 't' Include tearoff menu items. Currently only works for Win32,
3906 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003907 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003908 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003909 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003910 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003912 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 'R' Right-hand scrollbar is present when there is a vertically
3914 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003915 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003917 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 'L' Left-hand scrollbar is present when there is a vertically
3919 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003920 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3922 the longest visible line, or on the cursor line if the 'h'
3923 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003924 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 'h' Limit horizontal scrollbar size to the length of the cursor
3926 line. Reduces computations. |gui-horiz-scroll|
3927
3928 And yes, you may even have scrollbars on the left AND the right if
3929 you really want to :-). See |gui-scrollbars| for more information.
3930
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003931 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 'v' Use a vertical button layout for dialogs. When not included,
3933 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003934 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003935 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 'p' Use Pointer callbacks for X11 GUI. This is required for some
3937 window managers. If the cursor is not blinking or hollow at
3938 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003939 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003941 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003942 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003943 *'go-k'*
3944 'k' Keep the GUI window size when adding/removing a scrollbar, or
3945 toolbar, tabline, etc. Instead, the behavior is similar to
3946 when the window is maximized and will adjust 'lines' and
3947 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003948 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003949 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003950
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 *'guipty'* *'noguipty'*
3952'guipty' boolean (default on)
3953 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 {only available when compiled with GUI enabled}
3955 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3956 I/O to/from shell commands. See |gui-pty|.
3957
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003958 *'guitablabel'* *'gtl'*
3959'guitablabel' 'gtl' string (default empty)
3960 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003961 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003962 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003963 pages line. When empty and when the result is empty Vim will use a
3964 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003965
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003966 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003967 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003968 The expression will be evaluated in the |sandbox| when set from a
3969 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003970 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003971
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003972 Only used when the GUI tab pages line is displayed. 'e' must be
3973 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3974 used.
3975
Bram Moolenaar57657d82006-04-21 22:12:41 +00003976 *'guitabtooltip'* *'gtt'*
3977'guitabtooltip' 'gtt' string (default empty)
3978 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003979 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003980 When nonempty describes the text to use in a tooltip for the GUI tab
3981 pages line. When empty Vim will use a default tooltip.
3982 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003983 You can include a line break. Simplest method is to use |:let|: >
3984 :let &guitabtooltip = "line one\nline two"
3985<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003986
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003988'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 (others) "$VIMRUNTIME/doc/help.txt")
3990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 Name of the main help file. All distributed help files should be
3992 placed together in one directory. Additionally, all "doc" directories
3993 in 'runtimepath' will be used.
3994 Environment variables are expanded |:set_env|. For example:
3995 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003996 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 spaces and backslashes.
3998 This option cannot be set from a |modeline| or in the |sandbox|, for
3999 security reasons.
4000
4001 *'helpheight'* *'hh'*
4002'helpheight' 'hh' number (default 20)
4003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 Minimal initial height of the help window when it is opened with the
4005 ":help" command. The initial height of the help window is half of the
4006 current window, or (when the 'ea' option is on) the same as other
4007 windows. When the height is less than 'helpheight', the height is
4008 set to 'helpheight'. Set to zero to disable.
4009
4010 *'helplang'* *'hlg'*
4011'helplang' 'hlg' string (default: messages language or empty)
4012 global
4013 {only available when compiled with the |+multi_lang|
4014 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 Comma separated list of languages. Vim will use the first language
4016 for which the desired help can be found. The English help will always
4017 be used as a last resort. You can add "en" to prefer English over
4018 another language, but that will only find tags that exist in that
4019 language and not in the English help.
4020 Example: >
4021 :set helplang=de,it
4022< This will first search German, then Italian and finally English help
4023 files.
4024 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4025 try to find the tag in the current language before using this option.
4026 See |help-translated|.
4027
4028 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4029'hidden' 'hid' boolean (default off)
4030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 When off a buffer is unloaded when it is |abandon|ed. When on a
4032 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4033 displayed in another window, it does not become hidden, of course.
4034 The commands that move through the buffer list sometimes make a buffer
4035 hidden although the 'hidden' option is off: When the buffer is
4036 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004037 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004038 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 This option is set for one command with ":hide {command}" |:hide|.
4040 WARNING: It's easy to forget that you have changes in hidden buffers.
4041 Think twice when using ":q!" or ":qa!".
4042
4043 *'highlight'* *'hl'*
4044'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004045 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4046 d:Directory,e:ErrorMsg,i:IncSearch,
4047 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004048 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004049 N:CursorLineNr,r:Question,s:StatusLine,
4050 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004051 v:Visual,V:VisualNOS,w:WarningMsg,
4052 W:WildMenu,f:Folded,F:FoldColumn,
4053 A:DiffAdd,C:DiffChange,D:DiffDelete,
4054 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004055 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004056 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004057 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4058 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004059 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004060 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 This option can be used to set highlighting mode for various
4063 occasions. It is a comma separated list of character pairs. The
4064 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004065 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004067 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4068 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 characters from 'showbreak'
4070 |hl-Directory| d directories in CTRL-D listing and other special
4071 things in listings
4072 |hl-ErrorMsg| e error messages
4073 h (obsolete, ignored)
4074 |hl-IncSearch| i 'incsearch' highlighting
4075 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4076 |hl-MoreMsg| m |more-prompt|
4077 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004078 |hl-LineNr| n line number for ":number" and ":#" commands, and
4079 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004080 |hl-LineNrAbove| a line number above the cursor for when the
4081 'relativenumber' option is set.
4082 |hl-LineNrBelow| b line number below the cursor for when the
4083 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004084 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4085 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 |hl-Question| r |hit-enter| prompt and yes/no questions
4087 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004088 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4090 |hl-VertSplit| c column used to separate vertically split windows
4091 |hl-Visual| v Visual mode
4092 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4093 Selection" Only X11 Gui's |gui-x11| and
4094 |xterm-clipboard|.
4095 |hl-WarningMsg| w warning messages
4096 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4097 |hl-Folded| f line used for closed folds
4098 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004099 |hl-DiffAdd| A added line in diff mode
4100 |hl-DiffChange| C changed line in diff mode
4101 |hl-DiffDelete| D deleted line in diff mode
4102 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004104 |hl-Conceal| - the placeholders used for concealed characters
4105 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004106 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004107 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004108 |hl-SpellRare| R rare word |spell|
4109 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004110 |hl-Pmenu| + popup menu normal line
4111 |hl-PmenuSel| = popup menu selected line
4112 |hl-PmenuSbar| x popup menu scrollbar
4113 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114
4115 The display modes are:
4116 r reverse (termcap entry "mr" and "me")
4117 i italic (termcap entry "ZH" and "ZR")
4118 b bold (termcap entry "md" and "me")
4119 s standout (termcap entry "so" and "se")
4120 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004121 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004122 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 n no highlighting
4124 - no highlighting
4125 : use a highlight group
4126 The default is used for occasions that are not included.
4127 If you want to change what the display modes do, see |dos-colors|
4128 for an example.
4129 When using the ':' display mode, this must be followed by the name of
4130 a highlight group. A highlight group can be used to define any type
4131 of highlighting, including using color. See |:highlight| on how to
4132 define one. The default uses a different group for each occasion.
4133 See |highlight-default| for the default highlight groups.
4134
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004136'history' 'hi' number (Vim default: 50, Vi default: 0,
4137 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004140 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004142 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 NOTE: This option is set to the Vi default value when 'compatible' is
4144 set and to the Vim default value when 'compatible' is reset.
4145
4146 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4147'hkmap' 'hk' boolean (default off)
4148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 {only available when compiled with the |+rightleft|
4150 feature}
4151 When on, the keyboard is mapped for the Hebrew character set.
4152 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4153 toggle this option. See |rileft.txt|.
4154 NOTE: This option is reset when 'compatible' is set.
4155
4156 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4157'hkmapp' 'hkp' boolean (default off)
4158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 {only available when compiled with the |+rightleft|
4160 feature}
4161 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4162 This is useful if you have a non-Hebrew keyboard.
4163 See |rileft.txt|.
4164 NOTE: This option is reset when 'compatible' is set.
4165
Bram Moolenaar036986f2017-03-16 17:41:02 +01004166 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4167'hlsearch' 'hls' boolean (default off)
4168 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004169 {not available when compiled without the
4170 |+extra_search| feature}
4171 When there is a previous search pattern, highlight all its matches.
4172 The type of highlighting used can be set with the 'l' occasion in the
4173 'highlight' option. This uses the "Search" highlight group by
4174 default. Note that only the matching text is highlighted, any offsets
4175 are not applied.
4176 See also: 'incsearch' and |:match|.
4177 When you get bored looking at the highlighted matches, you can turn it
4178 off with |:nohlsearch|. This does not change the option value, as
4179 soon as you use a search command, the highlighting comes back.
4180 'redrawtime' specifies the maximum time spent on finding matches.
4181 When the search pattern can match an end-of-line, Vim will try to
4182 highlight all of the matched text. However, this depends on where the
4183 search starts. This will be the first line in the window or the first
4184 line below a closed fold. A match in a previous line which is not
4185 drawn may not continue in a newly drawn line.
4186 You can specify whether the highlight status is restored on startup
4187 with the 'h' flag in 'viminfo' |viminfo-h|.
4188 NOTE: This option is reset when 'compatible' is set.
4189
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 *'icon'* *'noicon'*
4191'icon' boolean (default off, on when title can be restored)
4192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 When on, the icon text of the window will be set to the value of
4194 'iconstring' (if it is not empty), or to the name of the file
4195 currently being edited. Only the last part of the name is used.
4196 Overridden by the 'iconstring' option.
4197 Only works if the terminal supports setting window icons (currently
4198 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4199 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4200 builtin termcap).
4201 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004202 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004204 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205
4206 *'iconstring'*
4207'iconstring' string (default "")
4208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 When this option is not empty, it will be used for the icon text of
4210 the window. This happens only when the 'icon' option is on.
4211 Only works if the terminal supports setting window icon text
4212 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004213 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 When Vim was compiled with HAVE_X11 defined, the original icon will be
4215 restored if possible |X11|.
4216 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004217 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004219 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 {not available when compiled without the |+statusline| feature}
4221
4222 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4223'ignorecase' 'ic' boolean (default off)
4224 global
4225 Ignore case in search patterns. Also used when searching in the tags
4226 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004227 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 Can be overruled by using "\c" or "\C" in the pattern, see
4229 |/ignorecase|.
4230
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004231 *'imactivatefunc'* *'imaf'*
4232'imactivatefunc' 'imaf' string (default "")
4233 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004234 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004235 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004236 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004237 The expression will be evaluated in the |sandbox| when set from a
4238 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004239
4240 Example: >
4241 function ImActivateFunc(active)
4242 if a:active
4243 ... do something
4244 else
4245 ... do something
4246 endif
4247 " return value is not used
4248 endfunction
4249 set imactivatefunc=ImActivateFunc
4250<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 *'imactivatekey'* *'imak'*
4252'imactivatekey' 'imak' string (default "")
4253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004255 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 Specifies the key that your Input Method in X-Windows uses for
4257 activation. When this is specified correctly, vim can fully control
4258 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4259 You can't use this option to change the activation key, the option
4260 tells Vim what the key is.
4261 Format:
4262 [MODIFIER_FLAG-]KEY_STRING
4263
4264 These characters can be used for MODIFIER_FLAG (case is ignored):
4265 S Shift key
4266 L Lock key
4267 C Control key
4268 1 Mod1 key
4269 2 Mod2 key
4270 3 Mod3 key
4271 4 Mod4 key
4272 5 Mod5 key
4273 Combinations are allowed, for example "S-C-space" or "SC-space" are
4274 both shift+ctrl+space.
4275 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4276
4277 Example: >
4278 :set imactivatekey=S-space
4279< "S-space" means shift+space. This is the activation key for kinput2 +
4280 canna (Japanese), and ami (Korean).
4281
4282 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4283'imcmdline' 'imc' boolean (default off)
4284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 When set the Input Method is always on when starting to edit a command
4286 line, unless entering a search pattern (see 'imsearch' for that).
4287 Setting this option is useful when your input method allows entering
4288 English characters directly, e.g., when it's used to type accented
4289 characters with dead keys.
4290
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004291 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4293 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 When set the Input Method is never used. This is useful to disable
4295 the IM when it doesn't work properly.
4296 Currently this option is on by default for SGI/IRIX machines. This
4297 may change in later releases.
4298
4299 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004300'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 Specifies whether :lmap or an Input Method (IM) is to be used in
4303 Insert mode. Valid values:
4304 0 :lmap is off and IM is off
4305 1 :lmap is ON and IM is off
4306 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 To always reset the option to zero when leaving Insert mode with <Esc>
4308 this can be used: >
4309 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4310< This makes :lmap and IM turn off automatically when leaving Insert
4311 mode.
4312 Note that this option changes when using CTRL-^ in Insert mode
4313 |i_CTRL-^|.
4314 The value is set to 1 when setting 'keymap' to a valid keymap name.
4315 It is also used for the argument of commands like "r" and "f".
4316 The value 0 may not work correctly with Athena and Motif with some XIM
4317 methods. Use 'imdisable' to disable XIM then.
4318
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004319 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004320 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004321 |+multi_byte_ime| or |global-ime|.
4322
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004324'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 Specifies whether :lmap or an Input Method (IM) is to be used when
4327 entering a search pattern. Valid values:
4328 -1 the value of 'iminsert' is used, makes it look like
4329 'iminsert' is also used when typing a search pattern
4330 0 :lmap is off and IM is off
4331 1 :lmap is ON and IM is off
4332 2 :lmap is off and IM is ON
4333 Note that this option changes when using CTRL-^ in Command-line mode
4334 |c_CTRL-^|.
4335 The value is set to 1 when it is not -1 and setting the 'keymap'
4336 option to a valid keymap name.
4337 The value 0 may not work correctly with Athena and Motif with some XIM
4338 methods. Use 'imdisable' to disable XIM then.
4339
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004340 *'imstatusfunc'* *'imsf'*
4341'imstatusfunc' 'imsf' string (default "")
4342 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004343 This option specifies a function that is called to obtain the status
4344 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004345 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004346
4347 Example: >
4348 function ImStatusFunc()
4349 let is_active = ...do something
4350 return is_active ? 1 : 0
4351 endfunction
4352 set imstatusfunc=ImStatusFunc
4353<
4354 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004355 The expression will be evaluated in the |sandbox| when set from a
4356 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004357
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004358 *'imstyle'* *'imst'*
4359'imstyle' 'imst' number (default 1)
4360 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004361 {only available when compiled with |+xim| and
4362 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004363 This option specifies the input style of Input Method:
4364 0 use on-the-spot style
4365 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004366 See: |xim-input-style|
4367
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004368 For a long time on-the-spot style had been used in the GTK version of
4369 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004370 |single-repeat|, etc. Therefore over-the-spot style becomes the
4371 default now. This should work fine for most people, however if you
4372 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004373 The expression will be evaluated in the |sandbox| when set from a
4374 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004375
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 *'include'* *'inc'*
4377'include' 'inc' string (default "^\s*#\s*include")
4378 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 {not available when compiled without the
4380 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004381 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 pattern, just like for the "/" command (See |pattern|). The default
4383 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004384 "]I", "[d", etc.
4385 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004386 comes after the matched pattern. But if "\zs" appears in the pattern
4387 then the text matched from "\zs" to the end, or until "\ze" if it
4388 appears, is used as the file name. Use this to include characters
4389 that are not in 'isfname', such as a space. You can then use
4390 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004391 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392
4393 *'includeexpr'* *'inex'*
4394'includeexpr' 'inex' string (default "")
4395 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004397 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004399 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 :set includeexpr=substitute(v:fname,'\\.','/','g')
4401< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004402
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004404 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 Also used for |<cfile>|.
4406
Bram Moolenaar30b65812012-07-12 22:01:11 +02004407 The expression will be evaluated in the |sandbox| when set from a
4408 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004409 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004410
4411 It is not allowed to change text or jump to another window while
4412 evaluating 'includeexpr' |textlock|.
4413
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004415'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4416 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004419 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004420 While typing a search command, show where the pattern, as it was typed
4421 so far, matches. The matched string is highlighted. If the pattern
4422 is invalid or not found, nothing is shown. The screen will be updated
4423 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004424 Also applies to the pattern in commands: >
4425 :global
4426 :lvimgrep
4427 :lvimgrepadd
4428 :smagic
4429 :snomagic
4430 :sort
4431 :substitute
4432 :vglobal
4433 :vimgrep
4434 :vimgrepadd
4435< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004436 original position when no match is found and when pressing <Esc>. You
4437 still need to finish the search command with <Enter> to move the
4438 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004439 You can use the CTRL-G and CTRL-T keys to move to the next and
4440 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004441 When compiled with the |+reltime| feature Vim only searches for about
4442 half a second. With a complicated pattern and/or a lot of text the
4443 match may not be found. This is to avoid that Vim hangs while you
4444 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004445 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004446 When 'hlsearch' is on, all matched strings are highlighted too while
4447 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004448 If you don't want to turn 'hlsearch' on, but want to highlight all
4449 matches while searching, you can turn on and off 'hlsearch' with
4450 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004451 augroup vimrc-incsearch-highlight
4452 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004453 autocmd CmdlineEnter /,\? :set hlsearch
4454 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004455 augroup END
4456<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004457 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004458 to the command line. If 'ignorecase' and 'smartcase' are set and the
4459 command line has no uppercase characters, the added character is
4460 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004461 CTRL-R CTRL-W can be used to add the word at the end of the current
4462 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 NOTE: This option is reset when 'compatible' is set.
4464
4465 *'indentexpr'* *'inde'*
4466'indentexpr' 'inde' string (default "")
4467 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 {not available when compiled without the |+cindent|
4469 or |+eval| features}
4470 Expression which is evaluated to obtain the proper indent for a line.
4471 It is used when a new line is created, for the |=| operator and
4472 in Insert mode as specified with the 'indentkeys' option.
4473 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004474 'smartindent' indenting. When 'lisp' is set, this option is
4475 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 When 'paste' is set this option is not used for indenting.
4477 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004478 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 when the expression is evaluated (but it may be moved around).
4480 The expression must return the number of spaces worth of indent. It
4481 can return "-1" to keep the current indent (this means 'autoindent' is
4482 used for the indent).
4483 Functions useful for computing the indent are |indent()|, |cindent()|
4484 and |lispindent()|.
4485 The evaluation of the expression must not have side effects! It must
4486 not change the text, jump to another window, etc. Afterwards the
4487 cursor position is always restored, thus the cursor may be moved.
4488 Normally this option would be set to call a function: >
4489 :set indentexpr=GetMyIndent()
4490< Error messages will be suppressed, unless the 'debug' option contains
4491 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004492 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004493 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494
Bram Moolenaar30b65812012-07-12 22:01:11 +02004495 The expression will be evaluated in the |sandbox| when set from a
4496 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004497 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004498
4499 It is not allowed to change text or jump to another window while
4500 evaluating 'indentexpr' |textlock|.
4501
4502
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004504'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 {not available when compiled without the |+cindent|
4507 feature}
4508 A list of keys that, when typed in Insert mode, cause reindenting of
4509 the current line. Only happens if 'indentexpr' isn't empty.
4510 The format is identical to 'cinkeys', see |indentkeys-format|.
4511 See |C-indenting| and |indent-expression|.
4512
4513 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4514'infercase' 'inf' boolean (default off)
4515 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004517 'ignorecase' is also on, the case of the match is adjusted depending
4518 on the typed text. If the typed text contains a lowercase letter
4519 where the match has an upper case letter, the completed part is made
4520 lowercase. If the typed text has no lowercase letters and the match
4521 has a lowercase letter where the typed text has an uppercase letter,
4522 and there is a letter before it, the completed part is made uppercase.
4523 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524
4525 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4526'insertmode' 'im' boolean (default off)
4527 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 Makes Vim work in a way that Insert mode is the default mode. Useful
4529 if you want to use Vim as a modeless editor. Used for |evim|.
4530 These Insert mode commands will be useful:
4531 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004532 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 this is a mapping, it is executed as if 'insertmode' was off.
4534 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004536 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4537 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538
4539 These items change when 'insertmode' is set:
4540 - when starting to edit of a file, Vim goes to Insert mode.
4541 - <Esc> in Insert mode is a no-op and beeps.
4542 - <Esc> in Normal mode makes Vim go to Insert mode.
4543 - CTRL-L in Insert mode is a command, it is not inserted.
4544 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4545 However, when <Esc> is used inside a mapping, it behaves like
4546 'insertmode' was not set. This was done to be able to use the same
4547 mappings with 'insertmode' set or not set.
4548 When executing commands with |:normal| 'insertmode' is not used.
4549
4550 NOTE: This option is reset when 'compatible' is set.
4551
4552 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004553'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4555 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4556 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4557 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4558 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 The characters specified by this option are included in file names and
4561 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004562 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563 Multi-byte characters 256 and above are always included, only the
4564 characters up to 255 are specified with this option.
4565 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004566 Think twice before adding white space to this option. Although a
4567 space may appear inside a file name, the effect will be that Vim
4568 doesn't know where a file name starts or ends when doing completion.
4569 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570
4571 Note that on systems using a backslash as path separator, Vim tries to
4572 do its best to make it work as you would expect. That is a bit
4573 tricky, since Vi originally used the backslash to escape special
4574 characters. Vim will not remove a backslash in front of a normal file
4575 name character on these systems, but it will on Unix and alikes. The
4576 '&' and '^' are not included by default, because these are special for
4577 cmd.exe.
4578
4579 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004580 Each part can be a single character number or a range. A range is two
4581 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 decimal number between 0 and 255 or the ASCII character itself (does
4583 not work for digits). Example:
4584 "_,-,128-140,#-43" (include '_' and '-' and the range
4585 128 to 140 and '#' to 43)
4586 If a part starts with '^', the following character number or range
4587 will be excluded from the option. The option is interpreted from left
4588 to right. Put the excluded character after the range where it is
4589 included. To include '^' itself use it as the last character of the
4590 option or the end of a range. Example:
4591 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4592 If the character is '@', all characters where isalpha() returns TRUE
4593 are included. Normally these are the characters a to z and A to Z,
4594 plus accented characters. To include '@' itself use "@-@". Examples:
4595 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004596 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 "a-z,A-Z,@-@" All letters plus the '@' character.
4598 A comma can be included by using it where a character number is
4599 expected. Example:
4600 "48-57,,,_" Digits, comma and underscore.
4601 A comma can be excluded by prepending a '^'. Example:
4602 " -~,^,,9" All characters from space to '~', excluding
4603 comma, plus <Tab>.
4604 See |option-backslash| about including spaces and backslashes.
4605
4606 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004607'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608 "@,48-57,_,128-167,224-235"
4609 otherwise: "@,48-57,_,192-255")
4610 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 The characters given by this option are included in identifiers.
4612 Identifiers are used in recognizing environment variables and after a
4613 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004614 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004615 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004617 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4619
4620 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004621'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 "@,48-57,_,128-167,224-235"
4623 otherwise: "@,48-57,_,192-255"
4624 Vi default: "@,48-57,_")
4625 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004627 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004628 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004629 characters above 255 check the "word" character class (any character
4630 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004631 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 For a help file it is set to all non-blank printable characters except
4633 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4634 command).
4635 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004636 This option also influences syntax highlighting, unless the syntax
4637 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 NOTE: This option is set to the Vi default value when 'compatible' is
4639 set and to the Vim default value when 'compatible' is reset.
4640
4641 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004642'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 "@,~-255"; otherwise: "@,161-255")
4644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 The characters given by this option are displayed directly on the
4646 screen. It is also used for "\p" in a |pattern|. The characters from
4647 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4648 even when they are not included in 'isprint' or excluded. See
4649 'isfname' for a description of the format of this option.
4650
4651 Non-printable characters are displayed with two characters:
4652 0 - 31 "^@" - "^_"
4653 32 - 126 always single characters
4654 127 "^?"
4655 128 - 159 "~@" - "~_"
4656 160 - 254 "| " - "|~"
4657 255 "~?"
4658 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4659 displayed as <xx>, with the hexadecimal value of the byte.
4660 When 'display' contains "uhex" all unprintable characters are
4661 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004662 The SpecialKey highlighting will be used for unprintable characters.
4663 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664
4665 Multi-byte characters 256 and above are always included, only the
4666 characters up to 255 are specified with this option. When a character
4667 is printable but it is not available in the current font, a
4668 replacement character will be shown.
4669 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4670 There is no option to specify these characters.
4671
4672 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4673'joinspaces' 'js' boolean (default on)
4674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 Insert two spaces after a '.', '?' and '!' with a join command.
4676 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4677 Otherwise only one space is inserted.
4678 NOTE: This option is set when 'compatible' is set.
4679
4680 *'key'*
4681'key' string (default "")
4682 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004683 {only available when compiled with the |+cryptv|
4684 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004686 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 Careful: Do not set the key value by hand, someone might see the typed
4688 key. Use the |:X| command. But you can make 'key' empty: >
4689 :set key=
4690< It is not possible to get the value of this option with ":set key" or
4691 "echo &key". This is to avoid showing it to someone who shouldn't
4692 know. It also means you cannot see it yourself once you have set it,
4693 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004694 You can use "&key" in an expression to detect whether encryption is
4695 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696
4697 *'keymap'* *'kmp'* *E544*
4698'keymap' 'kmp' string (default "")
4699 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 {only available when compiled with the |+keymap|
4701 feature}
4702 Name of a keyboard mapping. See |mbyte-keymap|.
4703 Setting this option to a valid keymap name has the side effect of
4704 setting 'iminsert' to one, so that the keymap becomes effective.
4705 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004706 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707
4708 *'keymodel'* *'km'*
4709'keymodel' 'km' string (default "")
4710 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 List of comma separated words, which enable special things that keys
4712 can do. These values can be used:
4713 startsel Using a shifted special key starts selection (either
4714 Select mode or Visual mode, depending on "key" being
4715 present in 'selectmode').
4716 stopsel Using a not-shifted special key stops selection.
4717 Special keys in this context are the cursor keys, <End>, <Home>,
4718 <PageUp> and <PageDown>.
4719 The 'keymodel' option is set by the |:behave| command.
4720
4721 *'keywordprg'* *'kp'*
4722'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004723 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 Program to use for the |K| command. Environment variables are
4726 expanded |:set_env|. ":help" may be used to access the Vim internal
4727 help. (Note that previously setting the global option to the empty
4728 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004729 When the first character is ":", the command is invoked as a Vim
4730 Ex command prefixed with [count].
4731 When "man", "man -s" or an Ex command is used, Vim will automatically
4732 translate a count for the "K" command and pass it as the first
4733 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 See |option-backslash| about including spaces and backslashes.
4735 Example: >
4736 :set keywordprg=man\ -s
4737< This option cannot be set from a |modeline| or in the |sandbox|, for
4738 security reasons.
4739
4740 *'langmap'* *'lmap'* *E357* *E358*
4741'langmap' 'lmap' string (default "")
4742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 {only available when compiled with the |+langmap|
4744 feature}
4745 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004746 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004747 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 care of translating these special characters to the original meaning
4749 of the key. This means you don't have to change the keyboard mode to
4750 be able to execute Normal mode commands.
4751 This is the opposite of the 'keymap' option, where characters are
4752 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004753 Also consider setting 'langremap' to off, to prevent 'langmap' from
4754 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004755 This option cannot be set from a |modeline| or in the |sandbox|, for
4756 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004758 Example (for Greek, in UTF-8): *greek* >
4759 :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 +00004760< Example (exchanges meaning of z and y for commands): >
4761 :set langmap=zy,yz,ZY,YZ
4762<
4763 The 'langmap' option is a list of parts, separated with commas. Each
4764 part can be in one of two forms:
4765 1. A list of pairs. Each pair is a "from" character immediately
4766 followed by the "to" character. Examples: "aA", "aAbBcC".
4767 2. A list of "from" characters, a semi-colon and a list of "to"
4768 characters. Example: "abc;ABC"
4769 Example: "aA,fgh;FGH,cCdDeE"
4770 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004771 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772
4773 This will allow you to activate vim actions without having to switch
4774 back and forth between the languages. Your language characters will
4775 be understood as normal vim English characters (according to the
4776 langmap mappings) in the following cases:
4777 o Normal/Visual mode (commands, buffer/register names, user mappings)
4778 o Insert/Replace Mode: Register names after CTRL-R
4779 o Insert/Replace Mode: Mappings
4780 Characters entered in Command-line mode will NOT be affected by
4781 this option. Note that this option can be changed at any time
4782 allowing to switch between mappings for different languages/encodings.
4783 Use a mapping to avoid having to type it each time!
4784
4785 *'langmenu'* *'lm'*
4786'langmenu' 'lm' string (default "")
4787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 {only available when compiled with the |+menu| and
4789 |+multi_lang| features}
4790 Language to use for menu translation. Tells which file is loaded
4791 from the "lang" directory in 'runtimepath': >
4792 "lang/menu_" . &langmenu . ".vim"
4793< (without the spaces). For example, to always use the Dutch menus, no
4794 matter what $LANG is set to: >
4795 :set langmenu=nl_NL.ISO_8859-1
4796< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004797 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 If your $LANG is set to a non-English language but you do want to use
4799 the English menus: >
4800 :set langmenu=none
4801< This option must be set before loading menus, switching on filetype
4802 detection or syntax highlighting. Once the menus are defined setting
4803 this option has no effect. But you could do this: >
4804 :source $VIMRUNTIME/delmenu.vim
4805 :set langmenu=de_DE.ISO_8859-1
4806 :source $VIMRUNTIME/menu.vim
4807< Warning: This deletes all menus that you defined yourself!
4808
Bram Moolenaard94464e2015-11-02 15:28:18 +01004809 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004810'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004811 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004812 {only available when compiled with the |+langmap|
4813 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004814 This is just like 'langremap' but with the value inverted. It only
4815 exists for backwards compatibility. When setting 'langremap' then
4816 'langnoremap' is set to the inverted value, and the other way around.
4817
4818 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004819'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004820 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004821 {only available when compiled with the |+langmap|
4822 feature}
4823 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004824 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004825 'langmap' disables some of your mappings, try resetting this option.
4826 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004827 that works for you to avoid mappings to break.
4828
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 *'laststatus'* *'ls'*
4830'laststatus' 'ls' number (default 1)
4831 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 The value of this option influences when the last window will have a
4833 status line:
4834 0: never
4835 1: only if there are at least two windows
4836 2: always
4837 The screen looks nicer with a status line if you have several
4838 windows, but it takes another screen line. |status-line|
4839
4840 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4841'lazyredraw' 'lz' boolean (default off)
4842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 When this option is set, the screen will not be redrawn while
4844 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004845 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 update use |:redraw|.
4847
4848 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4849'linebreak' 'lbr' boolean (default off)
4850 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004851 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004853 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854 than at the last character that fits on the screen. Unlike
4855 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004856 it only affects the way the file is displayed, not its contents.
4857 If 'breakindent' is set, line is visually indented. Then, the value
4858 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004859 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 Note that <Tab> characters after an <EOL> are mostly not displayed
4861 with the right amount of white space.
4862
4863 *'lines'* *E593*
4864'lines' number (default 24 or terminal height)
4865 global
4866 Number of lines of the Vim window.
4867 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004868 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 When Vim is running in the GUI or in a resizable window, setting this
4870 option will cause the window size to be changed. When you only want
4871 to use the size for the GUI, put the command in your |gvimrc| file.
4872 Vim limits the number of lines to what fits on the screen. You can
4873 use this command to get the tallest window possible: >
4874 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004875< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004876 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 When you set this option and Vim is unable to change the physical
4878 number of lines of the display, the display may be messed up.
4879
4880 *'linespace'* *'lsp'*
4881'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 {only in the GUI}
4884 Number of pixel lines inserted between characters. Useful if the font
4885 uses the full character cell height, making lines touch each other.
4886 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004887 With some fonts there can be too much room between lines (to have
4888 space for ascents and descents). Then it makes sense to set
4889 'linespace' to a negative value. This may cause display problems
4890 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891
4892 *'lisp'* *'nolisp'*
4893'lisp' boolean (default off)
4894 local to buffer
4895 {not available when compiled without the |+lispindent|
4896 feature}
4897 Lisp mode: When <Enter> is typed in insert mode set the indent for
4898 the next line to Lisp standards (well, sort of). Also happens with
4899 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4900 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4901 better. Also see 'lispwords'.
4902 The '-' character is included in keyword characters. Redefines the
4903 "=" operator to use this same indentation algorithm rather than
4904 calling an external program if 'equalprg' is empty.
4905 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906
4907 *'lispwords'* *'lw'*
4908'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004909 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 {not available when compiled without the |+lispindent|
4911 feature}
4912 Comma separated list of words that influence the Lisp indenting.
4913 |'lisp'|
4914
4915 *'list'* *'nolist'*
4916'list' boolean (default off)
4917 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004918 List mode: By default show tabs as CTRL-I is displayed, display $
4919 after end of line. Useful to see the difference between tabs and
4920 spaces and for trailing blanks. Further changed by the 'listchars'
4921 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004922
4923 The cursor is displayed at the start of the space a Tab character
4924 occupies, not at the end as usual in Normal mode. To get this cursor
4925 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004926 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004927<
4928 Note that list mode will also affect formatting (set with 'textwidth'
4929 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 changing the way tabs are displayed.
4931
4932 *'listchars'* *'lcs'*
4933'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004934 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004935 Strings to use in 'list' mode and for the |:list| command. It is a
4936 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004937 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 eol:c Character to show at the end of each line. When
4939 omitted, there is no extra character at the end of the
4940 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004941 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004942 tab:xy[z] Two or three characters to be used to show a tab.
4943 The third character is optional.
4944
4945 tab:xy The 'x' is always used, then 'y' as many times as will
4946 fit. Thus "tab:>-" displays:
4947 >
4948 >-
4949 >--
4950 etc.
4951
4952 tab:xyz The 'z' is always used, then 'x' is prepended, and
4953 then 'y' is used as many times as will fit. Thus
4954 "tab:<->" displays:
4955 >
4956 <>
4957 <->
4958 <-->
4959 etc.
4960
4961 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004962 *lcs-space*
4963 space:c Character to show for a space. When omitted, spaces
4964 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004965 *lcs-multispace*
4966 multispace:c...
4967 One or more characters to use cyclically to show for
4968 multiple consecutive spaces. Overrides the "space"
4969 setting, except for single spaces. When omitted, the
4970 "space" setting is used. For example,
4971 `:set listchars=multispace:---+` shows ten consecutive
4972 spaces as:
4973 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004974 *lcs-lead*
4975 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004976 leading spaces are blank. Overrides the "space" and
4977 "multispace" settings for leading spaces. You can
4978 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01004979 :set listchars+=tab:>-,lead:.
4980< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004981 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004982 trailing spaces are blank. Overrides the "space" and
4983 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02004984 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 extends:c Character to show in the last column, when 'wrap' is
4986 off and the line continues beyond the right of the
4987 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004988 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004989 precedes:c Character to show in the first visible column of the
4990 physical line, when there is text preceding the
4991 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004992 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004993 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004994 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004995 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004996 nbsp:c Character to show for a non-breakable space character
4997 (0xA0 (160 decimal) and U+202F). Left blank when
4998 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005000 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005002 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003
Bram Moolenaar93ff6722021-10-16 17:51:40 +01005004 Each character can be specified as hex: >
5005 set listchars=eol:\\x24
5006 set listchars=eol:\\u21b5
5007 set listchars=eol:\\U000021b5
5008< Note that a double backslash is used. The number of hex characters
5009 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5010
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011 Examples: >
5012 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005013 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014 :set lcs=extends:>,precedes:<
5015< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005016 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5017 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005018 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019
5020 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5021'loadplugins' 'lpl' boolean (default on)
5022 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 When on the plugin scripts are loaded when starting up |load-plugins|.
5024 This option can be reset in your |vimrc| file to disable the loading
5025 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005026 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5027 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028
Bram Moolenaard94464e2015-11-02 15:28:18 +01005029 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005030'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005031 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005032 {only available when compiled with the |+lua/dyn|
5033 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005034 Specifies the name of the Lua shared library. The default is
5035 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005036 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005037 This option cannot be set from a |modeline| or in the |sandbox|, for
5038 security reasons.
5039
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005040 *'macatsui'* *'nomacatsui'*
5041'macatsui' boolean (default on)
5042 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005043 {not supported}
5044 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005045
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 *'magic'* *'nomagic'*
5047'magic' boolean (default on)
5048 global
5049 Changes the special characters that can be used in search patterns.
5050 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005051 WARNING: Switching this option off most likely breaks plugins! That
5052 is because many patterns assume it's on and will fail when it's off.
5053 Only switch it off when working with old Vi scripts. In any other
5054 situation write patterns that work when 'magic' is on. Include "\M"
5055 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005056 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5057 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058
5059 *'makeef'* *'mef'*
5060'makeef' 'mef' string (default: "")
5061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 {not available when compiled without the |+quickfix|
5063 feature}
5064 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5065 and the |:grep| command.
5066 When it is empty, an internally generated temp file will be used.
5067 When "##" is included, it is replaced by a number to make the name
5068 unique. This makes sure that the ":make" command doesn't overwrite an
5069 existing file.
5070 NOT used for the ":cf" command. See 'errorfile' for that.
5071 Environment variables are expanded |:set_env|.
5072 See |option-backslash| about including spaces and backslashes.
5073 This option cannot be set from a |modeline| or in the |sandbox|, for
5074 security reasons.
5075
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005076 *'makeencoding'* *'menc'*
5077'makeencoding' 'menc' string (default "")
5078 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005079 Encoding used for reading the output of external commands. When empty,
5080 encoding is not converted.
5081 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5082 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5083 and `:laddfile`.
5084
5085 This would be mostly useful when you use MS-Windows and set 'encoding'
5086 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5087 'makeencoding' to "char" has the same effect as setting to the system
5088 locale encoding. Example: >
5089 :set encoding=utf-8
5090 :set makeencoding=char " system locale is used
5091<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 *'makeprg'* *'mp'*
5093'makeprg' 'mp' string (default "make", VMS: "MMS")
5094 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005095 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005096 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5097 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005098 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005099 Environment variables are expanded |:set_env|. See |option-backslash|
5100 about including spaces and backslashes.
5101 Note that a '|' must be escaped twice: once for ":set" and once for
5102 the interpretation of a command. When you use a filter called
5103 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 :set makeprg=gmake\ \\\|\ myfilter
5105< The placeholder "$*" can be given (even multiple times) to specify
5106 where the arguments will be included, for example: >
5107 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5108< This option cannot be set from a |modeline| or in the |sandbox|, for
5109 security reasons.
5110
5111 *'matchpairs'* *'mps'*
5112'matchpairs' 'mps' string (default "(:),{:},[:]")
5113 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005115 other.
5116 Only character pairs are allowed that are different, thus you cannot
5117 jump between two double quotes.
5118 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005119 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005120 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 :set mps+=<:>
5122
5123< A more exotic example, to jump between the '=' and ';' in an
5124 assignment, useful for languages like C and Java: >
5125 :au FileType c,cpp,java set mps+==:;
5126
5127< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005128 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129
5130 *'matchtime'* *'mat'*
5131'matchtime' 'mat' number (default 5)
5132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 Tenths of a second to show the matching paren, when 'showmatch' is
5134 set. Note that this is not in milliseconds, like other options that
5135 set a time. This is to be compatible with Nvi.
5136
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005137 *'maxcombine'* *'mco'*
5138'maxcombine' 'mco' number (default 2)
5139 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005140 The maximum number of combining characters supported for displaying.
5141 Only used when 'encoding' is "utf-8".
5142 The default is OK for most languages. Hebrew may require 4.
5143 Maximum value is 6.
5144 Even when this option is set to 2 you can still edit text with more
5145 combining characters, you just can't see them. Use |g8| or |ga|.
5146 See |mbyte-combining|.
5147
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 *'maxfuncdepth'* *'mfd'*
5149'maxfuncdepth' 'mfd' number (default 100)
5150 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005151 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005152 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 Maximum depth of function calls for user functions. This normally
5154 catches endless recursion. When using a recursive function with
5155 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5156 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005157 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005158 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 See also |:function|.
5160
5161 *'maxmapdepth'* *'mmd'* *E223*
5162'maxmapdepth' 'mmd' number (default 1000)
5163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 Maximum number of times a mapping is done without resulting in a
5165 character to be used. This normally catches endless mappings, like
5166 ":map x y" with ":map y x". It still does not catch ":map g wg",
5167 because the 'w' is used before the next mapping is done. See also
5168 |key-mapping|.
5169
5170 *'maxmem'* *'mm'*
5171'maxmem' 'mm' number (default between 256 to 5120 (system
5172 dependent) or half the amount of memory
5173 available)
5174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5176 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005177 other memory to be freed.
5178 The maximum usable value is about 2000000. Use this to work without a
5179 limit.
5180 The value is ignored when 'swapfile' is off.
5181 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005183 *'maxmempattern'* *'mmp'*
5184'maxmempattern' 'mmp' number (default 1000)
5185 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005186 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005187 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005188 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005189 When Vim runs into the limit it gives an error message and mostly
5190 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005191 Running into the limit often means that the pattern is very
5192 inefficient or too complex. This may already happen with the pattern
5193 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005194 Might also happen on redraw, when syntax rules try to match a complex
5195 text structure.
5196 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5197 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005198
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 *'maxmemtot'* *'mmt'*
5200'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5201 dependent) or half the amount of memory
5202 available)
5203 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005204 Maximum amount of memory in Kbyte to use for all buffers together.
5205 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005206 without a limit.
5207 On 64 bit machines higher values might work. But hey, do you really
5208 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005209 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005210 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005211 Buffers with 'swapfile' off still count to the total amount of memory
5212 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005213 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214
5215 *'menuitems'* *'mis'*
5216'menuitems' 'mis' number (default 25)
5217 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 {not available when compiled without the |+menu|
5219 feature}
5220 Maximum number of items to use in a menu. Used for menus that are
5221 generated from a list of items, e.g., the Buffers menu. Changing this
5222 option has no direct effect, the menu must be refreshed first.
5223
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005224 *'mkspellmem'* *'msm'*
5225'mkspellmem' 'msm' string (default "460000,2000,500")
5226 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005227 {not available when compiled without the |+syntax|
5228 feature}
5229 Parameters for |:mkspell|. This tunes when to start compressing the
5230 word tree. Compression can be slow when there are many words, but
5231 it's needed to avoid running out of memory. The amount of memory used
5232 per word depends very much on how similar the words are, that's why
5233 this tuning is complicated.
5234
5235 There are three numbers, separated by commas:
5236 {start},{inc},{added}
5237
5238 For most languages the uncompressed word tree fits in memory. {start}
5239 gives the amount of memory in Kbyte that can be used before any
5240 compression is done. It should be a bit smaller than the amount of
5241 memory that is available to Vim.
5242
5243 When going over the {start} limit the {inc} number specifies the
5244 amount of memory in Kbyte that can be allocated before another
5245 compression is done. A low number means compression is done after
5246 less words are added, which is slow. A high number means more memory
5247 will be allocated.
5248
5249 After doing compression, {added} times 1024 words can be added before
5250 the {inc} limit is ignored and compression is done when any extra
5251 amount of memory is needed. A low number means there is a smaller
5252 chance of hitting the {inc} limit, less memory is used but it's
5253 slower.
5254
5255 The languages for which these numbers are important are Italian and
5256 Hungarian. The default works for when you have about 512 Mbyte. If
5257 you have 1 Gbyte you could use: >
5258 :set mkspellmem=900000,3000,800
5259< If you have less than 512 Mbyte |:mkspell| may fail for some
5260 languages, no matter what you set 'mkspellmem' to.
5261
Bram Moolenaar07607392019-05-26 19:20:43 +02005262 This option cannot be set from a |modeline| or in the |sandbox|.
5263
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005265'modeline' 'ml' boolean (Vim default: on (off for root),
5266 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005268 If 'modeline' is on 'modelines' gives the number of lines that is
5269 checked for set commands. If 'modeline' is off or 'modelines' is zero
5270 no lines are checked. See |modeline|.
5271
5272 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5273'modelineexpr' 'mle' boolean (default: off)
5274 global
5275 When on allow some options that are an expression to be set in the
5276 modeline. Check the option for whether it is affected by
5277 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005278 This option cannot be set from a |modeline| or in the |sandbox|, for
5279 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005280
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 *'modelines'* *'mls'*
5282'modelines' 'mls' number (default 5)
5283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 If 'modeline' is on 'modelines' gives the number of lines that is
5285 checked for set commands. If 'modeline' is off or 'modelines' is zero
5286 no lines are checked. See |modeline|.
5287 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5288 set and to the Vim default value when 'compatible' is reset.
5289
5290 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005291 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292'modifiable' 'ma' boolean (default on)
5293 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 When off the buffer contents cannot be changed. The 'fileformat' and
5295 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005296 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297
5298 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5299'modified' 'mod' boolean (default off)
5300 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 When on, the buffer is considered to be modified. This option is set
5302 when:
5303 1. A change was made to the text since it was last written. Using the
5304 |undo| command to go back to the original text will reset the
5305 option. But undoing changes that were made before writing the
5306 buffer will set the option again, since the text is different from
5307 when it was written.
5308 2. 'fileformat' or 'fileencoding' is different from its original
5309 value. The original value is set when the buffer is read or
5310 written. A ":set nomodified" command also resets the original
5311 values to the current values and the 'modified' option will be
5312 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005313 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005314 This option is not set when a change is made to the buffer as the
5315 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5316 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5317 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5319 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005320 Note that the text may actually be the same, e.g. 'modified' is set
5321 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322
5323 *'more'* *'nomore'*
5324'more' boolean (Vim default: on, Vi default: off)
5325 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326 When on, listings pause when the whole screen is filled. You will get
5327 the |more-prompt|. When this option is off there are no pauses, the
5328 listing continues until finished.
5329 NOTE: This option is set to the Vi default value when 'compatible' is
5330 set and to the Vim default value when 'compatible' is reset.
5331
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005332 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005333'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005334 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005336 Enable the use of the mouse. Works for most terminals (xterm, Win32
5337 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5338 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5339 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005340 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 v Visual mode
5342 i Insert mode
5343 c Command-line mode
5344 h all previous modes when editing a help file
5345 a all previous modes
5346 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005347 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005349< If your terminal can't overrule the mouse events going to the
5350 application, use: >
5351 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005352< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005353 back to Vim using the mouse events.
5354 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5355 "xterm".
5356
5357 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358 modeless selection. This doesn't move the text cursor.
5359
5360 See |mouse-using|. Also see |'clipboard'|.
5361
5362 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005363 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364 the mouse buttons can still be used by keeping the shift key pressed.
5365 Also see the 'clipboard' option.
5366
5367 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5368'mousefocus' 'mousef' boolean (default off)
5369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 {only works in the GUI}
5371 The window that the mouse pointer is on is automatically activated.
5372 When changing the window layout or window focus in another way, the
5373 mouse pointer is moved to the window with keyboard focus. Off is the
5374 default because it makes using the pull down menus a little goofy, as
5375 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005376 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005377 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378
5379 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5380'mousehide' 'mh' boolean (default on)
5381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 {only works in the GUI}
5383 When on, the mouse pointer is hidden when characters are typed.
5384 The mouse pointer is restored when the mouse is moved.
5385
5386 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005387'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 Sets the model to use for the mouse. The name mostly specifies what
5390 the right mouse button is used for:
5391 extend Right mouse button extends a selection. This works
5392 like in an xterm.
5393 popup Right mouse button pops up a menu. The shifted left
5394 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005395 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 popup_setpos Like "popup", but the cursor will be moved to the
5397 position where the mouse was clicked, and thus the
5398 selected operation will act upon the clicked object.
5399 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005400 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 course, that right clicking outside a selection will
5402 end Visual mode.
5403 Overview of what button does what for each model:
5404 mouse extend popup(_setpos) ~
5405 left click place cursor place cursor
5406 left drag start selection start selection
5407 shift-left search word extend selection
5408 right click extend selection popup menu (place cursor)
5409 right drag extend selection -
5410 middle click paste paste
5411
5412 In the "popup" model the right mouse button produces a pop-up menu.
5413 You need to define this first, see |popup-menu|.
5414
5415 Note that you can further refine the meaning of buttons with mappings.
5416 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5417 selection (because that's handled in the GUI code directly).
5418
5419 The 'mousemodel' option is set by the |:behave| command.
5420
5421 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005422'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5423 vs:leftright,vd:lrsizing,m:no,
5424 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 {only available when compiled with the |+mouseshape|
5427 feature}
5428 This option tells Vim what the mouse pointer should look like in
5429 different modes. The option is a comma separated list of parts, much
5430 like used for 'guicursor'. Each part consist of a mode/location-list
5431 and an argument-list:
5432 mode-list:shape,mode-list:shape,..
5433 The mode-list is a dash separated list of these modes/locations:
5434 In a normal window: ~
5435 n Normal mode
5436 v Visual mode
5437 ve Visual mode with 'selection' "exclusive" (same as 'v',
5438 if not specified)
5439 o Operator-pending mode
5440 i Insert mode
5441 r Replace mode
5442
5443 Others: ~
5444 c appending to the command-line
5445 ci inserting in the command-line
5446 cr replacing in the command-line
5447 m at the 'Hit ENTER' or 'More' prompts
5448 ml idem, but cursor in the last line
5449 e any mode, pointer below last window
5450 s any mode, pointer on a status line
5451 sd any mode, while dragging a status line
5452 vs any mode, pointer on a vertical separator line
5453 vd any mode, while dragging a vertical separator line
5454 a everywhere
5455
5456 The shape is one of the following:
5457 avail name looks like ~
5458 w x arrow Normal mouse pointer
5459 w x blank no pointer at all (use with care!)
5460 w x beam I-beam
5461 w x updown up-down sizing arrows
5462 w x leftright left-right sizing arrows
5463 w x busy The system's usual busy pointer
5464 w x no The system's usual 'no input' pointer
5465 x udsizing indicates up-down resizing
5466 x lrsizing indicates left-right resizing
5467 x crosshair like a big thin +
5468 x hand1 black hand
5469 x hand2 white hand
5470 x pencil what you write with
5471 x question big ?
5472 x rightup-arrow arrow pointing right-up
5473 w x up-arrow arrow pointing up
5474 x <number> any X11 pointer number (see X11/cursorfont.h)
5475
5476 The "avail" column contains a 'w' if the shape is available for Win32,
5477 x for X11.
5478 Any modes not specified or shapes not available use the normal mouse
5479 pointer.
5480
5481 Example: >
5482 :set mouseshape=s:udsizing,m:no
5483< will make the mouse turn to a sizing arrow over the status lines and
5484 indicate no input when the hit-enter prompt is displayed (since
5485 clicking the mouse has no effect in this state.)
5486
5487 *'mousetime'* *'mouset'*
5488'mousetime' 'mouset' number (default 500)
5489 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005490 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 time in msec between two mouse clicks for the second click to be
5492 recognized as a multi click.
5493
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005494 *'mzschemedll'*
5495'mzschemedll' string (default depends on the build)
5496 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005497 {only available when compiled with the |+mzscheme/dyn|
5498 feature}
5499 Specifies the name of the MzScheme shared library. The default is
5500 DYNAMIC_MZSCH_DLL which was specified at compile time.
5501 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005502 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005503 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005504 This option cannot be set from a |modeline| or in the |sandbox|, for
5505 security reasons.
5506
5507 *'mzschemegcdll'*
5508'mzschemegcdll' string (default depends on the build)
5509 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005510 {only available when compiled with the |+mzscheme/dyn|
5511 feature}
5512 Specifies the name of the MzScheme GC shared library. The default is
5513 DYNAMIC_MZGC_DLL which was specified at compile time.
5514 The value can be equal to 'mzschemedll' if it includes the GC code.
5515 Environment variables are expanded |:set_env|.
5516 This option cannot be set from a |modeline| or in the |sandbox|, for
5517 security reasons.
5518
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005519 *'mzquantum'* *'mzq'*
5520'mzquantum' 'mzq' number (default 100)
5521 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005522 {not available when compiled without the |+mzscheme|
5523 feature}
5524 The number of milliseconds between polls for MzScheme threads.
5525 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005526 NOTE: This option is set to the Vim default value when 'compatible'
5527 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005528
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005530'nrformats' 'nf' string (default "bin,octal,hex",
5531 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 This defines what bases Vim will consider for numbers when using the
5534 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5535 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005536 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005538 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005539 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005541 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 considered to be hexadecimal. Example: Using CTRL-X on
5543 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005544 bin If included, numbers starting with "0b" or "0B" will be
5545 considered to be binary. Example: Using CTRL-X on
5546 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005547 unsigned If included, numbers are recognized as unsigned. Thus a
5548 leading dash or negative sign won't be considered as part of
5549 the number. Examples:
5550 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5551 (without "unsigned" it would become "9-2021").
5552 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5553 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005554 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5555 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 Numbers which simply begin with a digit in the range 1-9 are always
5557 considered decimal. This also happens for numbers that are not
5558 recognized as octal or hex.
5559
5560 *'number'* *'nu'* *'nonumber'* *'nonu'*
5561'number' 'nu' boolean (default off)
5562 local to window
5563 Print the line number in front of each line. When the 'n' option is
5564 excluded from 'cpoptions' a wrapped line will not use the column of
5565 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005566 The 'numberwidth' option can be used to set the room used for the line
5567 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 When a long, wrapped line doesn't start with the first character, '-'
5569 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005570 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5571 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005572 *number_relativenumber*
5573 The 'relativenumber' option changes the displayed number to be
5574 relative to the cursor. Together with 'number' there are these
5575 four combinations (cursor in line 3):
5576
Bram Moolenaar3848e002016-03-19 18:42:29 +01005577 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005578 'nornu' 'nornu' 'rnu' 'rnu'
5579
5580 |apple | 1 apple | 2 apple | 2 apple
5581 |pear | 2 pear | 1 pear | 1 pear
5582 |nobody | 3 nobody | 0 nobody |3 nobody
5583 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005585 *'numberwidth'* *'nuw'*
5586'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5587 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005588 {only available when compiled with the |+linebreak|
5589 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005590 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005591 when the 'number' or 'relativenumber' option is set or printing lines
5592 with a line number. Since one space is always between the number and
5593 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005594 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005595 fit the highest line number in the buffer respectively the number of
5596 rows in the window, depending on whether 'number' or 'relativenumber'
5597 is set. Thus with the Vim default of 4 there is room for a line number
5598 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005599 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005600 NOTE: This option is set to the Vi default value when 'compatible' is
5601 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005602
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005603 *'omnifunc'* *'ofu'*
5604'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005605 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005606 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005607 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005608 This option specifies a function to be used for Insert mode omni
5609 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005610 See |complete-functions| for an explanation of how the function is
5611 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005612 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005613 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005614 This option cannot be set from a |modeline| or in the |sandbox|, for
5615 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005616
5617
Bram Moolenaar02467872007-05-06 13:22:01 +00005618 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005619'opendevice' 'odev' boolean (default off)
5620 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005621 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005622 Enable reading and writing from devices. This may get Vim stuck on a
5623 device that can be opened but doesn't actually do the I/O. Therefore
5624 it is off by default.
5625 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5626 result in editing a device.
5627
5628
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005629 *'operatorfunc'* *'opfunc'*
5630'operatorfunc' 'opfunc' string (default: empty)
5631 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005632 This option specifies a function to be called by the |g@| operator.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00005633 See |:map-operator| for more info and an example. The value can be
5634 the name of a function, a |lambda| or a |Funcref|. See
5635 |option-value-function| for more information.
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005636
5637 This option cannot be set from a |modeline| or in the |sandbox|, for
5638 security reasons.
5639
5640
Bram Moolenaar251e1912011-06-19 05:09:16 +02005641 *'osfiletype'* *'oft'*
5642'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005644 This option was supported on RISC OS, which has been removed.
5645
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005647 *'packpath'* *'pp'*
5648'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005649 Directories used to find packages. See |packages|.
5650
5651
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005653'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 global
5655 Specifies the nroff macros that separate paragraphs. These are pairs
5656 of two letters (see |object-motions|).
5657
5658 *'paste'* *'nopaste'*
5659'paste' boolean (default off)
5660 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005661 Put Vim in Paste mode. This is useful if you want to cut or copy
5662 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 unexpected effects.
5664 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005665 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 knows about pasting and will mostly do the right thing without 'paste'
5667 being set. The same is true for a terminal where Vim handles the
5668 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005669 This option is reset when starting the GUI. Thus if you set it in
5670 your .vimrc it will work in a terminal, but not in the GUI. Setting
5671 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5672 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 When the 'paste' option is switched on (also when it was already on):
5674 - mapping in Insert mode and Command-line mode is disabled
5675 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005677 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005678 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 - 'revins' is reset
5680 - 'ruler' is reset
5681 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005682 - 'smarttab' is reset
5683 - 'softtabstop' is set to 0
5684 - 'textwidth' is set to 0
5685 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005686 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005689 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005690 - 'indentexpr'
5691 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005692 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 NOTE: When you start editing another file while the 'paste' option is
5694 on, settings from the modelines or autocommands may change the
5695 settings again, causing trouble when pasting text. You might want to
5696 set the 'paste' option again.
5697 When the 'paste' option is reset the mentioned options are restored to
5698 the value before the moment 'paste' was switched from off to on.
5699 Resetting 'paste' before ever setting it does not have any effect.
5700 Since mapping doesn't work while 'paste' is active, you need to use
5701 the 'pastetoggle' option to toggle the 'paste' option with some key.
5702
5703 *'pastetoggle'* *'pt'*
5704'pastetoggle' 'pt' string (default "")
5705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 When non-empty, specifies the key sequence that toggles the 'paste'
5707 option. This is like specifying a mapping: >
5708 :map {keys} :set invpaste<CR>
5709< Where {keys} is the value of 'pastetoggle'.
5710 The difference is that it will work even when 'paste' is set.
5711 'pastetoggle' works in Insert mode and Normal mode, but not in
5712 Command-line mode.
5713 Mappings are checked first, thus overrule 'pastetoggle'. However,
5714 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5715 this: >
5716 :map <F10> :set paste<CR>
5717 :map <F11> :set nopaste<CR>
5718 :imap <F10> <C-O>:set paste<CR>
5719 :imap <F11> <nop>
5720 :set pastetoggle=<F11>
5721< This will make <F10> start paste mode and <F11> stop paste mode.
5722 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5723 mode everything is inserted literally, except the 'pastetoggle' key
5724 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005725 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726
5727 *'pex'* *'patchexpr'*
5728'patchexpr' 'pex' string (default "")
5729 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 {not available when compiled without the |+diff|
5731 feature}
5732 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005733 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734
Bram Moolenaardbc28022014-07-26 13:40:44 +02005735 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736'patchmode' 'pm' string (default "")
5737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 When non-empty the oldest version of a file is kept. This can be used
5739 to keep the original version of a file if you are changing files in a
5740 source distribution. Only the first time that a file is written a
5741 copy of the original file will be kept. The name of the copy is the
5742 name of the original file with the string in the 'patchmode' option
5743 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005744 ".orig" or ".org". 'backupdir' must not be empty for this to work
5745 (Detail: The backup file is renamed to the patchmode file after the
5746 new file has been successfully written, that's why it must be possible
5747 to write a backup file). If there was no file to be backed up, an
5748 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 When the 'backupskip' pattern matches, a patchmode file is not made.
5750 Using 'patchmode' for compressed files appends the extension at the
5751 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5752 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005753 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005755 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 other systems: ".,,")
5758 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005760 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5761 provided that the file being searched for has a relative path (not
5762 starting with "/", "./" or "../"). The directories in the 'path'
5763 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 - Use commas to separate directory names: >
5765 :set path=.,/usr/local/include,/usr/include
5766< - Spaces can also be used to separate directory names (for backwards
5767 compatibility with version 3.0). To have a space in a directory
5768 name, precede it with an extra backslash, and escape the space: >
5769 :set path=.,/dir/with\\\ space
5770< - To include a comma in a directory name precede it with an extra
5771 backslash: >
5772 :set path=.,/dir/with\\,comma
5773< - To search relative to the directory of the current file, use: >
5774 :set path=.
5775< - To search in the current directory use an empty string between two
5776 commas: >
5777 :set path=,,
5778< - A directory name may end in a ':' or '/'.
5779 - Environment variables are expanded |:set_env|.
5780 - When using |netrw.vim| URLs can be used. For example, adding
5781 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005782 - Search upwards and downwards in a directory tree using "*", "**" and
5783 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 {not available when compiled without the |+path_extra| feature}
5785 - Careful with '\' characters, type two to get one in the option: >
5786 :set path=.,c:\\include
5787< Or just use '/' instead: >
5788 :set path=.,c:/include
5789< Don't forget "." or files won't even be found in the same directory as
5790 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005791 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 it is something like 256 or 1024 characters.
5793 You can check if all the include files are found, using the value of
5794 'path', see |:checkpath|.
5795 The use of |:set+=| and |:set-=| is preferred when adding or removing
5796 directories from the list. This avoids problems when a future version
5797 uses another default. To remove the current directory use: >
5798 :set path-=
5799< To add the current directory use: >
5800 :set path+=
5801< To use an environment variable, you probably need to replace the
5802 separator. Here is an example to append $INCL, in which directory
5803 names are separated with a semi-colon: >
5804 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5805< Replace the ';' with a ':' or whatever separator is used. Note that
5806 this doesn't work when $INCL contains a comma or white space.
5807
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005808 *'perldll'*
5809'perldll' string (default depends on the build)
5810 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005811 {only available when compiled with the |+perl/dyn|
5812 feature}
5813 Specifies the name of the Perl shared library. The default is
5814 DYNAMIC_PERL_DLL, which was specified at compile time.
5815 Environment variables are expanded |:set_env|.
5816 This option cannot be set from a |modeline| or in the |sandbox|, for
5817 security reasons.
5818
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5820'preserveindent' 'pi' boolean (default off)
5821 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 When changing the indent of the current line, preserve as much of the
5823 indent structure as possible. Normally the indent is replaced by a
5824 series of tabs followed by spaces as required (unless |'expandtab'| is
5825 enabled, in which case only spaces are used). Enabling this option
5826 means the indent will preserve as many existing characters as possible
5827 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005828 'expandtab' does not apply to the preserved white space, a Tab remains
5829 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 NOTE: When using ">>" multiple times the resulting indent is a mix of
5831 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005832 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 Also see 'copyindent'.
5834 Use |:retab| to clean up white space.
5835
5836 *'previewheight'* *'pvh'*
5837'previewheight' 'pvh' number (default 12)
5838 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005839 {not available when compiled without the |+quickfix|
5840 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005842 commands. Used for |CTRL-W_}| when no count is given. Not used when
5843 'previewpopup' is set.
5844
5845 *'previewpopup'* *'pvp'*
5846'previewpopup' 'pvp' string (default empty)
5847 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005848 {not available when compiled without the |+textprop|
5849 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005850 When not empty a popup window is used for commands that would open a
5851 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005852 Not used for the insert completion info, add "popup" to
5853 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854
5855 *'previewwindow'* *'nopreviewwindow'*
5856 *'pvw'* *'nopvw'* *E590*
5857'previewwindow' 'pvw' boolean (default off)
5858 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005859 {not available when compiled without the |+quickfix|
5860 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005861 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862 set. It's normally not set directly, but by using one of the commands
5863 |:ptag|, |:pedit|, etc.
5864
5865 *'printdevice'* *'pdev'*
5866'printdevice' 'pdev' string (default empty)
5867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 {only available when compiled with the |+printer|
5869 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005870 The name of the printer to be used for |:hardcopy|.
5871 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005872 This option cannot be set from a |modeline| or in the |sandbox|, for
5873 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874
Bram Moolenaar8299df92004-07-10 09:47:34 +00005875 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005876'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 {only available when compiled with the |+printer|
5879 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005880 Sets the character encoding used when printing.
5881 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882
5883 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005884'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 {only available when compiled with the |+printer|
5887 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005888 Expression used to print the PostScript produced with |:hardcopy|.
5889 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005890 This option cannot be set from a |modeline| or in the |sandbox|, for
5891 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892
Bram Moolenaar8299df92004-07-10 09:47:34 +00005893 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894'printfont' 'pfn' string (default "courier")
5895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 {only available when compiled with the |+printer|
5897 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005898 The name of the font that will be used for |:hardcopy|.
5899 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900
5901 *'printheader'* *'pheader'*
5902'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 {only available when compiled with the |+printer|
5905 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005906 The format of the header produced in |:hardcopy| output.
5907 See |pheader-option|.
5908
5909 *'printmbcharset'* *'pmbcs'*
5910'printmbcharset' 'pmbcs' string (default "")
5911 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005912 {only available when compiled with the |+printer|
5913 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005914 The CJK character set to be used for CJK output from |:hardcopy|.
5915 See |pmbcs-option|.
5916
5917 *'printmbfont'* *'pmbfn'*
5918'printmbfont' 'pmbfn' string (default "")
5919 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005920 {only available when compiled with the |+printer|
5921 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005922 List of font names to be used for CJK output from |:hardcopy|.
5923 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924
5925 *'printoptions'* *'popt'*
5926'printoptions' 'popt' string (default "")
5927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005929 List of items that control the format of the output of |:hardcopy|.
5930 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005932 *'prompt'* *'noprompt'*
5933'prompt' boolean (default on)
5934 global
5935 When on a ":" prompt is used in Ex mode.
5936
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005937 *'pumheight'* *'ph'*
5938'pumheight' 'ph' number (default 0)
5939 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005940 Determines the maximum number of items to show in the popup menu for
5941 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005942 |ins-completion-menu|.
5943
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005944 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005945'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005946 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005947 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005948 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005949
Bram Moolenaard94464e2015-11-02 15:28:18 +01005950 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005951'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005952 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005953 {only available when compiled with the |+python/dyn|
5954 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005955 Specifies the name of the Python 2.x shared library. The default is
5956 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005957 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005958 This option cannot be set from a |modeline| or in the |sandbox|, for
5959 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005960
Bram Moolenaar94073162018-01-31 21:49:05 +01005961 *'pythonhome'*
5962'pythonhome' string (default "")
5963 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005964 {only available when compiled with the |+python/dyn|
5965 feature}
5966 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5967 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5968 which was specified at compile time, will be used for the Python 2.x
5969 home directory.
5970 Environment variables are expanded |:set_env|.
5971 This option cannot be set from a |modeline| or in the |sandbox|, for
5972 security reasons.
5973
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005974 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005975'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005976 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005977 {only available when compiled with the |+python3/dyn|
5978 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005979 Specifies the name of the Python 3 shared library. The default is
5980 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005981 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005982 This option cannot be set from a |modeline| or in the |sandbox|, for
5983 security reasons.
5984
Bram Moolenaar94073162018-01-31 21:49:05 +01005985 *'pythonthreehome'*
5986'pythonthreehome' string (default "")
5987 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005988 {only available when compiled with the |+python3/dyn|
5989 feature}
5990 Specifies the name of the Python 3 home directory. When
5991 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5992 PYTHON3_HOME, which was specified at compile time, will be used for
5993 the Python 3 home directory.
5994 Environment variables are expanded |:set_env|.
5995 This option cannot be set from a |modeline| or in the |sandbox|, for
5996 security reasons.
5997
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005998 *'pyxversion'* *'pyx'*
5999'pyxversion' 'pyx' number (default depends on the build)
6000 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006001 {only available when compiled with the |+python| or
6002 the |+python3| feature}
6003 Specifies the python version used for pyx* functions and commands
6004 |python_x|. The default value is as follows:
6005
6006 Compiled with Default ~
6007 |+python| and |+python3| 0
6008 only |+python| 2
6009 only |+python3| 3
6010
6011 Available values are 0, 2 and 3.
6012 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6013 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6014 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6015 to 2 if Python 2 is available.
6016 See also: |has-pythonx|
6017
6018 If Vim is compiled with only |+python| or |+python3| setting
6019 'pyxversion' has no effect. The pyx* functions and commands are
6020 always the same as the compiled version.
6021
6022 This option cannot be set from a |modeline| or in the |sandbox|, for
6023 security reasons.
6024
Bram Moolenaar858ba062020-05-31 23:11:59 +02006025 *'quickfixtextfunc'* *'qftf'*
6026'quickfixtextfunc' 'qftf' string (default "")
6027 global
6028 {only available when compiled with the |+quickfix|
6029 feature}
6030 This option specifies a function to be used to get the text to display
6031 in the quickfix and location list windows. This can be used to
6032 customize the information displayed in the quickfix or location window
6033 for each entry in the corresponding quickfix or location list. See
6034 |quickfix-window-function| for an explanation of how to write the
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00006035 function and an example. The value can be the name of a function, a
6036 |lambda| or a |Funcref|. See |option-value-function| for more
6037 information.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006038
6039 This option cannot be set from a |modeline| or in the |sandbox|, for
6040 security reasons.
6041
Bram Moolenaar677ee682005-01-27 14:41:15 +00006042 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006043'quoteescape' 'qe' string (default "\")
6044 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006045 The characters that are used to escape quotes in a string. Used for
6046 objects like a', a" and a` |a'|.
6047 When one of the characters in this option is found inside a string,
6048 the following character will be skipped. The default value makes the
6049 text "foo\"bar\\" considered to be one string.
6050
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6052'readonly' 'ro' boolean (default off)
6053 local to buffer
6054 If on, writes fail unless you use a '!'. Protects you from
6055 accidentally overwriting a file. Default on when Vim is started
6056 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006057 When using ":w!" the 'readonly' option is reset for the current
6058 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006059 When using the ":view" command the 'readonly' option is set for the
6060 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006061 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006063 *'redrawtime'* *'rdt'*
6064'redrawtime' 'rdt' number (default 2000)
6065 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006066 {only available when compiled with the |+reltime|
6067 feature}
6068 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006069 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006070 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006071 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006072 matches will be highlighted.
6073 For syntax highlighting the time applies per window. When over the
6074 limit syntax highlighting is disabled until |CTRL-L| is used.
6075 This is used to avoid that Vim hangs when using a very complicated
6076 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006077
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006078 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006079'regexpengine' 're' number (default 0)
6080 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006081 This selects the default regexp engine. |two-engines|
6082 The possible values are:
6083 0 automatic selection
6084 1 old engine
6085 2 NFA engine
6086 Note that when using the NFA engine and the pattern contains something
6087 that is not supported the pattern will not match. This is only useful
6088 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006089 Using automatic selection enables Vim to switch the engine, if the
6090 default engine becomes too costly. E.g., when the NFA engine uses too
6091 many states. This should prevent Vim from hanging on a combination of
6092 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006093
Bram Moolenaar64486672010-05-16 15:46:46 +02006094 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6095'relativenumber' 'rnu' boolean (default off)
6096 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006097 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006098 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006099 precede some vertical motion commands (e.g. j k + -) with, without
6100 having to calculate it yourself. Especially useful in combination with
6101 other commands (e.g. y d c < > gq gw =).
6102 When the 'n' option is excluded from 'cpoptions' a wrapped
6103 line will not use the column of line numbers (this is the default when
6104 'compatible' isn't set).
6105 The 'numberwidth' option can be used to set the room used for the line
6106 number.
6107 When a long, wrapped line doesn't start with the first character, '-'
6108 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006109 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6110 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006111
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006112 The number in front of the cursor line also depends on the value of
6113 'number', see |number_relativenumber| for all combinations of the two
6114 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006115
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 *'remap'* *'noremap'*
6117'remap' boolean (default on)
6118 global
6119 Allows for mappings to work recursively. If you do not want this for
6120 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006121 NOTE: To avoid portability problems with Vim scripts, always keep
6122 this option at the default "on". Only switch it off when working with
6123 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006125 *'renderoptions'* *'rop'*
6126'renderoptions' 'rop' string (default: empty)
6127 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006128 {only available when compiled with GUI and DIRECTX on
6129 MS-Windows}
6130 Select a text renderer and set its options. The options depend on the
6131 renderer.
6132
6133 Syntax: >
6134 set rop=type:{renderer}(,{name}:{value})*
6135<
6136 Currently, only one optional renderer is available.
6137
6138 render behavior ~
6139 directx Vim will draw text using DirectX (DirectWrite). It makes
6140 drawn glyphs more beautiful than default GDI.
6141 It requires 'encoding' is "utf-8", and only works on
6142 MS-Windows Vista or newer version.
6143
6144 Options:
6145 name meaning type value ~
6146 gamma gamma float 1.0 - 2.2 (maybe)
6147 contrast enhancedContrast float (unknown)
6148 level clearTypeLevel float (unknown)
6149 geom pixelGeometry int 0 - 2 (see below)
6150 renmode renderingMode int 0 - 6 (see below)
6151 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006152 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006153
Bram Moolenaar92467d32017-12-05 13:22:16 +01006154 See this URL for detail (except for scrlines):
6155 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006156
6157 For geom: structure of a device pixel.
6158 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6159 1 - DWRITE_PIXEL_GEOMETRY_RGB
6160 2 - DWRITE_PIXEL_GEOMETRY_BGR
6161
6162 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006163 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006164
6165 For renmode: method of rendering glyphs.
6166 0 - DWRITE_RENDERING_MODE_DEFAULT
6167 1 - DWRITE_RENDERING_MODE_ALIASED
6168 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6169 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6170 4 - DWRITE_RENDERING_MODE_NATURAL
6171 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6172 6 - DWRITE_RENDERING_MODE_OUTLINE
6173
6174 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006175 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006176
6177 For taamode: antialiasing mode used for drawing text.
6178 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6179 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6180 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6181 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6182
6183 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006184 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6185
Bram Moolenaara338adc2018-01-31 20:51:47 +01006186 For scrlines:
6187 This was used for optimizing scrolling behavior, however this
6188 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006189
6190 Example: >
6191 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006192 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006193 set rop=type:directx
6194<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006195 If select a raster font (Courier, Terminal or FixedSys which
6196 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006197 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006198
6199 NOTE: It is known that some fonts and options combination
6200 causes trouble on drawing glyphs.
6201
Bram Moolenaar92467d32017-12-05 13:22:16 +01006202 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006203 special made fonts (True-Type fonts which includes only
6204 bitmap glyphs).
6205 - 'taamode:3' will not work with some vector fonts.
6206
6207 NOTE: With this option, you can display colored emoji
6208 (emoticon) in Windows 8.1 or later. To display colored emoji,
6209 there are some conditions which you should notice.
6210
6211 - If your font includes non-colored emoji already, it will
6212 be used.
6213 - If your font doesn't have emoji, the system chooses an
6214 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6215 will be used.
6216 - When this alternative font didn't have fixed width glyph,
6217 emoji might be rendered beyond the bounding box of drawing
6218 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006219
6220 Other render types are currently not supported.
6221
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 *'report'*
6223'report' number (default 2)
6224 global
6225 Threshold for reporting number of lines changed. When the number of
6226 changed lines is more than 'report' a message will be given for most
6227 ":" commands. If you want it always, set 'report' to 0.
6228 For the ":substitute" command the number of substitutions is used
6229 instead of the number of lines.
6230
6231 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6232'restorescreen' 'rs' boolean (default on)
6233 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006234 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 When set, the screen contents is restored when exiting Vim. This also
6236 happens when executing external commands.
6237
6238 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6239 options in your .vimrc. To disable restoring:
6240 set t_ti= t_te=
6241 To enable restoring (for an xterm):
6242 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6243 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6244
6245 *'revins'* *'ri'* *'norevins'* *'nori'*
6246'revins' 'ri' boolean (default off)
6247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 {only available when compiled with the |+rightleft|
6249 feature}
6250 Inserting characters in Insert mode will work backwards. See "typing
6251 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6252 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006253 NOTE: This option is reset when 'compatible' is set.
6254 This option is reset when 'paste' is set and restored when 'paste' is
6255 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256
6257 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6258'rightleft' 'rl' boolean (default off)
6259 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 {only available when compiled with the |+rightleft|
6261 feature}
6262 When on, display orientation becomes right-to-left, i.e., characters
6263 that are stored in the file appear from the right to the left.
6264 Using this option, it is possible to edit files for languages that
6265 are written from the right to the left such as Hebrew and Arabic.
6266 This option is per window, so it is possible to edit mixed files
6267 simultaneously, or to view the same file in both ways (this is
6268 useful whenever you have a mixed text file with both right-to-left
6269 and left-to-right strings so that both sets are displayed properly
6270 in different windows). Also see |rileft.txt|.
6271
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006272 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273'rightleftcmd' 'rlc' string (default "search")
6274 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006275 {only available when compiled with the |+rightleft|
6276 feature}
6277 Each word in this option enables the command line editing to work in
6278 right-to-left mode for a group of commands:
6279
6280 search "/" and "?" commands
6281
6282 This is useful for languages such as Hebrew, Arabic and Farsi.
6283 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6284
Bram Moolenaard94464e2015-11-02 15:28:18 +01006285 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006286'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006287 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006288 {only available when compiled with the |+ruby/dyn|
6289 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006290 Specifies the name of the Ruby shared library. The default is
6291 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006292 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006293 This option cannot be set from a |modeline| or in the |sandbox|, for
6294 security reasons.
6295
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006297'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299 {not available when compiled without the
6300 |+cmdline_info| feature}
6301 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006302 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 text in the file is shown on the far right:
6304 Top first line is visible
6305 Bot last line is visible
6306 All first and last line are visible
6307 45% relative position in the file
6308 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006309 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006311 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 this option takes precedence over 'ruler' and 'rulerformat'
6313 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006314 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 the text column (byte number) and the screen column are shown,
6316 separated with a dash.
6317 For an empty line "0-1" is shown.
6318 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006319 This option is reset when 'paste' is set and restored when 'paste' is
6320 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 If you don't want to see the ruler all the time but want to know where
6322 you are, use "g CTRL-G" |g_CTRL-G|.
6323 NOTE: This option is reset when 'compatible' is set.
6324
6325 *'rulerformat'* *'ruf'*
6326'rulerformat' 'ruf' string (default empty)
6327 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 {not available when compiled without the |+statusline|
6329 feature}
6330 When this option is not empty, it determines the content of the ruler
6331 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006332 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006333 This option cannot be set in a modeline when 'modelineexpr' is off.
6334
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 The default ruler width is 17 characters. To make the ruler 15
6336 characters wide, put "%15(" at the start and "%)" at the end.
6337 Example: >
6338 :set rulerformat=%15(%c%V\ %p%%%)
6339<
6340 *'runtimepath'* *'rtp'* *vimfiles*
6341'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006342 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 $VIM/vimfiles,
6344 $VIMRUNTIME,
6345 $VIM/vimfiles/after,
6346 $HOME/.vim/after"
6347 Amiga: "home:vimfiles,
6348 $VIM/vimfiles,
6349 $VIMRUNTIME,
6350 $VIM/vimfiles/after,
6351 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006352 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 $VIM/vimfiles,
6354 $VIMRUNTIME,
6355 $VIM/vimfiles/after,
6356 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006357 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358 $VIMRUNTIME,
6359 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006360 Haiku: "$BE_USER_SETTINGS/vim,
6361 $VIM/vimfiles,
6362 $VIMRUNTIME,
6363 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006364 $BE_USER_SETTINGS/vim/after"
6365 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 $VIM/vimfiles,
6367 $VIMRUNTIME,
6368 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006369 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 This is a list of directories which will be searched for runtime
6372 files:
6373 filetype.vim filetypes by file name |new-filetype|
6374 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006375 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 colors/ color scheme files |:colorscheme|
6377 compiler/ compiler files |:compiler|
6378 doc/ documentation |write-local-help|
6379 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006380 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 indent/ indent scripts |indent-expression|
6382 keymap/ key mapping files |mbyte-keymap|
6383 lang/ menu translations |:menutrans|
6384 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006385 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 plugin/ plugin scripts |write-plugin|
6387 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006388 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 syntax/ syntax files |mysyntaxfile|
6390 tutor/ files for vimtutor |tutor|
6391
6392 And any other file searched for with the |:runtime| command.
6393
6394 The defaults for most systems are setup to search five locations:
6395 1. In your home directory, for your personal preferences.
6396 2. In a system-wide Vim directory, for preferences from the system
6397 administrator.
6398 3. In $VIMRUNTIME, for files distributed with Vim.
6399 *after-directory*
6400 4. In the "after" directory in the system-wide Vim directory. This is
6401 for the system administrator to overrule or add to the distributed
6402 defaults (rarely needed)
6403 5. In the "after" directory in your home directory. This is for
6404 personal preferences to overrule or add to the distributed defaults
6405 or system-wide settings (rarely needed).
6406
Bram Moolenaard0796902016-09-16 20:02:31 +02006407 More entries are added when using |packages|. If it gets very long
6408 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6409 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006410
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6412 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006413 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 wildcards.
6415 See |:runtime|.
6416 Example: >
6417 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6418< This will use the directory "~/vimruntime" first (containing your
6419 personal Vim runtime files), then "/mygroup/vim" (shared between a
6420 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6421 files).
6422 You probably should always include $VIMRUNTIME somewhere, to use the
6423 distributed runtime files. You can put a directory before $VIMRUNTIME
6424 to find files which replace a distributed runtime files. You can put
6425 a directory after $VIMRUNTIME to find files which add to distributed
6426 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006427 When Vim is started with |--clean| the home directory entries are not
6428 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 This option cannot be set from a |modeline| or in the |sandbox|, for
6430 security reasons.
6431
6432 *'scroll'* *'scr'*
6433'scroll' 'scr' number (default: half the window height)
6434 local to window
6435 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6436 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006437 changes. This may happen when enabling the |status-line| or
6438 'tabline' option after setting the 'scroll' option.
6439 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006440 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006441 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442
6443 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6444'scrollbind' 'scb' boolean (default off)
6445 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 See also |scroll-binding|. When this option is set, the current
6447 window scrolls as other scrollbind windows (windows that also have
6448 this option set) scroll. This option is useful for viewing the
6449 differences between two versions of a file, see 'diff'.
6450 See |'scrollopt'| for options that determine how this option should be
6451 interpreted.
6452 This option is mostly reset when splitting a window to edit another
6453 file. This means that ":split | edit file" results in two windows
6454 with scroll-binding, but ":split file" does not.
6455
Bram Moolenaarae20f342019-11-05 21:09:23 +01006456 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6457'scrollfocus' 'scf' boolean (default off)
6458 global
6459 {only for MS-Windows GUI}
6460 When using the scroll wheel and this option is set, the window under
6461 the mouse pointer is scrolled. With this option off the current
6462 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006463 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006464
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 *'scrolljump'* *'sj'*
6466'scrolljump' 'sj' number (default 1)
6467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 Minimal number of lines to scroll when the cursor gets off the
6469 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6470 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006471 When set to a negative number from -1 to -100 this is used as the
6472 percentage of the window height. Thus -50 scrolls half the window
6473 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 NOTE: This option is set to 1 when 'compatible' is set.
6475
6476 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006477'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006478 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 Minimal number of screen lines to keep above and below the cursor.
6480 This will make some context visible around where you are working. If
6481 you set it to a very large value (999) the cursor line will always be
6482 in the middle of the window (except at the start or end of the file or
6483 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006484 After using the local value, go back the global value with one of
6485 these two: >
6486 setlocal scrolloff<
6487 setlocal scrolloff=-1
6488< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 NOTE: This option is set to 0 when 'compatible' is set.
6490
6491 *'scrollopt'* *'sbo'*
6492'scrollopt' 'sbo' string (default "ver,jump")
6493 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006495 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6496 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 The following words are available:
6498 ver Bind vertical scrolling for 'scrollbind' windows
6499 hor Bind horizontal scrolling for 'scrollbind' windows
6500 jump Applies to the offset between two windows for vertical
6501 scrolling. This offset is the difference in the first
6502 displayed line of the bound windows. When moving
6503 around in a window, another 'scrollbind' window may
6504 reach a position before the start or after the end of
6505 the buffer. The offset is not changed though, when
6506 moving back the 'scrollbind' window will try to scroll
6507 to the desired position when possible.
6508 When now making that window the current one, two
6509 things can be done with the relative offset:
6510 1. When "jump" is not included, the relative offset is
6511 adjusted for the scroll position in the new current
6512 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006513 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 2. When "jump" is included, the other windows are
6515 scrolled to keep the same relative offset. When
6516 going back to the other window, it still uses the
6517 same relative offset.
6518 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006519 When 'diff' mode is active there always is vertical scroll binding,
6520 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521
6522 *'sections'* *'sect'*
6523'sections' 'sect' string (default "SHNHH HUnhsh")
6524 global
6525 Specifies the nroff macros that separate sections. These are pairs of
6526 two letters (See |object-motions|). The default makes a section start
6527 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6528
6529 *'secure'* *'nosecure'* *E523*
6530'secure' boolean (default off)
6531 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 When on, ":autocmd", shell and write commands are not allowed in
6533 ".vimrc" and ".exrc" in the current directory and map commands are
6534 displayed. Switch it off only if you know that you will not run into
6535 problems, or when the 'exrc' option is off. On Unix this option is
6536 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006537 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 'secure' at the end of your ~/.vimrc then.
6539 This option cannot be set from a |modeline| or in the |sandbox|, for
6540 security reasons.
6541
6542 *'selection'* *'sel'*
6543'selection' 'sel' string (default "inclusive")
6544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 This option defines the behavior of the selection. It is only used
6546 in Visual and Select mode.
6547 Possible values:
6548 value past line inclusive ~
6549 old no yes
6550 inclusive yes yes
6551 exclusive yes no
6552 "past line" means that the cursor is allowed to be positioned one
6553 character past the line.
6554 "inclusive" means that the last character of the selection is included
6555 in an operation. For example, when "x" is used to delete the
6556 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006557 When "old" is used and 'virtualedit' allows the cursor to move past
6558 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 Note that when "exclusive" is used and selecting from the end
6560 backwards, you cannot include the last character of a line, when
6561 starting in Normal mode and 'virtualedit' empty.
6562
6563 The 'selection' option is set by the |:behave| command.
6564
6565 *'selectmode'* *'slm'*
6566'selectmode' 'slm' string (default "")
6567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 This is a comma separated list of words, which specifies when to start
6569 Select mode instead of Visual mode, when a selection is started.
6570 Possible values:
6571 mouse when using the mouse
6572 key when using shifted special keys
6573 cmd when using "v", "V" or CTRL-V
6574 See |Select-mode|.
6575 The 'selectmode' option is set by the |:behave| command.
6576
6577 *'sessionoptions'* *'ssop'*
6578'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006579 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006581 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 feature}
6583 Changes the effect of the |:mksession| command. It is a comma
6584 separated list of words. Each word enables saving and restoring
6585 something:
6586 word save and restore ~
6587 blank empty windows
6588 buffers hidden and unloaded buffers, not just those in windows
6589 curdir the current directory
6590 folds manually created folds, opened/closed folds and local
6591 fold options
6592 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006593 and contain at least one lowercase letter. Only
6594 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 help the help window
6596 localoptions options and mappings local to a window or buffer (not
6597 global values for local options)
6598 options all options and mappings (also global values for local
6599 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006600 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 resize size of the Vim window: 'lines' and 'columns'
6602 sesdir the directory in which the session file is located
6603 will become the current directory (useful with
6604 projects accessed over a network from different
6605 systems)
6606 slash backslashes in file names replaced with forward
6607 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006608 tabpages all tab pages; without this only the current tab page
6609 is restored, so that you can make a session for each
6610 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006611 terminal include terminal windows where the command can be
6612 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 unix with Unix end-of-line format (single <NL>), even when
6614 on Windows or DOS
6615 winpos position of the whole Vim window
6616 winsize window sizes
6617
6618 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006619 When neither "curdir" nor "sesdir" is included, file names are stored
6620 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 "slash" and "unix" are useful on Windows when sharing session files
6622 with Unix. The Unix version of Vim cannot source dos format scripts,
6623 but the Windows version of Vim can source unix format scripts.
6624
6625 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006626'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 global
6628 Name of the shell to use for ! and :! commands. When changing the
6629 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6630 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006631 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 See |option-backslash| about including spaces and backslashes.
6633 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006634
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006635 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006636 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6638< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006639 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006641 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006643 Example with escaped space (Vim will do this when initializing the
6644 option from $SHELL): >
6645 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006646< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006647 backslashes are consumed by `:set`.
6648
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 Under MS-Windows, when the executable ends in ".com" it must be
6650 included. Thus setting the shell to "command.com" or "4dos.com"
6651 works, but "command" and "4dos" do not work for all commands (e.g.,
6652 filtering).
6653 For unknown reasons, when using "4dos.com" the current directory is
6654 changed to "C:\". To avoid this set 'shell' like this: >
6655 :set shell=command.com\ /c\ 4dos
6656< This option cannot be set from a |modeline| or in the |sandbox|, for
6657 security reasons.
6658
6659 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006660'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006661 Win32, when 'shell' contains "powershell":
6662 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006663 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006666 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6667 For MS-Windows, the default is set according to the value of 'shell',
6668 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006669 On Unix it can have more than one flag. Each white space separated
6670 part is passed as an argument to the shell command.
6671 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006672 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 This option cannot be set from a |modeline| or in the |sandbox|, for
6674 security reasons.
6675
6676 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006677'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6678 "2>&1| tee", or
6679 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 {not available when compiled without the |+quickfix|
6682 feature}
6683 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006684 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 including spaces and backslashes.
6686 The name of the temporary file can be represented by "%s" if necessary
6687 (the file name is appended automatically if no %s appears in the value
6688 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006689 For the Amiga the default is ">". For MS-Windows using powershell the
6690 default is "2>&1 | Out-File -Encoding default", otherwise the default
6691 is ">%s 2>&1". The output is directly saved in a file and not echoed
6692 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006693 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 in a file and echoed to the screen. If the 'shell' option is "csh" or
6695 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006696 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006697 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6698 means that stderr is also included. Before using the 'shell' option a
6699 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006700 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6701 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 The initialization of this option is done after reading the ".vimrc"
6703 and the other initializations, so that when the 'shell' option is set
6704 there, the 'shellpipe' option changes automatically, unless it was
6705 explicitly set before.
6706 When 'shellpipe' is set to an empty string, no redirection of the
6707 ":make" output will be done. This is useful if you use a 'makeprg'
6708 that writes to 'makeef' by itself. If you want no piping, but do
6709 want to include the 'makeef', set 'shellpipe' to a single space.
6710 Don't forget to precede the space with a backslash: ":set sp=\ ".
6711 In the future pipes may be used for filtering and this option will
6712 become obsolete (at least for Unix).
6713 This option cannot be set from a |modeline| or in the |sandbox|, for
6714 security reasons.
6715
6716 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006717'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 Quoting character(s), put around the command passed to the shell, for
6720 the "!" and ":!" commands. The redirection is kept outside of the
6721 quoting. See 'shellxquote' to include the redirection. It's
6722 probably not useful to set both options.
6723 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006724 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006725 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 This option cannot be set from a |modeline| or in the |sandbox|, for
6727 security reasons.
6728
6729 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006730'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6731 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 String to be used to put the output of a filter command in a temporary
6734 file. See also |:!|. See |option-backslash| about including spaces
6735 and backslashes.
6736 The name of the temporary file can be represented by "%s" if necessary
6737 (the file name is appended automatically if no %s appears in the value
6738 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006739 The default is ">". For Unix, if the 'shell' option is "csh" or
6740 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006741 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006742 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6743 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006744 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6745 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006746 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6747 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 The initialization of this option is done after reading the ".vimrc"
6749 and the other initializations, so that when the 'shell' option is set
6750 there, the 'shellredir' option changes automatically unless it was
6751 explicitly set before.
6752 In the future pipes may be used for filtering and this option will
6753 become obsolete (at least for Unix).
6754 This option cannot be set from a |modeline| or in the |sandbox|, for
6755 security reasons.
6756
6757 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6758'shellslash' 'ssl' boolean (default off)
6759 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006760 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006762 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006763 powershell.exe. Backward slashes can still be typed, but they are
6764 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 Note that setting or resetting this option has no effect for some
6766 existing file names, thus this option needs to be set before opening
6767 any file for best results. This might change in the future.
6768 'shellslash' only works when a backslash can be used as a path
6769 separator. To test if this is so use: >
6770 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006771< Also see 'completeslash'.
6772
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006773 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6774'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6775 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006776 When on, use temp files for shell commands. When off use a pipe.
6777 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006778 Currently a pipe is only supported on Unix and MS-Windows 2K and
6779 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006780 :if has("filterpipe")
6781< The advantage of using a pipe is that nobody can read the temp file
6782 and the 'shell' command does not need to support redirection.
6783 The advantage of using a temp file is that the file type and encoding
6784 can be detected.
6785 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6786 |FilterWritePost| autocommands event are not triggered when
6787 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006788 The `system()` function does not respect this option and always uses
6789 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006790 NOTE: This option is set to the Vim default value when 'compatible'
6791 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006792
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 *'shelltype'* *'st'*
6794'shelltype' 'st' number (default 0)
6795 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006796 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 On the Amiga this option influences the way how the commands work
6798 which use a shell.
6799 0 and 1: always use the shell
6800 2 and 3: use the shell only to filter lines
6801 4 and 5: use shell only for ':sh' command
6802 When not using the shell, the command is executed directly.
6803
6804 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6805 1 and 3: use "shell cmd" to start external commands
6806
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006807 *'shellxescape'* *'sxe'*
6808'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006809 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006810 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006811 When 'shellxquote' is set to "(" then the characters listed in this
6812 option will be escaped with a '^' character. This makes it possible
6813 to execute most external commands with cmd.exe.
6814
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 *'shellxquote'* *'sxq'*
6816'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006817 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006818 for Win32, when 'shell' is
6819 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006820 for Win32, when 'shell' contains "sh"
6821 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 for Unix, when using system(): "\"")
6823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 Quoting character(s), put around the command passed to the shell, for
6825 the "!" and ":!" commands. Includes the redirection. See
6826 'shellquote' to exclude the redirection. It's probably not useful
6827 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006828 When the value is '(' then ')' is appended. When the value is '"('
6829 then ')"' is appended.
6830 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006831 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006832 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6833 pwsh.exe which automatically strips off the first and last quote on a
6834 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6835 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006836 'shell', to reduce the need to set this option by the user. See
6837 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 This option cannot be set from a |modeline| or in the |sandbox|, for
6839 security reasons.
6840
6841 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6842'shiftround' 'sr' boolean (default off)
6843 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 Round indent to multiple of 'shiftwidth'. Applies to > and <
6845 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6846 a multiple of 'shiftwidth' (this is Vi compatible).
6847 NOTE: This option is reset when 'compatible' is set.
6848
6849 *'shiftwidth'* *'sw'*
6850'shiftwidth' 'sw' number (default 8)
6851 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006852 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006854 When zero the 'ts' value will be used. Use the |shiftwidth()|
6855 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856
6857 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006858'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6859 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 This option helps to avoid all the |hit-enter| prompts caused by file
6862 messages, for example with CTRL-G, and to avoid some other messages.
6863 It is a list of flags:
6864 flag meaning when present ~
6865 f use "(3 of 5)" instead of "(file 3 of 5)"
6866 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006867 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 m use "[+]" instead of "[Modified]"
6869 n use "[New]" instead of "[New File]"
6870 r use "[RO]" instead of "[readonly]"
6871 w use "[w]" instead of "written" for file write message
6872 and "[a]" instead of "appended" for ':w >> file' command
6873 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6874 "[unix format]" and "[mac]" instead of "[mac format]".
6875 a all of the above abbreviations
6876
6877 o overwrite message for writing a file with subsequent message
6878 for reading a file (useful for ":wn" or when 'autowrite' on)
6879 O message for reading a file overwrites any previous message.
6880 Also for quickfix message (e.g., ":cn").
6881 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006882 hit TOP, continuing at BOTTOM" messages; when using the search
6883 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 t truncate file message at the start if it is too long to fit
6885 on the command-line, "<" will appear in the left most column.
6886 Ignored in Ex mode.
6887 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006888 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 Ignored in Ex mode.
6890 W don't give "written" or "[w]" when writing a file
6891 A don't give the "ATTENTION" message when an existing swap file
6892 is found.
6893 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006894 c don't give |ins-completion-menu| messages. For example,
6895 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6896 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006897 q use "recording" instead of "recording @a"
6898 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006899 was used for the command; note that this also affects messages
6900 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006901 S do not show search count message when searching, e.g.
6902 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903
6904 This gives you the opportunity to avoid that a change between buffers
6905 requires you to hit <Enter>, but still gives as useful a message as
6906 possible for the space available. To get the whole message that you
6907 would have got with 'shm' empty, use ":file!"
6908 Useful values:
6909 shm= No abbreviation of message.
6910 shm=a Abbreviation, but no loss of information.
6911 shm=at Abbreviation, and truncate message when necessary.
6912
6913 NOTE: This option is set to the Vi default value when 'compatible' is
6914 set and to the Vim default value when 'compatible' is reset.
6915
6916 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6917'shortname' 'sn' boolean (default off)
6918 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 Filenames are assumed to be 8 characters plus one extension of 3
6920 characters. Multiple dots in file names are not allowed. When this
6921 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006922 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006924 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925
6926 *'showbreak'* *'sbr'* *E595*
6927'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006928 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006929 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 feature}
6931 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006932 values are "> " or "+++ ": >
6933 :set showbreak=>\
6934< Note the backslash to escape the trailing space. It's easier like
6935 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006936 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006937< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 comma (in a future version the comma might be used to separate the
6939 part that is shown at the end and at the start of a line).
6940 The characters are highlighted according to the '@' flag in
6941 'highlight'.
6942 Note that tabs after the showbreak will be displayed differently.
6943 If you want the 'showbreak' to appear in between line numbers, add the
6944 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006945 A window-local value overrules a global value. If the global value is
6946 set and you want no value in the current window use NONE: >
6947 :setlocal showbreak=NONE
6948<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006950'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6951 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 {not available when compiled without the
6954 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006955 Show (partial) command in the last line of the screen. Set this
6956 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 In Visual mode the size of the selected area is shown:
6958 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006959 If the number of bytes is different it is also displayed: "2-6"
6960 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006962 - When selecting a block, the size in screen characters:
6963 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 NOTE: This option is set to the Vi default value when 'compatible' is
6965 set and to the Vim default value when 'compatible' is reset.
6966
6967 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6968'showfulltag' 'sft' boolean (default off)
6969 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 When completing a word in insert mode (see |ins-completion|) from the
6971 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006972 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 matched a C function, you can see a template for what arguments are
6974 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006975 Note that this doesn't work well together with having "longest" in
6976 'completeopt', because the completion from the search pattern may not
6977 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978
6979 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6980'showmatch' 'sm' boolean (default off)
6981 global
6982 When a bracket is inserted, briefly jump to the matching one. The
6983 jump is only done if the match can be seen on the screen. The time to
6984 show the match can be set with 'matchtime'.
6985 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006986 seen or not).
6987 This option is reset when 'paste' is set and restored when 'paste' is
6988 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 When the 'm' flag is not included in 'cpoptions', typing a character
6990 will immediately move the cursor back to where it belongs.
6991 See the "sm" field in 'guicursor' for setting the cursor shape and
6992 blinking when showing the match.
6993 The 'matchpairs' option can be used to specify the characters to show
6994 matches for. 'rightleft' and 'revins' are used to look for opposite
6995 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006996 Also see the matchparen plugin for highlighting the match when moving
6997 around |pi_paren.txt|.
6998 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999
7000 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7001'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7002 global
7003 If in Insert, Replace or Visual mode put a message on the last line.
7004 Use the 'M' flag in 'highlight' to set the type of highlighting for
7005 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007006 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007 doesn't mean XIM is really active, especially when 'imactivatekey' is
7008 not set.
7009 NOTE: This option is set to the Vi default value when 'compatible' is
7010 set and to the Vim default value when 'compatible' is reset.
7011
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007012 *'showtabline'* *'stal'*
7013'showtabline' 'stal' number (default 1)
7014 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007015 The value of this option specifies when the line with tab page labels
7016 will be displayed:
7017 0: never
7018 1: only if there are at least two tab pages
7019 2: always
7020 This is both for the GUI and non-GUI implementation of the tab pages
7021 line.
7022 See |tab-page| for more information about tab pages.
7023
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 *'sidescroll'* *'ss'*
7025'sidescroll' 'ss' number (default 0)
7026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 The minimal number of columns to scroll horizontally. Used only when
7028 the 'wrap' option is off and the cursor is moved off of the screen.
7029 When it is zero the cursor will be put in the middle of the screen.
7030 When using a slow terminal set it to a large number or 0. When using
7031 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7032 commands.
7033
7034 *'sidescrolloff'* *'siso'*
7035'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007036 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007038 right of the cursor if 'nowrap' is set. Setting this option to a
7039 value greater than 0 while having |'sidescroll'| also at a non-zero
7040 value makes some context visible in the line you are scrolling in
7041 horizontally (except at beginning of the line). Setting this option
7042 to a large value (like 999) has the effect of keeping the cursor
7043 horizontally centered in the window, as long as one does not come too
7044 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007045 After using the local value, go back the global value with one of
7046 these two: >
7047 setlocal sidescrolloff<
7048 setlocal sidescrolloff=-1
7049< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050
7051 Example: Try this together with 'sidescroll' and 'listchars' as
7052 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007053 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007054
7055 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7056 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007057<
7058 *'signcolumn'* *'scl'*
7059'signcolumn' 'scl' string (default "auto")
7060 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007061 {not available when compiled without the |+signs|
7062 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007063 Whether or not to draw the signcolumn. Valid values are:
7064 "auto" only when there is a sign to display
7065 "no" never
7066 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007067 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007068 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069
7070
7071 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7072'smartcase' 'scs' boolean (default off)
7073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 Override the 'ignorecase' option if the search pattern contains upper
7075 case characters. Only used when the search pattern is typed and
7076 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007077 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7079 recalling the search pattern from history and hitting <Enter>.
7080 NOTE: This option is reset when 'compatible' is set.
7081
7082 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7083'smartindent' 'si' boolean (default off)
7084 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085 {not available when compiled without the
7086 |+smartindent| feature}
7087 Do smart autoindenting when starting a new line. Works for C-like
7088 programs, but can also be used for other languages. 'cindent' does
7089 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007090 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007091 setting 'si' has no effect. 'indentexpr' is a more advanced
7092 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 Normally 'autoindent' should also be on when using 'smartindent'.
7094 An indent is automatically inserted:
7095 - After a line ending in '{'.
7096 - After a line starting with a keyword from 'cinwords'.
7097 - Before a line starting with '}' (only with the "O" command).
7098 When typing '}' as the first character in a new line, that line is
7099 given the same indent as the matching '{'.
7100 When typing '#' as the first character in a new line, the indent for
7101 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007102 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7104 When using the ">>" command, lines starting with '#' are not shifted
7105 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007106 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007107 This option is reset when 'paste' is set and restored when 'paste' is
7108 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109
7110 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7111'smarttab' 'sta' boolean (default off)
7112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007114 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7115 <BS> will delete a 'shiftwidth' worth of space at the start of the
7116 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007117 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007118 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7119 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007120 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007122 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007123 This option is reset when 'paste' is set and restored when 'paste' is
7124 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 NOTE: This option is reset when 'compatible' is set.
7126
7127 *'softtabstop'* *'sts'*
7128'softtabstop' 'sts' number (default 0)
7129 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 Number of spaces that a <Tab> counts for while performing editing
7131 operations, like inserting a <Tab> or using <BS>. It "feels" like
7132 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7133 used. This is useful to keep the 'ts' setting at its standard value
7134 of 8, while being able to edit like it is set to 'sts'. However,
7135 commands like "x" still work on the actual characters.
7136 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007137 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007138 'softtabstop' is set to 0 when the 'paste' option is set and restored
7139 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7141 spaces is minimized by using <Tab>s.
7142 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7143 set.
7144 NOTE: This option is set to 0 when 'compatible' is set.
7145
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007146 If Vim is compiled with the |+vartabs| feature then the value of
7147 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7148 anything other than an empty string.
7149
Bram Moolenaar217ad922005-03-20 22:37:15 +00007150 *'spell'* *'nospell'*
7151'spell' boolean (default off)
7152 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007153 {not available when compiled without the |+syntax|
7154 feature}
7155 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007156 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007157
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007158 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007159'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007160 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007161 {not available when compiled without the |+syntax|
7162 feature}
7163 Pattern to locate the end of a sentence. The following word will be
7164 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007165 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007166 When this check is not wanted make this option empty.
7167 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007168 Be careful with special characters, see |option-backslash| about
7169 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007170 To set this option automatically depending on the language, see
7171 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007172
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007173 *'spellfile'* *'spf'*
7174'spellfile' 'spf' string (default empty)
7175 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007176 {not available when compiled without the |+syntax|
7177 feature}
7178 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007179 commands. It must end in ".{encoding}.add". You need to include the
7180 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007181 *E765*
7182 It may also be a comma separated list of names. A count before the
7183 |zg| and |zw| commands can be used to access each. This allows using
7184 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007185 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007186 you: Using the first directory in 'runtimepath' that is writable. If
7187 there is no "spell" directory yet it will be created. For the file
7188 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007189 ignoring the region.
7190 The resulting ".spl" file will be used for spell checking, it does not
7191 have to appear in 'spelllang'.
7192 Normally one file is used for all regions, but you can add the region
7193 name if you want to. However, it will then only be used when
7194 'spellfile' is set to it, for entries in 'spelllang' only files
7195 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007196 This option cannot be set from a |modeline| or in the |sandbox|, for
7197 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007198
Bram Moolenaar217ad922005-03-20 22:37:15 +00007199 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007200'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007201 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007202 {not available when compiled without the |+syntax|
7203 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007204 A comma separated list of word list names. When the 'spell' option is
7205 on spellchecking will be done for these languages. Example: >
7206 set spelllang=en_us,nl,medical
7207< This means US English, Dutch and medical words are recognized. Words
7208 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007209 The word list name must consist of alphanumeric characters, a dash or
7210 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007211 recommended to separate the two letter language name from a
7212 specification. Thus "en-rare" is used for rare English words.
7213 A region name must come last and have the form "_xx", where "xx" is
7214 the two-letter, lower case region name. You can use more than one
7215 region by listing them: "en_us,en_ca" supports both US and Canadian
7216 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007217 Britain. (Note: currently en_au and en_nz dictionaries are older than
7218 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007219 If the name "cjk" is included East Asian characters are excluded from
7220 spell checking. This is useful when editing text that also has Asian
7221 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007222 Note that the "medical" dictionary does not exist, it is just an
7223 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007224 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007225 As a special case the name of a .spl file can be given as-is. The
7226 first "_xx" in the name is removed and used as the region name
7227 (_xx is an underscore, two letters and followed by a non-letter).
7228 This is mainly for testing purposes. You must make sure the correct
7229 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007230 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007231 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7232 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007233 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007234
Bram Moolenaar98692072006-02-04 00:57:42 +00007235 If the |spellfile.vim| plugin is active and you use a language name
7236 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7237 will ask you if you want to download the file.
7238
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007239 After this option has been set successfully, Vim will source the files
7240 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007241 up to the first character that is not an ASCII letter or number and
7242 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007243
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007244 *'spelloptions'* *'spo'*
7245'spelloptions' 'spo' string (default "")
7246 local to buffer
7247 {not available when compiled without the |+syntax|
7248 feature}
7249 A comma separated list of options for spell checking:
7250 camel When a word is CamelCased, assume "Cased" is a
7251 separate word: every upper-case character in a word
7252 that comes after a lower case character indicates the
7253 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007254
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007255 *'spellsuggest'* *'sps'*
7256'spellsuggest' 'sps' string (default "best")
7257 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007258 {not available when compiled without the |+syntax|
7259 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007260 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007261 the |spellsuggest()| function. This is a comma-separated list of
7262 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007263
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007264 best Internal method that works best for English. Finds
7265 changes like "fast" and uses a bit of sound-a-like
7266 scoring to improve the ordering.
7267
7268 double Internal method that uses two methods and mixes the
7269 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007270 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007271 word. That only works when the language specifies
7272 sound folding. Can be slow and doesn't always give
7273 better results.
7274
7275 fast Internal method that only checks for simple changes:
7276 character inserts/deletes/swaps. Works well for
7277 simple typing mistakes.
7278
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007279 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007280 Not used for |spellsuggest()|. The number of
7281 suggestions is never more than the value of 'lines'
7282 minus two.
7283
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007284 file:{filename} Read file {filename}, which must have two columns,
7285 separated by a slash. The first column contains the
7286 bad word, the second column the suggested good word.
7287 Example:
7288 theribal/terrible ~
7289 Use this for common mistakes that do not appear at the
7290 top of the suggestion list with the internal methods.
7291 Lines without a slash are ignored, use this for
7292 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007293 The word in the second column must be correct,
7294 otherwise it will not be used. Add the word to an
7295 ".add" file if it is currently flagged as a spelling
7296 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007297 The file is used for all languages.
7298
7299 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7300 trouble with spaces. |v:val| holds the badly spelled
7301 word. The expression must evaluate to a List of
7302 Lists, each with a suggestion and a score.
7303 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007304 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007305 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007306 internal methods use. A lower score is better.
7307 This may invoke |spellsuggest()| if you temporarily
7308 set 'spellsuggest' to exclude the "expr:" part.
7309 Errors are silently ignored, unless you set the
7310 'verbose' option to a non-zero value.
7311
7312 Only one of "best", "double" or "fast" may be used. The others may
7313 appear several times in any order. Example: >
7314 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7315<
7316 This option cannot be set from a |modeline| or in the |sandbox|, for
7317 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007318
7319
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7321'splitbelow' 'sb' boolean (default off)
7322 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 When on, splitting a window will put the new window below the current
7324 one. |:split|
7325
7326 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7327'splitright' 'spr' boolean (default off)
7328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 When on, splitting a window will put the new window right of the
7330 current one. |:vsplit|
7331
7332 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7333'startofline' 'sol' boolean (default on)
7334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007336 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007337 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007338 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 with a linewise operator, with "%" with a count and to buffer changing
7340 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7341 only has a line number, e.g., ":25" or ":+".
7342 In case of buffer changing commands the cursor is placed at the column
7343 where it was the last time the buffer was edited.
7344 NOTE: This option is set when 'compatible' is set.
7345
Bram Moolenaar00654022011-02-25 14:42:19 +01007346 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007348 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 {not available when compiled without the |+statusline|
7350 feature}
7351 When nonempty, this option determines the content of the status line.
7352 Also see |status-line|.
7353
7354 The option consists of printf style '%' items interspersed with
7355 normal text. Each status line item is of the form:
7356 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007357 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007358 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359
Bram Moolenaar238a5642006-02-21 22:12:05 +00007360 When the option starts with "%!" then it is used as an expression,
7361 evaluated and the result is used as the option value. Example: >
7362 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007363< The *g:statusline_winid* variable will be set to the |window-ID| of the
7364 window that the status line belongs to.
7365 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007366 Note that the "%!" expression is evaluated in the context of the
7367 current window and buffer, while %{} items are evaluated in the
7368 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007369
7370 When there is error while evaluating the option then it will be made
7371 empty to avoid further errors. Otherwise screen updating would loop.
7372
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 Note that the only effect of 'ruler' when this option is set (and
7374 'laststatus' is 2) is controlling the output of |CTRL-G|.
7375
7376 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007377 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007379 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380 minwid Minimum width of the item, padding as set by '-' & '0'.
7381 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007382 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 on the left for text items. Numeric items will be
7384 shifted down to maxwid-2 digits followed by '>'number
7385 where number is the amount of missing digits, much like
7386 an exponential notation.
7387 item A one letter code as described below.
7388
7389 Following is a description of the possible statusline items. The
7390 second character in "item" is the type:
7391 N for number
7392 S for string
7393 F for flags as described below
7394 - not applicable
7395
7396 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007397 f S Path to the file in the buffer, as typed or relative to current
7398 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 F S Full path to the file in the buffer.
7400 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007401 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007403 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007405 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007407 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007409 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007411 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7413 being used: "<keymap>"
7414 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007415 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 B N As above, in hexadecimal.
7417 o N Byte number in file of byte under cursor, first byte is 1.
7418 Mnemonic: Offset from start of file (with one added)
7419 {not available when compiled without |+byte_offset| feature}
7420 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007421 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 l N Line number.
7423 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007424 c N Column number (byte index).
7425 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007426 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427 p N Percentage through file in lines as in |CTRL-G|.
7428 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007429 percentage described for 'ruler'. Always 3 in length, unless
7430 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007431 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007433 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007434 Note that there is no '%' before the closing '}'. The
7435 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007436 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007437 {% - This is almost same as { except the result of the expression is
7438 re-evaluated as a statusline format string. Thus if the
7439 return value of expr contains % items they will get expanded.
7440 The expression can contain the } character, the end of
7441 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007442 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007443 func! Stl_filename() abort
7444 return "%t"
7445 endfunc
7446< `stl=%{Stl_filename()}` results in `"%t"`
7447 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007448 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 ( - Start of item group. Can be used for setting the width and
7450 alignment of a section. Must be followed by %) somewhere.
7451 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007452 T N For 'tabline': start of tab page N label. Use %T after the last
7453 label. This information is used for mouse clicks.
7454 X N For 'tabline': start of close tab N label. Use %X after the
7455 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7456 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 < - Where to truncate line if too long. Default is at the start.
7458 No width fields allowed.
7459 = - Separation point between left and right aligned items.
7460 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007461 # - Set highlight group. The name must follow and then a # again.
7462 Thus use %#HLname# for highlight group HLname. The same
7463 highlighting is used, also for the statusline of non-current
7464 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007466 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 The difference between User{N} and StatusLine will be applied
7468 to StatusLineNC for the statusline of non-current windows.
7469 The number N must be between 1 and 9. See |hl-User1..9|
7470
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007471 When displaying a flag, Vim removes the leading comma, if any, when
7472 that flag comes right after plaintext. This will make a nice display
7473 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474
Bram Moolenaar582fd852005-03-28 20:58:01 +00007475 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 not set) and a minwid is not set for the group, the whole group will
7477 become empty. This will make a group like the following disappear
7478 completely from the statusline when none of the flags are set. >
7479 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007480< Beware that an expression is evaluated each and every time the status
7481 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007482 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007483 While evaluating %{} the current buffer and current window will be set
7484 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007485 currently being drawn. The expression will evaluate in this context.
7486 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7487 real current buffer and "g:actual_curwin" to the |window-ID| of the
7488 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007489
Bram Moolenaar30b65812012-07-12 22:01:11 +02007490 The 'statusline' option will be evaluated in the |sandbox| if set from
7491 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007492 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007493
7494 It is not allowed to change text or jump to another window while
7495 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496
7497 If the statusline is not updated when you want it (e.g., after setting
7498 a variable that's used in an expression), you can force an update by
7499 setting an option without changing its value. Example: >
7500 :let &ro = &ro
7501
7502< A result of all digits is regarded a number for display purposes.
7503 Otherwise the result is taken as flag text and applied to the rules
7504 described above.
7505
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007506 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007508 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509
7510 Examples:
7511 Emulate standard status line with 'ruler' set >
7512 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7513< Similar, but add ASCII value of char under the cursor (like "ga") >
7514 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7515< Display byte count and byte value, modified flag in red. >
7516 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7517 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7518< Display a ,GZ flag if a compressed file is loaded >
7519 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7520< In the |:autocmd|'s: >
7521 :let b:gzflag = 1
7522< And: >
7523 :unlet b:gzflag
7524< And define this function: >
7525 :function VarExists(var, val)
7526 : if exists(a:var) | return a:val | else | return '' | endif
7527 :endfunction
7528<
7529 *'suffixes'* *'su'*
7530'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7531 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 Files with these suffixes get a lower priority when multiple files
7533 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007534 suffixes. Spaces after the comma are ignored. A dot is also seen as
7535 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 separator, precede it with a backslash (see |option-backslash| about
7537 including spaces and backslashes).
7538 See 'wildignore' for completely ignoring files.
7539 The use of |:set+=| and |:set-=| is preferred when adding or removing
7540 suffixes from the list. This avoids problems when a future version
7541 uses another default.
7542
7543 *'suffixesadd'* *'sua'*
7544'suffixesadd' 'sua' string (default "")
7545 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 {not available when compiled without the
7547 |+file_in_path| feature}
7548 Comma separated list of suffixes, which are used when searching for a
7549 file for the "gf", "[I", etc. commands. Example: >
7550 :set suffixesadd=.java
7551<
7552 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7553'swapfile' 'swf' boolean (default on)
7554 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007555 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 swapfile is not wanted for a specific buffer. For example, with
7557 confidential information that even root must not be able to access.
7558 Careful: All text will be in memory:
7559 - Don't use this for big files.
7560 - Recovery will be impossible!
7561 A swapfile will only be present when |'updatecount'| is non-zero and
7562 'swapfile' is set.
7563 When 'swapfile' is reset, the swap file for the current buffer is
7564 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7565 non-zero, a swap file is immediately created.
7566 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007567 If you want to open a new buffer without creating a swap file for it,
7568 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007569 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570
7571 This option is used together with 'bufhidden' and 'buftype' to
7572 specify special kinds of buffers. See |special-buffers|.
7573
7574 *'swapsync'* *'sws'*
7575'swapsync' 'sws' string (default "fsync")
7576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007578 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 When this option is empty parts of the swap file may be in memory and
7580 not written to disk. When the system crashes you may lose more work.
7581 On Unix the system does a sync now and then without Vim asking for it,
7582 so the disadvantage of setting this option off is small. On some
7583 systems the swap file will not be written at all. For a unix system
7584 setting it to "sync" will use the sync() call instead of the default
7585 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007586 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587
7588 *'switchbuf'* *'swb'*
7589'switchbuf' 'swb' string (default "")
7590 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007592 Mostly for |quickfix| commands some values are also used for other
7593 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 Possible values (comma separated list):
7595 useopen If included, jump to the first open window that
7596 contains the specified buffer (if there is one).
7597 Otherwise: Do not examine other windows.
7598 This setting is checked with |quickfix| commands, when
7599 jumping to errors (":cc", ":cn", "cp", etc.). It is
7600 also used in all buffer related split commands, for
7601 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007602 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007603 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007605 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007606 Otherwise: do not split, use current window (when used
7607 in the quickfix window: the previously used window or
7608 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007609 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007610 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007611 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007612 uselast If included, jump to the previously used window when
7613 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007615 *'synmaxcol'* *'smc'*
7616'synmaxcol' 'smc' number (default 3000)
7617 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007618 {not available when compiled without the |+syntax|
7619 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007620 Maximum column in which to search for syntax items. In long lines the
7621 text after this column is not highlighted and following lines may not
7622 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007623 This helps to avoid very slow redrawing for an XML file that is one
7624 long line.
7625 Set to zero to remove the limit.
7626
Bram Moolenaar071d4272004-06-13 20:20:40 +00007627 *'syntax'* *'syn'*
7628'syntax' 'syn' string (default empty)
7629 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630 {not available when compiled without the |+syntax|
7631 feature}
7632 When this option is set, the syntax with this name is loaded, unless
7633 syntax highlighting has been switched off with ":syntax off".
7634 Otherwise this option does not always reflect the current syntax (the
7635 b:current_syntax variable does).
7636 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007637 not automatically recognized. Example, in an IDL file:
7638 /* vim: set syntax=idl : */ ~
7639 When a dot appears in the value then this separates two filetype
7640 names. Example:
7641 /* vim: set syntax=c.doxygen : */ ~
7642 This will use the "c" syntax first, then the "doxygen" syntax.
7643 Note that the second one must be prepared to be loaded as an addition,
7644 otherwise it will be skipped. More than one dot may appear.
7645 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 :set syntax=OFF
7647< To switch syntax highlighting on according to the current value of the
7648 'filetype' option: >
7649 :set syntax=ON
7650< What actually happens when setting the 'syntax' option is that the
7651 Syntax autocommand event is triggered with the value as argument.
7652 This option is not copied to another buffer, independent of the 's' or
7653 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007654 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007656 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007657'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007658 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007659 When nonempty, this option determines the content of the tab pages
7660 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007661 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007662
7663 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007664 option and only when there is no GUI tab line. When 'e' is in
7665 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007666 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007667
7668 The value is evaluated like with 'statusline'. You can use
7669 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007670 the text to be displayed. Use "%1T" for the first label, "%2T" for
7671 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007672
Bram Moolenaare12bab32019-01-08 22:02:56 +01007673 When changing something that is used in 'tabline' that does not
7674 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007675 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007676
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007677 Keep in mind that only one of the tab pages is the current one, others
7678 are invisible and you can't jump to their windows.
7679
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007680
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007681 *'tabpagemax'* *'tpm'*
7682'tabpagemax' 'tpm' number (default 10)
7683 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007684 Maximum number of tab pages to be opened by the |-p| command line
7685 argument or the ":tab all" command. |tabpage|
7686
7687
7688 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689'tabstop' 'ts' number (default 8)
7690 local to buffer
7691 Number of spaces that a <Tab> in the file counts for. Also see
7692 |:retab| command, and 'softtabstop' option.
7693
7694 Note: Setting 'tabstop' to any other value than 8 can make your file
7695 appear wrong in many places (e.g., when printing it).
7696
7697 There are four main ways to use tabs in Vim:
7698 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7699 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007700 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701 behave like a tab appears every 4 (or 3) characters.
7702 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7703 'expandtab'. This way you will always insert spaces. The
7704 formatting will never be messed up when 'tabstop' is changed.
7705 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007706 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 works when using Vim to edit the file.
7708 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7709 'noexpandtab'. This should then work (for initial indents only)
7710 for any tabstop setting that people use. It might be nice to have
7711 tabs after the first non-blank inserted as spaces if you do this
7712 though. Otherwise aligned comments will be wrong when 'tabstop' is
7713 changed.
7714
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007715 If Vim is compiled with the |+vartabs| feature then the value of
7716 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7717 than an empty string.
7718
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7720'tagbsearch' 'tbs' boolean (default on)
7721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007723 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724 searching makes searching for a tag a LOT faster, but a linear search
7725 will find more tags if the tags file wasn't properly sorted.
7726 Vim normally assumes that your tags files are sorted, or indicate that
7727 they are not sorted. Only when this is not the case does the
7728 'tagbsearch' option need to be switched off.
7729
7730 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007731 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 certain files, or retry all files with a linear search. When
7733 'tagbsearch' is off, only a linear search is done.
7734
7735 Linear searching is done anyway, for one file, when Vim finds a line
7736 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007737 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738< [The whitespace before and after the '0' must be a single <Tab>]
7739
7740 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007741 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 instead of a normal tag name, a retry is done with a linear search.
7743 Tags in unsorted tags files, and matches with different case will only
7744 be found in the retry.
7745
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007746 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007747 linear search can be avoided when case is ignored. Use a value of '2'
7748 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7749 sorted with the -f switch to "sort" in most unices, as in the command:
7750 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7751 (at least 5.5) the --sort=foldcase switch can be used for this as
7752 well. Note that case must be folded to uppercase for this to work.
7753
7754 By default, tag searches are case-sensitive. Case is ignored when
7755 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7756 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007757 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7758 'tagcase' is "smart", and the pattern contains only lowercase
7759 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760
7761 When 'tagbsearch' is off, tags searching is slower when a full match
7762 exists, but faster when no full match exists. Tags in unsorted tags
7763 files may only be found with 'tagbsearch' off.
7764 When the tags file is not sorted, or sorted in a wrong way (not on
7765 ASCII byte value), 'tagbsearch' should be off, or the line given above
7766 must be included in the tags file.
7767 This option doesn't affect commands that find all matching tags (e.g.,
7768 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007770 *'tagcase'* *'tc'*
7771'tagcase' 'tc' string (default "followic")
7772 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007773 This option specifies how case is handled when searching the tags
7774 file:
7775 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007776 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007777 ignore Ignore case
7778 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007779 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007780 NOTE: This option is set to the Vi default value when 'compatible' is
7781 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007782
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007783 *'tagfunc'* *'tfu'*
7784'tagfunc' 'tfu' string (default: empty)
7785 local to buffer
7786 {not available when compiled without the |+eval|
7787 feature}
7788 This option specifies a function to be used to perform tag searches.
7789 The function gets the tag pattern and should return a List of matching
7790 tags. See |tag-function| for an explanation of how to write the
Yegappan Lakshmanan19916a82021-11-24 16:32:55 +00007791 function and an example. The value can be the name of a function, a
7792 |lambda| or a |Funcref|. See |option-value-function| for more
7793 information.
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007794
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795 *'taglength'* *'tl'*
7796'taglength' 'tl' number (default 0)
7797 global
7798 If non-zero, tags are significant up to this number of characters.
7799
7800 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7801'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7802 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007803 If on and using a tags file in another directory, file names in that
7804 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 NOTE: This option is set to the Vi default value when 'compatible' is
7806 set and to the Vim default value when 'compatible' is reset.
7807
7808 *'tags'* *'tag'* *E433*
7809'tags' 'tag' string (default "./tags,tags", when compiled with
7810 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7811 global or local to buffer |global-local|
7812 Filenames for the tag command, separated by spaces or commas. To
7813 include a space or comma in a file name, precede it with a backslash
7814 (see |option-backslash| about including spaces and backslashes).
7815 When a file name starts with "./", the '.' is replaced with the path
7816 of the current file. But only when the 'd' flag is not included in
7817 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7818 |tags-option|.
7819 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007820 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7821 find all files named "tags" below "/lib". The filename itself cannot
7822 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7823 files called "tags?". {not available when compiled without the
7824 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007825 The |tagfiles()| function can be used to get a list of the file names
7826 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7828 files are also supported. They are automatically recognized. The
7829 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7830 differences are ignored (MS-Windows). |emacs-tags|
7831 The use of |:set+=| and |:set-=| is preferred when adding or removing
7832 file names from the list. This avoids problems when a future version
7833 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007834
7835 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7836'tagstack' 'tgst' boolean (default on)
7837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 When on, the |tagstack| is used normally. When off, a ":tag" or
7839 ":tselect" command with an argument will not push the tag onto the
7840 tagstack. A following ":tag" without an argument, a ":pop" command or
7841 any other command that uses the tagstack will use the unmodified
7842 tagstack, but does change the pointer to the active entry.
7843 Resetting this option is useful when using a ":tag" command in a
7844 mapping which should not change the tagstack.
7845
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007846 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007847'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007848 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007849 {only available when compiled with the |+tcl/dyn|
7850 feature}
7851 Specifies the name of the Tcl shared library. The default is
7852 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007853 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007854 This option cannot be set from a |modeline| or in the |sandbox|, for
7855 security reasons.
7856
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 *'term'* *E529* *E530* *E531*
7858'term' string (default is $TERM, if that fails:
7859 in the GUI: "builtin_gui"
7860 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007861 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863 on Unix: "ansi"
7864 on VMS: "ansi"
7865 on Win 32: "win32")
7866 global
7867 Name of the terminal. Used for choosing the terminal control
7868 characters. Environment variables are expanded |:set_env|.
7869 For example: >
7870 :set term=$TERM
7871< See |termcap|.
7872
7873 *'termbidi'* *'tbidi'*
7874 *'notermbidi'* *'notbidi'*
7875'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 {only available when compiled with the |+arabic|
7878 feature}
7879 The terminal is in charge of Bi-directionality of text (as specified
7880 by Unicode). The terminal is also expected to do the required shaping
7881 that some languages (such as Arabic) require.
7882 Setting this option implies that 'rightleft' will not be set when
7883 'arabic' is set and the value of 'arabicshape' will be ignored.
7884 Note that setting 'termbidi' has the immediate effect that
7885 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7886 This option is reset when the GUI is started.
7887 For further details see |arabic.txt|.
7888
7889 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007890'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 Encoding used for the terminal. This specifies what character
7893 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007894 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007895 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007896 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007897 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7899 Any attempts to set a different value will be rejected, and an error
7900 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007901 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 because the Win32 system always passes Unicode characters.
7903 When empty, the same encoding is used as for the 'encoding' option.
7904 This is the normal value.
7905 Not all combinations for 'termencoding' and 'encoding' are valid. See
7906 |encoding-table|.
7907 The value for this option must be supported by internal conversions or
7908 iconv(). When this is not possible no conversion will be done and you
7909 will probably experience problems with non-ASCII characters.
7910 Example: You are working with the locale set to euc-jp (Japanese) and
7911 want to edit a UTF-8 file: >
7912 :let &termencoding = &encoding
7913 :set encoding=utf-8
7914< You need to do this when your system has no locale support for UTF-8.
7915
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007916 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007917'termguicolors' 'tgc' boolean (default off)
7918 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007919 {not available when compiled without the
7920 |+termguicolors| feature}
7921 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007922 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007923
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007924 Requires a ISO-8613-3 compatible terminal. If setting this option
7925 does not work (produces a colorless UI) reading |xterm-true-color|
7926 might help.
7927
7928 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7929 is required. Use this check to find out: >
7930 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007931< This requires Vim to be built with the |+vtp| feature.
7932
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007933 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007934 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007935
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007936 *'termwinkey'* *'twk'*
7937'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007938 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007939 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007940 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007941 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007942 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007943< The string must be one key stroke but can be multiple bytes.
7944 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007945 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007946 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007947
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007948 *'termwinscroll'* *'twsl'*
7949'termwinscroll' 'twsl' number (default 10000)
7950 local to buffer
7951 {not available when compiled without the
7952 |+terminal| feature}
7953 Number of scrollback lines to keep. When going over this limit the
7954 first 10% of the scrollback lines are deleted. This is just to reduce
7955 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00007956 Also used as a limit for text sent to the terminal in one write,
7957 multiplied by the number of columns times 3 (average number of bytes
7958 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007959
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007960 *'termwinsize'* *'tws'*
7961'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007962 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007963 Size used when opening the |terminal| window. Format:
7964 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007965 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007966 - When set with a "x" (e.g., "24x80") the terminal size is not
7967 adjusted to the window size. If the window is smaller only the
7968 top-left part is displayed.
7969 - When set with a "*" (e.g., "10*50") the terminal size follows the
7970 window size, but will not be smaller than the specified rows and/or
7971 columns.
7972 - When rows is zero then use the height of the window.
7973 - When columns is zero then use the width of the window.
7974 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007975 - Can be overruled in the |term_start()| options with "term_rows" and
7976 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007977
7978 Examples:
7979 "30x0" uses 30 rows and the current window width.
7980 "20*0" uses at least 20 rows and the current window width.
7981 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007982 Note that the command running in the terminal window may still change
7983 the size of the terminal. In that case the Vim window will be
7984 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007985
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007986 *'termwintype'* *'twt'*
7987'termwintype' 'twt' string (default "")
7988 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007989 {only available when compiled with the |terminal|
7990 feature on MS-Windows}
7991 Specify the virtual console (pty) used when opening the terminal
7992 window.
7993
7994 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007995 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007996 "winpty" use winpty, fail if not supported
7997 "conpty" use |ConPTY|, fail if not supported
7998
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007999 |ConPTY| support depends on the platform. Windows 10 October 2018
8000 Update is the first version that supports ConPTY, however it is still
8001 considered unstable. ConPTY might become stable in the next release
8002 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008003 supported then you cannot open a terminal window.
8004
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 *'terse'* *'noterse'*
8006'terse' boolean (default off)
8007 global
8008 When set: Add 's' flag to 'shortmess' option (this makes the message
8009 for a search that hits the start or end of the file not being
8010 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8011 shortens a lot of messages}
8012
8013 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8014'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 This option is obsolete. Use 'fileformats'.
8017 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8018 set to the default value for the current system. When 'textauto' is
8019 reset, 'fileformats' is made empty.
8020 NOTE: This option is set to the Vi default value when 'compatible' is
8021 set and to the Vim default value when 'compatible' is reset.
8022
8023 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008024'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 others: default off)
8026 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 This option is obsolete. Use 'fileformat'.
8028 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8029 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8030 "unix".
8031
8032 *'textwidth'* *'tw'*
8033'textwidth' 'tw' number (default 0)
8034 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 Maximum width of text that is being inserted. A longer line will be
8036 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008037 this.
8038 'textwidth' is set to 0 when the 'paste' option is set and restored
8039 when 'paste' is reset.
8040 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008042 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 NOTE: This option is set to 0 when 'compatible' is set.
8044
8045 *'thesaurus'* *'tsr'*
8046'thesaurus' 'tsr' string (default "")
8047 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008049 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8050 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008051
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008052 This option is not used if 'thesaurusfunc' is set, either for the
8053 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008054
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008055 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008057 name. See |option-backslash| about using backslashes. The use of
8058 |:set+=| and |:set-=| is preferred when adding or removing directories
8059 from the list. This avoids problems when a future version uses
8060 another default. Backticks cannot be used in this option for security
8061 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008063 *'thesaurusfunc'* *tsrfu'*
8064'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008065 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008066 {not available when compiled without the |+eval|
8067 feature}
8068 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008069 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
8070
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008071 This option cannot be set from a |modeline| or in the |sandbox|, for
8072 security reasons.
8073
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8075'tildeop' 'top' boolean (default off)
8076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 When on: The tilde command "~" behaves like an operator.
8078 NOTE: This option is reset when 'compatible' is set.
8079
8080 *'timeout'* *'to'* *'notimeout'* *'noto'*
8081'timeout' 'to' boolean (default on)
8082 global
8083 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008084'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 These two options together determine the behavior when part of a
8087 mapped key sequence or keyboard code has been received:
8088
8089 'timeout' 'ttimeout' action ~
8090 off off do not time out
8091 on on or off time out on :mappings and key codes
8092 off on time out on key codes
8093
8094 If both options are off, Vim will wait until either the complete
8095 mapping or key sequence has been received, or it is clear that there
8096 is no mapping or key sequence for the received characters. For
8097 example: if you have mapped "vl" and Vim has received 'v', the next
8098 character is needed to see if the 'v' is followed by an 'l'.
8099 When one of the options is on, Vim will wait for about 1 second for
8100 the next character to arrive. After that the already received
8101 characters are interpreted as single characters. The waiting time can
8102 be changed with the 'timeoutlen' option.
8103 On slow terminals or very busy systems timing out may cause
8104 malfunctioning cursor keys. If both options are off, Vim waits
8105 forever after an entered <Esc> if there are key codes that start
8106 with <Esc>. You will have to type <Esc> twice. If you do not have
8107 problems with key codes, but would like to have :mapped key
8108 sequences not timing out in 1 second, set the 'ttimeout' option and
8109 reset the 'timeout' option.
8110
8111 NOTE: 'ttimeout' is reset when 'compatible' is set.
8112
8113 *'timeoutlen'* *'tm'*
8114'timeoutlen' 'tm' number (default 1000)
8115 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008116
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008118'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 The time in milliseconds that is waited for a key code or mapped key
8121 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8122 when part of a command has been typed.
8123 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8124 different timeout value for key codes is desired set 'ttimeoutlen' to
8125 a non-negative number.
8126
8127 ttimeoutlen mapping delay key code delay ~
8128 < 0 'timeoutlen' 'timeoutlen'
8129 >= 0 'timeoutlen' 'ttimeoutlen'
8130
8131 The timeout only happens when the 'timeout' and 'ttimeout' options
8132 tell so. A useful setting would be >
8133 :set timeout timeoutlen=3000 ttimeoutlen=100
8134< (time out on mapping after three seconds, time out on key codes after
8135 a tenth of a second).
8136
8137 *'title'* *'notitle'*
8138'title' boolean (default off, on when title can be restored)
8139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 When on, the title of the window will be set to the value of
8141 'titlestring' (if it is not empty), or to:
8142 filename [+=-] (path) - VIM
8143 Where:
8144 filename the name of the file being edited
8145 - indicates the file cannot be modified, 'ma' off
8146 + indicates the file was modified
8147 = indicates the file is read-only
8148 =+ indicates the file is read-only and modified
8149 (path) is the path of the file being edited
8150 - VIM the server name |v:servername| or "VIM"
8151 Only works if the terminal supports setting window titles
8152 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008153 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008154 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8155 *X11*
8156 When Vim was compiled with HAVE_X11 defined, the original title will
8157 be restored if possible. The output of ":version" will include "+X11"
8158 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8159 works for the icon name |'icon'|.
8160 But: When Vim was started with the |-X| argument, restoring the title
8161 will not work (except in the GUI).
8162 If the title cannot be restored, it is set to the value of 'titleold'.
8163 You might want to restore the title outside of Vim then.
8164 When using an xterm from a remote machine you can use this command:
8165 rsh machine_name xterm -display $DISPLAY &
8166 then the WINDOWID environment variable should be inherited and the
8167 title of the window should change back to what it should be after
8168 exiting Vim.
8169
8170 *'titlelen'*
8171'titlelen' number (default 85)
8172 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008174 title. When the title is longer, only the end of the path name is
8175 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176 Using a percentage makes this adapt to the width of the window. But
8177 it won't work perfectly, because the actual number of characters
8178 available also depends on the font used and other things in the title
8179 bar. When 'titlelen' is zero the full path is used. Otherwise,
8180 values from 1 to 30000 percent can be used.
8181 'titlelen' is also used for the 'titlestring' option.
8182
8183 *'titleold'*
8184'titleold' string (default "Thanks for flying Vim")
8185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 This option will be used for the window title when exiting Vim if the
8187 original title cannot be restored. Only happens if 'title' is on or
8188 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008189 This option cannot be set from a |modeline| or in the |sandbox|, for
8190 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191 *'titlestring'*
8192'titlestring' string (default "")
8193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 When this option is not empty, it will be used for the title of the
8195 window. This happens only when the 'title' option is on.
8196 Only works if the terminal supports setting window titles (currently
8197 Amiga console, Win32 console, all GUI versions and terminals with a
8198 non-empty 't_ts' option).
8199 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008200 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008201
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 When this option contains printf-style '%' items, they will be
8203 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008204 This option cannot be set in a modeline when 'modelineexpr' is off.
8205
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 Example: >
8207 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8208 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8209< The value of 'titlelen' is used to align items in the middle or right
8210 of the available space.
8211 Some people prefer to have the file name first: >
8212 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8213< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008214 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215 separating space only when needed.
8216 NOTE: Use of special characters in 'titlestring' may cause the display
8217 to be garbled (e.g., when it contains a CR or NL character).
8218 {not available when compiled without the |+statusline| feature}
8219
8220 *'toolbar'* *'tb'*
8221'toolbar' 'tb' string (default "icons,tooltips")
8222 global
8223 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8224 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008225 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 possible values are:
8227 icons Toolbar buttons are shown with icons.
8228 text Toolbar buttons shown with text.
8229 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008230 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 tooltips Tooltips are active for toolbar buttons.
8232 Tooltips refer to the popup help text which appears after the mouse
8233 cursor is placed over a toolbar button for a brief moment.
8234
8235 If you want the toolbar to be shown with icons as well as text, do the
8236 following: >
8237 :set tb=icons,text
8238< Motif and Athena cannot display icons and text at the same time. They
8239 will show icons if both are requested.
8240
8241 If none of the strings specified in 'toolbar' are valid or if
8242 'toolbar' is empty, this option is ignored. If you want to disable
8243 the toolbar, you need to set the 'guioptions' option. For example: >
8244 :set guioptions-=T
8245< Also see |gui-toolbar|.
8246
8247 *'toolbariconsize'* *'tbis'*
8248'toolbariconsize' 'tbis' string (default "small")
8249 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008250 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008252 tiny Use tiny icons.
8253 small Use small icons (default).
8254 medium Use medium-sized icons.
8255 large Use large icons.
8256 huge Use even larger icons.
8257 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008259 the current theme. Common dimensions are giant=48x48, huge=32x32,
8260 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008261
8262 If 'toolbariconsize' is empty, the global default size as determined
8263 by user preferences or the current theme is used.
8264
8265 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8266'ttybuiltin' 'tbi' boolean (default on)
8267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 When on, the builtin termcaps are searched before the external ones.
8269 When off the builtin termcaps are searched after the external ones.
8270 When this option is changed, you should set the 'term' option next for
8271 the change to take effect, for example: >
8272 :set notbi term=$TERM
8273< See also |termcap|.
8274 Rationale: The default for this option is "on", because the builtin
8275 termcap entries are generally better (many systems contain faulty
8276 xterm entries...).
8277
8278 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8279'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8280 sun-cmd, screen, rxvt, dtterm or
8281 iris-ansi; also on when running Vim in
8282 a DOS console)
8283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 Indicates a fast terminal connection. More characters will be sent to
8285 the screen for redrawing, instead of using insert/delete line
8286 commands. Improves smoothness of redrawing when there are multiple
8287 windows and the terminal does not support a scrolling region.
8288 Also enables the extra writing of characters at the end of each screen
8289 line for lines that wrap. This helps when using copy/paste with the
8290 mouse in an xterm and other terminals.
8291
8292 *'ttymouse'* *'ttym'*
8293'ttymouse' 'ttym' string (default depends on 'term')
8294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 {only in Unix and VMS, doesn't work in the GUI; not
8296 available when compiled without |+mouse|}
8297 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008298 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008299 *xterm-mouse*
8300 xterm xterm-like mouse handling. The mouse generates
8301 "<Esc>[Mscr", where "scr" is three bytes:
8302 "s" = button state
8303 "c" = column plus 33
8304 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008305 This only works up to 223 columns! See "dec",
8306 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 xterm2 Works like "xterm", but with the xterm reporting the
8308 mouse position while the mouse is dragged. This works
8309 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008310 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 work. See below for how Vim detects this
8312 automatically.
8313 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008314 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008316 for the row and column. No other mouse events are
8317 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008318 *dec-mouse*
8319 dec DEC terminal mouse handling. The mouse generates a
8320 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008321 This is also available for an Xterm, if it was
8322 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 *jsbterm-mouse*
8324 jsbterm JSB term mouse handling.
8325 *pterm-mouse*
8326 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008327 *urxvt-mouse*
8328 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008329 The mouse works only if the terminal supports this
8330 encoding style, but it does not have 223 columns limit
8331 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008332 *sgr-mouse*
8333 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008334 mouse reporting. The mouse works even in columns
8335 beyond 223. This option is backward compatible with
8336 "xterm2" because it can also decode "xterm2" style
8337 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338
8339 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008340 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8341 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8343 recognized, if enabled at compile time. DEC terminal mouse codes
8344 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008345 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8346 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008348 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8349 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8350 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008351 Additionally, if vim is compiled with the |+termresponse| feature and
8352 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008353 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008355 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8356 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8357 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008358 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8359 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 :set t_RV=
8361<
8362 *'ttyscroll'* *'tsl'*
8363'ttyscroll' 'tsl' number (default 999)
8364 global
8365 Maximum number of lines to scroll the screen. If there are more lines
8366 to scroll the window is redrawn. For terminals where scrolling is
8367 very slow and redrawing is not slow this can be set to a small number,
8368 e.g., 3, to speed up displaying.
8369
8370 *'ttytype'* *'tty'*
8371'ttytype' 'tty' string (default from $TERM)
8372 global
8373 Alias for 'term', see above.
8374
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008375 *'undodir'* *'udir'*
8376'undodir' 'udir' string (default ".")
8377 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008378 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008379 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008380 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008381 "." means using the directory of the file. The undo file name for
8382 "file.txt" is ".file.txt.un~".
8383 For other directories the file name is the full path of the edited
8384 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008385 When writing: The first directory that exists is used. "." always
8386 works, no directories after "." will be used for writing.
8387 When reading all entries are tried to find an undo file. The first
8388 undo file that exists is used. When it cannot be read an error is
8389 given, no further entry is used.
8390 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008391 This option cannot be set from a |modeline| or in the |sandbox|, for
8392 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008393
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008394 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008395'undofile' 'udf' boolean (default off)
8396 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008397 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008398 When on, Vim automatically saves undo history to an undo file when
8399 writing a buffer to a file, and restores undo history from the same
8400 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008401 The directory where the undo file is stored is specified by 'undodir'.
8402 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008403 The undo file is not read when 'undoreload' causes the buffer from
8404 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008405 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008406 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008407
Bram Moolenaar071d4272004-06-13 20:20:40 +00008408 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008409'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008410 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008412 is kept in memory, higher numbers will cause more memory to be used.
8413 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8415 itself: >
8416 set ul=0
8417< But you can also get Vi compatibility by including the 'u' flag in
8418 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008419 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008420 Set to -1 for no undo at all. You might want to do this only for the
8421 current buffer: >
8422 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008424
8425 The local value is set to -123456 when the global value is to be used.
8426
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008427 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008429 *'undoreload'* *'ur'*
8430'undoreload' 'ur' number (default 10000)
8431 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008432 Save the whole buffer for undo when reloading it. This applies to the
8433 ":e!" command and reloading for when the buffer changed outside of
8434 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008435 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008436 of lines is smaller than the value of this option.
8437 Set this option to zero to disable undo for a reload.
8438
8439 When saving undo for a reload, any undo file is not read.
8440
8441 Note that this causes the whole buffer to be stored in memory. Set
8442 this option to a lower value if you run out of memory.
8443
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 *'updatecount'* *'uc'*
8445'updatecount' 'uc' number (default: 200)
8446 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447 After typing this many characters the swap file will be written to
8448 disk. When zero, no swap file will be created at all (see chapter on
8449 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8450 Vim with the "-n" option, see |startup|. When editing in readonly
8451 mode this option will be initialized to 10000.
8452 The swapfile can be disabled per buffer with |'swapfile'|.
8453 When 'updatecount' is set from zero to non-zero, swap files are
8454 created for all buffers that have 'swapfile' set. When 'updatecount'
8455 is set to zero, existing swap files are not deleted.
8456 Also see |'swapsync'|.
8457 This option has no meaning in buffers where |'buftype'| is "nofile"
8458 or "nowrite".
8459
8460 *'updatetime'* *'ut'*
8461'updatetime' 'ut' number (default 4000)
8462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 If this many milliseconds nothing is typed the swap file will be
8464 written to disk (see |crash-recovery|). Also used for the
8465 |CursorHold| autocommand event.
8466
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008467 *'varsofttabstop'* *'vsts'*
8468'varsofttabstop' 'vsts' string (default "")
8469 local to buffer
8470 {only available when compiled with the |+vartabs|
8471 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008472 A list of the number of spaces that a <Tab> counts for while editing,
8473 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8474 width <Tab>s are being inserted, while in fact a mixture of spaces
8475 and <Tab>s is used. Tab widths are separated with commas, with the
8476 final value applying to all subsequent tabs.
8477
8478 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008479 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008480 to use the following: >
8481 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008482< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8483 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008484
8485 Note that the value of |'softtabstop'| will be ignored while
8486 'varsofttabstop' is set.
8487
8488 *'vartabstop'* *'vts'*
8489'vartabstop' 'vts' string (default "")
8490 local to buffer
8491 {only available when compiled with the |+vartabs|
8492 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008493 A list of the number of spaces that a <Tab> in the file counts for,
8494 separated by commas. Each value corresponds to one tab, with the
8495 final value applying to all subsequent tabs. For example: >
8496 :set vartabstop=4,20,10,8
8497< This will make the first tab 4 spaces wide, the second 20 spaces,
8498 the third 10 spaces, and all following tabs 8 spaces.
8499
8500 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8501 is set.
8502
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 *'verbose'* *'vbs'*
8504'verbose' 'vbs' number (default 0)
8505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 When bigger than zero, Vim will give messages about what it is doing.
8507 Currently, these messages are given:
8508 >= 1 When the viminfo file is read or written.
8509 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008510 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008511 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 >= 8 Files for which a group of autocommands is executed.
8513 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008514 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008515 >= 12 Every executed function.
8516 >= 13 When an exception is thrown, caught, finished, or discarded.
8517 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008518 >= 15 Every executed Ex command from a script (truncated at 200
8519 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008520 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521
8522 This option can also be set with the "-V" argument. See |-V|.
8523 This option is also set by the |:verbose| command.
8524
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008525 When the 'verbosefile' option is set then the verbose messages are not
8526 displayed.
8527
8528 *'verbosefile'* *'vfile'*
8529'verbosefile' 'vfile' string (default empty)
8530 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008531 When not empty all messages are written in a file with this name.
8532 When the file exists messages are appended.
8533 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008534 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008535 Setting 'verbosefile' to a new value is like making it empty first.
8536 The difference with |:redir| is that verbose messages are not
8537 displayed when 'verbosefile' is set.
8538
Bram Moolenaar071d4272004-06-13 20:20:40 +00008539 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008540'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 "$VIM/vimfiles/view",
8542 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008543 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008544 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008546 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008547 feature}
8548 Name of the directory where to store files for |:mkview|.
8549 This option cannot be set from a |modeline| or in the |sandbox|, for
8550 security reasons.
8551
8552 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008553'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008555 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556 feature}
8557 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008558 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 word save and restore ~
8560 cursor cursor position in file and in window
8561 folds manually created folds, opened/closed folds and local
8562 fold options
8563 options options and mappings local to a window or buffer (not
8564 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008565 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 slash backslashes in file names replaced with forward
8567 slashes
8568 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008569 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008570 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008571
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008572 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008574 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575
8576 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008577'viminfo' 'vi' string (Vi default: "", Vim default for
8578 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008579 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8580 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008582 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 feature}
8584 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008585 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8586 "NONE".
8587 The string should be a comma separated list of parameters, each
8588 consisting of a single character identifying the particular parameter,
8589 followed by a number or string which specifies the value of that
8590 parameter. If a particular character is left out, then the default
8591 value is used for that parameter. The following is a list of the
8592 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008594 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008595 ! When included, save and restore global variables that start
8596 with an uppercase letter, and don't contain a lowercase
8597 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008598 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008599 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008600 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 " Maximum number of lines saved for each register. Old name of
8602 the '<' item, with the disadvantage that you need to put a
8603 backslash before the ", otherwise it will be recognized as the
8604 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008605 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 % When included, save and restore the buffer list. If Vim is
8607 started with a file name argument, the buffer list is not
8608 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008609 buffer list is restored from the viminfo file. Quickfix
8610 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8611 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008612 When followed by a number, the number specifies the maximum
8613 number of buffers that are stored. Without a number all
8614 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008615 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 ' Maximum number of previously edited files for which the marks
8617 are remembered. This parameter must always be included when
8618 'viminfo' is non-empty.
8619 Including this item also means that the |jumplist| and the
8620 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008621 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008623 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624 patterns are also saved. When not included, the value of
8625 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008626 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008628 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008629 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 < Maximum number of lines saved for each register. If zero then
8631 registers are not saved. When not included, all lines are
8632 saved. '"' is the old name for this item.
8633 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008634 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008636 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008637 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 c When included, convert the text in the viminfo file from the
8639 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008640 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008641 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642 f Whether file marks need to be stored. If zero, file marks ('0
8643 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008644 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008646 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 h Disable the effect of 'hlsearch' when loading the viminfo
8648 file. When not included, it depends on whether ":nohlsearch"
8649 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008650 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008652 the 'n'. Must be at the end of the option! If the
8653 'viminfofile' option is set, that file name overrides the one
8654 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008655 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008656 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 r Removable media. The argument is a string (up to the next
8658 ','). This parameter can be given several times. Each
8659 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008660 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8662 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8663 ignored. Maximum length of each 'r' argument is 50
8664 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008665 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 s Maximum size of an item in Kbyte. If zero then registers are
8667 not saved. Currently only applies to registers. The default
8668 "s10" will exclude registers with more than 10 Kbyte of text.
8669 Also see the '<' item above: line count limit.
8670
8671 Example: >
8672 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8673<
8674 '50 Marks will be remembered for the last 50 files you
8675 edited.
8676 <1000 Contents of registers (up to 1000 lines each) will be
8677 remembered.
8678 s100 Registers with more than 100 Kbyte text are skipped.
8679 :0 Command-line history will not be saved.
8680 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8681 no / Since '/' is not specified, the default will be used,
8682 that is, save all of the search history, and also the
8683 previous search and substitute patterns.
8684 no % The buffer list will not be saved nor read back.
8685 no h 'hlsearch' highlighting will be restored.
8686
8687 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8688 load the contents of the file, this is not done automatically.
8689
8690 This option cannot be set from a |modeline| or in the |sandbox|, for
8691 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008692 NOTE: This option is set to the Vim default value when 'compatible'
8693 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008695 *'viminfofile'* *'vif'*
8696'viminfofile' 'vif' string (default: "")
8697 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008698 {not available when compiled without the |+viminfo|
8699 feature}
8700 When non-empty, overrides the file name used for viminfo.
8701 When equal to "NONE" no viminfo file will be read or written.
8702 This option can be set with the |-i| command line flag. The |--clean|
8703 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008704 This option cannot be set from a |modeline| or in the |sandbox|, for
8705 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008706
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 *'virtualedit'* *'ve'*
8708'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008709 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 A comma separated list of these words:
8711 block Allow virtual editing in Visual block mode.
8712 insert Allow virtual editing in Insert mode.
8713 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008714 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008715 none When used as the local value, do not allow virtual
8716 editing even when the global value is set. When used
8717 as the global value, "none" is the same as "".
8718 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008719
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008721 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 of the line. Useful for selecting a rectangle in Visual mode and
8723 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008724 "onemore" is not the same, it will only allow moving the cursor just
8725 after the last character of the line. This makes some commands more
8726 consistent. Previously the cursor was always past the end of the line
8727 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008728 break some plugins or Vim scripts. For example because |l| can move
8729 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008730 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008731 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008732 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008733 It doesn't make sense to combine "all" with "onemore", but you will
8734 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008735 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008736 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737
8738 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8739'visualbell' 'vb' boolean (default off)
8740 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008741 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008743 use: >
8744 :set vb t_vb=
8745< If you want a short flash, you can use this on many terminals: >
8746 :set vb t_vb=[?5h$<100>[?5l
8747< Here $<100> specifies the time, you can use a smaller or bigger value
8748 to get a shorter or longer flash.
8749
8750 Note: Vim will limit the bell to once per half a second. This avoids
8751 having to wait for the flashing to finish when there are lots of
8752 bells, e.g. on key repeat. This also happens without 'visualbell'
8753 set.
8754
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8756 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8757 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008758
8759 Note: When the GUI starts, 't_vb' is reset to its default value. You
8760 might want to set it again in your |gvimrc|.
8761
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 Does not work on the Amiga, you always get a screen flash.
8763 Also see 'errorbells'.
8764
8765 *'warn'* *'nowarn'*
8766'warn' boolean (default on)
8767 global
8768 Give a warning message when a shell command is used while the buffer
8769 has been changed.
8770
8771 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8772'weirdinvert' 'wiv' boolean (default off)
8773 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008774 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775 It is provided for backwards compatibility with version 4.x.
8776 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8777 vice versa. Has no effect when the GUI is running.
8778
8779 *'whichwrap'* *'ww'*
8780'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 Allow specified keys that move the cursor left/right to move to the
8783 previous/next line when the cursor is on the first/last character in
8784 the line. Concatenate characters to allow this for these keys:
8785 char key mode ~
8786 b <BS> Normal and Visual
8787 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008788 h "h" Normal and Visual (not recommended)
8789 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008790 < <Left> Normal and Visual
8791 > <Right> Normal and Visual
8792 ~ "~" Normal
8793 [ <Left> Insert and Replace
8794 ] <Right> Insert and Replace
8795 For example: >
8796 :set ww=<,>,[,]
8797< allows wrap only when cursor keys are used.
8798 When the movement keys are used in combination with a delete or change
8799 operator, the <EOL> also counts for a character. This makes "3h"
8800 different from "3dh" when the cursor crosses the end of a line. This
8801 is also true for "x" and "X", because they do the same as "dl" and
8802 "dh". If you use this, you may also want to use the mapping
8803 ":map <BS> X" to make backspace delete the character in front of the
8804 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008805 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008806 line (not an empty line) then it will not move to the next line. This
8807 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808 NOTE: This option is set to the Vi default value when 'compatible' is
8809 set and to the Vim default value when 'compatible' is reset.
8810
8811 *'wildchar'* *'wc'*
8812'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 Character you have to type to start wildcard expansion in the
8815 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008816 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008817 The character is not recognized when used inside a macro. See
8818 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008819 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008821 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822< NOTE: This option is set to the Vi default value when 'compatible' is
8823 set and to the Vim default value when 'compatible' is reset.
8824
8825 *'wildcharm'* *'wcm'*
8826'wildcharm' 'wcm' number (default: none (0))
8827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008829 recognized when used inside a macro. You can find "spare" command-line
8830 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 you'll never actually type 'wildcharm', just use it in mappings that
8832 automatically invoke completion mode, e.g.: >
8833 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008834 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835< Then after typing :ss you can use CTRL-P & CTRL-N.
8836
8837 *'wildignore'* *'wig'*
8838'wildignore' 'wig' string (default "")
8839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 {not available when compiled without the |+wildignore|
8841 feature}
8842 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008843 patterns is ignored when expanding |wildcards|, completing file or
8844 directory names, and influences the result of |expand()|, |glob()| and
8845 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8847 Also see 'suffixes'.
8848 Example: >
8849 :set wildignore=*.o,*.obj
8850< The use of |:set+=| and |:set-=| is preferred when adding or removing
8851 a pattern from the list. This avoids problems when a future version
8852 uses another default.
8853
Bram Moolenaar94950a92010-12-02 16:01:29 +01008854
Bram Moolenaar81af9252010-12-10 20:35:50 +01008855 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008856'wildignorecase' 'wic' boolean (default off)
8857 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008858 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008859 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008860 Does not apply when the shell is used to expand wildcards, which
8861 happens when there are special characters.
8862
8863
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008865'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008867 {not available if compiled without the |+wildmenu|
8868 feature}
8869 When 'wildmenu' is on, command-line completion operates in an enhanced
8870 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8871 the possible matches are shown just above the command line, with the
8872 first match highlighted (overwriting the status line, if there is
8873 one). Keys that show the previous/next match, such as <Tab> or
8874 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8875 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8876 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008877 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 If there are more matches than can fit in the line, a ">" is shown on
8879 the right and/or a "<" is shown on the left. The status line scrolls
8880 as needed.
8881 The "wildmenu" mode is abandoned when a key is hit that is not used
8882 for selecting a completion.
8883 While the "wildmenu" is active the following keys have special
8884 meanings:
8885
8886 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8887 <Down> - in filename/menu name completion: move into a
8888 subdirectory or submenu.
8889 <CR> - in menu completion, when the cursor is just after a
8890 dot: move into a submenu.
8891 <Up> - in filename/menu name completion: move up into
8892 parent directory or parent menu.
8893
8894 This makes the menus accessible from the console |console-menus|.
8895
8896 If you prefer the <Left> and <Right> keys to move the cursor instead
8897 of selecting a different match, use this: >
8898 :cnoremap <Left> <Space><BS><Left>
8899 :cnoremap <Right> <Space><BS><Right>
8900<
8901 The "WildMenu" highlighting is used for displaying the current match
8902 |hl-WildMenu|.
8903
8904 *'wildmode'* *'wim'*
8905'wildmode' 'wim' string (Vim default: "full")
8906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008907 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008908 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008909 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 first part specifies the behavior for the first use of 'wildchar',
8911 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008912
8913 Each part consists of a colon separated list consisting of the
8914 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 "" Complete only the first match.
8916 "full" Complete the next full match. After the last match,
8917 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008918 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008919 "longest" Complete till longest common string. If this doesn't
8920 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008922 "lastused" When completing buffer names and more than one buffer
8923 matches, sort buffers by time last used (other than
8924 the current buffer).
8925 When there is only a single match, it is fully completed in all cases.
8926
8927 Examples of useful colon-separated values:
8928 "longest:full" Like "longest", but also start 'wildmenu' if it is
8929 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 "list:full" When more than one match, list all matches and
8931 complete first match.
8932 "list:longest" When more than one match, list all matches and
8933 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008934 "list:lastused" When more than one buffer matches, list all matches
8935 and sort buffers by time last used (other than the
8936 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937
8938 Examples: >
8939 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008940< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 :set wildmode=longest,full
8942< Complete longest common string, then each full match >
8943 :set wildmode=list:full
8944< List all matches and complete each full match >
8945 :set wildmode=list,full
8946< List all matches without completing, then each full match >
8947 :set wildmode=longest,list
8948< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008949 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008950
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008951 *'wildoptions'* *'wop'*
8952'wildoptions' 'wop' string (default "")
8953 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008954 {not available when compiled without the |+wildignore|
8955 feature}
8956 A list of words that change how command line completion is done.
8957 Currently only one word is allowed:
8958 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008959 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008960 is displayed per line. Often used tag kinds are:
8961 d #define
8962 f function
8963 Also see |cmdline-completion|.
8964
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965 *'winaltkeys'* *'wak'*
8966'winaltkeys' 'wak' string (default "menu")
8967 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 {only used in Win32, Motif, GTK and Photon GUI}
8969 Some GUI versions allow the access to menu entries by using the ALT
8970 key in combination with a character that appears underlined in the
8971 menu. This conflicts with the use of the ALT key for mappings and
8972 entering special characters. This option tells what to do:
8973 no Don't use ALT keys for menus. ALT key combinations can be
8974 mapped, but there is no automatic handling. This can then be
8975 done with the |:simalt| command.
8976 yes ALT key handling is done by the windowing system. ALT key
8977 combinations cannot be mapped.
8978 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008979 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 keys can be mapped.
8981 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8982 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008983 This option is not used for <F10>; on Win32 and with GTK <F10> will
8984 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008985
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008986 *'wincolor'* *'wcr'*
8987'wincolor' 'wcr' string (default empty)
8988 local to window
8989 Highlight group name to use for this window instead of the Normal
8990 color |hl-Normal|.
8991
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008992 *'window'* *'wi'*
8993'window' 'wi' number (default screen height - 1)
8994 global
Bram Moolenaardad44732021-03-31 20:07:33 +02008995 Window height used for |CTRL-F| and |CTRL-B| when there is only one
8996 window and the value is smaller than 'lines' minus one. The screen
8997 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008998 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8999 in a much smarter way, taking care of wrapping lines.
9000 When resizing the Vim window, the value is smaller than 1 or more than
9001 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02009002 Note: Do not confuse this with the height of the Vim window, use
9003 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009004
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 *'winheight'* *'wh'* *E591*
9006'winheight' 'wh' number (default 1)
9007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009009 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009010 focus goes to a window that is smaller, its size is increased, at the
9011 cost of the height of other windows.
9012 Set 'winheight' to a small number for normal editing.
9013 Set it to 999 to make the current window fill most of the screen.
9014 Other windows will be only 'winminheight' high. This has the drawback
9015 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9016 to create only two windows, set the option after startup is done,
9017 using the |VimEnter| event: >
9018 au VimEnter * set winheight=999
9019< Minimum value is 1.
9020 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 height of the current window.
9022 'winheight' applies to the current window. Use 'winminheight' to set
9023 the minimal height for other windows.
9024
9025 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9026'winfixheight' 'wfh' boolean (default off)
9027 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009029 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9030 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 The height may be changed anyway when running out of room.
9032
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009033 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9034'winfixwidth' 'wfw' boolean (default off)
9035 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009036 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009037 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009038 The width may be changed anyway when running out of room.
9039
Bram Moolenaar071d4272004-06-13 20:20:40 +00009040 *'winminheight'* *'wmh'*
9041'winminheight' 'wmh' number (default 1)
9042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043 The minimal height of a window, when it's not the current window.
9044 This is a hard minimum, windows will never become smaller.
9045 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9046 status bar) if necessary. They will return to at least one line when
9047 they become active (since the cursor has to have somewhere to go.)
9048 Use 'winheight' to set the minimal height of the current window.
9049 This option is only checked when making a window smaller. Don't use a
9050 large number, it will cause errors when opening more than a few
9051 windows. A value of 0 to 3 is reasonable.
9052
9053 *'winminwidth'* *'wmw'*
9054'winminwidth' 'wmw' number (default 1)
9055 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009056 The minimal width of a window, when it's not the current window.
9057 This is a hard minimum, windows will never become smaller.
9058 When set to zero, windows may be "squashed" to zero columns (i.e. just
9059 a vertical separator) if necessary. They will return to at least one
9060 line when they become active (since the cursor has to have somewhere
9061 to go.)
9062 Use 'winwidth' to set the minimal width of the current window.
9063 This option is only checked when making a window smaller. Don't use a
9064 large number, it will cause errors when opening more than a few
9065 windows. A value of 0 to 12 is reasonable.
9066
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009067 *'winptydll'*
9068'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9069 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009070 {only available when compiled with the |terminal|
9071 feature on MS-Windows}
9072 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009073 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009074 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009075 a fallback.
9076 Environment variables are expanded |:set_env|.
9077 This option cannot be set from a |modeline| or in the |sandbox|, for
9078 security reasons.
9079
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 *'winwidth'* *'wiw'* *E592*
9081'winwidth' 'wiw' number (default 20)
9082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009083 Minimal number of columns for the current window. This is not a hard
9084 minimum, Vim will use fewer columns if there is not enough room. If
9085 the current window is smaller, its size is increased, at the cost of
9086 the width of other windows. Set it to 999 to make the current window
9087 always fill the screen. Set it to a small number for normal editing.
9088 The width is not adjusted after one of the commands to change the
9089 width of the current window.
9090 'winwidth' applies to the current window. Use 'winminwidth' to set
9091 the minimal width for other windows.
9092
9093 *'wrap'* *'nowrap'*
9094'wrap' boolean (default on)
9095 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009096 This option changes how text is displayed. It doesn't change the text
9097 in the buffer, see 'textwidth' for that.
9098 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009099 displaying continues on the next line. When off lines will not wrap
9100 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009101 moved to a part that is not shown, the screen will scroll
9102 horizontally.
9103 The line will be broken in the middle of a word if necessary. See
9104 'linebreak' to get the break at a word boundary.
9105 To make scrolling horizontally a bit more useful, try this: >
9106 :set sidescroll=5
9107 :set listchars+=precedes:<,extends:>
9108< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009109 This option can't be set from a |modeline| when the 'diff' option is
9110 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009111
9112 *'wrapmargin'* *'wm'*
9113'wrapmargin' 'wm' number (default 0)
9114 local to buffer
9115 Number of characters from the right window border where wrapping
9116 starts. When typing text beyond this limit, an <EOL> will be inserted
9117 and inserting continues on the next line.
9118 Options that add a margin, such as 'number' and 'foldcolumn', cause
9119 the text width to be further reduced. This is Vi compatible.
9120 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009121 This option is set to 0 when 'paste' is set and restored when 'paste'
9122 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009123 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124
9125 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9126'wrapscan' 'ws' boolean (default on) *E384* *E385*
9127 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009128 Searches wrap around the end of the file. Also applies to |]s| and
9129 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130
9131 *'write'* *'nowrite'*
9132'write' boolean (default on)
9133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009134 Allows writing files. When not set, writing a file is not allowed.
9135 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009136 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009137 argument. Filtering text is still possible, even though this requires
9138 writing a temporary file.
9139
9140 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9141'writeany' 'wa' boolean (default off)
9142 global
9143 Allows writing to any file with no need for "!" override.
9144
9145 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9146'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9147 otherwise)
9148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009149 Make a backup before overwriting a file. The backup is removed after
9150 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009151 also on.
9152 WARNING: Switching this option off means that when Vim fails to write
9153 your buffer correctly and then, for whatever reason, Vim exits, you
9154 lose both the original file and what you were writing. Only reset
9155 this option if your file system is almost full and it makes the write
9156 fail (and make sure not to exit Vim until the write was successful).
9157 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009158 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009159 Depending on 'backupcopy' the backup is a new file or the original
9160 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161 NOTE: This option is set to the default value when 'compatible' is
9162 set.
9163
9164 *'writedelay'* *'wd'*
9165'writedelay' 'wd' number (default 0)
9166 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009167 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009168 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009169 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009171 vim:tw=78:ts=8:noet:ft=help:norl: