blob: 7fe371b5213cc76e8c2472a8f11fb334628db476 [file] [log] [blame]
Bram Moolenaar113cb512021-11-07 20:27:04 +00001*options.txt* For Vim version 8.2. Last change: 2021 Nov 06
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
374Setting the filetype
375
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200376:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377 Set the 'filetype' option to {filetype}, but only if
378 not done yet in a sequence of (nested) autocommands.
379 This is short for: >
380 :if !did_filetype()
381 : setlocal filetype={filetype}
382 :endif
383< This command is used in a filetype.vim file to avoid
384 setting the 'filetype' option twice, causing different
385 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200386
387 When the optional FALLBACK argument is present, a
388 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100389 'filetype'. This is to be used for filetype
390 detections that are just a guess. |did_filetype()|
391 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200392
Bram Moolenaard58e9292011-02-09 17:07:58 +0100393 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
395:opt[ions] Open a window for viewing and setting all options.
396 Options are grouped by function.
397 Offers short help for each option. Hit <CR> on the
398 short help to open a help window with more help for
399 the option.
400 Modify the value of the option and hit <CR> on the
401 "set" line to set the new value. For window and
402 buffer specific options, the last accessed window is
403 used to set the option value in, unless this is a help
404 window, in which case the window below help window is
405 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100406 {not available when compiled without the |+eval|
407 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408
409 *$HOME*
410Using "~" is like using "$HOME", but it is only recognized at the start of an
411option and after a space or comma.
412
413On Unix systems "~user" can be used too. It is replaced by the home directory
414of user "user". Example: >
415 :set path=~mool/include,/usr/include,.
416
417On Unix systems the form "${HOME}" can be used too. The name between {} can
418contain non-id characters then. Note that if you want to use this for the
419"gf" command, you need to add the '{' and '}' characters to 'isfname'.
420
421NOTE: expanding environment variables and "~/" is only done with the ":set"
422command, not when assigning a value to an option with ":let".
423
Bram Moolenaarc572da52017-08-27 16:52:01 +0200424 *$HOME-windows*
425On MS-Windows, if $HOME is not defined as an environment variable, then
426at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200427If $HOMEDRIVE is not set then $USERPROFILE is used.
428
429This expanded value is not exported to the environment, this matters when
430running an external command: >
431 :echo system('set | findstr ^HOME=')
432and >
433 :echo luaeval('os.getenv("HOME")')
434should echo nothing (an empty string) despite exists('$HOME') being true.
435When setting $HOME to a non-empty string it will be exported to the
436subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200437
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
439Note the maximum length of an expanded option is limited. How much depends on
440the system, mostly it is something like 256 or 1024 characters.
441
442 *:fix* *:fixdel*
443:fix[del] Set the value of 't_kD':
444 't_kb' is 't_kD' becomes ~
445 CTRL-? CTRL-H
446 not CTRL-? CTRL-?
447
Bram Moolenaar82be4842021-01-11 19:40:15 +0100448 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449
450 If your delete key terminal code is wrong, but the
451 code for backspace is alright, you can put this in
452 your .vimrc: >
453 :fixdel
454< This works no matter what the actual code for
455 backspace is.
456
457 If the backspace key terminal code is wrong you can
458 use this: >
459 :if &term == "termname"
460 : set t_kb=^V<BS>
461 : fixdel
462 :endif
463< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000464 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000465 with your terminal name.
466
467 If your <Delete> key sends a strange key sequence (not
468 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
469 :if &term == "termname"
470 : set t_kD=^V<Delete>
471 :endif
472< Where "^V" is CTRL-V and "<Delete>" is the delete key
473 (don't type eight characters!). Replace "termname"
474 with your terminal name.
475
476 *Linux-backspace*
477 Note about Linux: By default the backspace key
478 produces CTRL-?, which is wrong. You can fix it by
479 putting this line in your rc.local: >
480 echo "keycode 14 = BackSpace" | loadkeys
481<
482 *NetBSD-backspace*
483 Note about NetBSD: If your backspace doesn't produce
484 the right code, try this: >
485 xmodmap -e "keycode 22 = BackSpace"
486< If this works, add this in your .Xmodmap file: >
487 keysym 22 = BackSpace
488< You need to restart for this to take effect.
489
490==============================================================================
4912. Automatically setting options *auto-setting*
492
493Besides changing options with the ":set" command, there are three alternatives
494to set options automatically for one or more files:
495
4961. When starting Vim initializations are read from various places. See
497 |initialization|. Most of them are performed for all editing sessions,
498 and some of them depend on the directory where Vim is started.
499 You can create an initialization file with |:mkvimrc|, |:mkview| and
500 |:mksession|.
5012. If you start editing a new file, the automatic commands are executed.
502 This can be used to set options for files matching a particular pattern and
503 many other things. See |autocommand|.
5043. If you start editing a new file, and the 'modeline' option is on, a
505 number of lines at the beginning and end of the file are checked for
506 modelines. This is explained here.
507
508 *modeline* *vim:* *vi:* *ex:* *E520*
509There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100510 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100512[text{white}] empty or any text followed by at least one blank
513 character (<Space> or <Tab>); "ex:" always requires at
514 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200515{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200516[white] optional white space
517{options} a list of option settings, separated with white space
518 or ':', where each part between ':' is the argument
519 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000520
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200523 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000524
525The second form (this is compatible with some versions of Vi):
526
Bram Moolenaarade0d392020-01-21 22:33:58 +0100527 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
Bram Moolenaarade0d392020-01-21 22:33:58 +0100529[text{white}] empty or any text followed by at least one blank
530 character (<Space> or <Tab>); "ex:" always requires at
531 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
533[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534se[t] the string "set " or "se " (note the space); When
535 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200536{options} a list of options, separated with white space, which
537 is the argument for a ":set" command
538: a colon
539[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
Bram Moolenaar14b69452013-06-29 23:05:20 +0200541Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000542 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200543 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200545The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
546chance that a normal word like "lex:" is caught. There is one exception:
547"vi:" and "vim:" can also be at the start of the line (for compatibility with
548version 3.0). Using "ex:" at the start of the line will be ignored (this
549could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
Hu Jialun9dcd3492021-08-28 20:42:50 +0200551If the modeline is disabled within a modeline, subsequent modelines will be
552ignored. This is to allow turning off modeline on a per-file basis. This is
553useful when a line looks like a modeline but isn't. For example, it would be
554good to start a YAML file containing strings like "vim:" with
555 # vim: nomodeline ~
556so as to avoid modeline misdetection. Following options on the same line
557after modeline deactivation, if any, are still evaluated (but you would
558normally not have any).
559
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560 *modeline-local*
561The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000562buffer and window that contain the file. Although it's possible to set global
563options from a modeline, this is unusual. If you have two windows open and
564the files in it set the same global option to a different value, the result
565depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000567When editing a file that was already loaded, only the window-local options
568from the modeline are used. Thus if you manually changed a buffer-local
569option after opening the file, it won't be changed if you edit the same buffer
570in another window. But window-local options will be set.
571
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572 *modeline-version*
573If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200574number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575 vim{vers}: version {vers} or later
576 vim<{vers}: version before {vers}
577 vim={vers}: version {vers}
578 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100579{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
580For example, to use a modeline only for Vim 7.0:
581 /* vim700: set foldmethod=marker */ ~
582To use a modeline for Vim after version 7.2:
583 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584There can be no blanks between "vim" and the ":".
585
586
587The number of lines that are checked can be set with the 'modelines' option.
588If 'modeline' is off or 'modelines' is 0 no lines are checked.
589
590Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000591like:
592 /* vi:ts=4: */ ~
593will give an error message for the trailing "*/". This line is OK:
594 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595
596If an error is detected the rest of the line is skipped.
597
598If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000599backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100600 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
601This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
602before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200603 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000605might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200606can be set. For some options a flag is set, so that when the value is used
607the |sandbox| is effective. Some options can only be set from the modeline
608when 'modelineexpr' is set (the default is off).
609
610Still, there is always a small risk that a modeline causes trouble. E.g.,
611when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
612So disable modelines before editing untrusted text. The mail ftplugin does
613this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614
615Hint: If you would like to do something else than setting an option, you could
616define an autocommand that checks the file for a specific string. For
617example: >
618 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
619And define a function SetVar() that does something with the line containing
620"VAR".
621
622==============================================================================
6233. Options summary *option-summary*
624
625In the list below all the options are mentioned with their full name and with
626an abbreviation if there is one. Both forms may be used.
627
628In this document when a boolean option is "set" that means that ":set option"
629is entered. When an option is "reset", ":set nooption" is used.
630
631For some options there are two default values: The "Vim default", which is
632used when 'compatible' is not set, and the "Vi default", which is used when
633'compatible' is set.
634
635Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000636are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637different value in each window. For example the 'list' option can be set in
638one window and reset in another for the same text, giving both types of view
639at the same time. There are a few options that are specific to a certain
640file. These can have a different value for each file or buffer. For example
641the 'textwidth' option can be 78 for a normal text file and 0 for a C
642program.
643
644 global one option for all buffers and windows
645 local to window each window has its own copy of this option
646 local to buffer each buffer has its own copy of this option
647
648When creating a new window the option values from the currently active window
649are used as a default value for the window-specific options. For the
650buffer-specific options this depends on the 's' and 'S' flags in the
651'cpoptions' option. If 's' is included (which is the default) the values for
652buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000653first entered. If 'S' is present the options are copied each time the buffer
654is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655present, the options are copied from the currently active buffer when the
656buffer is created.
657
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000658Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000660Not all options are supported in all versions. This depends on the supported
661features and sometimes on the system. A remark about this is in curly braces
662below. When an option is not supported it may still be set without getting an
663error, this is called a hidden option. You can't get the value of a hidden
664option though, it is not stored.
665
666To test if option "foo" can be used with ":set" use something like this: >
667 if exists('&foo')
668This also returns true for a hidden option. To test if option "foo" is really
669supported use something like this: >
670 if exists('+foo')
671<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 *E355*
673A jump table for the options with a short description can be found at |Q_op|.
674
675 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100676'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 {only available when compiled with the |+rightleft|
679 feature}
680 The ASCII code for the first letter of the Hebrew alphabet. The
681 routine that maps the keyboard in Hebrew mode, both in Insert mode
682 (when hkmap is set) and on the command-line (when hitting CTRL-_)
683 outputs the Hebrew characters in the range [aleph..aleph+26].
684 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
685 See |rileft.txt|.
686
687 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
688'allowrevins' 'ari' boolean (default off)
689 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690 {only available when compiled with the |+rightleft|
691 feature}
692 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
693 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
694 into reverse Insert mode, and don't know how to get out. See
695 'revins'.
696 NOTE: This option is reset when 'compatible' is set.
697
698 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
699'altkeymap' 'akm' boolean (default off)
700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701 {only available when compiled with the |+farsi|
702 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100703 This option was for using Farsi, which has been removed. See
704 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705
706 *'ambiwidth'* *'ambw'*
707'ambiwidth' 'ambw' string (default: "single")
708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
710 Tells Vim what to do with characters with East Asian Width Class
711 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
712 letters, Cyrillic letters).
713
714 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000715 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 expected by most users.
717 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200718 *E834* *E835*
719 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100720 contains a character that would be double width. These errors may
721 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200722
723 The values are overruled for characters specified with
724 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725
726 There are a number of CJK fonts for which the width of glyphs for
727 those characters are solely based on how many octets they take in
728 legacy/traditional CJK encodings. In those encodings, Euro,
729 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000730 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000732 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 Vim is running inside a terminal (emulators) that uses a CJK font
734 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
735 this option should be set to "double" to match the width perceived
736 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100737 to be set to "double" under CJK MS-Windows when the system locale is
738 set to one of CJK locales. See Unicode Standard Annex #11
739 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100741 Vim may set this option automatically at startup time when Vim is
742 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200743 escape sequence to request cursor position report. The response can
744 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100745
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
747'antialias' 'anti' boolean (default: off)
748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200750 on macOS}
751 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
753 which can be easier to read at certain sizes on certain displays.
754 Setting this option can sometimes cause problems if 'guifont' is set
755 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100756 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757
758 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
759'autochdir' 'acd' boolean (default off)
760 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200761 {only available when compiled with it, use
762 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000763 When on, Vim will change the current working directory whenever you
764 open a file, switch buffers, delete a buffer or open/close a window.
765 It will change to the directory containing the file which was opened
766 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000767 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200769 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
770'autoshelldir' 'asd' boolean (default off)
771 global
772 When on, Vim will change the current working directory whenever you
773 change the directory of the shell running in a terminal window. You
774 need proper setting-up, so whenever the shell's pwd changes an OSC 7
775 escape sequence will be emitted. For example, on Linux, you can source
776 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
777
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
779'arabic' 'arab' boolean (default off)
780 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 {only available when compiled with the |+arabic|
782 feature}
783 This option can be set to start editing Arabic text.
784 Setting this option will:
785 - Set the 'rightleft' option, unless 'termbidi' is set.
786 - Set the 'arabicshape' option, unless 'termbidi' is set.
787 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
788 between typing English and Arabic key mapping.
789 - Set the 'delcombine' option
790 Note that 'encoding' must be "utf-8" for working with Arabic text.
791
792 Resetting this option will:
793 - Reset the 'rightleft' option.
794 - Disable the use of 'keymap' (without changing its value).
795 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200796 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100797 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 Also see |arabic.txt|.
799
800 *'arabicshape'* *'arshape'*
801 *'noarabicshape'* *'noarshape'*
802'arabicshape' 'arshape' boolean (default on)
803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 {only available when compiled with the |+arabic|
805 feature}
806 When on and 'termbidi' is off, the required visual character
807 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200808 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809 one which encompasses:
810 a) the changing/morphing of characters based on their location
811 within a word (initial, medial, final and stand-alone).
812 b) the enabling of the ability to compose characters
813 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100814 When disabled the display shows each character's true stand-alone
815 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 Arabic is a complex language which requires other settings, for
817 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100818 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819
820 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
821'autoindent' 'ai' boolean (default off)
822 local to buffer
823 Copy indent from current line when starting a new line (typing <CR>
824 in Insert mode or when using the "o" or "O" command). If you do not
825 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000826 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
827 to another line has the same effect, unless the 'I' flag is included
828 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000829 When autoindent is on, formatting (with the "gq" command or when you
830 reach 'textwidth' in Insert mode) uses the indentation of the first
831 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 When 'smartindent' or 'cindent' is on the indent is changed in
833 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200834 The 'autoindent' option is reset when the 'paste' option is set and
835 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836
837 *'autoread'* *'ar'* *'noautoread'* *'noar'*
838'autoread' 'ar' boolean (default off)
839 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 When a file has been detected to have been changed outside of Vim and
841 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200842 When the file has been deleted this is not done, so you have the text
843 from before it was deleted. When it appears again then it is read.
844 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 If this option has a local value, use this command to switch back to
846 using the global value: >
847 :set autoread<
848<
849 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
850'autowrite' 'aw' boolean (default off)
851 global
852 Write the contents of the file, if it has been modified, on each
853 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000854 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
856 Note that for some commands the 'autowrite' option is not used, see
857 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200858 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200859 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860
861 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
862'autowriteall' 'awa' boolean (default off)
863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
865 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
866 Setting this option also implies that Vim behaves like 'autowrite' has
867 been set.
868
869 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200870'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 When set to "dark", Vim will try to use colors that look good on a
873 dark background. When set to "light", Vim will try to use colors that
874 look good on a light background. Any other value is illegal.
875 Vim tries to set the default value according to the terminal used.
876 This will not always be correct.
877 Setting this option does not change the background color, it tells Vim
878 what the background color looks like. For changing the background
879 color, see |:hi-normal|.
880
881 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000882 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000883 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100884 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 setting 'background' will cause the color scheme to be reloaded. If
886 the color scheme adjusts to the value of 'background' this will work.
887 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100888 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889
890 When setting 'background' to the default value with: >
891 :set background&
892< Vim will guess the value. In the GUI this should work correctly,
893 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200894 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200895 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200897 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200898 color from the terminal. If the returned RGB value is dark/light and
899 'background' is not dark/light, 'background' will be set and the
900 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200901 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100902 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200903
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 When starting the GUI, the default value for 'background' will be
905 "light". When the value is not set in the .gvimrc, and Vim detects
906 that the background is actually quite dark, 'background' is set to
907 "dark". But this happens only AFTER the .gvimrc file has been read
908 (because the window needs to be opened to find the actual background
909 color). To get around this, force the GUI window to be opened by
910 putting a ":gui" command in the .gvimrc file, before where the value
911 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200912
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100913 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200914 For other systems "dark" is used when 'term' is "linux",
915 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
916 background. Otherwise the default is "light".
917
Bram Moolenaarc572da52017-08-27 16:52:01 +0200918 The |:terminal| command and the |term_start()| function use the
919 'background' value to decide whether the terminal window will start
920 with a white or black background.
921
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 Normally this option would be set in the .vimrc file. Possibly
923 depending on the terminal name. Example: >
924 :if &term == "pcterm"
925 : set background=dark
926 :endif
927< When this option is set, the default settings for the highlight groups
928 will change. To use other settings, place ":highlight" commands AFTER
929 the setting of the 'background' option.
930 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
931 to select the colors for syntax highlighting. After changing this
932 option, you must load syntax.vim again to see the result. This can be
933 done with ":syntax on".
934
935 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200936'backspace' 'bs' string (default "", set to "indent,eol,start"
937 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
940 mode. This is a list of items, separated by commas. Each item allows
941 a way to backspace over something:
942 value effect ~
943 indent allow backspacing over autoindent
944 eol allow backspacing over line breaks (join lines)
945 start allow backspacing over the start of insert; CTRL-W and CTRL-U
946 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200947 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
948 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949
950 When the value is empty, Vi compatible backspacing is used.
951
952 For backwards compatibility with version 5.4 and earlier:
953 value effect ~
954 0 same as ":set backspace=" (Vi compatible)
955 1 same as ":set backspace=indent,eol"
956 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200957 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958
959 See |:fixdel| if your <BS> or <Del> key does not do what you want.
960 NOTE: This option is set to "" when 'compatible' is set.
961
962 *'backup'* *'bk'* *'nobackup'* *'nobk'*
963'backup' 'bk' boolean (default off)
964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 Make a backup before overwriting a file. Leave it around after the
966 file has been successfully written. If you do not want to keep the
967 backup file, but you do want a backup while the file is being
968 written, reset this option and set the 'writebackup' option (this is
969 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000970 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971 |backup-table| for more explanations.
972 When the 'backupskip' pattern matches, a backup is not made anyway.
973 When 'patchmode' is set, the backup may be renamed to become the
974 oldest version of a file.
975 NOTE: This option is reset when 'compatible' is set.
976
977 *'backupcopy'* *'bkc'*
978'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200979 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980 When writing a file and a backup is made, this option tells how it's
981 done. This is a comma separated list of words.
982
983 The main values are:
984 "yes" make a copy of the file and overwrite the original one
985 "no" rename the file and write a new one
986 "auto" one of the previous, what works best
987
988 Extra values that can be combined with the ones above are:
989 "breaksymlink" always break symlinks when writing
990 "breakhardlink" always break hardlinks when writing
991
992 Making a copy and overwriting the original file:
993 - Takes extra time to copy the file.
994 + When the file has special attributes, is a (hard/symbolic) link or
995 has a resource fork, all this is preserved.
996 - When the file is a link the backup will have the name of the link,
997 not of the real file.
998
999 Renaming the file and writing a new one:
1000 + It's fast.
1001 - Sometimes not all attributes of the file can be copied to the new
1002 file.
1003 - When the file is a link the new file will not be a link.
1004
1005 The "auto" value is the middle way: When Vim sees that renaming file
1006 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001007 the file is not a link) that is used. When problems are expected, a
1008 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009
1010 The "breaksymlink" and "breakhardlink" values can be used in
1011 combination with any of "yes", "no" and "auto". When included, they
1012 force Vim to always break either symbolic or hard links by doing
1013 exactly what the "no" option does, renaming the original file to
1014 become the backup and writing a new file in its place. This can be
1015 useful for example in source trees where all the files are symbolic or
1016 hard links and any changes should stay in the local source tree, not
1017 be propagated back to the original source.
1018 *crontab*
1019 One situation where "no" and "auto" will cause problems: A program
1020 that opens a file, invokes Vim to edit that file, and then tests if
1021 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001022 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 example.
1024
1025 When a copy is made, the original file is truncated and then filled
1026 with the new text. This means that protection bits, owner and
1027 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001028 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 group of the backup is set to the group of the original file. If this
1030 fails, the protection bits for the group are made the same as for
1031 others.
1032
1033 When the file is renamed this is the other way around: The backup has
1034 the same attributes of the original file, and the newly written file
1035 is owned by the current user. When the file was a (hard/symbolic)
1036 link, the new file will not! That's why the "auto" value doesn't
1037 rename when the file is a link. The owner and group of the newly
1038 written file will be set to the same ones as the original file, but
1039 the system may refuse to do this. In that case the "auto" value will
1040 again not rename the file.
1041
Bram Moolenaar036986f2017-03-16 17:41:02 +01001042 NOTE: This option is set to the Vi default value when 'compatible' is
1043 set and to the Vim default value when 'compatible' is reset.
1044
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 *'backupdir'* *'bdir'*
1046'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001047 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 for Unix: ".,~/tmp,~/")
1049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050 List of directories for the backup file, separated with commas.
1051 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001052 where this is possible. The directory must exist, Vim will not
1053 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001054 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 impossible!). Writing may fail because of this.
1056 - A directory "." means to put the backup file in the same directory
1057 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001058 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1059 the backup file relative to where the edited file is. The leading
1060 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 ("." inside a directory name has no special meaning).
1062 - Spaces after the comma are ignored, other spaces are considered part
1063 of the directory name. To have a space at the start of a directory
1064 name, precede it with a backslash.
1065 - To include a comma in a directory name precede it with a backslash.
1066 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001067 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001068 the backup file name will be built from the complete path to the
1069 file with all path separators changed to percent '%' signs. This
1070 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001071 On Win32, it is also possible to end with "\\". However, When a
1072 separating comma is following, you must use "//", since "\\" will
1073 include the comma in the file name. Therefore it is recommended to
1074 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 - Environment variables are expanded |:set_env|.
1076 - Careful with '\' characters, type one before a space, type two to
1077 get one in the option (see |option-backslash|), for example: >
1078 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1079< - For backwards compatibility with Vim version 3.0 a '>' at the start
1080 of the option is removed.
1081 See also 'backup' and 'writebackup' options.
1082 If you want to hide your backup files on Unix, consider this value: >
1083 :set backupdir=./.backup,~/.backup,.,/tmp
1084< You must create a ".backup" directory in each directory and in your
1085 home directory for this to work properly.
1086 The use of |:set+=| and |:set-=| is preferred when adding or removing
1087 directories from the list. This avoids problems when a future version
1088 uses another default.
1089 This option cannot be set from a |modeline| or in the |sandbox|, for
1090 security reasons.
1091
1092 *'backupext'* *'bex'* *E589*
1093'backupext' 'bex' string (default "~", for VMS: "_")
1094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 String which is appended to a file name to make the name of the
1096 backup file. The default is quite unusual, because this avoids
1097 accidentally overwriting existing files with a backup file. You might
1098 prefer using ".bak", but make sure that you don't have files with
1099 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001100 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001102 If you like to keep a lot of backups, you could use a BufWritePre
1103 autocommand to change 'backupext' just before writing the file to
1104 include a timestamp. >
1105 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1106< Use 'backupdir' to put the backup in a different directory.
1107
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001109'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1110 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1111 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 {not available when compiled without the |+wildignore|
1114 feature}
1115 A list of file patterns. When one of the patterns matches with the
1116 name of the file which is written, no backup file is created. Both
1117 the specified file name and the full path name of the file are used.
1118 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1119 Watch out for special characters, see |option-backslash|.
1120 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001121 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001122
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001123 WARNING: Not having a backup file means that when Vim fails to write
1124 your buffer correctly and then, for whatever reason, Vim exits, you
1125 lose both the original file and what you were writing. Only disable
1126 backups if you don't care about losing the file.
1127
Bram Moolenaar02467872007-05-06 13:22:01 +00001128 Note that environment variables are not expanded. If you want to use
1129 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001130 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001131
1132< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001133 backup would be made by renaming the original file crontab won't see
1134 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135
1136 *'balloondelay'* *'bdlay'*
1137'balloondelay' 'bdlay' number (default: 600)
1138 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001139 {only available when compiled with the |+balloon_eval|
1140 feature}
1141 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1142
1143 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1144'ballooneval' 'beval' boolean (default off)
1145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001147 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001148 Switch on the |balloon-eval| functionality for the GUI.
1149
1150 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1151 *'nobevalterm'*
1152'balloonevalterm' 'bevalterm' boolean (default off)
1153 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001154 {only available when compiled with the
1155 |+balloon_eval_term| feature}
1156 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001158 *'balloonexpr'* *'bexpr'*
1159'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001160 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001161 {only available when compiled with the |+balloon_eval|
1162 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001163 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001164 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1165 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001166
1167 v:beval_bufnr number of the buffer in which balloon is going to show
1168 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001169 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001170 v:beval_lnum line number
1171 v:beval_col column number (byte index)
1172 v:beval_text word under or after the mouse pointer
1173
Bram Moolenaar54775062019-07-31 21:07:14 +02001174 Instead of showing a balloon, which is limited to plain text, consider
1175 using a popup window, see |popup_beval_example|. A popup window can
1176 use highlighting and show a border.
1177
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001178 The evaluation of the expression must not have side effects!
1179 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001180 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001181 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001182 \', column ' . v:beval_col .
1183 \ ' of file ' . bufname(v:beval_bufnr) .
1184 \ ' on word "' . v:beval_text . '"'
1185 endfunction
1186 set bexpr=MyBalloonExpr()
1187 set ballooneval
1188<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001189 Also see |balloon_show()|, it can be used if the content of the balloon
1190 is to be fetched asynchronously. In that case evaluating
1191 'balloonexpr' should result in an empty string. If you get a balloon
1192 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001193
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001194 NOTE: The balloon is displayed only if the cursor is on a text
1195 character. If the result of evaluating 'balloonexpr' is not empty,
1196 Vim does not try to send a message to an external debugger (Netbeans
1197 or Sun Workshop).
1198
Bram Moolenaar30b65812012-07-12 22:01:11 +02001199 The expression will be evaluated in the |sandbox| when set from a
1200 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001201 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001202
1203 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001204 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001205
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001206 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001207 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001208< When they are supported "\n" characters will start a new line. If the
1209 expression evaluates to a |List| this is equal to using each List item
1210 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001211 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001212
Bram Moolenaar165bc692015-07-21 17:53:25 +02001213 *'belloff'* *'bo'*
1214'belloff' 'bo' string (default "")
1215 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001216 Specifies for which events the bell will not be rung. It is a comma
1217 separated list of items. For each item that is present, the bell
1218 will be silenced. This is most useful to specify specific events in
1219 insert mode to be silenced.
1220
1221 item meaning when present ~
1222 all All events.
1223 backspace When hitting <BS> or <Del> and deleting results in an
1224 error.
1225 cursor Fail to move around using the cursor keys or
1226 <PageUp>/<PageDown> in |Insert-mode|.
1227 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1228 |i_CTRL-X_CTRL-T|.
1229 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1230 |i_CTRL-E|.
1231 ctrlg Unknown Char after <C-G> in Insert mode.
1232 error Other Error occurred (e.g. try to join last line)
1233 (mostly used in |Normal-mode| or |Cmdline-mode|).
1234 esc hitting <Esc> in |Normal-mode|.
1235 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001236 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001237 insertmode Pressing <Esc> in 'insertmode'.
1238 lang Calling the beep module for Lua/Mzscheme/TCL.
1239 mess No output available for |g<|.
1240 showmatch Error occurred for 'showmatch' function.
1241 operator Empty region error |cpo-E|.
1242 register Unknown register after <C-R> in |Insert-mode|.
1243 shell Bell from shell output |:!|.
1244 spell Error happened on spell suggest.
1245 wildmode More matches in |cmdline-completion| available
1246 (depends on the 'wildmode' setting).
1247
Bram Moolenaar036986f2017-03-16 17:41:02 +01001248 This is most useful to fine tune when in Insert mode the bell should
1249 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001250 indicate that an error occurred. It can be silenced by adding the
1251 "error" keyword.
1252
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1254'binary' 'bin' boolean (default off)
1255 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 This option should be set before editing a binary file. You can also
1257 use the |-b| Vim argument. When this option is switched on a few
1258 options will be changed (also when it already was on):
1259 'textwidth' will be set to 0
1260 'wrapmargin' will be set to 0
1261 'modeline' will be off
1262 'expandtab' will be off
1263 Also, 'fileformat' and 'fileformats' options will not be used, the
1264 file is read and written like 'fileformat' was "unix" (a single <NL>
1265 separates lines).
1266 The 'fileencoding' and 'fileencodings' options will not be used, the
1267 file is read without conversion.
1268 NOTE: When you start editing a(nother) file while the 'bin' option is
1269 on, settings from autocommands may change the settings again (e.g.,
1270 'textwidth'), causing trouble when editing. You might want to set
1271 'bin' again when the file has been loaded.
1272 The previous values of these options are remembered and restored when
1273 'bin' is switched from on to off. Each buffer has its own set of
1274 saved option values.
1275 To edit a file with 'binary' set you can use the |++bin| argument.
1276 This avoids you have to do ":set bin", which would have effect for all
1277 files you edit.
1278 When writing a file the <EOL> for the last line is only written if
1279 there was one in the original file (normally Vim appends an <EOL> to
1280 the last line if there is none; this would make the file longer). See
1281 the 'endofline' option.
1282
1283 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1284'bioskey' 'biosk' boolean (default on)
1285 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001286 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001287 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288
1289 *'bomb'* *'nobomb'*
1290'bomb' boolean (default off)
1291 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 When writing a file and the following conditions are met, a BOM (Byte
1293 Order Mark) is prepended to the file:
1294 - this option is on
1295 - the 'binary' option is off
1296 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1297 endian variants.
1298 Some applications use the BOM to recognize the encoding of the file.
1299 Often used for UCS-2 files on MS-Windows. For other applications it
1300 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001301 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1303 check for the presence of the BOM is done and 'bomb' set accordingly.
1304 Unless 'binary' is set, it is removed from the first line, so that you
1305 don't see it when editing. When you don't change the options, the BOM
1306 will be restored when writing the file.
1307
1308 *'breakat'* *'brk'*
1309'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1310 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001311 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 feature}
1313 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001314 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1315 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001317 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001318'breakindent' 'bri' boolean (default off)
1319 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001320 {not available when compiled without the |+linebreak|
1321 feature}
1322 Every wrapped line will continue visually indented (same amount of
1323 space as the beginning of that line), thus preserving horizontal blocks
1324 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001325 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001326
1327 *'breakindentopt'* *'briopt'*
1328'breakindentopt' 'briopt' string (default empty)
1329 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001330 {not available when compiled without the |+linebreak|
1331 feature}
1332 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001333 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001334 min:{n} Minimum text width that will be kept after
1335 applying 'breakindent', even if the resulting
1336 text should normally be narrower. This prevents
1337 text indented almost to the right window border
1338 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001339 shift:{n} After applying 'breakindent', the wrapped line's
1340 beginning will be shifted by the given number of
1341 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001342 indentation (negative) or emphasizing the line
1343 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001344 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001345 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001346 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001347 numbered or bulleted list (using the
1348 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001349 list:-1 Uses the length of a match with 'formatlistpat'
1350 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001351 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001352
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001354'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001356 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001358 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001359 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 buffer Use the directory of the related buffer.
1361 current Use the current directory.
1362 {path} Use the specified directory
1363
1364 *'bufhidden'* *'bh'*
1365'bufhidden' 'bh' string (default: "")
1366 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 This option specifies what happens when a buffer is no longer
1368 displayed in a window:
1369 <empty> follow the global 'hidden' option
1370 hide hide the buffer (don't unload it), also when 'hidden'
1371 is not set
1372 unload unload the buffer, also when 'hidden' is set or using
1373 |:hide|
1374 delete delete the buffer from the buffer list, also when
1375 'hidden' is set or using |:hide|, like using
1376 |:bdelete|
1377 wipe wipe out the buffer from the buffer list, also when
1378 'hidden' is set or using |:hide|, like using
1379 |:bwipeout|
1380
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001381 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001382 are lost without a warning. Also, these values may break autocommands
1383 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 This option is used together with 'buftype' and 'swapfile' to specify
1385 special kinds of buffers. See |special-buffers|.
1386
1387 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1388'buflisted' 'bl' boolean (default: on)
1389 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 When this option is set, the buffer shows up in the buffer list. If
1391 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1392 This option is reset by Vim for buffers that are only used to remember
1393 a file name or marks. Vim sets it when starting to edit a buffer.
1394 But not when moving to a buffer with ":buffer".
1395
1396 *'buftype'* *'bt'* *E382*
1397'buftype' 'bt' string (default: "")
1398 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 The value of this option specifies the type of a buffer:
1400 <empty> normal buffer
1401 nofile buffer which is not related to a file and will not be
1402 written
1403 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001404 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001405 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001407 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408 help help buffer (you are not supposed to set this
1409 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001410 terminal buffer for a |terminal| (you are not supposed to set
1411 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001412 prompt buffer where only the last line can be edited, meant
1413 to be used by a plugin, see |prompt-buffer|
1414 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001415 popup buffer used in a popup window, see |popup|.
1416 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417
1418 This option is used together with 'bufhidden' and 'swapfile' to
1419 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001420 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421
1422 Be careful with changing this option, it can have many side effects!
Bram Moolenaar113cb512021-11-07 20:27:04 +00001423 One such effect is that Vim will not check the timestamp of the file,
1424 if the file is changed by another program this will not be noticed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425
Bram Moolenaar280f1262006-01-30 00:14:18 +00001426 A "quickfix" buffer is only used for the error list and the location
1427 list. This value is set by the |:cwindow| and |:lwindow| commands and
1428 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429
1430 "nofile" and "nowrite" buffers are similar:
1431 both: The buffer is not to be written to disk, ":w" doesn't
1432 work (":w filename" does work though).
1433 both: The buffer is never considered to be |'modified'|.
1434 There is no warning when the changes will be lost, for
1435 example when you quit Vim.
1436 both: A swap file is only created when using too much memory
1437 (when 'swapfile' has been reset there is never a swap
1438 file).
1439 nofile only: The buffer name is fixed, it is not handled like a
1440 file name. It is not modified in response to a |:cd|
1441 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001442 both: When using ":e bufname" and already editing "bufname"
1443 the buffer is made empty and autocommands are
1444 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001445 *E676*
1446 "acwrite" implies that the buffer name is not related to a file, like
1447 "nofile", but it will be written. Thus, in contrast to "nofile" and
1448 "nowrite", ":w" does work and a modified buffer can't be abandoned
1449 without saving. For writing there must be matching |BufWriteCmd|,
1450 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451
1452 *'casemap'* *'cmp'*
1453'casemap' 'cmp' string (default: "internal,keepascii")
1454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 Specifies details about changing the case of letters. It may contain
1456 these words, separated by a comma:
1457 internal Use internal case mapping functions, the current
1458 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001459 matters when 'encoding' is a Unicode encoding,
1460 "latin1" or "iso-8859-15". When "internal" is
1461 omitted, the towupper() and towlower() system library
1462 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1464 case mapping, the current locale is not effective.
1465 This probably only matters for Turkish.
1466
1467 *'cdpath'* *'cd'* *E344* *E346*
1468'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1469 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 {not available when compiled without the
1471 |+file_in_path| feature}
1472 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001473 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1474 searched for has a relative path, not an absolute part starting with
1475 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476 The 'cdpath' option's value has the same form and semantics as
1477 |'path'|. Also see |file-searching|.
1478 The default value is taken from $CDPATH, with a "," prepended to look
1479 in the current directory first.
1480 If the default value taken from $CDPATH is not what you want, include
1481 a modified version of the following command in your vimrc file to
1482 override it: >
1483 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1484< This option cannot be set from a |modeline| or in the |sandbox|, for
1485 security reasons.
1486 (parts of 'cdpath' can be passed to the shell to expand file names).
1487
1488 *'cedit'*
1489'cedit' string (Vi default: "", Vim default: CTRL-F)
1490 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 The key used in Command-line Mode to open the command-line window.
1492 The default is CTRL-F when 'compatible' is off.
1493 Only non-printable keys are allowed.
1494 The key can be specified as a single character, but it is difficult to
1495 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001496 :exe "set cedit=\<C-Y>"
1497 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498< |Nvi| also has this option, but it only uses the first character.
1499 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001500 NOTE: This option is set to the Vim default value when 'compatible'
1501 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502
1503 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1504'charconvert' 'ccv' string (default "")
1505 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001506 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 An expression that is used for character encoding conversion. It is
1508 evaluated when a file that is to be read or has been written has a
1509 different encoding from what is desired.
1510 'charconvert' is not used when the internal iconv() function is
1511 supported and is able to do the conversion. Using iconv() is
1512 preferred, because it is much faster.
1513 'charconvert' is not used when reading stdin |--|, because there is no
1514 file to convert from. You will have to save the text in a file first.
1515 The expression must return zero or an empty string for success,
1516 non-zero for failure.
1517 The possible encoding names encountered are in 'encoding'.
1518 Additionally, names given in 'fileencodings' and 'fileencoding' are
1519 used.
1520 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1521 is done internally by Vim, 'charconvert' is not used for this.
1522 'charconvert' is also used to convert the viminfo file, if the 'c'
1523 flag is present in 'viminfo'. Also used for Unicode conversion.
1524 Example: >
1525 set charconvert=CharConvert()
1526 fun CharConvert()
1527 system("recode "
1528 \ . v:charconvert_from . ".." . v:charconvert_to
1529 \ . " <" . v:fname_in . " >" v:fname_out)
1530 return v:shell_error
1531 endfun
1532< The related Vim variables are:
1533 v:charconvert_from name of the current encoding
1534 v:charconvert_to name of the desired encoding
1535 v:fname_in name of the input file
1536 v:fname_out name of the output file
1537 Note that v:fname_in and v:fname_out will never be the same.
1538 Note that v:charconvert_from and v:charconvert_to may be different
1539 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1540 Encryption is not done by Vim when using 'charconvert'. If you want
1541 to encrypt the file after conversion, 'charconvert' should take care
1542 of this.
1543 This option cannot be set from a |modeline| or in the |sandbox|, for
1544 security reasons.
1545
1546 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1547'cindent' 'cin' boolean (default off)
1548 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 {not available when compiled without the |+cindent|
1550 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001551 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 that trigger reindenting in insert mode and 'cinoptions' to set your
1553 preferred indent style.
1554 If 'indentexpr' is not empty, it overrules 'cindent'.
1555 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1556 the "=" operator indents using this algorithm rather than calling an
1557 external program.
1558 See |C-indenting|.
1559 When you don't like the way 'cindent' works, try the 'smartindent'
1560 option or 'indentexpr'.
1561 This option is not used when 'paste' is set.
1562 NOTE: This option is reset when 'compatible' is set.
1563
1564 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001565'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 {not available when compiled without the |+cindent|
1568 feature}
1569 A list of keys that, when typed in Insert mode, cause reindenting of
1570 the current line. Only used if 'cindent' is on and 'indentexpr' is
1571 empty.
1572 For the format of this option see |cinkeys-format|.
1573 See |C-indenting|.
1574
1575 *'cinoptions'* *'cino'*
1576'cinoptions' 'cino' string (default "")
1577 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 {not available when compiled without the |+cindent|
1579 feature}
1580 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1581 program. See |cinoptions-values| for the values of this option, and
1582 |C-indenting| for info on C indenting in general.
1583
1584
1585 *'cinwords'* *'cinw'*
1586'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1587 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 {not available when compiled without both the
1589 |+cindent| and the |+smartindent| features}
1590 These keywords start an extra indent in the next line when
1591 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1592 an appropriate place (inside {}).
1593 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1594 matter, include the keyword both the uppercase and lowercase:
1595 "if,If,IF".
1596
1597 *'clipboard'* *'cb'*
1598'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1599 for X-windows, "" otherwise)
1600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 {only in GUI versions or when the |+xterm_clipboard|
1602 feature is included}
1603 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001604 Note: if one of the items is "exclude:", then you can't add an item
1605 after that. Therefore do append an item with += but use ^= to
1606 prepend, e.g.: >
1607 set clipboard^=unnamed
1608< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001610 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 unnamed When included, Vim will use the clipboard register '*'
1612 for all yank, delete, change and put operations which
1613 would normally go to the unnamed register. When a
1614 register is explicitly specified, it will always be
1615 used regardless of whether "unnamed" is in 'clipboard'
1616 or not. The clipboard register can always be
1617 explicitly accessed using the "* notation. Also see
1618 |gui-clipboard|.
1619
Bram Moolenaar30b65812012-07-12 22:01:11 +02001620 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001621 unnamedplus A variant of the "unnamed" flag which uses the
1622 clipboard register '+' (|quoteplus|) instead of
1623 register '*' for all yank, delete, change and put
1624 operations which would normally go to the unnamed
1625 register. When "unnamed" is also included to the
1626 option, yank operations (but not delete, change or
1627 put) will additionally copy the text into register
1628 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001629 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001630 Availability can be checked with: >
1631 if has('unnamedplus')
1632<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001633 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 autoselect Works like the 'a' flag in 'guioptions': If present,
1635 then whenever Visual mode is started, or the Visual
1636 area extended, Vim tries to become the owner of the
1637 windowing system's global selection or put the
1638 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001639 register "*. See |'go-a'| and |quotestar| for details.
1640 When the GUI is active, the 'a' flag in 'guioptions'
1641 is used, when the GUI is not active, this "autoselect"
1642 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 Also applies to the modeless selection.
1644
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001645 *clipboard-autoselectplus*
1646 autoselectplus Like "autoselect" but using the + register instead of
1647 the * register. Compare to the 'P' flag in
1648 'guioptions'.
1649
1650 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 autoselectml Like "autoselect", but for the modeless selection
1652 only. Compare to the 'A' flag in 'guioptions'.
1653
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001654 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001655 html When the clipboard contains HTML, use this when
1656 pasting. When putting text on the clipboard, mark it
1657 as HTML. This works to copy rendered HTML from
1658 Firefox, paste it as raw HTML in Vim, select the HTML
1659 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001660 You probably want to add this only temporarily,
1661 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001662 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001663
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001664 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 exclude:{pattern}
1666 Defines a pattern that is matched against the name of
1667 the terminal 'term'. If there is a match, no
1668 connection will be made to the X server. This is
1669 useful in this situation:
1670 - Running Vim in a console.
1671 - $DISPLAY is set to start applications on another
1672 display.
1673 - You do not want to connect to the X server in the
1674 console, but do want this in a terminal emulator.
1675 To never connect to the X server use: >
1676 exclude:.*
1677< This has the same effect as using the |-X| argument.
1678 Note that when there is no connection to the X server
1679 the window title won't be restored and the clipboard
1680 cannot be accessed.
1681 The value of 'magic' is ignored, {pattern} is
1682 interpreted as if 'magic' was on.
1683 The rest of the option value will be used for
1684 {pattern}, this must be the last entry.
1685
1686 *'cmdheight'* *'ch'*
1687'cmdheight' 'ch' number (default 1)
1688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 Number of screen lines to use for the command-line. Helps avoiding
1690 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001691 The value of this option is stored with the tab page, so that each tab
1692 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693
1694 *'cmdwinheight'* *'cwh'*
1695'cmdwinheight' 'cwh' number (default 7)
1696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 Number of screen lines to use for the command-line window. |cmdwin|
1698
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001699 *'colorcolumn'* *'cc'*
1700'colorcolumn' 'cc' string (default "")
1701 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001702 {not available when compiled without the |+syntax|
1703 feature}
1704 'colorcolumn' is a comma separated list of screen columns that are
1705 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1706 text. Will make screen redrawing slower.
1707 The screen column can be an absolute number, or a number preceded with
1708 '+' or '-', which is added to or subtracted from 'textwidth'. >
1709
1710 :set cc=+1 " highlight column after 'textwidth'
1711 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1712 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1713<
1714 When 'textwidth' is zero then the items with '-' and '+' are not used.
1715 A maximum of 256 columns are highlighted.
1716
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 *'columns'* *'co'* *E594*
1718'columns' 'co' number (default 80 or terminal width)
1719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001721 initialization and does not have to be set by hand. Also see
1722 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 When Vim is running in the GUI or in a resizable window, setting this
1724 option will cause the window size to be changed. When you only want
1725 to use the size for the GUI, put the command in your |gvimrc| file.
1726 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001727 number of columns of the display, the display may be messed up. For
1728 the GUI it is always possible and Vim limits the number of columns to
1729 what fits on the screen. You can use this command to get the widest
1730 window possible: >
1731 :set columns=9999
1732< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733
1734 *'comments'* *'com'* *E524* *E525*
1735'comments' 'com' string (default
1736 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1737 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 A comma separated list of strings that can start a comment line. See
1739 |format-comments|. See |option-backslash| about using backslashes to
1740 insert a space.
1741
1742 *'commentstring'* *'cms'* *E537*
1743'commentstring' 'cms' string (default "/*%s*/")
1744 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 {not available when compiled without the |+folding|
1746 feature}
1747 A template for a comment. The "%s" in the value is replaced with the
1748 comment text. Currently only used to add markers for folding, see
1749 |fold-marker|.
1750
1751 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001752'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001753 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 This option has the effect of making Vim either more Vi-compatible, or
1756 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001757
Bram Moolenaar071d4272004-06-13 20:20:40 +00001758 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001759 other options are also changed as a side effect.
1760 NOTE: Setting or resetting this option can have a lot of unexpected
1761 effects: Mappings are interpreted in another way, undo behaves
1762 differently, etc. If you set this option in your vimrc file, you
1763 should probably put it at the very start.
1764
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 By default this option is on and the Vi defaults are used for the
1766 options. This default was chosen for those people who want to use Vim
1767 just like Vi, and don't even (want to) know about the 'compatible'
1768 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001769 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001770 this option is switched off, and all options that have not been
1771 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001772 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001773 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001774 happen for the system-wide vimrc or gvimrc file, nor for a file given
1775 with the |-u| argument). Also see |compatible-default| and
1776 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 You can also set this option with the "-C" argument, and reset it with
1778 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001779 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780
Bram Moolenaar214641f2017-03-05 17:04:09 +01001781 When this option is set, numerous other options are set to make Vim as
1782 Vi-compatible as possible. When this option is unset, various options
1783 are set to make Vim more useful. The table below lists all the
1784 options affected.
1785 The {?} column indicates when the options are affected:
1786 + Means that the option is set to the value given in {set value} when
1787 'compatible' is set.
1788 & Means that the option is set to the value given in {set value} when
1789 'compatible' is set AND is set to its Vim default value when
1790 'compatible' is unset.
1791 - Means the option is NOT changed when setting 'compatible' but IS
1792 set to its Vim default when 'compatible' is unset.
1793 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794
Bram Moolenaar036986f2017-03-16 17:41:02 +01001795 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001796
1797 'allowrevins' + off no CTRL-_ command
1798 'antialias' + off don't use antialiased fonts
1799 'arabic' + off reset arabic-related options
1800 'arabicshape' + on correct character shapes
1801 'backspace' + "" normal backspace
1802 'backup' + off no backup file
1803 'backupcopy' & Unix: "yes" backup file is a copy
1804 else: "auto" copy or rename backup file
1805 'balloonexpr' + "" text to show in evaluation balloon
1806 'breakindent' + off don't indent when wrapping lines
1807 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1808 'cindent' + off no C code indentation
1809 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1810 'copyindent' + off don't copy indent structure
1811 'cpoptions' & (all flags) Vi-compatible flags
1812 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001813 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001814 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001815 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'cscopeverbose' + off see |cscopeverbose|
1817 'delcombine' + off unicode: delete whole char combination
1818 'digraph' + off no digraphs
1819 'esckeys' & off no <Esc>-keys in Insert mode
1820 'expandtab' + off tabs not expanded to spaces
1821 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001822 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001823 'formatexpr' + "" use 'formatprg' for auto-formatting
1824 'formatoptions' & "vt" Vi compatible formatting
1825 'gdefault' + off no default 'g' flag for ":s"
1826 'history' & 0 no commandline history
1827 'hkmap' + off no Hebrew keyboard mapping
1828 'hkmapp' + off no phonetic Hebrew keyboard mapping
1829 'hlsearch' + off no highlighting of search matches
1830 'incsearch' + off no incremental searching
1831 'indentexpr' + "" no indenting by expression
1832 'insertmode' + off do not start in Insert mode
1833 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001835 'joinspaces' + on insert 2 spaces after period
1836 'modeline' & off no modelines
1837 'more' & off no pauses in listings
1838 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1839 'numberwidth' & 8 min number of columns for line number
1840 'preserveindent'+ off don't preserve current indent structure
1841 when changing it
1842 'revins' + off no reverse insert
1843 'ruler' + off no ruler
1844 'scrolljump' + 1 no jump scroll
1845 'scrolloff' + 0 no scroll offset
1846 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1847 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001848 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001849 'showcmd' & off command characters not shown
1850 'showmode' & off current mode not shown
1851 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1852 'smartcase' + off no automatic ignore case switch
1853 'smartindent' + off no smart indentation
1854 'smarttab' + off no smart tab size
1855 'softtabstop' + 0 tabs are always 'tabstop' positions
1856 'startofline' + on goto startofline with some commands
1857 'tagcase' & "followic" 'ignorecase' when searching tags file
1858 'tagrelative' & off tag file names are not relative
1859 'termguicolors' + off don't use highlight-(guifg|guibg)
1860 'textauto' & off no automatic textmode detection
1861 'textwidth' + 0 no automatic line wrap
1862 'tildeop' + off tilde is not an operator
1863 'ttimeout' + off no terminal timeout
1864 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001865 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001866 'virtualedit' + "" cursor can only be placed on characters
1867 'whichwrap' & "" left-right movements don't wrap
1868 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001870 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871
1872 *'complete'* *'cpt'* *E535*
1873'complete' 'cpt' string (default: ".,w,b,u,t,i")
1874 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 This option specifies how keyword completion |ins-completion| works
1876 when CTRL-P or CTRL-N are used. It is also used for whole-line
1877 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1878 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001879 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 w scan buffers from other windows
1881 b scan other loaded buffers that are in the buffer list
1882 u scan the unloaded buffers that are in the buffer list
1883 U scan the buffers that are not in the buffer list
1884 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001885 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 k{dict} scan the file {dict}. Several "k" flags can be given,
1887 patterns are valid too. For example: >
1888 :set cpt=k/usr/dict/*,k~/spanish
1889< s scan the files given with the 'thesaurus' option
1890 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1891 are valid too.
1892 i scan current and included files
1893 d scan current and included files for defined name or macro
1894 |i_CTRL-X_CTRL-D|
1895 ] tag completion
1896 t same as "]"
1897
1898 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1899 not executed, this may lead to unexpected completions from some files
1900 (gzipped files for example). Unloaded buffers are not scanned for
1901 whole-line completion.
1902
1903 The default is ".,w,b,u,t,i", which means to scan:
1904 1. the current buffer
1905 2. buffers in other windows
1906 3. other loaded buffers
1907 4. unloaded buffers
1908 5. tags
1909 6. included files
1910
1911 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001912 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1913 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001915 *'completefunc'* *'cfu'*
1916'completefunc' 'cfu' string (default: empty)
1917 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001918 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001919 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001920 This option specifies a function to be used for Insert mode completion
1921 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001922 See |complete-functions| for an explanation of how the function is
1923 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001924 This option cannot be set from a |modeline| or in the |sandbox|, for
1925 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001926
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001927 *'completeslash'* *'csl'*
1928'completeslash' 'csl' string (default: "")
1929 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001930 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001931 When this option is set it overrules 'shellslash' for completion:
1932 - When this option is set to "slash", a forward slash is used for path
1933 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001934 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001935 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001936 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001937 - When this option is empty, same character is used as for
1938 'shellslash'.
1939 For Insert mode completion the buffer-local value is used. For
1940 command line completion the global value is used.
1941
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001942 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001943'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001944 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001945 A comma separated list of options for Insert mode completion
1946 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001947
1948 menu Use a popup menu to show the possible completions. The
1949 menu is only shown when there is more than one match and
1950 sufficient colors are available. |ins-completion-menu|
1951
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001952 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001953 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001954 match, e.g., what file it comes from.
1955
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001956 longest Only insert the longest common text of the matches. If
1957 the menu is displayed you can use CTRL-L to add more
1958 characters. Whether case is ignored depends on the kind
1959 of completion. For buffer text the 'ignorecase' option is
1960 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001961
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001962 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001963 completion in the preview window. Only works in
1964 combination with "menu" or "menuone".
1965
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001966 popup Show extra information about the currently selected
1967 completion in a popup window. Only works in combination
1968 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001969 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001970 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001971
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001972 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001973 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001974 |CompleteChanged| autocommand to fetch the info and call
1975 |popup_show()| once the popup has been filled.
1976 See the example at |complete-popuphidden|.
1977 {only works when compiled with the |+textprop| feature}
1978
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001979 noinsert Do not insert any text for a match until the user selects
1980 a match from the menu. Only works in combination with
1981 "menu" or "menuone". No effect if "longest" is present.
1982
1983 noselect Do not select a match in the menu, force the user to
1984 select one from the menu. Only works in combination with
1985 "menu" or "menuone".
1986
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001987
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001988 *'completepopup'* *'cpp'*
1989'completepopup' 'cpp' string (default empty)
1990 global
1991 {not available when compiled without the |+textprop|
1992 or |+quickfix| feature}
1993 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001994 properties of the info popup when it is created. If an info popup
1995 window already exists it is closed, so that the option value is
1996 applied when it is created again.
1997 You can also use |popup_findinfo()| and then set properties for an
1998 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001999
2000
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002001 *'concealcursor'* *'cocu'*
2002'concealcursor' 'cocu' string (default: "")
2003 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002004 {not available when compiled without the |+conceal|
2005 feature}
2006 Sets the modes in which text in the cursor line can also be concealed.
2007 When the current mode is listed then concealing happens just like in
2008 other lines.
2009 n Normal mode
2010 v Visual mode
2011 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002012 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002013
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002014 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002015 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002016 are moving around text is concealed, but when starting to insert text
2017 or selecting a Visual area the concealed text is displayed, so that
2018 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002019 Keep in mind that the cursor position is not always where it's
2020 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002021
2022
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002023 *'conceallevel'* *'cole'*
2024'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002025 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002026 {not available when compiled without the |+conceal|
2027 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002028 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2029 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002030
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002031 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002032 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002033 1 Each block of concealed text is replaced with one
2034 character. If the syntax item does not have a custom
2035 replacement character defined (see |:syn-cchar|) the
2036 character defined in 'listchars' is used (default is a
2037 space).
2038 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002039 2 Concealed text is completely hidden unless it has a
2040 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002041 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002042 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002043
Bram Moolenaara7781e02010-07-19 20:13:22 +02002044 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002045 edit and copy the text. This can be changed with the 'concealcursor'
2046 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002047
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2049'confirm' 'cf' boolean (default off)
2050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 When 'confirm' is on, certain operations that would normally
2052 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2053 instead raise a |dialog| asking if you wish to save the current
2054 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2055 If 'confirm' is off you can still activate confirmation for one
2056 command only (this is most useful in mappings) with the |:confirm|
2057 command.
2058 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2059
2060 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2061'conskey' 'consk' boolean (default off)
2062 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002063 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064
2065 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2066'copyindent' 'ci' boolean (default off)
2067 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 Copy the structure of the existing lines indent when autoindenting a
2069 new line. Normally the new indent is reconstructed by a series of
2070 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2071 in which case only spaces are used). Enabling this option makes the
2072 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002073 existing line. 'expandtab' has no effect on these characters, a Tab
2074 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002076 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077 Also see 'preserveindent'.
2078
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002079 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080'cpoptions' 'cpo' string (Vim default: "aABceFs",
2081 Vi default: all flags)
2082 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002084 this indicates Vi-compatible behavior. This is used for things where
2085 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086 'cpoptions' stands for "compatible-options".
2087 Commas can be added for readability.
2088 To avoid problems with flags that are added in the future, use the
2089 "+=" and "-=" feature of ":set" |add-option-flags|.
2090 NOTE: This option is set to the Vi default value when 'compatible' is
2091 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002092 NOTE: This option is set to the POSIX default value at startup when
2093 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002094 variable exists |posix|. This means Vim tries to behave like the
2095 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096
2097 contains behavior ~
2098 *cpo-a*
2099 a When included, a ":read" command with a file name
2100 argument will set the alternate file name for the
2101 current window.
2102 *cpo-A*
2103 A When included, a ":write" command with a file name
2104 argument will set the alternate file name for the
2105 current window.
2106 *cpo-b*
2107 b "\|" in a ":map" command is recognized as the end of
2108 the map command. The '\' is included in the mapping,
2109 the text after the '|' is interpreted as the next
2110 command. Use a CTRL-V instead of a backslash to
2111 include the '|' in the mapping. Applies to all
2112 mapping, abbreviation, menu and autocmd commands.
2113 See also |map_bar|.
2114 *cpo-B*
2115 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002116 abbreviations, user commands and the "to" part of the
2117 menu commands. Remove this flag to be able to use a
2118 backslash like a CTRL-V. For example, the command
2119 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002120 'B' included: "\^[" (^[ is a real <Esc>)
2121 'B' excluded: "<Esc>" (5 characters)
2122 ('<' excluded in both cases)
2123 *cpo-c*
2124 c Searching continues at the end of any match at the
2125 cursor position, but not further than the start of the
2126 next line. When not present searching continues
2127 one character from the cursor position. With 'c'
2128 "abababababab" only gets three matches when repeating
2129 "/abab", without 'c' there are five matches.
2130 *cpo-C*
2131 C Do not concatenate sourced lines that start with a
2132 backslash. See |line-continuation|.
2133 *cpo-d*
2134 d Using "./" in the 'tags' option doesn't mean to use
2135 the tags file relative to the current file, but the
2136 tags file in the current directory.
2137 *cpo-D*
2138 D Can't use CTRL-K to enter a digraph after Normal mode
2139 commands with a character argument, like |r|, |f| and
2140 |t|.
2141 *cpo-e*
2142 e When executing a register with ":@r", always add a
2143 <CR> to the last line, also when the register is not
2144 linewise. If this flag is not present, the register
2145 is not linewise and the last line does not end in a
2146 <CR>, then the last line is put on the command-line
2147 and can be edited before hitting <CR>.
2148 *cpo-E*
2149 E It is an error when using "y", "d", "c", "g~", "gu" or
2150 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002151 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 This makes "y0" fail in the first column.
2153 *cpo-f*
2154 f When included, a ":read" command with a file name
2155 argument will set the file name for the current buffer,
2156 if the current buffer doesn't have a file name yet.
2157 *cpo-F*
2158 F When included, a ":write" command with a file name
2159 argument will set the file name for the current
2160 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002161 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 *cpo-g*
2163 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002164 *cpo-H*
2165 H When using "I" on a line with only blanks, insert
2166 before the last blank. Without this flag insert after
2167 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 *cpo-i*
2169 i When included, interrupting the reading of a file will
2170 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002171 *cpo-I*
2172 I When moving the cursor up or down just after inserting
2173 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 *cpo-j*
2175 j When joining lines, only add two spaces after a '.',
2176 not after '!' or '?'. Also see 'joinspaces'.
2177 *cpo-J*
2178 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002179 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 white space.
2181 *cpo-k*
2182 k Disable the recognition of raw key codes in
2183 mappings, abbreviations, and the "to" part of menu
2184 commands. For example, if <Key> sends ^[OA (where ^[
2185 is <Esc>), the command ":map X ^[OA" results in X
2186 being mapped to:
2187 'k' included: "^[OA" (3 characters)
2188 'k' excluded: "<Key>" (one key code)
2189 Also see the '<' flag below.
2190 *cpo-K*
2191 K Don't wait for a key code to complete when it is
2192 halfway a mapping. This breaks mapping <F1><F1> when
2193 only part of the second <F1> has been read. It
2194 enables cancelling the mapping by typing <F1><Esc>.
2195 *cpo-l*
2196 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002197 literally, only "\]", "\^", "\-" and "\\" are special.
2198 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2200 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002201 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202 *cpo-L*
2203 L When the 'list' option is set, 'wrapmargin',
2204 'textwidth', 'softtabstop' and Virtual Replace mode
2205 (see |gR|) count a <Tab> as two characters, instead of
2206 the normal behavior of a <Tab>.
2207 *cpo-m*
2208 m When included, a showmatch will always wait half a
2209 second. When not included, a showmatch will wait half
2210 a second or until a character is typed. |'showmatch'|
2211 *cpo-M*
2212 M When excluded, "%" matching will take backslashes into
2213 account. Thus in "( \( )" and "\( ( \)" the outer
2214 parenthesis match. When included "%" ignores
2215 backslashes, which is Vi compatible.
2216 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002217 n When included, the column used for 'number' and
2218 'relativenumber' will also be used for text of wrapped
2219 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 *cpo-o*
2221 o Line offset to search command is not remembered for
2222 next search.
2223 *cpo-O*
2224 O Don't complain if a file is being overwritten, even
2225 when it didn't exist when editing it. This is a
2226 protection against a file unexpectedly created by
2227 someone else. Vi didn't complain about this.
2228 *cpo-p*
2229 p Vi compatible Lisp indenting. When not present, a
2230 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002231 *cpo-P*
2232 P When included, a ":write" command that appends to a
2233 file will set the file name for the current buffer, if
2234 the current buffer doesn't have a file name yet and
2235 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002236 *cpo-q*
2237 q When joining multiple lines leave the cursor at the
2238 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 *cpo-r*
2240 r Redo ("." command) uses "/" to repeat a search
2241 command, instead of the actually used search string.
2242 *cpo-R*
2243 R Remove marks from filtered lines. Without this flag
2244 marks are kept like |:keepmarks| was used.
2245 *cpo-s*
2246 s Set buffer options when entering the buffer for the
2247 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002248 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 set when the buffer is created.
2250 *cpo-S*
2251 S Set buffer options always when entering a buffer
2252 (except 'readonly', 'fileformat', 'filetype' and
2253 'syntax'). This is the (most) Vi compatible setting.
2254 The options are set to the values in the current
2255 buffer. When you change an option and go to another
2256 buffer, the value is copied. Effectively makes the
2257 buffer options global to all buffers.
2258
2259 's' 'S' copy buffer options
2260 no no when buffer created
2261 yes no when buffer first entered (default)
2262 X yes each time when buffer entered (vi comp.)
2263 *cpo-t*
2264 t Search pattern for the tag command is remembered for
2265 "n" command. Otherwise Vim only puts the pattern in
2266 the history for search pattern, but doesn't change the
2267 last used search pattern.
2268 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002269 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 *cpo-v*
2271 v Backspaced characters remain visible on the screen in
2272 Insert mode. Without this flag the characters are
2273 erased from the screen right away. With this flag the
2274 screen newly typed text overwrites backspaced
2275 characters.
2276 *cpo-w*
2277 w When using "cw" on a blank character, only change one
2278 character and not all blanks until the start of the
2279 next word.
2280 *cpo-W*
2281 W Don't overwrite a readonly file. When omitted, ":w!"
2282 overwrites a readonly file, if possible.
2283 *cpo-x*
2284 x <Esc> on the command-line executes the command-line.
2285 The default in Vim is to abandon the command-line,
2286 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002287 *cpo-X*
2288 X When using a count with "R" the replaced text is
2289 deleted only once. Also when repeating "R" with "."
2290 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002292 y A yank command can be redone with ".". Think twice if
2293 you really want to use this, it may break some
2294 plugins, since most people expect "." to only repeat a
2295 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002296 *cpo-Z*
2297 Z When using "w!" while the 'readonly' option is set,
2298 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 *cpo-!*
2300 ! When redoing a filter command, use the last used
2301 external command, whatever it was. Otherwise the last
2302 used -filter- command is used.
2303 *cpo-$*
2304 $ When making a change to one line, don't redisplay the
2305 line, but put a '$' at the end of the changed text.
2306 The changed text will be overwritten when you type the
2307 new text. The line is redisplayed if you type any
2308 command that moves the cursor from the insertion
2309 point.
2310 *cpo-%*
2311 % Vi-compatible matching is done for the "%" command.
2312 Does not recognize "#if", "#endif", etc.
2313 Does not recognize "/*" and "*/".
2314 Parens inside single and double quotes are also
2315 counted, causing a string that contains a paren to
2316 disturb the matching. For example, in a line like
2317 "if (strcmp("foo(", s))" the first paren does not
2318 match the last one. When this flag is not included,
2319 parens inside single and double quotes are treated
2320 specially. When matching a paren outside of quotes,
2321 everything inside quotes is ignored. When matching a
2322 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002323 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002324 This flag is also used for other features, such as
2325 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002326 *cpo--*
2327 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002328 it would go above the first line or below the last
2329 line. Without it the cursor moves to the first or
2330 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002331 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002332 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002333 *cpo-+*
2334 + When included, a ":write file" command will reset the
2335 'modified' flag of the buffer, even though the buffer
2336 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002337 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 * Use ":*" in the same way as ":@". When not included,
2339 ":*" is an alias for ":'<,'>", select the Visual area.
2340 *cpo-<*
2341 < Disable the recognition of special key codes in |<>|
2342 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002343 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344 ":map X <Tab>" results in X being mapped to:
2345 '<' included: "<Tab>" (5 characters)
2346 '<' excluded: "^I" (^I is a real <Tab>)
2347 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002348 *cpo->*
2349 > When appending to a register, put a line break before
2350 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002351 *cpo-;*
2352 ; When using |,| or |;| to repeat the last |t| search
2353 and the cursor is right in front of the searched
2354 character, the cursor won't move. When not included,
2355 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002356 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002357
2358 POSIX flags. These are not included in the Vi default value, except
2359 when $VIM_POSIX was set on startup. |posix|
2360
2361 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002362 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002363 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002364 *cpo-&*
2365 & When ":preserve" was used keep the swap file when
2366 exiting normally while this buffer is still loaded.
2367 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002368 *cpo-\*
2369 \ Backslash in a [] range in a search pattern is taken
2370 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002371 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2372 '\' excluded: "/[ \-]" finds <Space> and '-'
2373 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002374 *cpo-/*
2375 / When "%" is used as the replacement string in a |:s|
2376 command, use the previous replacement string. |:s%|
2377 *cpo-{*
2378 { The |{| and |}| commands also stop at a "{" character
2379 at the start of a line.
2380 *cpo-.*
2381 . The ":chdir" and ":cd" commands fail if the current
2382 buffer is modified, unless ! is used. Vim doesn't
2383 need this, since it remembers the full path of an
2384 opened file.
2385 *cpo-bar*
2386 | The value of the $LINES and $COLUMNS environment
2387 variables overrule the terminal size values obtained
2388 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002389
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002391 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002392'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002393 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002394 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002395 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002396 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002397 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002398 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002399 blowfish Blowfish method. Medium strong encryption but it has
2400 an implementation flaw. Requires Vim 7.3 or later,
2401 files can NOT be read by Vim 7.2 and older. This adds
2402 a "seed" to the file, every time you write the file
2403 the encrypted bytes will be different.
2404 *blowfish2*
2405 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002406 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002407 and older. This adds a "seed" to the file, every time
2408 you write the file the encrypted bytes will be
2409 different. The whole undo file is encrypted, not just
2410 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002411 *E1193* *E1194* *E1195* *E1196*
2412 *E1197* *E1198* *E1199* *E1200* *E1201*
2413 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2414 Code. Medium strong till strong encryption.
2415 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002416 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002417 It adds a seed and a message authentication code (MAC)
2418 to the file. This needs at least a Vim 8.2.3022 to
2419 read the encrypted file.
2420 Encryption of swap files is not supported, therefore
2421 no swap file will be used when xchacha20 encryption is
2422 enabled.
2423 Encryption of undo files is not yet supported,
2424 therefore no undo file will currently be written.
2425 CURRENTLY EXPERIMENTAL: Files written with this method
2426 might have to be read back with the same version of
2427 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002428
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002429 You should use "blowfish2", also to re-encrypt older files.
2430
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002431 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002432 to the detected method of the file being read. Thus if you write it
2433 without changing 'cryptmethod' the same method will be used.
2434 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002435 explicitly write it, you don't get a warning unless there are other
2436 modifications. Also see |:X|.
2437
2438 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002439 the value "blowfish2". When setting the local value to an empty
2440 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002441
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002442 When a new encryption method is added in a later version of Vim, and
2443 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002444 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002445
2446
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 *'cscopepathcomp'* *'cspc'*
2448'cscopepathcomp' 'cspc' number (default 0)
2449 global
2450 {not available when compiled without the |+cscope|
2451 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 Determines how many components of the path to show in a list of tags.
2453 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002454 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455
2456 *'cscopeprg'* *'csprg'*
2457'cscopeprg' 'csprg' string (default "cscope")
2458 global
2459 {not available when compiled without the |+cscope|
2460 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 Specifies the command to execute cscope. See |cscopeprg|.
2462 This option cannot be set from a |modeline| or in the |sandbox|, for
2463 security reasons.
2464
2465 *'cscopequickfix'* *'csqf'*
2466'cscopequickfix' 'csqf' string (default "")
2467 global
2468 {not available when compiled without the |+cscope|
2469 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470 Specifies whether to use quickfix window to show cscope results.
2471 See |cscopequickfix|.
2472
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002473 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002474'cscoperelative' 'csre' boolean (default off)
2475 global
2476 {not available when compiled without the |+cscope|
2477 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002478 In the absence of a prefix (-P) for cscope. setting this option enables
2479 to use the basename of cscope.out path as the prefix.
2480 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002481 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002482
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2484'cscopetag' 'cst' boolean (default off)
2485 global
2486 {not available when compiled without the |+cscope|
2487 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 Use cscope for tag commands. See |cscope-options|.
2489 NOTE: This option is reset when 'compatible' is set.
2490
2491 *'cscopetagorder'* *'csto'*
2492'cscopetagorder' 'csto' number (default 0)
2493 global
2494 {not available when compiled without the |+cscope|
2495 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 Determines the order in which ":cstag" performs a search. See
2497 |cscopetagorder|.
2498 NOTE: This option is set to 0 when 'compatible' is set.
2499
2500 *'cscopeverbose'* *'csverb'*
2501 *'nocscopeverbose'* *'nocsverb'*
2502'cscopeverbose' 'csverb' boolean (default off)
2503 global
2504 {not available when compiled without the |+cscope|
2505 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 Give messages when adding a cscope database. See |cscopeverbose|.
2507 NOTE: This option is reset when 'compatible' is set.
2508
Bram Moolenaar860cae12010-06-05 23:22:07 +02002509 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2510'cursorbind' 'crb' boolean (default off)
2511 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002512 When this option is set, as the cursor in the current
2513 window moves other cursorbound windows (windows that also have
2514 this option set) move their cursors to the corresponding line and
2515 column. This option is useful for viewing the
2516 differences between two versions of a file (see 'diff'); in diff mode,
2517 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002518 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002519
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002520
2521 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2522'cursorcolumn' 'cuc' boolean (default off)
2523 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002524 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002525 feature}
2526 Highlight the screen column of the cursor with CursorColumn
2527 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2528 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002529 If you only want the highlighting in the current window you can use
2530 these autocommands: >
2531 au WinLeave * set nocursorline nocursorcolumn
2532 au WinEnter * set cursorline cursorcolumn
2533<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002534
2535 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2536'cursorline' 'cul' boolean (default off)
2537 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002538 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002539 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002540 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2541 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002542 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002543 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002544
2545
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002546 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002547'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002548 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002549 {not available when compiled without the |+syntax|
2550 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002551 Comma separated list of settings for how 'cursorline' is displayed.
2552 Valid values:
2553 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002554 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002555 "screenline" Highlight only the screen line of the cursor with
2556 CursorLine |hl-CursorLine|.
2557 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002558 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002559
2560 Special value:
2561 "both" Alias for the values "line,number".
2562
2563 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002564
2565
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 *'debug'*
2567'debug' string (default "")
2568 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002569 These values can be used:
2570 msg Error messages that would otherwise be omitted will be given
2571 anyway.
2572 throw Error messages that would otherwise be omitted will be given
2573 anyway and also throw an exception and set |v:errmsg|.
2574 beep A message will be given when otherwise only a beep would be
2575 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002576 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002577 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2578 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579
2580 *'define'* *'def'*
2581'define' 'def' string (default "^\s*#\s*define")
2582 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002583 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 pattern, just like for the "/" command. This option is used for the
2585 commands like "[i" and "[d" |include-search|. The 'isident' option is
2586 used to recognize the defined name after the match:
2587 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2588 See |option-backslash| about inserting backslashes to include a space
2589 or backslash.
2590 The default value is for C programs. For C++ this value would be
2591 useful, to include const type declarations: >
2592 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002593< You can also use "\ze" just before the name and continue the pattern
2594 to check what is following. E.g. for Javascript, if a function is
2595 defined with "func_name = function(args)": >
2596 ^\s*\ze\i\+\s*=\s*function(
2597< If the function is defined with "func_name : function() {...": >
2598 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002600 To avoid that use `:let` with a single quote string: >
2601 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002602<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603
2604 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2605'delcombine' 'deco' boolean (default off)
2606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 If editing Unicode and this option is set, backspace and Normal mode
2608 "x" delete each combining character on its own. When it is off (the
2609 default) the character along with its combining characters are
2610 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002611 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612
2613 This is useful for Arabic, Hebrew and many other languages where one
2614 may have combining characters overtop of base characters, and want
2615 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002616 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617
2618 *'dictionary'* *'dict'*
2619'dictionary' 'dict' string (default "")
2620 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 List of file names, separated by commas, that are used to lookup words
2622 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2623 contain a list of words. This can be one word per line, or several
2624 words per line, separated by non-keyword characters (white space is
2625 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002626
2627 When this option is empty or an entry "spell" is present, and spell
2628 checking is enabled, words in the word lists for the currently active
2629 'spelllang' are used. See |spell|.
2630
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002631 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 after a comma are ignored, otherwise spaces are included in the file
2633 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002634 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 Where to find a list of words?
2636 - On FreeBSD, there is the file "/usr/share/dict/words".
2637 - In the Simtel archive, look in the "msdos/linguist" directory.
2638 - In "miscfiles" of the GNU collection.
2639 The use of |:set+=| and |:set-=| is preferred when adding or removing
2640 directories from the list. This avoids problems when a future version
2641 uses another default.
2642 Backticks cannot be used in this option for security reasons.
2643
2644 *'diff'* *'nodiff'*
2645'diff' boolean (default off)
2646 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 {not available when compiled without the |+diff|
2648 feature}
2649 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002650 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651
2652 *'dex'* *'diffexpr'*
2653'diffexpr' 'dex' string (default "")
2654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 {not available when compiled without the |+diff|
2656 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002657 Expression which is evaluated to obtain a diff file (either ed-style
2658 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 This option cannot be set from a |modeline| or in the |sandbox|, for
2660 security reasons.
2661
2662 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002663'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 {not available when compiled without the |+diff|
2666 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002667 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 All are optional. Items must be separated by a comma.
2669
2670 filler Show filler lines, to keep the text
2671 synchronized with a window that has inserted
2672 lines at the same position. Mostly useful
2673 when windows are side-by-side and 'scrollbind'
2674 is set.
2675
2676 context:{n} Use a context of {n} lines between a change
2677 and a fold that contains unchanged lines.
2678 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002679 When using zero the context is actually one,
2680 since folds require a line in between, also
2681 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 See |fold-diff|.
2683
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002684 iblank Ignore changes where lines are all blank. Adds
2685 the "-B" flag to the "diff" command if
2686 'diffexpr' is empty. Check the documentation
2687 of the "diff" command for what this does
2688 exactly.
2689 NOTE: the diff windows will get out of sync,
2690 because no differences between blank lines are
2691 taken into account.
2692
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 icase Ignore changes in case of text. "a" and "A"
2694 are considered the same. Adds the "-i" flag
2695 to the "diff" command if 'diffexpr' is empty.
2696
2697 iwhite Ignore changes in amount of white space. Adds
2698 the "-b" flag to the "diff" command if
2699 'diffexpr' is empty. Check the documentation
2700 of the "diff" command for what this does
2701 exactly. It should ignore adding trailing
2702 white space, but not leading white space.
2703
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002704 iwhiteall Ignore all white space changes. Adds
2705 the "-w" flag to the "diff" command if
2706 'diffexpr' is empty. Check the documentation
2707 of the "diff" command for what this does
2708 exactly.
2709
2710 iwhiteeol Ignore white space changes at end of line.
2711 Adds the "-Z" flag to the "diff" command if
2712 'diffexpr' is empty. Check the documentation
2713 of the "diff" command for what this does
2714 exactly.
2715
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002716 horizontal Start diff mode with horizontal splits (unless
2717 explicitly specified otherwise).
2718
2719 vertical Start diff mode with vertical splits (unless
2720 explicitly specified otherwise).
2721
Bram Moolenaarc8234772019-11-10 21:00:27 +01002722 closeoff When a window is closed where 'diff' is set
2723 and there is only one window remaining in the
2724 same tab page with 'diff' set, execute
2725 `:diffoff` in that window. This undoes a
2726 `:diffsplit` command.
2727
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002728 hiddenoff Do not use diff mode for a buffer when it
2729 becomes hidden.
2730
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002731 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2732 starting diff mode. Without this 2 is used.
2733
Bram Moolenaar4223d432021-02-10 13:18:17 +01002734 followwrap Follow the 'wrap' option and leave as it is.
2735
Bram Moolenaare828b762018-09-10 17:51:58 +02002736 internal Use the internal diff library. This is
2737 ignored when 'diffexpr' is set. *E960*
2738 When running out of memory when writing a
2739 buffer this item will be ignored for diffs
2740 involving that buffer. Set the 'verbose'
2741 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742
Bram Moolenaare828b762018-09-10 17:51:58 +02002743 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002744 Use the indent heuristic for the internal
2745 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002746
2747 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002748 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002749 algorithms are:
2750 myers the default algorithm
2751 minimal spend extra time to generate the
2752 smallest possible diff
2753 patience patience diff algorithm
2754 histogram histogram diff algorithm
2755
2756 Examples: >
2757 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002759 :set diffopt=internal,filler,foldcolumn:3
2760 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761<
2762 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2763'digraph' 'dg' boolean (default off)
2764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 {not available when compiled without the |+digraphs|
2766 feature}
2767 Enable the entering of digraphs in Insert mode with {char1} <BS>
2768 {char2}. See |digraphs|.
2769 NOTE: This option is reset when 'compatible' is set.
2770
2771 *'directory'* *'dir'*
2772'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002773 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 for Unix: ".,~/tmp,/var/tmp,/tmp")
2775 global
2776 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002777 Recommended value: ".,~/vimswap//" - this will put the swap file next
2778 to the edited file if possible, and in your personal swap directory
2779 otherwise. Make sure "~/vimswap//" is only readable for you.
2780
2781 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 - The swap file will be created in the first directory where this is
2783 possible.
2784 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002785 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 - A directory "." means to put the swap file in the same directory as
2787 the edited file. On Unix, a dot is prepended to the file name, so
2788 it doesn't show in a directory listing. On MS-Windows the "hidden"
2789 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002790 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2791 the swap file relative to where the edited file is. The leading "."
2792 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002793 - For Unix and Win32, if a directory ends in two path separators "//",
2794 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002795 with all path separators replaced by percent '%' signs (including
2796 the colon following the drive letter on Win32). This will ensure
2797 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002798 On Win32, it is also possible to end with "\\". However, When a
2799 separating comma is following, you must use "//", since "\\" will
2800 include the comma in the file name. Therefore it is recommended to
2801 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 - Spaces after the comma are ignored, other spaces are considered part
2803 of the directory name. To have a space at the start of a directory
2804 name, precede it with a backslash.
2805 - To include a comma in a directory name precede it with a backslash.
2806 - A directory name may end in an ':' or '/'.
2807 - Environment variables are expanded |:set_env|.
2808 - Careful with '\' characters, type one before a space, type two to
2809 get one in the option (see |option-backslash|), for example: >
2810 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2811< - For backwards compatibility with Vim version 3.0 a '>' at the start
2812 of the option is removed.
2813 Using "." first in the list is recommended. This means that editing
2814 the same file twice will result in a warning. Using "/tmp" on Unix is
2815 discouraged: When the system crashes you lose the swap file.
2816 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002817 choice than "/tmp". But others on the computer may be able to see the
2818 files, and it can contain a lot of files, your swap files get lost in
2819 the crowd. That is why a "tmp" directory in your home directory is
2820 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 The use of |:set+=| and |:set-=| is preferred when adding or removing
2822 directories from the list. This avoids problems when a future version
2823 uses another default.
2824 This option cannot be set from a |modeline| or in the |sandbox|, for
2825 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826
2827 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002828'display' 'dy' string (default "", set to "truncate" in
2829 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 Change the way text is displayed. This is comma separated list of
2832 flags:
2833 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002834 in a window will be displayed. "@@@" is put in the
2835 last columns of the last screen line to indicate the
2836 rest of the line is not displayed.
2837 truncate Like "lastline", but "@@@" is displayed in the first
2838 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 uhex Show unprintable characters hexadecimal as <xx>
2840 instead of using ^C and ~C.
2841
Bram Moolenaard0796902016-09-16 20:02:31 +02002842 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002843 doesn't fit is replaced with "@" lines.
2844
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 *'eadirection'* *'ead'*
2846'eadirection' 'ead' string (default "both")
2847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 Tells when the 'equalalways' option applies:
2849 ver vertically, width of windows is not affected
2850 hor horizontally, height of windows is not affected
2851 both width and height of windows is affected
2852
2853 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2854'edcompatible' 'ed' boolean (default off)
2855 global
2856 Makes the 'g' and 'c' flags of the ":substitute" command to be
2857 toggled each time the flag is given. See |complex-change|. See
2858 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002859 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002860 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861
Bram Moolenaar03413f42016-04-12 21:07:15 +02002862 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002863'emoji' 'emo' boolean (default: on)
2864 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002865 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002866 This excludes "text emoji" characters, which are normally displayed as
2867 single width. Unfortunately there is no good specification for this
2868 and it has been determined on trial-and-error basis. Use the
2869 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002870
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002872'encoding' 'enc' string (default for MS-Windows: "utf-8",
2873 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 Sets the character encoding used inside Vim. It applies to text in
2876 the buffers, registers, Strings in expressions, text stored in the
2877 viminfo file, etc. It sets the kind of characters which Vim can work
2878 with. See |encoding-names| for the possible values.
2879
2880 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002881 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002883 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884
Bram Moolenaar865242e2010-07-14 21:12:05 +02002885 This option cannot be set from a |modeline|. It would most likely
2886 corrupt the text.
2887
Bram Moolenaar3df01732017-02-17 22:47:16 +01002888 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2889 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 'encoding', "utf-8" is the natural choice for the environment and
2891 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002892 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 versions, and to avoid changing the encoding of newly created files
2894 without your knowledge (in case 'fileencodings' is empty).
2895
2896 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002897 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 iconv() or as specified with 'charconvert'.
2899
Bram Moolenaar207f0092020-08-30 17:20:20 +02002900 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002901 can use: >
2902 if has("multi_byte_encoding")
2903<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 Normally 'encoding' will be equal to your current locale. This will
2905 be the default if Vim recognizes your environment settings. If
2906 'encoding' is not set to the current locale, 'termencoding' must be
2907 set to convert typed and displayed text. See |encoding-table|.
2908
2909 When you set this option, it fires the |EncodingChanged| autocommand
2910 event so that you can set up fonts if necessary.
2911
2912 When the option is set, the value is converted to lowercase. Thus
2913 you can set it with uppercase values too. Underscores are translated
2914 to '-' signs.
2915 When the encoding is recognized, it is changed to the standard name.
2916 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2917 "iso-8859-2" and "utf8" becomes "utf-8".
2918
2919 Note: "latin1" is also used when the encoding could not be detected.
2920 This only works when editing files in the same encoding! When the
2921 actual character set is not latin1, make sure 'fileencoding' and
2922 'fileencodings' are empty. When conversion is needed, switch to using
2923 utf-8.
2924
2925 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2926 You don't notice this while editing, but it does matter for the
2927 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2928 setting 'encoding' to one of these values instead of utf-8 only has
2929 effect for encoding used for files when 'fileencoding' is empty.
2930
Bram Moolenaar661b1822005-07-28 22:36:45 +00002931 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2932 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933
2934 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2935'endofline' 'eol' boolean (default on)
2936 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002938 is on, or 'fixeol' option is off, no <EOL> will be written for the
2939 last line in the file. This option is automatically set or reset when
2940 starting to edit a new file, depending on whether file has an <EOL>
2941 for the last line in the file. Normally you don't have to set or
2942 reset this option.
2943 When 'binary' is off and 'fixeol' is on the value is not used when
2944 writing the file. When 'binary' is on or 'fixeol' is off it is used
2945 to remember the presence of a <EOL> for the last line in the file, so
2946 that when you write the file the situation from the original file can
2947 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948
2949 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2950'equalalways' 'ea' boolean (default on)
2951 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002953 splitting or closing a window. This also happens the moment the
2954 option is switched on. When off, splitting a window will reduce the
2955 size of the current window and leave the other windows the same. When
2956 closing a window the extra lines are given to the window next to it
2957 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 When mixing vertically and horizontally split windows, a minimal size
2959 is computed and some windows may be larger if there is room. The
2960 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002961 Changing the height and width of a window can be avoided by setting
2962 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002963 If a window size is specified when creating a new window sizes are
2964 currently not equalized (it's complicated, but may be implemented in
2965 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966
2967 *'equalprg'* *'ep'*
2968'equalprg' 'ep' string (default "")
2969 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002971 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002972 or 'indentexpr'. When Vim was compiled without internal formatting,
2973 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002974 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 about including spaces and backslashes.
2976 This option cannot be set from a |modeline| or in the |sandbox|, for
2977 security reasons.
2978
2979 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2980'errorbells' 'eb' boolean (default off)
2981 global
2982 Ring the bell (beep or screen flash) for error messages. This only
2983 makes a difference for error messages, the bell will be used always
2984 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002985 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002986 screen flash or do nothing. See 'belloff' to finetune when to ring the
2987 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988
2989 *'errorfile'* *'ef'*
2990'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2991 others: "errors.err")
2992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 {not available when compiled without the |+quickfix|
2994 feature}
2995 Name of the errorfile for the QuickFix mode (see |:cf|).
2996 When the "-q" command-line argument is used, 'errorfile' is set to the
2997 following argument. See |-q|.
2998 NOT used for the ":make" command. See 'makeef' for that.
2999 Environment variables are expanded |:set_env|.
3000 See |option-backslash| about including spaces and backslashes.
3001 This option cannot be set from a |modeline| or in the |sandbox|, for
3002 security reasons.
3003
3004 *'errorformat'* *'efm'*
3005'errorformat' 'efm' string (default is very long)
3006 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 {not available when compiled without the |+quickfix|
3008 feature}
3009 Scanf-like description of the format for the lines in the error file
3010 (see |errorformat|).
3011
3012 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3013'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3014 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 Function keys that start with an <Esc> are recognized in Insert
3016 mode. When this option is off, the cursor and function keys cannot be
3017 used in Insert mode if they start with an <Esc>. The advantage of
3018 this is that the single <Esc> is recognized immediately, instead of
3019 after one second. Instead of resetting this option, you might want to
3020 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3021 when 'esckeys' is off, you can still map anything, but the cursor keys
3022 won't work by default.
3023 NOTE: This option is set to the Vi default value when 'compatible' is
3024 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003025 NOTE: when this option is off then the |modifyOtherKeys| functionality
3026 is disabled while in Insert mode to avoid ending Insert mode with any
3027 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028
3029 *'eventignore'* *'ei'*
3030'eventignore' 'ei' string (default "")
3031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003033 When set to "all" or when "all" is one of the items, all autocommand
3034 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 Otherwise this is a comma separated list of event names. Example: >
3036 :set ei=WinEnter,WinLeave
3037<
3038 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3039'expandtab' 'et' boolean (default off)
3040 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003042 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3044 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003045 This option is reset when the 'paste' option is set and restored when
3046 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 NOTE: This option is reset when 'compatible' is set.
3048
3049 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3050'exrc' 'ex' boolean (default off)
3051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003053 directory.
3054
3055 Setting this option is a potential security leak. E.g., consider
3056 unpacking a package or fetching files from github, a .vimrc in there
3057 might be a trojan horse. BETTER NOT SET THIS OPTION!
3058 Instead, define an autocommand in your .vimrc to set options for a
3059 matching directory.
3060
3061 If you do switch this option on you should also consider setting the
3062 'secure' option (see |initialization|).
3063 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 This option cannot be set from a |modeline| or in the |sandbox|, for
3065 security reasons.
3066
3067 *'fileencoding'* *'fenc'* *E213*
3068'fileencoding' 'fenc' string (default: "")
3069 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003071
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003073 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 When 'fileencoding' is empty, the same value as 'encoding' will be
3075 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003076 No error will be given when the value is set, only when it is used,
3077 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003078 Conversion will also be done when 'encoding' and 'fileencoding' are
3079 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3080 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003082 'encoding' is "utf-8" or another Unicode encoding, conversion
3083 is most likely done in a way that the reverse conversion
3084 results in the same text. When 'encoding' is not "utf-8" some
3085 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003086
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 See 'encoding' for the possible values. Additionally, values may be
3088 specified that can be handled by the converter, see
3089 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003090
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 When reading a file 'fileencoding' will be set from 'fileencodings'.
3092 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003093 'fileencoding', use the |++enc| argument. One exception: when
3094 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003095 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003096
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3098 When the option is set, the value is converted to lowercase. Thus
3099 you can set it with uppercase values too. '_' characters are
3100 replaced with '-'. If a name is recognized from the list for
3101 'encoding', it is replaced by the standard name. For example
3102 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003103
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104 When this option is set, after starting to edit a file, the 'modified'
3105 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003106
3107 Keep in mind that changing 'fenc' from a modeline happens
3108 AFTER the text has been read, thus it applies to when the file will be
3109 written. If you do set 'fenc' in a modeline, you might want to set
3110 'nomodified' to avoid not being able to ":q".
3111
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 This option can not be changed when 'modifiable' is off.
3113
3114 *'fe'*
3115 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003116 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 old short name was 'fe', which is no longer used.
3118
3119 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003120'fileencodings' 'fencs' string (default: "ucs-bom",
3121 "ucs-bom,utf-8,default,latin1" when
3122 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 This is a list of character encodings considered when starting to edit
3125 an existing file. When a file is read, Vim tries to use the first
3126 mentioned character encoding. If an error is detected, the next one
3127 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003128 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 an empty string, which means the value of 'encoding' is used.
3130 WARNING: Conversion can cause loss of information! When
3131 'encoding' is "utf-8" (or one of the other Unicode variants)
3132 conversion is most likely done in a way that the reverse
3133 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003134 "utf-8" some non-ASCII characters may be lost! You can use
3135 the |++bad| argument to specify what is done with characters
3136 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 For an empty file or a file with only ASCII characters most encodings
3138 will work and the first entry of 'fileencodings' will be used (except
3139 "ucs-bom", which requires the BOM to be present). If you prefer
3140 another encoding use an BufReadPost autocommand event to test if your
3141 preferred encoding is to be used. Example: >
3142 au BufReadPost * if search('\S', 'w') == 0 |
3143 \ set fenc=iso-2022-jp | endif
3144< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3145 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003146 When the |++enc| argument is used then the value of 'fileencodings' is
3147 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003148 Note that 'fileencodings' is not used for a new file, the global value
3149 of 'fileencoding' is used instead. You can set it with: >
3150 :setglobal fenc=iso-8859-2
3151< This means that a non-existing file may get a different encoding than
3152 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 The special value "ucs-bom" can be used to check for a Unicode BOM
3154 (Byte Order Mark) at the start of the file. It must not be preceded
3155 by "utf-8" or another Unicode encoding for this to work properly.
3156 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3157 because Vim cannot detect an error, thus the encoding is always
3158 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003159 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003160 environment. On MS-Windows this is the system encoding. Otherwise
3161 this is the default value for 'encoding'. It is useful when
3162 'encoding' is set to "utf-8" and your environment uses a non-latin1
3163 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003164 When 'encoding' is "utf-8" and a file contains an illegal byte
3165 sequence it won't be recognized as UTF-8. You can use the |8g8|
3166 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 WRONG VALUES: WHAT'S WRONG:
3168 latin1,utf-8 "latin1" will always be used
3169 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3170 file
3171 cp1250,latin1 "cp1250" will always be used
3172 If 'fileencodings' is empty, 'fileencoding' is not modified.
3173 See 'fileencoding' for the possible values.
3174 Setting this option does not have an effect until the next time a file
3175 is read.
3176
3177 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003178'fileformat' 'ff' string (MS-Windows default: "dos",
3179 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 This gives the <EOL> of the current buffer, which is used for
3182 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003183 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 unix <NL>
3185 mac <CR>
3186 When "dos" is used, CTRL-Z at the end of a file is ignored.
3187 See |file-formats| and |file-read|.
3188 For the character encoding of the file see 'fileencoding'.
3189 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003190 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 This option is set automatically when starting to edit a file and
3192 'fileformats' is not empty and 'binary' is off.
3193 When this option is set, after starting to edit a file, the 'modified'
3194 option is set, because the file would be different when written.
3195 This option can not be changed when 'modifiable' is off.
3196 For backwards compatibility: When this option is set to "dos",
3197 'textmode' is set, otherwise 'textmode' is reset.
3198
3199 *'fileformats'* *'ffs'*
3200'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003201 Vim+Vi MS-Windows: "dos,unix",
3202 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 Vi Cygwin: "unix,dos",
3204 Vi others: "")
3205 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 This gives the end-of-line (<EOL>) formats that will be tried when
3207 starting to edit a new buffer and when reading a file into an existing
3208 buffer:
3209 - When empty, the format defined with 'fileformat' will be used
3210 always. It is not set automatically.
3211 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003212 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 'fileformats' name will be used when a file is read into an existing
3214 buffer, no matter what 'fileformat' for that buffer is set to.
3215 - When more than one name is present, separated by commas, automatic
3216 <EOL> detection will be done when reading a file. When starting to
3217 edit a file, a check is done for the <EOL>:
3218 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3219 'fileformat' is set to "dos".
3220 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003221 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003223 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3224 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003225 This means that "mac" is only chosen when:
3226 "unix" is not present or no <NL> is found in the file, and
3227 "dos" is not present or no <CR><NL> is found in the file.
3228 Except: if "unix" was chosen, but there is a <CR> before
3229 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003230 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 4. If 'fileformat' is still not set, the first name from
3232 'fileformats' is used.
3233 When reading a file into an existing buffer, the same is done, but
3234 this happens like 'fileformat' has been set appropriately for that
3235 file only, the option is not changed.
3236 When 'binary' is set, the value of 'fileformats' is not used.
3237
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003238 When Vim starts up with an empty buffer the first item is used. You
3239 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003240
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3242 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3243 done:
3244 - When 'fileformats' is empty, there is no automatic detection. Dos
3245 format will be used.
3246 - When 'fileformats' is set to one or more names, automatic detection
3247 is done. This is based on the first <NL> in the file: If there is a
3248 <CR> in front of it, Dos format is used, otherwise Unix format is
3249 used.
3250 Also see |file-formats|.
3251 For backwards compatibility: When this option is set to an empty
3252 string or one format (no comma is included), 'textauto' is reset,
3253 otherwise 'textauto' is set.
3254 NOTE: This option is set to the Vi default value when 'compatible' is
3255 set and to the Vim default value when 'compatible' is reset.
3256
Bram Moolenaarbf884932013-04-05 22:26:15 +02003257 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3258'fileignorecase' 'fic' boolean (default on for systems where case in file
3259 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003260 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003261 When set case is ignored when using file names and directories.
3262 See 'wildignorecase' for only ignoring case when doing completion.
3263
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 *'filetype'* *'ft'*
3265'filetype' 'ft' string (default: "")
3266 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 When this option is set, the FileType autocommand event is triggered.
3268 All autocommands that match with the value of this option will be
3269 executed. Thus the value of 'filetype' is used in place of the file
3270 name.
3271 Otherwise this option does not always reflect the current file type.
3272 This option is normally set when the file type is detected. To enable
3273 this use the ":filetype on" command. |:filetype|
3274 Setting this option to a different value is most useful in a modeline,
3275 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003276 Example, for in an IDL file:
3277 /* vim: set filetype=idl : */ ~
3278 |FileType| |filetypes|
3279 When a dot appears in the value then this separates two filetype
3280 names. Example:
3281 /* vim: set filetype=c.doxygen : */ ~
3282 This will use the "c" filetype first, then the "doxygen" filetype.
3283 This works both for filetype plugins and for syntax files. More than
3284 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 This option is not copied to another buffer, independent of the 's' or
3286 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003287 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288
3289 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003290'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003292 {not available when compiled without the |+folding|
3293 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 Characters to fill the statuslines and vertical separators.
3295 It is a comma separated list of items:
3296
3297 item default Used for ~
3298 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003299 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 vert:c '|' vertical separators |:vsplit|
3301 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003302 foldopen:c '-' mark the beginning of a fold
3303 foldclose:c '+' show a closed fold
3304 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003306 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003308 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003309 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 otherwise.
3311
3312 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003313 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314< This is similar to the default, except that these characters will also
3315 be used when there is highlighting.
3316
Bram Moolenaar008bff92021-03-04 21:55:58 +01003317 For "stl" and "stlnc" single-byte and multibyte characters are
3318 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003319
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 The highlighting used for these items:
3321 item highlight group ~
3322 stl:c StatusLine |hl-StatusLine|
3323 stlnc:c StatusLineNC |hl-StatusLineNC|
3324 vert:c VertSplit |hl-VertSplit|
3325 fold:c Folded |hl-Folded|
3326 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003327 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003329 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3330'fixendofline' 'fixeol' boolean (default on)
3331 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003332 When writing a file and this option is on, <EOL> at the end of file
3333 will be restored if missing. Turn this option off if you want to
3334 preserve the situation from the original file.
3335 When the 'binary' option is set the value of this option doesn't
3336 matter.
3337 See the 'endofline' option.
3338
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003340'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 {only available when compiled with the |+rightleft|
3343 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003344 This option was for using Farsi, which has been removed. See
3345 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346
3347 *'foldclose'* *'fcl'*
3348'foldclose' 'fcl' string (default "")
3349 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 {not available when compiled without the |+folding|
3351 feature}
3352 When set to "all", a fold is closed when the cursor isn't in it and
3353 its level is higher than 'foldlevel'. Useful if you want folds to
3354 automatically close when moving out of them.
3355
3356 *'foldcolumn'* *'fdc'*
3357'foldcolumn' 'fdc' number (default 0)
3358 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 {not available when compiled without the |+folding|
3360 feature}
3361 When non-zero, a column with the specified width is shown at the side
3362 of the window which indicates open and closed folds. The maximum
3363 value is 12.
3364 See |folding|.
3365
3366 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3367'foldenable' 'fen' boolean (default on)
3368 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 {not available when compiled without the |+folding|
3370 feature}
3371 When off, all folds are open. This option can be used to quickly
3372 switch between showing all text unfolded and viewing the text with
3373 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003374 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 'foldenable' is off.
3376 This option is set by commands that create a new fold or close a fold.
3377 See |folding|.
3378
3379 *'foldexpr'* *'fde'*
3380'foldexpr' 'fde' string (default: "0")
3381 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003383 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003385 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003386
Bram Moolenaar30b65812012-07-12 22:01:11 +02003387 The expression will be evaluated in the |sandbox| if set from a
3388 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003389 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003390 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003391
3392 It is not allowed to change text or jump to another window while
3393 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394
3395 *'foldignore'* *'fdi'*
3396'foldignore' 'fdi' string (default: "#")
3397 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 {not available when compiled without the |+folding|
3399 feature}
3400 Used only when 'foldmethod' is "indent". Lines starting with
3401 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003402 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 The default "#" works well for C programs. See |fold-indent|.
3404
3405 *'foldlevel'* *'fdl'*
3406'foldlevel' 'fdl' number (default: 0)
3407 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 {not available when compiled without the |+folding|
3409 feature}
3410 Sets the fold level: Folds with a higher level will be closed.
3411 Setting this option to zero will close all folds. Higher numbers will
3412 close fewer folds.
3413 This option is set by commands like |zm|, |zM| and |zR|.
3414 See |fold-foldlevel|.
3415
3416 *'foldlevelstart'* *'fdls'*
3417'foldlevelstart' 'fdls' number (default: -1)
3418 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 {not available when compiled without the |+folding|
3420 feature}
3421 Sets 'foldlevel' when starting to edit another buffer in a window.
3422 Useful to always start editing with all folds closed (value zero),
3423 some folds closed (one) or no folds closed (99).
3424 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003425 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 ignores this option and closes all folds.
3427 It is also done before BufReadPre autocommands, to allow an autocmd to
3428 overrule the 'foldlevel' value for specific files.
3429 When the value is negative, it is not used.
3430
3431 *'foldmarker'* *'fmr'* *E536*
3432'foldmarker' 'fmr' string (default: "{{{,}}}")
3433 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 {not available when compiled without the |+folding|
3435 feature}
3436 The start and end marker used when 'foldmethod' is "marker". There
3437 must be one comma, which separates the start and end marker. The
3438 marker is a literal string (a regular expression would be too slow).
3439 See |fold-marker|.
3440
3441 *'foldmethod'* *'fdm'*
3442'foldmethod' 'fdm' string (default: "manual")
3443 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 {not available when compiled without the |+folding|
3445 feature}
3446 The kind of folding used for the current window. Possible values:
3447 |fold-manual| manual Folds are created manually.
3448 |fold-indent| indent Lines with equal indent form a fold.
3449 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3450 |fold-marker| marker Markers are used to specify folds.
3451 |fold-syntax| syntax Syntax highlighting items specify folds.
3452 |fold-diff| diff Fold text that is not changed.
3453
3454 *'foldminlines'* *'fml'*
3455'foldminlines' 'fml' number (default: 1)
3456 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 {not available when compiled without the |+folding|
3458 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003459 Sets the number of screen lines above which a fold can be displayed
3460 closed. Also for manually closed folds. With the default value of
3461 one a fold can only be closed if it takes up two or more screen lines.
3462 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003463 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 "zc" to close a fold, which is displayed open because it's smaller
3465 than 'foldminlines', a following "zc" may close a containing fold.
3466
3467 *'foldnestmax'* *'fdn'*
3468'foldnestmax' 'fdn' number (default: 20)
3469 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 {not available when compiled without the |+folding|
3471 feature}
3472 Sets the maximum nesting of folds for the "indent" and "syntax"
3473 methods. This avoids that too many folds will be created. Using more
3474 than 20 doesn't work, because the internal limit is 20.
3475
3476 *'foldopen'* *'fdo'*
3477'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3478 search,tag,undo")
3479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 {not available when compiled without the |+folding|
3481 feature}
3482 Specifies for which type of commands folds will be opened, if the
3483 command moves the cursor into a closed fold. It is a comma separated
3484 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003485 NOTE: When the command is part of a mapping this option is not used.
3486 Add the |zv| command to the mapping to get the same effect.
3487 (rationale: the mapping may want to control opening folds itself)
3488
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 item commands ~
3490 all any
3491 block "(", "{", "[[", "[{", etc.
3492 hor horizontal movements: "l", "w", "fx", etc.
3493 insert any command in Insert mode
3494 jump far jumps: "G", "gg", etc.
3495 mark jumping to a mark: "'m", CTRL-O, etc.
3496 percent "%"
3497 quickfix ":cn", ":crew", ":make", etc.
3498 search search for a pattern: "/", "n", "*", "gd", etc.
3499 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003500 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 tag jumping to a tag: ":ta", CTRL-T, etc.
3502 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 When a movement command is used for an operator (e.g., "dl" or "y%")
3504 this option is not used. This means the operator will include the
3505 whole closed fold.
3506 Note that vertical movements are not here, because it would make it
3507 very difficult to move onto a closed fold.
3508 In insert mode the folds containing the cursor will always be open
3509 when text is inserted.
3510 To close folds you can re-apply 'foldlevel' with the |zx| command or
3511 set the 'foldclose' option to "all".
3512
3513 *'foldtext'* *'fdt'*
3514'foldtext' 'fdt' string (default: "foldtext()")
3515 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 {not available when compiled without the |+folding|
3517 feature}
3518 An expression which is used to specify the text displayed for a closed
3519 fold. See |fold-foldtext|.
3520
Bram Moolenaar30b65812012-07-12 22:01:11 +02003521 The expression will be evaluated in the |sandbox| if set from a
3522 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003523 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003524
3525 It is not allowed to change text or jump to another window while
3526 evaluating 'foldtext' |textlock|.
3527
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003528 *'formatexpr'* *'fex'*
3529'formatexpr' 'fex' string (default "")
3530 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003531 {not available when compiled without the |+eval|
3532 feature}
3533 Expression which is evaluated to format a range of lines for the |gq|
3534 operator or automatic formatting (see 'formatoptions'). When this
3535 option is empty 'formatprg' is used.
3536
3537 The |v:lnum| variable holds the first line to be formatted.
3538 The |v:count| variable holds the number of lines to be formatted.
3539 The |v:char| variable holds the character that is going to be
3540 inserted if the expression is being evaluated due to
3541 automatic formatting. This can be empty. Don't insert
3542 it yet!
3543
3544 Example: >
3545 :set formatexpr=mylang#Format()
3546< This will invoke the mylang#Format() function in the
3547 autoload/mylang.vim file in 'runtimepath'. |autoload|
3548
3549 The expression is also evaluated when 'textwidth' is set and adding
3550 text beyond that limit. This happens under the same conditions as
3551 when internal formatting is used. Make sure the cursor is kept in the
3552 same spot relative to the text then! The |mode()| function will
3553 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003554
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003555 When the expression evaluates to non-zero Vim will fall back to using
3556 the internal format mechanism.
3557
3558 The expression will be evaluated in the |sandbox| when set from a
3559 modeline, see |sandbox-option|. That stops the option from working,
3560 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003561 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003562 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003563
Bram Moolenaar86b68352004-12-27 21:59:20 +00003564 *'formatlistpat'* *'flp'*
3565'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3566 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003567 A pattern that is used to recognize a list header. This is used for
3568 the "n" flag in 'formatoptions'.
3569 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003570 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003571 while still checking more characters. There must be a character
3572 following the pattern, when it matches the whole line it is handled
3573 like there is no match.
3574 The default recognizes a number, followed by an optional punctuation
3575 character and white space.
3576
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003577 *'formatoptions'* *'fo'*
3578'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3579 local to buffer
3580 This is a sequence of letters which describes how automatic
3581 formatting is to be done. See |fo-table|. When the 'paste' option is
3582 on, no formatting is done (like 'formatoptions' is empty). Commas can
3583 be inserted for readability.
3584 To avoid problems with flags that are added in the future, use the
3585 "+=" and "-=" feature of ":set" |add-option-flags|.
3586 NOTE: This option is set to the Vi default value when 'compatible' is
3587 set and to the Vim default value when 'compatible' is reset.
3588
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 *'formatprg'* *'fp'*
3590'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003591 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003593 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003595 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003596 If the 'formatexpr' option is not empty it will be used instead.
3597 Otherwise, if 'formatprg' option is an empty string, the internal
3598 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003599 Environment variables are expanded |:set_env|. See |option-backslash|
3600 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003601 This option cannot be set from a |modeline| or in the |sandbox|, for
3602 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603
Bram Moolenaard94464e2015-11-02 15:28:18 +01003604 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003605'fsync' 'fs' boolean (default on)
3606 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003607 When on, the library function fsync() will be called after writing a
3608 file. This will flush a file to disk, ensuring that it is safely
3609 written even on filesystems which do metadata-only journaling. This
3610 will force the harddrive to spin up on Linux systems running in laptop
3611 mode, so it may be undesirable in some situations. Be warned that
3612 turning this off increases the chances of data loss after a crash. On
3613 systems without an fsync() implementation, this variable is always
3614 off.
3615 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003616 'fsync' also applies to |writefile()| (unless a flag is used to
3617 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003618 This option cannot be set from a |modeline| or in the |sandbox|, for
3619 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003620
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3622'gdefault' 'gd' boolean (default off)
3623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 When on, the ":substitute" flag 'g' is default on. This means that
3625 all matches in a line are substituted instead of one. When a 'g' flag
3626 is given to a ":substitute" command, this will toggle the substitution
3627 of all or one match. See |complex-change|.
3628
3629 command 'gdefault' on 'gdefault' off ~
3630 :s/// subst. all subst. one
3631 :s///g subst. one subst. all
3632 :s///gg subst. all subst. one
3633
3634 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003635 DEPRECATED: Setting this option may break plugins that are not aware
3636 of this option. Also, many users get confused that adding the /g flag
3637 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003638 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639
3640 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003641'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 Format to recognize for the ":grep" command output.
3644 This is a scanf-like string that uses the same format as the
3645 'errorformat' option: see |errorformat|.
3646
3647 *'grepprg'* *'gp'*
3648'grepprg' 'gp' string (default "grep -n ",
3649 Unix: "grep -n $* /dev/null",
3650 Win32: "findstr /n" or "grep -n",
3651 VMS: "SEARCH/NUMBERS ")
3652 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003653 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 and '#' characters, which are expanded like when used in a command-
3655 line. The placeholder "$*" is allowed to specify where the arguments
3656 will be included. Environment variables are expanded |:set_env|. See
3657 |option-backslash| about including spaces and backslashes.
3658 When your "grep" accepts the "-H" argument, use this to make ":grep"
3659 also work well with a single file: >
3660 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003661< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003662 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3663 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003664 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 apply equally to 'grepprg'.
3666 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3667 otherwise it's "grep -n".
3668 This option cannot be set from a |modeline| or in the |sandbox|, for
3669 security reasons.
3670
3671 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3672'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3673 ve:ver35-Cursor,
3674 o:hor50-Cursor,
3675 i-ci:ver25-Cursor/lCursor,
3676 r-cr:hor20-Cursor/lCursor,
3677 sm:block-Cursor
3678 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003679 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 "n-v-c:block,o:hor50,i-ci:hor15,
3681 r-cr:hor30,sm:block")
3682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003684 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003686 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003687 height of the cursor can be changed. This can be done by specifying a
3688 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003689 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3690 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003692 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 mode-list and an argument-list:
3694 mode-list:argument-list,mode-list:argument-list,..
3695 The mode-list is a dash separated list of these modes:
3696 n Normal mode
3697 v Visual mode
3698 ve Visual mode with 'selection' "exclusive" (same as 'v',
3699 if not specified)
3700 o Operator-pending mode
3701 i Insert mode
3702 r Replace mode
3703 c Command-line Normal (append) mode
3704 ci Command-line Insert mode
3705 cr Command-line Replace mode
3706 sm showmatch in Insert mode
3707 a all modes
3708 The argument-list is a dash separated list of these arguments:
3709 hor{N} horizontal bar, {N} percent of the character height
3710 ver{N} vertical bar, {N} percent of the character width
3711 block block cursor, fills the whole character
3712 [only one of the above three should be present]
3713 blinkwait{N} *cursor-blinking*
3714 blinkon{N}
3715 blinkoff{N}
3716 blink times for cursor: blinkwait is the delay before
3717 the cursor starts blinking, blinkon is the time that
3718 the cursor is shown and blinkoff is the time that the
3719 cursor is not shown. The times are in msec. When one
3720 of the numbers is zero, there is no blinking. The
3721 default is: "blinkwait700-blinkon400-blinkoff250".
3722 These numbers are used for a missing entry. This
3723 means that blinking is enabled by default. To switch
3724 blinking off you can use "blinkon0". The cursor only
3725 blinks when Vim is waiting for input, not while
3726 executing a command.
3727 To make the cursor blink in an xterm, see
3728 |xterm-blink|.
3729 {group-name}
3730 a highlight group name, that sets the color and font
3731 for the cursor
3732 {group-name}/{group-name}
3733 Two highlight group names, the first is used when
3734 no language mappings are used, the other when they
3735 are. |language-mapping|
3736
3737 Examples of parts:
3738 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3739 block cursor with colors from the "nCursor"
3740 highlight group
3741 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3742 In Insert and Command-line Insert mode, use a
3743 30% vertical bar cursor with colors from the
3744 "iCursor" highlight group. Blink a bit
3745 faster.
3746
3747 The 'a' mode is different. It will set the given argument-list for
3748 all modes. It does not reset anything to defaults. This can be used
3749 to do a common setting for all modes. For example, to switch off
3750 blinking: "a:blinkon0"
3751
3752 Examples of cursor highlighting: >
3753 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3754 :highlight Cursor gui=NONE guifg=bg guibg=fg
3755<
3756 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003757 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758'guifont' 'gfn' string (default "")
3759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 {only available when compiled with GUI enabled}
3761 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003762 In its simplest form the value is just one font name.
3763 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764
3765 *'guifontset'* *'gfs'*
3766 *E250* *E252* *E234* *E597* *E598*
3767'guifontset' 'gfs' string (default "")
3768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 {only available when compiled with GUI enabled and
3770 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003771 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 When not empty, specifies two (or more) fonts to be used. The first
3773 one for normal English, the second one for your special language. See
3774 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003775
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3777'guifontwide' 'gfw' string (default "")
3778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 {only available when compiled with GUI enabled}
3780 When not empty, specifies a comma-separated list of fonts to be used
3781 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003782 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003783
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 *'guiheadroom'* *'ghr'*
3785'guiheadroom' 'ghr' number (default 50)
3786 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003787 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 The number of pixels subtracted from the screen height when fitting
3789 the GUI window on the screen. Set this before the GUI is started,
3790 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003791 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 lines will be left for window decorations and other items on the
3793 screen. Set it to a negative value to allow windows taller than the
3794 screen.
3795
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003796 *'guiligatures'* *'gli'* *E1243*
3797'guiligatures' 'gli' string (default "")
3798 global
3799 {only for GTK GUI}
3800 List of ASCII characters that, when combined together, can create more
3801 complex shapes. Each character must be a printable ASCII character
3802 with a value in the 32-127 range.
3803 Example: >
3804 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3805< Changing this option updates screen output immediately. Set it to an
3806 empty string to disable ligatures.
3807
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003809'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3810 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003811 "aegimrLtT" (GTK, Motif and Athena),
3812 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003815 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 sequence of letters which describes what components and options of the
3817 GUI should be used.
3818 To avoid problems with flags that are added in the future, use the
3819 "+=" and "-=" feature of ":set" |add-option-flags|.
3820
Bram Moolenaar13568252018-03-16 20:46:58 +01003821 Valid characters are as follows:
3822 *'go-!'*
3823 '!' External commands are executed in a terminal window. Without
3824 this flag the MS-Windows GUI will open a console window to
3825 execute the command. The Unix GUI will simulate a dumb
3826 terminal to list the command output.
3827 The terminal window will be positioned at the bottom, and grow
3828 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003829 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 'a' Autoselect: If present, then whenever VISUAL mode is started,
3831 or the Visual area extended, Vim tries to become the owner of
3832 the windowing system's global selection. This means that the
3833 Visually highlighted text is available for pasting into other
3834 applications as well as into Vim itself. When the Visual mode
3835 ends, possibly due to an operation on the text, or when an
3836 application wants to paste the selection, the highlighted text
3837 is automatically yanked into the "* selection register.
3838 Thus the selection is still available for pasting into other
3839 applications after the VISUAL mode has ended.
3840 If not present, then Vim won't become the owner of the
3841 windowing system's global selection unless explicitly told to
3842 by a yank or delete operation for the "* register.
3843 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003844 *'go-P'*
3845 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003846 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003847 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003848 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 applies to the modeless selection.
3850
3851 'guioptions' autoselect Visual autoselect modeless ~
3852 "" - -
3853 "a" yes yes
3854 "A" - yes
3855 "aA" yes yes
3856
Bram Moolenaar02467872007-05-06 13:22:01 +00003857 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 'c' Use console dialogs instead of popup dialogs for simple
3859 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003860 *'go-d'*
3861 'd' Use dark theme variant if available. Currently only works for
3862 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003863 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003864 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003865 'guitablabel' can be used to change the text in the labels.
3866 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003867 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003868 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003869 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 'f' Foreground: Don't use fork() to detach the GUI from the shell
3871 where it was started. Use this for programs that wait for the
3872 editor to finish (e.g., an e-mail program). Alternatively you
3873 can use "gvim -f" or ":gui -f" to start the GUI in the
3874 foreground. |gui-fork|
3875 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003876 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003877 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3879 corner of the window. It's black&white on non-GTK, because of
3880 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003881 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003883 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003884 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003886 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003888 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003889 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 'g' Grey menu items: Make menu items that are not active grey. If
3891 'g' is not included inactive menu items are not shown at all.
3892 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003893 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 't' Include tearoff menu items. Currently only works for Win32,
3895 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003896 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003897 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003898 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003899 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003901 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 'R' Right-hand scrollbar is present when there is a vertically
3903 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003904 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003906 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 'L' Left-hand scrollbar is present when there is a vertically
3908 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003909 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3911 the longest visible line, or on the cursor line if the 'h'
3912 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003913 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 'h' Limit horizontal scrollbar size to the length of the cursor
3915 line. Reduces computations. |gui-horiz-scroll|
3916
3917 And yes, you may even have scrollbars on the left AND the right if
3918 you really want to :-). See |gui-scrollbars| for more information.
3919
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003920 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 'v' Use a vertical button layout for dialogs. When not included,
3922 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003923 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003924 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 'p' Use Pointer callbacks for X11 GUI. This is required for some
3926 window managers. If the cursor is not blinking or hollow at
3927 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003928 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003930 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003931 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003932 *'go-k'*
3933 'k' Keep the GUI window size when adding/removing a scrollbar, or
3934 toolbar, tabline, etc. Instead, the behavior is similar to
3935 when the window is maximized and will adjust 'lines' and
3936 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003937 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003938 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003939
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 *'guipty'* *'noguipty'*
3941'guipty' boolean (default on)
3942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 {only available when compiled with GUI enabled}
3944 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3945 I/O to/from shell commands. See |gui-pty|.
3946
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003947 *'guitablabel'* *'gtl'*
3948'guitablabel' 'gtl' string (default empty)
3949 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003950 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003951 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003952 pages line. When empty and when the result is empty Vim will use a
3953 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003954
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003955 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003956 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003957 The expression will be evaluated in the |sandbox| when set from a
3958 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003959 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003960
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003961 Only used when the GUI tab pages line is displayed. 'e' must be
3962 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3963 used.
3964
Bram Moolenaar57657d82006-04-21 22:12:41 +00003965 *'guitabtooltip'* *'gtt'*
3966'guitabtooltip' 'gtt' string (default empty)
3967 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003968 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003969 When nonempty describes the text to use in a tooltip for the GUI tab
3970 pages line. When empty Vim will use a default tooltip.
3971 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003972 You can include a line break. Simplest method is to use |:let|: >
3973 :let &guitabtooltip = "line one\nline two"
3974<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003975
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003977'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 (others) "$VIMRUNTIME/doc/help.txt")
3979 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 Name of the main help file. All distributed help files should be
3981 placed together in one directory. Additionally, all "doc" directories
3982 in 'runtimepath' will be used.
3983 Environment variables are expanded |:set_env|. For example:
3984 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003985 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 spaces and backslashes.
3987 This option cannot be set from a |modeline| or in the |sandbox|, for
3988 security reasons.
3989
3990 *'helpheight'* *'hh'*
3991'helpheight' 'hh' number (default 20)
3992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 Minimal initial height of the help window when it is opened with the
3994 ":help" command. The initial height of the help window is half of the
3995 current window, or (when the 'ea' option is on) the same as other
3996 windows. When the height is less than 'helpheight', the height is
3997 set to 'helpheight'. Set to zero to disable.
3998
3999 *'helplang'* *'hlg'*
4000'helplang' 'hlg' string (default: messages language or empty)
4001 global
4002 {only available when compiled with the |+multi_lang|
4003 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 Comma separated list of languages. Vim will use the first language
4005 for which the desired help can be found. The English help will always
4006 be used as a last resort. You can add "en" to prefer English over
4007 another language, but that will only find tags that exist in that
4008 language and not in the English help.
4009 Example: >
4010 :set helplang=de,it
4011< This will first search German, then Italian and finally English help
4012 files.
4013 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4014 try to find the tag in the current language before using this option.
4015 See |help-translated|.
4016
4017 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4018'hidden' 'hid' boolean (default off)
4019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 When off a buffer is unloaded when it is |abandon|ed. When on a
4021 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4022 displayed in another window, it does not become hidden, of course.
4023 The commands that move through the buffer list sometimes make a buffer
4024 hidden although the 'hidden' option is off: When the buffer is
4025 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004026 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004027 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 This option is set for one command with ":hide {command}" |:hide|.
4029 WARNING: It's easy to forget that you have changes in hidden buffers.
4030 Think twice when using ":q!" or ":qa!".
4031
4032 *'highlight'* *'hl'*
4033'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004034 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4035 d:Directory,e:ErrorMsg,i:IncSearch,
4036 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004037 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004038 N:CursorLineNr,r:Question,s:StatusLine,
4039 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004040 v:Visual,V:VisualNOS,w:WarningMsg,
4041 W:WildMenu,f:Folded,F:FoldColumn,
4042 A:DiffAdd,C:DiffChange,D:DiffDelete,
4043 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004044 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004045 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004046 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4047 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004048 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004049 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 This option can be used to set highlighting mode for various
4052 occasions. It is a comma separated list of character pairs. The
4053 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004054 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004056 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4057 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 characters from 'showbreak'
4059 |hl-Directory| d directories in CTRL-D listing and other special
4060 things in listings
4061 |hl-ErrorMsg| e error messages
4062 h (obsolete, ignored)
4063 |hl-IncSearch| i 'incsearch' highlighting
4064 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4065 |hl-MoreMsg| m |more-prompt|
4066 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004067 |hl-LineNr| n line number for ":number" and ":#" commands, and
4068 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004069 |hl-LineNrAbove| a line number above the cursor for when the
4070 'relativenumber' option is set.
4071 |hl-LineNrBelow| b line number below the cursor for when the
4072 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004073 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4074 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 |hl-Question| r |hit-enter| prompt and yes/no questions
4076 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004077 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4079 |hl-VertSplit| c column used to separate vertically split windows
4080 |hl-Visual| v Visual mode
4081 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4082 Selection" Only X11 Gui's |gui-x11| and
4083 |xterm-clipboard|.
4084 |hl-WarningMsg| w warning messages
4085 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4086 |hl-Folded| f line used for closed folds
4087 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004088 |hl-DiffAdd| A added line in diff mode
4089 |hl-DiffChange| C changed line in diff mode
4090 |hl-DiffDelete| D deleted line in diff mode
4091 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004093 |hl-Conceal| - the placeholders used for concealed characters
4094 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004095 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004096 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004097 |hl-SpellRare| R rare word |spell|
4098 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004099 |hl-Pmenu| + popup menu normal line
4100 |hl-PmenuSel| = popup menu selected line
4101 |hl-PmenuSbar| x popup menu scrollbar
4102 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103
4104 The display modes are:
4105 r reverse (termcap entry "mr" and "me")
4106 i italic (termcap entry "ZH" and "ZR")
4107 b bold (termcap entry "md" and "me")
4108 s standout (termcap entry "so" and "se")
4109 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004110 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004111 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 n no highlighting
4113 - no highlighting
4114 : use a highlight group
4115 The default is used for occasions that are not included.
4116 If you want to change what the display modes do, see |dos-colors|
4117 for an example.
4118 When using the ':' display mode, this must be followed by the name of
4119 a highlight group. A highlight group can be used to define any type
4120 of highlighting, including using color. See |:highlight| on how to
4121 define one. The default uses a different group for each occasion.
4122 See |highlight-default| for the default highlight groups.
4123
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004125'history' 'hi' number (Vim default: 50, Vi default: 0,
4126 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004129 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004131 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 NOTE: This option is set to the Vi default value when 'compatible' is
4133 set and to the Vim default value when 'compatible' is reset.
4134
4135 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4136'hkmap' 'hk' boolean (default off)
4137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 {only available when compiled with the |+rightleft|
4139 feature}
4140 When on, the keyboard is mapped for the Hebrew character set.
4141 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4142 toggle this option. See |rileft.txt|.
4143 NOTE: This option is reset when 'compatible' is set.
4144
4145 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4146'hkmapp' 'hkp' boolean (default off)
4147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 {only available when compiled with the |+rightleft|
4149 feature}
4150 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4151 This is useful if you have a non-Hebrew keyboard.
4152 See |rileft.txt|.
4153 NOTE: This option is reset when 'compatible' is set.
4154
Bram Moolenaar036986f2017-03-16 17:41:02 +01004155 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4156'hlsearch' 'hls' boolean (default off)
4157 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004158 {not available when compiled without the
4159 |+extra_search| feature}
4160 When there is a previous search pattern, highlight all its matches.
4161 The type of highlighting used can be set with the 'l' occasion in the
4162 'highlight' option. This uses the "Search" highlight group by
4163 default. Note that only the matching text is highlighted, any offsets
4164 are not applied.
4165 See also: 'incsearch' and |:match|.
4166 When you get bored looking at the highlighted matches, you can turn it
4167 off with |:nohlsearch|. This does not change the option value, as
4168 soon as you use a search command, the highlighting comes back.
4169 'redrawtime' specifies the maximum time spent on finding matches.
4170 When the search pattern can match an end-of-line, Vim will try to
4171 highlight all of the matched text. However, this depends on where the
4172 search starts. This will be the first line in the window or the first
4173 line below a closed fold. A match in a previous line which is not
4174 drawn may not continue in a newly drawn line.
4175 You can specify whether the highlight status is restored on startup
4176 with the 'h' flag in 'viminfo' |viminfo-h|.
4177 NOTE: This option is reset when 'compatible' is set.
4178
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 *'icon'* *'noicon'*
4180'icon' boolean (default off, on when title can be restored)
4181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 {not available when compiled without the |+title|
4183 feature}
4184 When on, the icon text of the window will be set to the value of
4185 'iconstring' (if it is not empty), or to the name of the file
4186 currently being edited. Only the last part of the name is used.
4187 Overridden by the 'iconstring' option.
4188 Only works if the terminal supports setting window icons (currently
4189 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4190 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4191 builtin termcap).
4192 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004193 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004195 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196
4197 *'iconstring'*
4198'iconstring' string (default "")
4199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 {not available when compiled without the |+title|
4201 feature}
4202 When this option is not empty, it will be used for the icon text of
4203 the window. This happens only when the 'icon' option is on.
4204 Only works if the terminal supports setting window icon text
4205 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004206 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 When Vim was compiled with HAVE_X11 defined, the original icon will be
4208 restored if possible |X11|.
4209 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004210 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004212 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 {not available when compiled without the |+statusline| feature}
4214
4215 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4216'ignorecase' 'ic' boolean (default off)
4217 global
4218 Ignore case in search patterns. Also used when searching in the tags
4219 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004220 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 Can be overruled by using "\c" or "\C" in the pattern, see
4222 |/ignorecase|.
4223
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004224 *'imactivatefunc'* *'imaf'*
4225'imactivatefunc' 'imaf' string (default "")
4226 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004227 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004228 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004229 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004230 The expression will be evaluated in the |sandbox| when set from a
4231 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004232
4233 Example: >
4234 function ImActivateFunc(active)
4235 if a:active
4236 ... do something
4237 else
4238 ... do something
4239 endif
4240 " return value is not used
4241 endfunction
4242 set imactivatefunc=ImActivateFunc
4243<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 *'imactivatekey'* *'imak'*
4245'imactivatekey' 'imak' string (default "")
4246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004248 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 Specifies the key that your Input Method in X-Windows uses for
4250 activation. When this is specified correctly, vim can fully control
4251 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4252 You can't use this option to change the activation key, the option
4253 tells Vim what the key is.
4254 Format:
4255 [MODIFIER_FLAG-]KEY_STRING
4256
4257 These characters can be used for MODIFIER_FLAG (case is ignored):
4258 S Shift key
4259 L Lock key
4260 C Control key
4261 1 Mod1 key
4262 2 Mod2 key
4263 3 Mod3 key
4264 4 Mod4 key
4265 5 Mod5 key
4266 Combinations are allowed, for example "S-C-space" or "SC-space" are
4267 both shift+ctrl+space.
4268 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4269
4270 Example: >
4271 :set imactivatekey=S-space
4272< "S-space" means shift+space. This is the activation key for kinput2 +
4273 canna (Japanese), and ami (Korean).
4274
4275 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4276'imcmdline' 'imc' boolean (default off)
4277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 When set the Input Method is always on when starting to edit a command
4279 line, unless entering a search pattern (see 'imsearch' for that).
4280 Setting this option is useful when your input method allows entering
4281 English characters directly, e.g., when it's used to type accented
4282 characters with dead keys.
4283
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004284 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4286 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 When set the Input Method is never used. This is useful to disable
4288 the IM when it doesn't work properly.
4289 Currently this option is on by default for SGI/IRIX machines. This
4290 may change in later releases.
4291
4292 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004293'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 Specifies whether :lmap or an Input Method (IM) is to be used in
4296 Insert mode. Valid values:
4297 0 :lmap is off and IM is off
4298 1 :lmap is ON and IM is off
4299 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 To always reset the option to zero when leaving Insert mode with <Esc>
4301 this can be used: >
4302 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4303< This makes :lmap and IM turn off automatically when leaving Insert
4304 mode.
4305 Note that this option changes when using CTRL-^ in Insert mode
4306 |i_CTRL-^|.
4307 The value is set to 1 when setting 'keymap' to a valid keymap name.
4308 It is also used for the argument of commands like "r" and "f".
4309 The value 0 may not work correctly with Athena and Motif with some XIM
4310 methods. Use 'imdisable' to disable XIM then.
4311
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004312 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004313 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004314 |+multi_byte_ime| or |global-ime|.
4315
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004317'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 Specifies whether :lmap or an Input Method (IM) is to be used when
4320 entering a search pattern. Valid values:
4321 -1 the value of 'iminsert' is used, makes it look like
4322 'iminsert' is also used when typing a search pattern
4323 0 :lmap is off and IM is off
4324 1 :lmap is ON and IM is off
4325 2 :lmap is off and IM is ON
4326 Note that this option changes when using CTRL-^ in Command-line mode
4327 |c_CTRL-^|.
4328 The value is set to 1 when it is not -1 and setting the 'keymap'
4329 option to a valid keymap name.
4330 The value 0 may not work correctly with Athena and Motif with some XIM
4331 methods. Use 'imdisable' to disable XIM then.
4332
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004333 *'imstatusfunc'* *'imsf'*
4334'imstatusfunc' 'imsf' string (default "")
4335 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004336 This option specifies a function that is called to obtain the status
4337 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004338 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004339
4340 Example: >
4341 function ImStatusFunc()
4342 let is_active = ...do something
4343 return is_active ? 1 : 0
4344 endfunction
4345 set imstatusfunc=ImStatusFunc
4346<
4347 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004348 The expression will be evaluated in the |sandbox| when set from a
4349 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004350
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004351 *'imstyle'* *'imst'*
4352'imstyle' 'imst' number (default 1)
4353 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004354 {only available when compiled with |+xim| and
4355 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004356 This option specifies the input style of Input Method:
4357 0 use on-the-spot style
4358 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004359 See: |xim-input-style|
4360
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004361 For a long time on-the-spot style had been used in the GTK version of
4362 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004363 |single-repeat|, etc. Therefore over-the-spot style becomes the
4364 default now. This should work fine for most people, however if you
4365 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004366 The expression will be evaluated in the |sandbox| when set from a
4367 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004368
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 *'include'* *'inc'*
4370'include' 'inc' string (default "^\s*#\s*include")
4371 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 {not available when compiled without the
4373 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004374 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 pattern, just like for the "/" command (See |pattern|). The default
4376 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004377 "]I", "[d", etc.
4378 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004379 comes after the matched pattern. But if "\zs" appears in the pattern
4380 then the text matched from "\zs" to the end, or until "\ze" if it
4381 appears, is used as the file name. Use this to include characters
4382 that are not in 'isfname', such as a space. You can then use
4383 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004384 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385
4386 *'includeexpr'* *'inex'*
4387'includeexpr' 'inex' string (default "")
4388 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004390 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004392 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 :set includeexpr=substitute(v:fname,'\\.','/','g')
4394< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004395
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004397 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 Also used for |<cfile>|.
4399
Bram Moolenaar30b65812012-07-12 22:01:11 +02004400 The expression will be evaluated in the |sandbox| when set from a
4401 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004402 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004403
4404 It is not allowed to change text or jump to another window while
4405 evaluating 'includeexpr' |textlock|.
4406
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004408'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4409 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004412 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004413 While typing a search command, show where the pattern, as it was typed
4414 so far, matches. The matched string is highlighted. If the pattern
4415 is invalid or not found, nothing is shown. The screen will be updated
4416 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004417 Also applies to the pattern in commands: >
4418 :global
4419 :lvimgrep
4420 :lvimgrepadd
4421 :smagic
4422 :snomagic
4423 :sort
4424 :substitute
4425 :vglobal
4426 :vimgrep
4427 :vimgrepadd
4428< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004429 original position when no match is found and when pressing <Esc>. You
4430 still need to finish the search command with <Enter> to move the
4431 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004432 You can use the CTRL-G and CTRL-T keys to move to the next and
4433 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004434 When compiled with the |+reltime| feature Vim only searches for about
4435 half a second. With a complicated pattern and/or a lot of text the
4436 match may not be found. This is to avoid that Vim hangs while you
4437 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004438 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004439 When 'hlsearch' is on, all matched strings are highlighted too while
4440 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004441 If you don't want to turn 'hlsearch' on, but want to highlight all
4442 matches while searching, you can turn on and off 'hlsearch' with
4443 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004444 augroup vimrc-incsearch-highlight
4445 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004446 autocmd CmdlineEnter /,\? :set hlsearch
4447 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004448 augroup END
4449<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004450 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004451 to the command line. If 'ignorecase' and 'smartcase' are set and the
4452 command line has no uppercase characters, the added character is
4453 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004454 CTRL-R CTRL-W can be used to add the word at the end of the current
4455 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 NOTE: This option is reset when 'compatible' is set.
4457
4458 *'indentexpr'* *'inde'*
4459'indentexpr' 'inde' string (default "")
4460 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 {not available when compiled without the |+cindent|
4462 or |+eval| features}
4463 Expression which is evaluated to obtain the proper indent for a line.
4464 It is used when a new line is created, for the |=| operator and
4465 in Insert mode as specified with the 'indentkeys' option.
4466 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004467 'smartindent' indenting. When 'lisp' is set, this option is
4468 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 When 'paste' is set this option is not used for indenting.
4470 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004471 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 when the expression is evaluated (but it may be moved around).
4473 The expression must return the number of spaces worth of indent. It
4474 can return "-1" to keep the current indent (this means 'autoindent' is
4475 used for the indent).
4476 Functions useful for computing the indent are |indent()|, |cindent()|
4477 and |lispindent()|.
4478 The evaluation of the expression must not have side effects! It must
4479 not change the text, jump to another window, etc. Afterwards the
4480 cursor position is always restored, thus the cursor may be moved.
4481 Normally this option would be set to call a function: >
4482 :set indentexpr=GetMyIndent()
4483< Error messages will be suppressed, unless the 'debug' option contains
4484 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004485 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004486 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487
Bram Moolenaar30b65812012-07-12 22:01:11 +02004488 The expression will be evaluated in the |sandbox| when set from a
4489 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004490 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004491
4492 It is not allowed to change text or jump to another window while
4493 evaluating 'indentexpr' |textlock|.
4494
4495
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004497'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 {not available when compiled without the |+cindent|
4500 feature}
4501 A list of keys that, when typed in Insert mode, cause reindenting of
4502 the current line. Only happens if 'indentexpr' isn't empty.
4503 The format is identical to 'cinkeys', see |indentkeys-format|.
4504 See |C-indenting| and |indent-expression|.
4505
4506 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4507'infercase' 'inf' boolean (default off)
4508 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004510 'ignorecase' is also on, the case of the match is adjusted depending
4511 on the typed text. If the typed text contains a lowercase letter
4512 where the match has an upper case letter, the completed part is made
4513 lowercase. If the typed text has no lowercase letters and the match
4514 has a lowercase letter where the typed text has an uppercase letter,
4515 and there is a letter before it, the completed part is made uppercase.
4516 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517
4518 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4519'insertmode' 'im' boolean (default off)
4520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 Makes Vim work in a way that Insert mode is the default mode. Useful
4522 if you want to use Vim as a modeless editor. Used for |evim|.
4523 These Insert mode commands will be useful:
4524 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004525 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 this is a mapping, it is executed as if 'insertmode' was off.
4527 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004529 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4530 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531
4532 These items change when 'insertmode' is set:
4533 - when starting to edit of a file, Vim goes to Insert mode.
4534 - <Esc> in Insert mode is a no-op and beeps.
4535 - <Esc> in Normal mode makes Vim go to Insert mode.
4536 - CTRL-L in Insert mode is a command, it is not inserted.
4537 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4538 However, when <Esc> is used inside a mapping, it behaves like
4539 'insertmode' was not set. This was done to be able to use the same
4540 mappings with 'insertmode' set or not set.
4541 When executing commands with |:normal| 'insertmode' is not used.
4542
4543 NOTE: This option is reset when 'compatible' is set.
4544
4545 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004546'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4548 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4549 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4550 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4551 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 The characters specified by this option are included in file names and
4554 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004555 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 Multi-byte characters 256 and above are always included, only the
4557 characters up to 255 are specified with this option.
4558 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004559 Think twice before adding white space to this option. Although a
4560 space may appear inside a file name, the effect will be that Vim
4561 doesn't know where a file name starts or ends when doing completion.
4562 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563
4564 Note that on systems using a backslash as path separator, Vim tries to
4565 do its best to make it work as you would expect. That is a bit
4566 tricky, since Vi originally used the backslash to escape special
4567 characters. Vim will not remove a backslash in front of a normal file
4568 name character on these systems, but it will on Unix and alikes. The
4569 '&' and '^' are not included by default, because these are special for
4570 cmd.exe.
4571
4572 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004573 Each part can be a single character number or a range. A range is two
4574 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 decimal number between 0 and 255 or the ASCII character itself (does
4576 not work for digits). Example:
4577 "_,-,128-140,#-43" (include '_' and '-' and the range
4578 128 to 140 and '#' to 43)
4579 If a part starts with '^', the following character number or range
4580 will be excluded from the option. The option is interpreted from left
4581 to right. Put the excluded character after the range where it is
4582 included. To include '^' itself use it as the last character of the
4583 option or the end of a range. Example:
4584 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4585 If the character is '@', all characters where isalpha() returns TRUE
4586 are included. Normally these are the characters a to z and A to Z,
4587 plus accented characters. To include '@' itself use "@-@". Examples:
4588 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004589 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 "a-z,A-Z,@-@" All letters plus the '@' character.
4591 A comma can be included by using it where a character number is
4592 expected. Example:
4593 "48-57,,,_" Digits, comma and underscore.
4594 A comma can be excluded by prepending a '^'. Example:
4595 " -~,^,,9" All characters from space to '~', excluding
4596 comma, plus <Tab>.
4597 See |option-backslash| about including spaces and backslashes.
4598
4599 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004600'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 "@,48-57,_,128-167,224-235"
4602 otherwise: "@,48-57,_,192-255")
4603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 The characters given by this option are included in identifiers.
4605 Identifiers are used in recognizing environment variables and after a
4606 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004607 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004608 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004610 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4612
4613 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004614'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 "@,48-57,_,128-167,224-235"
4616 otherwise: "@,48-57,_,192-255"
4617 Vi default: "@,48-57,_")
4618 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004620 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004621 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004622 characters above 255 check the "word" character class (any character
4623 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004624 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 For a help file it is set to all non-blank printable characters except
4626 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4627 command).
4628 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004629 This option also influences syntax highlighting, unless the syntax
4630 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 NOTE: This option is set to the Vi default value when 'compatible' is
4632 set and to the Vim default value when 'compatible' is reset.
4633
4634 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004635'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 "@,~-255"; otherwise: "@,161-255")
4637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 The characters given by this option are displayed directly on the
4639 screen. It is also used for "\p" in a |pattern|. The characters from
4640 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4641 even when they are not included in 'isprint' or excluded. See
4642 'isfname' for a description of the format of this option.
4643
4644 Non-printable characters are displayed with two characters:
4645 0 - 31 "^@" - "^_"
4646 32 - 126 always single characters
4647 127 "^?"
4648 128 - 159 "~@" - "~_"
4649 160 - 254 "| " - "|~"
4650 255 "~?"
4651 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4652 displayed as <xx>, with the hexadecimal value of the byte.
4653 When 'display' contains "uhex" all unprintable characters are
4654 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004655 The SpecialKey highlighting will be used for unprintable characters.
4656 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657
4658 Multi-byte characters 256 and above are always included, only the
4659 characters up to 255 are specified with this option. When a character
4660 is printable but it is not available in the current font, a
4661 replacement character will be shown.
4662 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4663 There is no option to specify these characters.
4664
4665 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4666'joinspaces' 'js' boolean (default on)
4667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 Insert two spaces after a '.', '?' and '!' with a join command.
4669 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4670 Otherwise only one space is inserted.
4671 NOTE: This option is set when 'compatible' is set.
4672
4673 *'key'*
4674'key' string (default "")
4675 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004676 {only available when compiled with the |+cryptv|
4677 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004679 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 Careful: Do not set the key value by hand, someone might see the typed
4681 key. Use the |:X| command. But you can make 'key' empty: >
4682 :set key=
4683< It is not possible to get the value of this option with ":set key" or
4684 "echo &key". This is to avoid showing it to someone who shouldn't
4685 know. It also means you cannot see it yourself once you have set it,
4686 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004687 You can use "&key" in an expression to detect whether encryption is
4688 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689
4690 *'keymap'* *'kmp'* *E544*
4691'keymap' 'kmp' string (default "")
4692 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 {only available when compiled with the |+keymap|
4694 feature}
4695 Name of a keyboard mapping. See |mbyte-keymap|.
4696 Setting this option to a valid keymap name has the side effect of
4697 setting 'iminsert' to one, so that the keymap becomes effective.
4698 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004699 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700
4701 *'keymodel'* *'km'*
4702'keymodel' 'km' string (default "")
4703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 List of comma separated words, which enable special things that keys
4705 can do. These values can be used:
4706 startsel Using a shifted special key starts selection (either
4707 Select mode or Visual mode, depending on "key" being
4708 present in 'selectmode').
4709 stopsel Using a not-shifted special key stops selection.
4710 Special keys in this context are the cursor keys, <End>, <Home>,
4711 <PageUp> and <PageDown>.
4712 The 'keymodel' option is set by the |:behave| command.
4713
4714 *'keywordprg'* *'kp'*
4715'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004716 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 Program to use for the |K| command. Environment variables are
4719 expanded |:set_env|. ":help" may be used to access the Vim internal
4720 help. (Note that previously setting the global option to the empty
4721 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004722 When the first character is ":", the command is invoked as a Vim
4723 Ex command prefixed with [count].
4724 When "man", "man -s" or an Ex command is used, Vim will automatically
4725 translate a count for the "K" command and pass it as the first
4726 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 See |option-backslash| about including spaces and backslashes.
4728 Example: >
4729 :set keywordprg=man\ -s
4730< This option cannot be set from a |modeline| or in the |sandbox|, for
4731 security reasons.
4732
4733 *'langmap'* *'lmap'* *E357* *E358*
4734'langmap' 'lmap' string (default "")
4735 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 {only available when compiled with the |+langmap|
4737 feature}
4738 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004739 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004740 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 care of translating these special characters to the original meaning
4742 of the key. This means you don't have to change the keyboard mode to
4743 be able to execute Normal mode commands.
4744 This is the opposite of the 'keymap' option, where characters are
4745 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004746 Also consider setting 'langremap' to off, to prevent 'langmap' from
4747 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004748 This option cannot be set from a |modeline| or in the |sandbox|, for
4749 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004751 Example (for Greek, in UTF-8): *greek* >
4752 :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 +00004753< Example (exchanges meaning of z and y for commands): >
4754 :set langmap=zy,yz,ZY,YZ
4755<
4756 The 'langmap' option is a list of parts, separated with commas. Each
4757 part can be in one of two forms:
4758 1. A list of pairs. Each pair is a "from" character immediately
4759 followed by the "to" character. Examples: "aA", "aAbBcC".
4760 2. A list of "from" characters, a semi-colon and a list of "to"
4761 characters. Example: "abc;ABC"
4762 Example: "aA,fgh;FGH,cCdDeE"
4763 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004764 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765
4766 This will allow you to activate vim actions without having to switch
4767 back and forth between the languages. Your language characters will
4768 be understood as normal vim English characters (according to the
4769 langmap mappings) in the following cases:
4770 o Normal/Visual mode (commands, buffer/register names, user mappings)
4771 o Insert/Replace Mode: Register names after CTRL-R
4772 o Insert/Replace Mode: Mappings
4773 Characters entered in Command-line mode will NOT be affected by
4774 this option. Note that this option can be changed at any time
4775 allowing to switch between mappings for different languages/encodings.
4776 Use a mapping to avoid having to type it each time!
4777
4778 *'langmenu'* *'lm'*
4779'langmenu' 'lm' string (default "")
4780 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 {only available when compiled with the |+menu| and
4782 |+multi_lang| features}
4783 Language to use for menu translation. Tells which file is loaded
4784 from the "lang" directory in 'runtimepath': >
4785 "lang/menu_" . &langmenu . ".vim"
4786< (without the spaces). For example, to always use the Dutch menus, no
4787 matter what $LANG is set to: >
4788 :set langmenu=nl_NL.ISO_8859-1
4789< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004790 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 If your $LANG is set to a non-English language but you do want to use
4792 the English menus: >
4793 :set langmenu=none
4794< This option must be set before loading menus, switching on filetype
4795 detection or syntax highlighting. Once the menus are defined setting
4796 this option has no effect. But you could do this: >
4797 :source $VIMRUNTIME/delmenu.vim
4798 :set langmenu=de_DE.ISO_8859-1
4799 :source $VIMRUNTIME/menu.vim
4800< Warning: This deletes all menus that you defined yourself!
4801
Bram Moolenaard94464e2015-11-02 15:28:18 +01004802 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004803'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004804 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004805 {only available when compiled with the |+langmap|
4806 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004807 This is just like 'langremap' but with the value inverted. It only
4808 exists for backwards compatibility. When setting 'langremap' then
4809 'langnoremap' is set to the inverted value, and the other way around.
4810
4811 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004812'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004813 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004814 {only available when compiled with the |+langmap|
4815 feature}
4816 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004817 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004818 'langmap' disables some of your mappings, try resetting this option.
4819 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004820 that works for you to avoid mappings to break.
4821
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 *'laststatus'* *'ls'*
4823'laststatus' 'ls' number (default 1)
4824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 The value of this option influences when the last window will have a
4826 status line:
4827 0: never
4828 1: only if there are at least two windows
4829 2: always
4830 The screen looks nicer with a status line if you have several
4831 windows, but it takes another screen line. |status-line|
4832
4833 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4834'lazyredraw' 'lz' boolean (default off)
4835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 When this option is set, the screen will not be redrawn while
4837 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004838 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 update use |:redraw|.
4840
4841 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4842'linebreak' 'lbr' boolean (default off)
4843 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004844 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004846 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 than at the last character that fits on the screen. Unlike
4848 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004849 it only affects the way the file is displayed, not its contents.
4850 If 'breakindent' is set, line is visually indented. Then, the value
4851 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004852 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 Note that <Tab> characters after an <EOL> are mostly not displayed
4854 with the right amount of white space.
4855
4856 *'lines'* *E593*
4857'lines' number (default 24 or terminal height)
4858 global
4859 Number of lines of the Vim window.
4860 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004861 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 When Vim is running in the GUI or in a resizable window, setting this
4863 option will cause the window size to be changed. When you only want
4864 to use the size for the GUI, put the command in your |gvimrc| file.
4865 Vim limits the number of lines to what fits on the screen. You can
4866 use this command to get the tallest window possible: >
4867 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004868< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004869 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 When you set this option and Vim is unable to change the physical
4871 number of lines of the display, the display may be messed up.
4872
4873 *'linespace'* *'lsp'*
4874'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 {only in the GUI}
4877 Number of pixel lines inserted between characters. Useful if the font
4878 uses the full character cell height, making lines touch each other.
4879 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004880 With some fonts there can be too much room between lines (to have
4881 space for ascents and descents). Then it makes sense to set
4882 'linespace' to a negative value. This may cause display problems
4883 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884
4885 *'lisp'* *'nolisp'*
4886'lisp' boolean (default off)
4887 local to buffer
4888 {not available when compiled without the |+lispindent|
4889 feature}
4890 Lisp mode: When <Enter> is typed in insert mode set the indent for
4891 the next line to Lisp standards (well, sort of). Also happens with
4892 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4893 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4894 better. Also see 'lispwords'.
4895 The '-' character is included in keyword characters. Redefines the
4896 "=" operator to use this same indentation algorithm rather than
4897 calling an external program if 'equalprg' is empty.
4898 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899
4900 *'lispwords'* *'lw'*
4901'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004902 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 {not available when compiled without the |+lispindent|
4904 feature}
4905 Comma separated list of words that influence the Lisp indenting.
4906 |'lisp'|
4907
4908 *'list'* *'nolist'*
4909'list' boolean (default off)
4910 local to window
Bram Moolenaar113cb512021-11-07 20:27:04 +00004911 List mode: By default show tabs as CTRL-I is displayed, display $
4912 after end of line. Useful to see the difference between tabs and
4913 spaces and for trailing blanks. Further changed by the 'listchars'
4914 option.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004915
4916 The cursor is displayed at the start of the space a Tab character
4917 occupies, not at the end as usual in Normal mode. To get this cursor
4918 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004919 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004920<
4921 Note that list mode will also affect formatting (set with 'textwidth'
4922 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 changing the way tabs are displayed.
4924
4925 *'listchars'* *'lcs'*
4926'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004927 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004928 Strings to use in 'list' mode and for the |:list| command. It is a
4929 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004930 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 eol:c Character to show at the end of each line. When
4932 omitted, there is no extra character at the end of the
4933 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004934 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004935 tab:xy[z] Two or three characters to be used to show a tab.
4936 The third character is optional.
4937
4938 tab:xy The 'x' is always used, then 'y' as many times as will
4939 fit. Thus "tab:>-" displays:
4940 >
4941 >-
4942 >--
4943 etc.
4944
4945 tab:xyz The 'z' is always used, then 'x' is prepended, and
4946 then 'y' is used as many times as will fit. Thus
4947 "tab:<->" displays:
4948 >
4949 <>
4950 <->
4951 <-->
4952 etc.
4953
4954 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004955 *lcs-space*
4956 space:c Character to show for a space. When omitted, spaces
4957 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004958 *lcs-multispace*
4959 multispace:c...
4960 One or more characters to use cyclically to show for
4961 multiple consecutive spaces. Overrides the "space"
4962 setting, except for single spaces. When omitted, the
4963 "space" setting is used. For example,
4964 `:set listchars=multispace:---+` shows ten consecutive
4965 spaces as:
4966 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004967 *lcs-lead*
4968 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004969 leading spaces are blank. Overrides the "space" and
4970 "multispace" settings for leading spaces. You can
4971 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01004972 :set listchars+=tab:>-,lead:.
4973< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004974 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004975 trailing spaces are blank. Overrides the "space" and
4976 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02004977 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 extends:c Character to show in the last column, when 'wrap' is
4979 off and the line continues beyond the right of the
4980 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004981 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004982 precedes:c Character to show in the first visible column of the
4983 physical line, when there is text preceding the
4984 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004985 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004986 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004987 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004988 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004989 nbsp:c Character to show for a non-breakable space character
4990 (0xA0 (160 decimal) and U+202F). Left blank when
4991 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004993 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004995 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996
Bram Moolenaar93ff6722021-10-16 17:51:40 +01004997 Each character can be specified as hex: >
4998 set listchars=eol:\\x24
4999 set listchars=eol:\\u21b5
5000 set listchars=eol:\\U000021b5
5001< Note that a double backslash is used. The number of hex characters
5002 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5003
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 Examples: >
5005 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005006 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 :set lcs=extends:>,precedes:<
5008< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005009 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5010 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005011 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012
5013 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5014'loadplugins' 'lpl' boolean (default on)
5015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 When on the plugin scripts are loaded when starting up |load-plugins|.
5017 This option can be reset in your |vimrc| file to disable the loading
5018 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005019 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5020 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021
Bram Moolenaard94464e2015-11-02 15:28:18 +01005022 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005023'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005024 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005025 {only available when compiled with the |+lua/dyn|
5026 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005027 Specifies the name of the Lua shared library. The default is
5028 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005029 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005030 This option cannot be set from a |modeline| or in the |sandbox|, for
5031 security reasons.
5032
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005033 *'macatsui'* *'nomacatsui'*
5034'macatsui' boolean (default on)
5035 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005036 {not supported}
5037 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005038
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 *'magic'* *'nomagic'*
5040'magic' boolean (default on)
5041 global
5042 Changes the special characters that can be used in search patterns.
5043 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005044 WARNING: Switching this option off most likely breaks plugins! That
5045 is because many patterns assume it's on and will fail when it's off.
5046 Only switch it off when working with old Vi scripts. In any other
5047 situation write patterns that work when 'magic' is on. Include "\M"
5048 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005049 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5050 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051
5052 *'makeef'* *'mef'*
5053'makeef' 'mef' string (default: "")
5054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 {not available when compiled without the |+quickfix|
5056 feature}
5057 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5058 and the |:grep| command.
5059 When it is empty, an internally generated temp file will be used.
5060 When "##" is included, it is replaced by a number to make the name
5061 unique. This makes sure that the ":make" command doesn't overwrite an
5062 existing file.
5063 NOT used for the ":cf" command. See 'errorfile' for that.
5064 Environment variables are expanded |:set_env|.
5065 See |option-backslash| about including spaces and backslashes.
5066 This option cannot be set from a |modeline| or in the |sandbox|, for
5067 security reasons.
5068
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005069 *'makeencoding'* *'menc'*
5070'makeencoding' 'menc' string (default "")
5071 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005072 Encoding used for reading the output of external commands. When empty,
5073 encoding is not converted.
5074 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5075 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5076 and `:laddfile`.
5077
5078 This would be mostly useful when you use MS-Windows and set 'encoding'
5079 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5080 'makeencoding' to "char" has the same effect as setting to the system
5081 locale encoding. Example: >
5082 :set encoding=utf-8
5083 :set makeencoding=char " system locale is used
5084<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 *'makeprg'* *'mp'*
5086'makeprg' 'mp' string (default "make", VMS: "MMS")
5087 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005088 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005089 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5090 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005091 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005092 Environment variables are expanded |:set_env|. See |option-backslash|
5093 about including spaces and backslashes.
5094 Note that a '|' must be escaped twice: once for ":set" and once for
5095 the interpretation of a command. When you use a filter called
5096 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 :set makeprg=gmake\ \\\|\ myfilter
5098< The placeholder "$*" can be given (even multiple times) to specify
5099 where the arguments will be included, for example: >
5100 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5101< This option cannot be set from a |modeline| or in the |sandbox|, for
5102 security reasons.
5103
5104 *'matchpairs'* *'mps'*
5105'matchpairs' 'mps' string (default "(:),{:},[:]")
5106 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005108 other.
5109 Only character pairs are allowed that are different, thus you cannot
5110 jump between two double quotes.
5111 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005112 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005113 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 :set mps+=<:>
5115
5116< A more exotic example, to jump between the '=' and ';' in an
5117 assignment, useful for languages like C and Java: >
5118 :au FileType c,cpp,java set mps+==:;
5119
5120< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005121 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122
5123 *'matchtime'* *'mat'*
5124'matchtime' 'mat' number (default 5)
5125 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 Tenths of a second to show the matching paren, when 'showmatch' is
5127 set. Note that this is not in milliseconds, like other options that
5128 set a time. This is to be compatible with Nvi.
5129
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005130 *'maxcombine'* *'mco'*
5131'maxcombine' 'mco' number (default 2)
5132 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005133 The maximum number of combining characters supported for displaying.
5134 Only used when 'encoding' is "utf-8".
5135 The default is OK for most languages. Hebrew may require 4.
5136 Maximum value is 6.
5137 Even when this option is set to 2 you can still edit text with more
5138 combining characters, you just can't see them. Use |g8| or |ga|.
5139 See |mbyte-combining|.
5140
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 *'maxfuncdepth'* *'mfd'*
5142'maxfuncdepth' 'mfd' number (default 100)
5143 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005144 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005145 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 Maximum depth of function calls for user functions. This normally
5147 catches endless recursion. When using a recursive function with
5148 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5149 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005150 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005151 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 See also |:function|.
5153
5154 *'maxmapdepth'* *'mmd'* *E223*
5155'maxmapdepth' 'mmd' number (default 1000)
5156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 Maximum number of times a mapping is done without resulting in a
5158 character to be used. This normally catches endless mappings, like
5159 ":map x y" with ":map y x". It still does not catch ":map g wg",
5160 because the 'w' is used before the next mapping is done. See also
5161 |key-mapping|.
5162
5163 *'maxmem'* *'mm'*
5164'maxmem' 'mm' number (default between 256 to 5120 (system
5165 dependent) or half the amount of memory
5166 available)
5167 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5169 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005170 other memory to be freed.
5171 The maximum usable value is about 2000000. Use this to work without a
5172 limit.
5173 The value is ignored when 'swapfile' is off.
5174 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005176 *'maxmempattern'* *'mmp'*
5177'maxmempattern' 'mmp' number (default 1000)
5178 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005179 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005180 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005181 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005182 When Vim runs into the limit it gives an error message and mostly
5183 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005184 Running into the limit often means that the pattern is very
5185 inefficient or too complex. This may already happen with the pattern
5186 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005187 Might also happen on redraw, when syntax rules try to match a complex
5188 text structure.
5189 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5190 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005191
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 *'maxmemtot'* *'mmt'*
5193'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5194 dependent) or half the amount of memory
5195 available)
5196 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005197 Maximum amount of memory in Kbyte to use for all buffers together.
5198 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005199 without a limit.
5200 On 64 bit machines higher values might work. But hey, do you really
5201 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005202 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005203 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005204 Buffers with 'swapfile' off still count to the total amount of memory
5205 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005206 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207
5208 *'menuitems'* *'mis'*
5209'menuitems' 'mis' number (default 25)
5210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 {not available when compiled without the |+menu|
5212 feature}
5213 Maximum number of items to use in a menu. Used for menus that are
5214 generated from a list of items, e.g., the Buffers menu. Changing this
5215 option has no direct effect, the menu must be refreshed first.
5216
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005217 *'mkspellmem'* *'msm'*
5218'mkspellmem' 'msm' string (default "460000,2000,500")
5219 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005220 {not available when compiled without the |+syntax|
5221 feature}
5222 Parameters for |:mkspell|. This tunes when to start compressing the
5223 word tree. Compression can be slow when there are many words, but
5224 it's needed to avoid running out of memory. The amount of memory used
5225 per word depends very much on how similar the words are, that's why
5226 this tuning is complicated.
5227
5228 There are three numbers, separated by commas:
5229 {start},{inc},{added}
5230
5231 For most languages the uncompressed word tree fits in memory. {start}
5232 gives the amount of memory in Kbyte that can be used before any
5233 compression is done. It should be a bit smaller than the amount of
5234 memory that is available to Vim.
5235
5236 When going over the {start} limit the {inc} number specifies the
5237 amount of memory in Kbyte that can be allocated before another
5238 compression is done. A low number means compression is done after
5239 less words are added, which is slow. A high number means more memory
5240 will be allocated.
5241
5242 After doing compression, {added} times 1024 words can be added before
5243 the {inc} limit is ignored and compression is done when any extra
5244 amount of memory is needed. A low number means there is a smaller
5245 chance of hitting the {inc} limit, less memory is used but it's
5246 slower.
5247
5248 The languages for which these numbers are important are Italian and
5249 Hungarian. The default works for when you have about 512 Mbyte. If
5250 you have 1 Gbyte you could use: >
5251 :set mkspellmem=900000,3000,800
5252< If you have less than 512 Mbyte |:mkspell| may fail for some
5253 languages, no matter what you set 'mkspellmem' to.
5254
Bram Moolenaar07607392019-05-26 19:20:43 +02005255 This option cannot be set from a |modeline| or in the |sandbox|.
5256
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005258'modeline' 'ml' boolean (Vim default: on (off for root),
5259 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005261 If 'modeline' is on 'modelines' gives the number of lines that is
5262 checked for set commands. If 'modeline' is off or 'modelines' is zero
5263 no lines are checked. See |modeline|.
5264
5265 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5266'modelineexpr' 'mle' boolean (default: off)
5267 global
5268 When on allow some options that are an expression to be set in the
5269 modeline. Check the option for whether it is affected by
5270 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005271 This option cannot be set from a |modeline| or in the |sandbox|, for
5272 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005273
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 *'modelines'* *'mls'*
5275'modelines' 'mls' number (default 5)
5276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 If 'modeline' is on 'modelines' gives the number of lines that is
5278 checked for set commands. If 'modeline' is off or 'modelines' is zero
5279 no lines are checked. See |modeline|.
5280 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5281 set and to the Vim default value when 'compatible' is reset.
5282
5283 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005284 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285'modifiable' 'ma' boolean (default on)
5286 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 When off the buffer contents cannot be changed. The 'fileformat' and
5288 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005289 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005290
5291 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5292'modified' 'mod' boolean (default off)
5293 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 When on, the buffer is considered to be modified. This option is set
5295 when:
5296 1. A change was made to the text since it was last written. Using the
5297 |undo| command to go back to the original text will reset the
5298 option. But undoing changes that were made before writing the
5299 buffer will set the option again, since the text is different from
5300 when it was written.
5301 2. 'fileformat' or 'fileencoding' is different from its original
5302 value. The original value is set when the buffer is read or
5303 written. A ":set nomodified" command also resets the original
5304 values to the current values and the 'modified' option will be
5305 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005306 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005307 This option is not set when a change is made to the buffer as the
5308 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5309 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5310 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5312 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005313 Note that the text may actually be the same, e.g. 'modified' is set
5314 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315
5316 *'more'* *'nomore'*
5317'more' boolean (Vim default: on, Vi default: off)
5318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 When on, listings pause when the whole screen is filled. You will get
5320 the |more-prompt|. When this option is off there are no pauses, the
5321 listing continues until finished.
5322 NOTE: This option is set to the Vi default value when 'compatible' is
5323 set and to the Vim default value when 'compatible' is reset.
5324
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005325 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005326'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005327 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005329 Enable the use of the mouse. Works for most terminals (xterm, Win32
5330 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5331 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5332 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005333 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 v Visual mode
5335 i Insert mode
5336 c Command-line mode
5337 h all previous modes when editing a help file
5338 a all previous modes
5339 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005340 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005342< If your terminal can't overrule the mouse events going to the
5343 application, use: >
5344 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005345< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005346 back to Vim using the mouse events.
5347 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5348 "xterm".
5349
5350 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351 modeless selection. This doesn't move the text cursor.
5352
5353 See |mouse-using|. Also see |'clipboard'|.
5354
5355 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005356 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 the mouse buttons can still be used by keeping the shift key pressed.
5358 Also see the 'clipboard' option.
5359
5360 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5361'mousefocus' 'mousef' boolean (default off)
5362 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 {only works in the GUI}
5364 The window that the mouse pointer is on is automatically activated.
5365 When changing the window layout or window focus in another way, the
5366 mouse pointer is moved to the window with keyboard focus. Off is the
5367 default because it makes using the pull down menus a little goofy, as
5368 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005369 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005370 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371
5372 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5373'mousehide' 'mh' boolean (default on)
5374 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 {only works in the GUI}
5376 When on, the mouse pointer is hidden when characters are typed.
5377 The mouse pointer is restored when the mouse is moved.
5378
5379 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005380'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 Sets the model to use for the mouse. The name mostly specifies what
5383 the right mouse button is used for:
5384 extend Right mouse button extends a selection. This works
5385 like in an xterm.
5386 popup Right mouse button pops up a menu. The shifted left
5387 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005388 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 popup_setpos Like "popup", but the cursor will be moved to the
5390 position where the mouse was clicked, and thus the
5391 selected operation will act upon the clicked object.
5392 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005393 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 course, that right clicking outside a selection will
5395 end Visual mode.
5396 Overview of what button does what for each model:
5397 mouse extend popup(_setpos) ~
5398 left click place cursor place cursor
5399 left drag start selection start selection
5400 shift-left search word extend selection
5401 right click extend selection popup menu (place cursor)
5402 right drag extend selection -
5403 middle click paste paste
5404
5405 In the "popup" model the right mouse button produces a pop-up menu.
5406 You need to define this first, see |popup-menu|.
5407
5408 Note that you can further refine the meaning of buttons with mappings.
5409 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5410 selection (because that's handled in the GUI code directly).
5411
5412 The 'mousemodel' option is set by the |:behave| command.
5413
5414 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005415'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5416 vs:leftright,vd:lrsizing,m:no,
5417 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 {only available when compiled with the |+mouseshape|
5420 feature}
5421 This option tells Vim what the mouse pointer should look like in
5422 different modes. The option is a comma separated list of parts, much
5423 like used for 'guicursor'. Each part consist of a mode/location-list
5424 and an argument-list:
5425 mode-list:shape,mode-list:shape,..
5426 The mode-list is a dash separated list of these modes/locations:
5427 In a normal window: ~
5428 n Normal mode
5429 v Visual mode
5430 ve Visual mode with 'selection' "exclusive" (same as 'v',
5431 if not specified)
5432 o Operator-pending mode
5433 i Insert mode
5434 r Replace mode
5435
5436 Others: ~
5437 c appending to the command-line
5438 ci inserting in the command-line
5439 cr replacing in the command-line
5440 m at the 'Hit ENTER' or 'More' prompts
5441 ml idem, but cursor in the last line
5442 e any mode, pointer below last window
5443 s any mode, pointer on a status line
5444 sd any mode, while dragging a status line
5445 vs any mode, pointer on a vertical separator line
5446 vd any mode, while dragging a vertical separator line
5447 a everywhere
5448
5449 The shape is one of the following:
5450 avail name looks like ~
5451 w x arrow Normal mouse pointer
5452 w x blank no pointer at all (use with care!)
5453 w x beam I-beam
5454 w x updown up-down sizing arrows
5455 w x leftright left-right sizing arrows
5456 w x busy The system's usual busy pointer
5457 w x no The system's usual 'no input' pointer
5458 x udsizing indicates up-down resizing
5459 x lrsizing indicates left-right resizing
5460 x crosshair like a big thin +
5461 x hand1 black hand
5462 x hand2 white hand
5463 x pencil what you write with
5464 x question big ?
5465 x rightup-arrow arrow pointing right-up
5466 w x up-arrow arrow pointing up
5467 x <number> any X11 pointer number (see X11/cursorfont.h)
5468
5469 The "avail" column contains a 'w' if the shape is available for Win32,
5470 x for X11.
5471 Any modes not specified or shapes not available use the normal mouse
5472 pointer.
5473
5474 Example: >
5475 :set mouseshape=s:udsizing,m:no
5476< will make the mouse turn to a sizing arrow over the status lines and
5477 indicate no input when the hit-enter prompt is displayed (since
5478 clicking the mouse has no effect in this state.)
5479
5480 *'mousetime'* *'mouset'*
5481'mousetime' 'mouset' number (default 500)
5482 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005483 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484 time in msec between two mouse clicks for the second click to be
5485 recognized as a multi click.
5486
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005487 *'mzschemedll'*
5488'mzschemedll' string (default depends on the build)
5489 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005490 {only available when compiled with the |+mzscheme/dyn|
5491 feature}
5492 Specifies the name of the MzScheme shared library. The default is
5493 DYNAMIC_MZSCH_DLL which was specified at compile time.
5494 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005495 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005496 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005497 This option cannot be set from a |modeline| or in the |sandbox|, for
5498 security reasons.
5499
5500 *'mzschemegcdll'*
5501'mzschemegcdll' string (default depends on the build)
5502 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005503 {only available when compiled with the |+mzscheme/dyn|
5504 feature}
5505 Specifies the name of the MzScheme GC shared library. The default is
5506 DYNAMIC_MZGC_DLL which was specified at compile time.
5507 The value can be equal to 'mzschemedll' if it includes the GC code.
5508 Environment variables are expanded |:set_env|.
5509 This option cannot be set from a |modeline| or in the |sandbox|, for
5510 security reasons.
5511
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005512 *'mzquantum'* *'mzq'*
5513'mzquantum' 'mzq' number (default 100)
5514 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005515 {not available when compiled without the |+mzscheme|
5516 feature}
5517 The number of milliseconds between polls for MzScheme threads.
5518 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005519 NOTE: This option is set to the Vim default value when 'compatible'
5520 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005521
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005523'nrformats' 'nf' string (default "bin,octal,hex",
5524 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 This defines what bases Vim will consider for numbers when using the
5527 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5528 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005529 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005531 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005532 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005534 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 considered to be hexadecimal. Example: Using CTRL-X on
5536 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005537 bin If included, numbers starting with "0b" or "0B" will be
5538 considered to be binary. Example: Using CTRL-X on
5539 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005540 unsigned If included, numbers are recognized as unsigned. Thus a
5541 leading dash or negative sign won't be considered as part of
5542 the number. Examples:
5543 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5544 (without "unsigned" it would become "9-2021").
5545 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5546 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005547 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5548 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 Numbers which simply begin with a digit in the range 1-9 are always
5550 considered decimal. This also happens for numbers that are not
5551 recognized as octal or hex.
5552
5553 *'number'* *'nu'* *'nonumber'* *'nonu'*
5554'number' 'nu' boolean (default off)
5555 local to window
5556 Print the line number in front of each line. When the 'n' option is
5557 excluded from 'cpoptions' a wrapped line will not use the column of
5558 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005559 The 'numberwidth' option can be used to set the room used for the line
5560 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 When a long, wrapped line doesn't start with the first character, '-'
5562 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005563 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5564 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005565 *number_relativenumber*
5566 The 'relativenumber' option changes the displayed number to be
5567 relative to the cursor. Together with 'number' there are these
5568 four combinations (cursor in line 3):
5569
Bram Moolenaar3848e002016-03-19 18:42:29 +01005570 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005571 'nornu' 'nornu' 'rnu' 'rnu'
5572
5573 |apple | 1 apple | 2 apple | 2 apple
5574 |pear | 2 pear | 1 pear | 1 pear
5575 |nobody | 3 nobody | 0 nobody |3 nobody
5576 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005578 *'numberwidth'* *'nuw'*
5579'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5580 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005581 {only available when compiled with the |+linebreak|
5582 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005583 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005584 when the 'number' or 'relativenumber' option is set or printing lines
5585 with a line number. Since one space is always between the number and
5586 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005587 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005588 fit the highest line number in the buffer respectively the number of
5589 rows in the window, depending on whether 'number' or 'relativenumber'
5590 is set. Thus with the Vim default of 4 there is room for a line number
5591 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005592 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005593 NOTE: This option is set to the Vi default value when 'compatible' is
5594 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005595
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005596 *'omnifunc'* *'ofu'*
5597'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005598 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005599 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005600 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005601 This option specifies a function to be used for Insert mode omni
5602 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005603 See |complete-functions| for an explanation of how the function is
5604 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005605 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005606 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005607 This option cannot be set from a |modeline| or in the |sandbox|, for
5608 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005609
5610
Bram Moolenaar02467872007-05-06 13:22:01 +00005611 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005612'opendevice' 'odev' boolean (default off)
5613 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005614 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005615 Enable reading and writing from devices. This may get Vim stuck on a
5616 device that can be opened but doesn't actually do the I/O. Therefore
5617 it is off by default.
5618 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5619 result in editing a device.
5620
5621
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005622 *'operatorfunc'* *'opfunc'*
5623'operatorfunc' 'opfunc' string (default: empty)
5624 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005625 This option specifies a function to be called by the |g@| operator.
5626 See |:map-operator| for more info and an example.
5627
5628 This option cannot be set from a |modeline| or in the |sandbox|, for
5629 security reasons.
5630
5631
Bram Moolenaar251e1912011-06-19 05:09:16 +02005632 *'osfiletype'* *'oft'*
5633'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005635 This option was supported on RISC OS, which has been removed.
5636
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005638 *'packpath'* *'pp'*
5639'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005640 Directories used to find packages. See |packages|.
5641
5642
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005644'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 global
5646 Specifies the nroff macros that separate paragraphs. These are pairs
5647 of two letters (see |object-motions|).
5648
5649 *'paste'* *'nopaste'*
5650'paste' boolean (default off)
5651 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005652 Put Vim in Paste mode. This is useful if you want to cut or copy
5653 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 unexpected effects.
5655 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005656 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 knows about pasting and will mostly do the right thing without 'paste'
5658 being set. The same is true for a terminal where Vim handles the
5659 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005660 This option is reset when starting the GUI. Thus if you set it in
5661 your .vimrc it will work in a terminal, but not in the GUI. Setting
5662 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5663 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 When the 'paste' option is switched on (also when it was already on):
5665 - mapping in Insert mode and Command-line mode is disabled
5666 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005668 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005669 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 - 'revins' is reset
5671 - 'ruler' is reset
5672 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005673 - 'smarttab' is reset
5674 - 'softtabstop' is set to 0
5675 - 'textwidth' is set to 0
5676 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005677 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005680 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005681 - 'indentexpr'
5682 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005683 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 NOTE: When you start editing another file while the 'paste' option is
5685 on, settings from the modelines or autocommands may change the
5686 settings again, causing trouble when pasting text. You might want to
5687 set the 'paste' option again.
5688 When the 'paste' option is reset the mentioned options are restored to
5689 the value before the moment 'paste' was switched from off to on.
5690 Resetting 'paste' before ever setting it does not have any effect.
5691 Since mapping doesn't work while 'paste' is active, you need to use
5692 the 'pastetoggle' option to toggle the 'paste' option with some key.
5693
5694 *'pastetoggle'* *'pt'*
5695'pastetoggle' 'pt' string (default "")
5696 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 When non-empty, specifies the key sequence that toggles the 'paste'
5698 option. This is like specifying a mapping: >
5699 :map {keys} :set invpaste<CR>
5700< Where {keys} is the value of 'pastetoggle'.
5701 The difference is that it will work even when 'paste' is set.
5702 'pastetoggle' works in Insert mode and Normal mode, but not in
5703 Command-line mode.
5704 Mappings are checked first, thus overrule 'pastetoggle'. However,
5705 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5706 this: >
5707 :map <F10> :set paste<CR>
5708 :map <F11> :set nopaste<CR>
5709 :imap <F10> <C-O>:set paste<CR>
5710 :imap <F11> <nop>
5711 :set pastetoggle=<F11>
5712< This will make <F10> start paste mode and <F11> stop paste mode.
5713 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5714 mode everything is inserted literally, except the 'pastetoggle' key
5715 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005716 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717
5718 *'pex'* *'patchexpr'*
5719'patchexpr' 'pex' string (default "")
5720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 {not available when compiled without the |+diff|
5722 feature}
5723 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005724 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725
Bram Moolenaardbc28022014-07-26 13:40:44 +02005726 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727'patchmode' 'pm' string (default "")
5728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 When non-empty the oldest version of a file is kept. This can be used
5730 to keep the original version of a file if you are changing files in a
5731 source distribution. Only the first time that a file is written a
5732 copy of the original file will be kept. The name of the copy is the
5733 name of the original file with the string in the 'patchmode' option
5734 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005735 ".orig" or ".org". 'backupdir' must not be empty for this to work
5736 (Detail: The backup file is renamed to the patchmode file after the
5737 new file has been successfully written, that's why it must be possible
5738 to write a backup file). If there was no file to be backed up, an
5739 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 When the 'backupskip' pattern matches, a patchmode file is not made.
5741 Using 'patchmode' for compressed files appends the extension at the
5742 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5743 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005744 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005746 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 other systems: ".,,")
5749 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005751 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5752 provided that the file being searched for has a relative path (not
5753 starting with "/", "./" or "../"). The directories in the 'path'
5754 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 - Use commas to separate directory names: >
5756 :set path=.,/usr/local/include,/usr/include
5757< - Spaces can also be used to separate directory names (for backwards
5758 compatibility with version 3.0). To have a space in a directory
5759 name, precede it with an extra backslash, and escape the space: >
5760 :set path=.,/dir/with\\\ space
5761< - To include a comma in a directory name precede it with an extra
5762 backslash: >
5763 :set path=.,/dir/with\\,comma
5764< - To search relative to the directory of the current file, use: >
5765 :set path=.
5766< - To search in the current directory use an empty string between two
5767 commas: >
5768 :set path=,,
5769< - A directory name may end in a ':' or '/'.
5770 - Environment variables are expanded |:set_env|.
5771 - When using |netrw.vim| URLs can be used. For example, adding
5772 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005773 - Search upwards and downwards in a directory tree using "*", "**" and
5774 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 {not available when compiled without the |+path_extra| feature}
5776 - Careful with '\' characters, type two to get one in the option: >
5777 :set path=.,c:\\include
5778< Or just use '/' instead: >
5779 :set path=.,c:/include
5780< Don't forget "." or files won't even be found in the same directory as
5781 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005782 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 it is something like 256 or 1024 characters.
5784 You can check if all the include files are found, using the value of
5785 'path', see |:checkpath|.
5786 The use of |:set+=| and |:set-=| is preferred when adding or removing
5787 directories from the list. This avoids problems when a future version
5788 uses another default. To remove the current directory use: >
5789 :set path-=
5790< To add the current directory use: >
5791 :set path+=
5792< To use an environment variable, you probably need to replace the
5793 separator. Here is an example to append $INCL, in which directory
5794 names are separated with a semi-colon: >
5795 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5796< Replace the ';' with a ':' or whatever separator is used. Note that
5797 this doesn't work when $INCL contains a comma or white space.
5798
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005799 *'perldll'*
5800'perldll' string (default depends on the build)
5801 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005802 {only available when compiled with the |+perl/dyn|
5803 feature}
5804 Specifies the name of the Perl shared library. The default is
5805 DYNAMIC_PERL_DLL, which was specified at compile time.
5806 Environment variables are expanded |:set_env|.
5807 This option cannot be set from a |modeline| or in the |sandbox|, for
5808 security reasons.
5809
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5811'preserveindent' 'pi' boolean (default off)
5812 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 When changing the indent of the current line, preserve as much of the
5814 indent structure as possible. Normally the indent is replaced by a
5815 series of tabs followed by spaces as required (unless |'expandtab'| is
5816 enabled, in which case only spaces are used). Enabling this option
5817 means the indent will preserve as many existing characters as possible
5818 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005819 'expandtab' does not apply to the preserved white space, a Tab remains
5820 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 NOTE: When using ">>" multiple times the resulting indent is a mix of
5822 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005823 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 Also see 'copyindent'.
5825 Use |:retab| to clean up white space.
5826
5827 *'previewheight'* *'pvh'*
5828'previewheight' 'pvh' number (default 12)
5829 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005830 {not available when compiled without the |+quickfix|
5831 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005833 commands. Used for |CTRL-W_}| when no count is given. Not used when
5834 'previewpopup' is set.
5835
5836 *'previewpopup'* *'pvp'*
5837'previewpopup' 'pvp' string (default empty)
5838 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005839 {not available when compiled without the |+textprop|
5840 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005841 When not empty a popup window is used for commands that would open a
5842 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005843 Not used for the insert completion info, add "popup" to
5844 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845
5846 *'previewwindow'* *'nopreviewwindow'*
5847 *'pvw'* *'nopvw'* *E590*
5848'previewwindow' 'pvw' boolean (default off)
5849 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005850 {not available when compiled without the |+quickfix|
5851 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005852 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 set. It's normally not set directly, but by using one of the commands
5854 |:ptag|, |:pedit|, etc.
5855
5856 *'printdevice'* *'pdev'*
5857'printdevice' 'pdev' string (default empty)
5858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005859 {only available when compiled with the |+printer|
5860 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005861 The name of the printer to be used for |:hardcopy|.
5862 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005863 This option cannot be set from a |modeline| or in the |sandbox|, for
5864 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865
Bram Moolenaar8299df92004-07-10 09:47:34 +00005866 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005867'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 {only available when compiled with the |+printer|
5870 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005871 Sets the character encoding used when printing.
5872 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873
5874 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005875'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 {only available when compiled with the |+printer|
5878 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005879 Expression used to print the PostScript produced with |:hardcopy|.
5880 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005881 This option cannot be set from a |modeline| or in the |sandbox|, for
5882 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883
Bram Moolenaar8299df92004-07-10 09:47:34 +00005884 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885'printfont' 'pfn' string (default "courier")
5886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887 {only available when compiled with the |+printer|
5888 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005889 The name of the font that will be used for |:hardcopy|.
5890 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891
5892 *'printheader'* *'pheader'*
5893'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5894 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895 {only available when compiled with the |+printer|
5896 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005897 The format of the header produced in |:hardcopy| output.
5898 See |pheader-option|.
5899
5900 *'printmbcharset'* *'pmbcs'*
5901'printmbcharset' 'pmbcs' string (default "")
5902 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005903 {only available when compiled with the |+printer|
5904 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005905 The CJK character set to be used for CJK output from |:hardcopy|.
5906 See |pmbcs-option|.
5907
5908 *'printmbfont'* *'pmbfn'*
5909'printmbfont' 'pmbfn' string (default "")
5910 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005911 {only available when compiled with the |+printer|
5912 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005913 List of font names to be used for CJK output from |:hardcopy|.
5914 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915
5916 *'printoptions'* *'popt'*
5917'printoptions' 'popt' string (default "")
5918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005920 List of items that control the format of the output of |:hardcopy|.
5921 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005923 *'prompt'* *'noprompt'*
5924'prompt' boolean (default on)
5925 global
5926 When on a ":" prompt is used in Ex mode.
5927
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005928 *'pumheight'* *'ph'*
5929'pumheight' 'ph' number (default 0)
5930 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005931 Determines the maximum number of items to show in the popup menu for
5932 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005933 |ins-completion-menu|.
5934
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005935 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005936'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005937 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005938 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005939 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005940
Bram Moolenaard94464e2015-11-02 15:28:18 +01005941 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005942'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005943 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005944 {only available when compiled with the |+python/dyn|
5945 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005946 Specifies the name of the Python 2.x shared library. The default is
5947 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005948 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005949 This option cannot be set from a |modeline| or in the |sandbox|, for
5950 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005951
Bram Moolenaar94073162018-01-31 21:49:05 +01005952 *'pythonhome'*
5953'pythonhome' string (default "")
5954 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005955 {only available when compiled with the |+python/dyn|
5956 feature}
5957 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5958 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5959 which was specified at compile time, will be used for the Python 2.x
5960 home directory.
5961 Environment variables are expanded |:set_env|.
5962 This option cannot be set from a |modeline| or in the |sandbox|, for
5963 security reasons.
5964
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005965 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005966'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005967 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005968 {only available when compiled with the |+python3/dyn|
5969 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005970 Specifies the name of the Python 3 shared library. The default is
5971 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005972 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005973 This option cannot be set from a |modeline| or in the |sandbox|, for
5974 security reasons.
5975
Bram Moolenaar94073162018-01-31 21:49:05 +01005976 *'pythonthreehome'*
5977'pythonthreehome' string (default "")
5978 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005979 {only available when compiled with the |+python3/dyn|
5980 feature}
5981 Specifies the name of the Python 3 home directory. When
5982 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5983 PYTHON3_HOME, which was specified at compile time, will be used for
5984 the Python 3 home directory.
5985 Environment variables are expanded |:set_env|.
5986 This option cannot be set from a |modeline| or in the |sandbox|, for
5987 security reasons.
5988
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005989 *'pyxversion'* *'pyx'*
5990'pyxversion' 'pyx' number (default depends on the build)
5991 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005992 {only available when compiled with the |+python| or
5993 the |+python3| feature}
5994 Specifies the python version used for pyx* functions and commands
5995 |python_x|. The default value is as follows:
5996
5997 Compiled with Default ~
5998 |+python| and |+python3| 0
5999 only |+python| 2
6000 only |+python3| 3
6001
6002 Available values are 0, 2 and 3.
6003 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6004 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6005 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6006 to 2 if Python 2 is available.
6007 See also: |has-pythonx|
6008
6009 If Vim is compiled with only |+python| or |+python3| setting
6010 'pyxversion' has no effect. The pyx* functions and commands are
6011 always the same as the compiled version.
6012
6013 This option cannot be set from a |modeline| or in the |sandbox|, for
6014 security reasons.
6015
Bram Moolenaar858ba062020-05-31 23:11:59 +02006016 *'quickfixtextfunc'* *'qftf'*
6017'quickfixtextfunc' 'qftf' string (default "")
6018 global
6019 {only available when compiled with the |+quickfix|
6020 feature}
6021 This option specifies a function to be used to get the text to display
6022 in the quickfix and location list windows. This can be used to
6023 customize the information displayed in the quickfix or location window
6024 for each entry in the corresponding quickfix or location list. See
6025 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02006026 function and an example. The value can be the name of a function or a
6027 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006028
6029 This option cannot be set from a |modeline| or in the |sandbox|, for
6030 security reasons.
6031
Bram Moolenaar677ee682005-01-27 14:41:15 +00006032 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006033'quoteescape' 'qe' string (default "\")
6034 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006035 The characters that are used to escape quotes in a string. Used for
6036 objects like a', a" and a` |a'|.
6037 When one of the characters in this option is found inside a string,
6038 the following character will be skipped. The default value makes the
6039 text "foo\"bar\\" considered to be one string.
6040
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6042'readonly' 'ro' boolean (default off)
6043 local to buffer
6044 If on, writes fail unless you use a '!'. Protects you from
6045 accidentally overwriting a file. Default on when Vim is started
6046 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006047 When using ":w!" the 'readonly' option is reset for the current
6048 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006049 When using the ":view" command the 'readonly' option is set for the
6050 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006051 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006053 *'redrawtime'* *'rdt'*
6054'redrawtime' 'rdt' number (default 2000)
6055 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006056 {only available when compiled with the |+reltime|
6057 feature}
6058 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006059 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006060 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006061 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006062 matches will be highlighted.
6063 For syntax highlighting the time applies per window. When over the
6064 limit syntax highlighting is disabled until |CTRL-L| is used.
6065 This is used to avoid that Vim hangs when using a very complicated
6066 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006067
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006068 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006069'regexpengine' 're' number (default 0)
6070 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006071 This selects the default regexp engine. |two-engines|
6072 The possible values are:
6073 0 automatic selection
6074 1 old engine
6075 2 NFA engine
6076 Note that when using the NFA engine and the pattern contains something
6077 that is not supported the pattern will not match. This is only useful
6078 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006079 Using automatic selection enables Vim to switch the engine, if the
6080 default engine becomes too costly. E.g., when the NFA engine uses too
6081 many states. This should prevent Vim from hanging on a combination of
6082 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006083
Bram Moolenaar64486672010-05-16 15:46:46 +02006084 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6085'relativenumber' 'rnu' boolean (default off)
6086 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006087 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006088 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006089 precede some vertical motion commands (e.g. j k + -) with, without
6090 having to calculate it yourself. Especially useful in combination with
6091 other commands (e.g. y d c < > gq gw =).
6092 When the 'n' option is excluded from 'cpoptions' a wrapped
6093 line will not use the column of line numbers (this is the default when
6094 'compatible' isn't set).
6095 The 'numberwidth' option can be used to set the room used for the line
6096 number.
6097 When a long, wrapped line doesn't start with the first character, '-'
6098 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006099 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6100 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006101
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006102 The number in front of the cursor line also depends on the value of
6103 'number', see |number_relativenumber| for all combinations of the two
6104 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006105
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 *'remap'* *'noremap'*
6107'remap' boolean (default on)
6108 global
6109 Allows for mappings to work recursively. If you do not want this for
6110 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006111 NOTE: To avoid portability problems with Vim scripts, always keep
6112 this option at the default "on". Only switch it off when working with
6113 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006115 *'renderoptions'* *'rop'*
6116'renderoptions' 'rop' string (default: empty)
6117 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006118 {only available when compiled with GUI and DIRECTX on
6119 MS-Windows}
6120 Select a text renderer and set its options. The options depend on the
6121 renderer.
6122
6123 Syntax: >
6124 set rop=type:{renderer}(,{name}:{value})*
6125<
6126 Currently, only one optional renderer is available.
6127
6128 render behavior ~
6129 directx Vim will draw text using DirectX (DirectWrite). It makes
6130 drawn glyphs more beautiful than default GDI.
6131 It requires 'encoding' is "utf-8", and only works on
6132 MS-Windows Vista or newer version.
6133
6134 Options:
6135 name meaning type value ~
6136 gamma gamma float 1.0 - 2.2 (maybe)
6137 contrast enhancedContrast float (unknown)
6138 level clearTypeLevel float (unknown)
6139 geom pixelGeometry int 0 - 2 (see below)
6140 renmode renderingMode int 0 - 6 (see below)
6141 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006142 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006143
Bram Moolenaar92467d32017-12-05 13:22:16 +01006144 See this URL for detail (except for scrlines):
6145 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006146
6147 For geom: structure of a device pixel.
6148 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6149 1 - DWRITE_PIXEL_GEOMETRY_RGB
6150 2 - DWRITE_PIXEL_GEOMETRY_BGR
6151
6152 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006153 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006154
6155 For renmode: method of rendering glyphs.
6156 0 - DWRITE_RENDERING_MODE_DEFAULT
6157 1 - DWRITE_RENDERING_MODE_ALIASED
6158 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6159 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6160 4 - DWRITE_RENDERING_MODE_NATURAL
6161 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6162 6 - DWRITE_RENDERING_MODE_OUTLINE
6163
6164 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006165 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006166
6167 For taamode: antialiasing mode used for drawing text.
6168 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6169 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6170 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6171 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6172
6173 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006174 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6175
Bram Moolenaara338adc2018-01-31 20:51:47 +01006176 For scrlines:
6177 This was used for optimizing scrolling behavior, however this
6178 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006179
6180 Example: >
6181 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006182 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006183 set rop=type:directx
6184<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006185 If select a raster font (Courier, Terminal or FixedSys which
6186 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006187 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006188
6189 NOTE: It is known that some fonts and options combination
6190 causes trouble on drawing glyphs.
6191
Bram Moolenaar92467d32017-12-05 13:22:16 +01006192 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006193 special made fonts (True-Type fonts which includes only
6194 bitmap glyphs).
6195 - 'taamode:3' will not work with some vector fonts.
6196
6197 NOTE: With this option, you can display colored emoji
6198 (emoticon) in Windows 8.1 or later. To display colored emoji,
6199 there are some conditions which you should notice.
6200
6201 - If your font includes non-colored emoji already, it will
6202 be used.
6203 - If your font doesn't have emoji, the system chooses an
6204 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6205 will be used.
6206 - When this alternative font didn't have fixed width glyph,
6207 emoji might be rendered beyond the bounding box of drawing
6208 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006209
6210 Other render types are currently not supported.
6211
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 *'report'*
6213'report' number (default 2)
6214 global
6215 Threshold for reporting number of lines changed. When the number of
6216 changed lines is more than 'report' a message will be given for most
6217 ":" commands. If you want it always, set 'report' to 0.
6218 For the ":substitute" command the number of substitutions is used
6219 instead of the number of lines.
6220
6221 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6222'restorescreen' 'rs' boolean (default on)
6223 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006224 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 When set, the screen contents is restored when exiting Vim. This also
6226 happens when executing external commands.
6227
6228 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6229 options in your .vimrc. To disable restoring:
6230 set t_ti= t_te=
6231 To enable restoring (for an xterm):
6232 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6233 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6234
6235 *'revins'* *'ri'* *'norevins'* *'nori'*
6236'revins' 'ri' boolean (default off)
6237 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 {only available when compiled with the |+rightleft|
6239 feature}
6240 Inserting characters in Insert mode will work backwards. See "typing
6241 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6242 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006243 NOTE: This option is reset when 'compatible' is set.
6244 This option is reset when 'paste' is set and restored when 'paste' is
6245 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246
6247 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6248'rightleft' 'rl' boolean (default off)
6249 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 {only available when compiled with the |+rightleft|
6251 feature}
6252 When on, display orientation becomes right-to-left, i.e., characters
6253 that are stored in the file appear from the right to the left.
6254 Using this option, it is possible to edit files for languages that
6255 are written from the right to the left such as Hebrew and Arabic.
6256 This option is per window, so it is possible to edit mixed files
6257 simultaneously, or to view the same file in both ways (this is
6258 useful whenever you have a mixed text file with both right-to-left
6259 and left-to-right strings so that both sets are displayed properly
6260 in different windows). Also see |rileft.txt|.
6261
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006262 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263'rightleftcmd' 'rlc' string (default "search")
6264 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 {only available when compiled with the |+rightleft|
6266 feature}
6267 Each word in this option enables the command line editing to work in
6268 right-to-left mode for a group of commands:
6269
6270 search "/" and "?" commands
6271
6272 This is useful for languages such as Hebrew, Arabic and Farsi.
6273 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6274
Bram Moolenaard94464e2015-11-02 15:28:18 +01006275 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006276'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006277 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006278 {only available when compiled with the |+ruby/dyn|
6279 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006280 Specifies the name of the Ruby shared library. The default is
6281 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006282 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006283 This option cannot be set from a |modeline| or in the |sandbox|, for
6284 security reasons.
6285
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006287'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 {not available when compiled without the
6290 |+cmdline_info| feature}
6291 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006292 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 text in the file is shown on the far right:
6294 Top first line is visible
6295 Bot last line is visible
6296 All first and last line are visible
6297 45% relative position in the file
6298 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006299 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006301 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 this option takes precedence over 'ruler' and 'rulerformat'
6303 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006304 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 the text column (byte number) and the screen column are shown,
6306 separated with a dash.
6307 For an empty line "0-1" is shown.
6308 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006309 This option is reset when 'paste' is set and restored when 'paste' is
6310 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 If you don't want to see the ruler all the time but want to know where
6312 you are, use "g CTRL-G" |g_CTRL-G|.
6313 NOTE: This option is reset when 'compatible' is set.
6314
6315 *'rulerformat'* *'ruf'*
6316'rulerformat' 'ruf' string (default empty)
6317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 {not available when compiled without the |+statusline|
6319 feature}
6320 When this option is not empty, it determines the content of the ruler
6321 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006322 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006323 This option cannot be set in a modeline when 'modelineexpr' is off.
6324
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325 The default ruler width is 17 characters. To make the ruler 15
6326 characters wide, put "%15(" at the start and "%)" at the end.
6327 Example: >
6328 :set rulerformat=%15(%c%V\ %p%%%)
6329<
6330 *'runtimepath'* *'rtp'* *vimfiles*
6331'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006332 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 $VIM/vimfiles,
6334 $VIMRUNTIME,
6335 $VIM/vimfiles/after,
6336 $HOME/.vim/after"
6337 Amiga: "home:vimfiles,
6338 $VIM/vimfiles,
6339 $VIMRUNTIME,
6340 $VIM/vimfiles/after,
6341 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006342 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 $VIM/vimfiles,
6344 $VIMRUNTIME,
6345 $VIM/vimfiles/after,
6346 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006347 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 $VIMRUNTIME,
6349 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006350 Haiku: "$BE_USER_SETTINGS/vim,
6351 $VIM/vimfiles,
6352 $VIMRUNTIME,
6353 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006354 $BE_USER_SETTINGS/vim/after"
6355 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 $VIM/vimfiles,
6357 $VIMRUNTIME,
6358 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006359 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 This is a list of directories which will be searched for runtime
6362 files:
6363 filetype.vim filetypes by file name |new-filetype|
6364 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006365 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 colors/ color scheme files |:colorscheme|
6367 compiler/ compiler files |:compiler|
6368 doc/ documentation |write-local-help|
6369 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006370 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 indent/ indent scripts |indent-expression|
6372 keymap/ key mapping files |mbyte-keymap|
6373 lang/ menu translations |:menutrans|
6374 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006375 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 plugin/ plugin scripts |write-plugin|
6377 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006378 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 syntax/ syntax files |mysyntaxfile|
6380 tutor/ files for vimtutor |tutor|
6381
6382 And any other file searched for with the |:runtime| command.
6383
6384 The defaults for most systems are setup to search five locations:
6385 1. In your home directory, for your personal preferences.
6386 2. In a system-wide Vim directory, for preferences from the system
6387 administrator.
6388 3. In $VIMRUNTIME, for files distributed with Vim.
6389 *after-directory*
6390 4. In the "after" directory in the system-wide Vim directory. This is
6391 for the system administrator to overrule or add to the distributed
6392 defaults (rarely needed)
6393 5. In the "after" directory in your home directory. This is for
6394 personal preferences to overrule or add to the distributed defaults
6395 or system-wide settings (rarely needed).
6396
Bram Moolenaard0796902016-09-16 20:02:31 +02006397 More entries are added when using |packages|. If it gets very long
6398 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6399 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006400
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6402 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006403 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 wildcards.
6405 See |:runtime|.
6406 Example: >
6407 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6408< This will use the directory "~/vimruntime" first (containing your
6409 personal Vim runtime files), then "/mygroup/vim" (shared between a
6410 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6411 files).
6412 You probably should always include $VIMRUNTIME somewhere, to use the
6413 distributed runtime files. You can put a directory before $VIMRUNTIME
6414 to find files which replace a distributed runtime files. You can put
6415 a directory after $VIMRUNTIME to find files which add to distributed
6416 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006417 When Vim is started with |--clean| the home directory entries are not
6418 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 This option cannot be set from a |modeline| or in the |sandbox|, for
6420 security reasons.
6421
6422 *'scroll'* *'scr'*
6423'scroll' 'scr' number (default: half the window height)
6424 local to window
6425 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6426 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006427 changes. This may happen when enabling the |status-line| or
6428 'tabline' option after setting the 'scroll' option.
6429 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006430 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006431 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432
6433 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6434'scrollbind' 'scb' boolean (default off)
6435 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 See also |scroll-binding|. When this option is set, the current
6437 window scrolls as other scrollbind windows (windows that also have
6438 this option set) scroll. This option is useful for viewing the
6439 differences between two versions of a file, see 'diff'.
6440 See |'scrollopt'| for options that determine how this option should be
6441 interpreted.
6442 This option is mostly reset when splitting a window to edit another
6443 file. This means that ":split | edit file" results in two windows
6444 with scroll-binding, but ":split file" does not.
6445
Bram Moolenaarae20f342019-11-05 21:09:23 +01006446 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6447'scrollfocus' 'scf' boolean (default off)
6448 global
6449 {only for MS-Windows GUI}
6450 When using the scroll wheel and this option is set, the window under
6451 the mouse pointer is scrolled. With this option off the current
6452 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006453 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006454
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 *'scrolljump'* *'sj'*
6456'scrolljump' 'sj' number (default 1)
6457 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 Minimal number of lines to scroll when the cursor gets off the
6459 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6460 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006461 When set to a negative number from -1 to -100 this is used as the
6462 percentage of the window height. Thus -50 scrolls half the window
6463 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 NOTE: This option is set to 1 when 'compatible' is set.
6465
6466 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006467'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006468 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 Minimal number of screen lines to keep above and below the cursor.
6470 This will make some context visible around where you are working. If
6471 you set it to a very large value (999) the cursor line will always be
6472 in the middle of the window (except at the start or end of the file or
6473 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006474 After using the local value, go back the global value with one of
6475 these two: >
6476 setlocal scrolloff<
6477 setlocal scrolloff=-1
6478< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 NOTE: This option is set to 0 when 'compatible' is set.
6480
6481 *'scrollopt'* *'sbo'*
6482'scrollopt' 'sbo' string (default "ver,jump")
6483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006485 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6486 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 The following words are available:
6488 ver Bind vertical scrolling for 'scrollbind' windows
6489 hor Bind horizontal scrolling for 'scrollbind' windows
6490 jump Applies to the offset between two windows for vertical
6491 scrolling. This offset is the difference in the first
6492 displayed line of the bound windows. When moving
6493 around in a window, another 'scrollbind' window may
6494 reach a position before the start or after the end of
6495 the buffer. The offset is not changed though, when
6496 moving back the 'scrollbind' window will try to scroll
6497 to the desired position when possible.
6498 When now making that window the current one, two
6499 things can be done with the relative offset:
6500 1. When "jump" is not included, the relative offset is
6501 adjusted for the scroll position in the new current
6502 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006503 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 2. When "jump" is included, the other windows are
6505 scrolled to keep the same relative offset. When
6506 going back to the other window, it still uses the
6507 same relative offset.
6508 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006509 When 'diff' mode is active there always is vertical scroll binding,
6510 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511
6512 *'sections'* *'sect'*
6513'sections' 'sect' string (default "SHNHH HUnhsh")
6514 global
6515 Specifies the nroff macros that separate sections. These are pairs of
6516 two letters (See |object-motions|). The default makes a section start
6517 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6518
6519 *'secure'* *'nosecure'* *E523*
6520'secure' boolean (default off)
6521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 When on, ":autocmd", shell and write commands are not allowed in
6523 ".vimrc" and ".exrc" in the current directory and map commands are
6524 displayed. Switch it off only if you know that you will not run into
6525 problems, or when the 'exrc' option is off. On Unix this option is
6526 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006527 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 'secure' at the end of your ~/.vimrc then.
6529 This option cannot be set from a |modeline| or in the |sandbox|, for
6530 security reasons.
6531
6532 *'selection'* *'sel'*
6533'selection' 'sel' string (default "inclusive")
6534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 This option defines the behavior of the selection. It is only used
6536 in Visual and Select mode.
6537 Possible values:
6538 value past line inclusive ~
6539 old no yes
6540 inclusive yes yes
6541 exclusive yes no
6542 "past line" means that the cursor is allowed to be positioned one
6543 character past the line.
6544 "inclusive" means that the last character of the selection is included
6545 in an operation. For example, when "x" is used to delete the
6546 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006547 When "old" is used and 'virtualedit' allows the cursor to move past
6548 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 Note that when "exclusive" is used and selecting from the end
6550 backwards, you cannot include the last character of a line, when
6551 starting in Normal mode and 'virtualedit' empty.
6552
6553 The 'selection' option is set by the |:behave| command.
6554
6555 *'selectmode'* *'slm'*
6556'selectmode' 'slm' string (default "")
6557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 This is a comma separated list of words, which specifies when to start
6559 Select mode instead of Visual mode, when a selection is started.
6560 Possible values:
6561 mouse when using the mouse
6562 key when using shifted special keys
6563 cmd when using "v", "V" or CTRL-V
6564 See |Select-mode|.
6565 The 'selectmode' option is set by the |:behave| command.
6566
6567 *'sessionoptions'* *'ssop'*
6568'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006569 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006571 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572 feature}
6573 Changes the effect of the |:mksession| command. It is a comma
6574 separated list of words. Each word enables saving and restoring
6575 something:
6576 word save and restore ~
6577 blank empty windows
6578 buffers hidden and unloaded buffers, not just those in windows
6579 curdir the current directory
6580 folds manually created folds, opened/closed folds and local
6581 fold options
6582 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006583 and contain at least one lowercase letter. Only
6584 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 help the help window
6586 localoptions options and mappings local to a window or buffer (not
6587 global values for local options)
6588 options all options and mappings (also global values for local
6589 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006590 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 resize size of the Vim window: 'lines' and 'columns'
6592 sesdir the directory in which the session file is located
6593 will become the current directory (useful with
6594 projects accessed over a network from different
6595 systems)
6596 slash backslashes in file names replaced with forward
6597 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006598 tabpages all tab pages; without this only the current tab page
6599 is restored, so that you can make a session for each
6600 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006601 terminal include terminal windows where the command can be
6602 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 unix with Unix end-of-line format (single <NL>), even when
6604 on Windows or DOS
6605 winpos position of the whole Vim window
6606 winsize window sizes
6607
6608 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006609 When neither "curdir" nor "sesdir" is included, file names are stored
6610 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 "slash" and "unix" are useful on Windows when sharing session files
6612 with Unix. The Unix version of Vim cannot source dos format scripts,
6613 but the Windows version of Vim can source unix format scripts.
6614
6615 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006616'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 global
6618 Name of the shell to use for ! and :! commands. When changing the
6619 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6620 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006621 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 See |option-backslash| about including spaces and backslashes.
6623 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006624
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006625 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006626 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6628< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006629 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006631 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006633 Example with escaped space (Vim will do this when initializing the
6634 option from $SHELL): >
6635 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006636< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006637 backslashes are consumed by `:set`.
6638
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 Under MS-Windows, when the executable ends in ".com" it must be
6640 included. Thus setting the shell to "command.com" or "4dos.com"
6641 works, but "command" and "4dos" do not work for all commands (e.g.,
6642 filtering).
6643 For unknown reasons, when using "4dos.com" the current directory is
6644 changed to "C:\". To avoid this set 'shell' like this: >
6645 :set shell=command.com\ /c\ 4dos
6646< This option cannot be set from a |modeline| or in the |sandbox|, for
6647 security reasons.
6648
6649 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006650'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006651 Win32, when 'shell' contains "powershell":
6652 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006653 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006656 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6657 For MS-Windows, the default is set according to the value of 'shell',
6658 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006659 On Unix it can have more than one flag. Each white space separated
6660 part is passed as an argument to the shell command.
6661 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006662 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 This option cannot be set from a |modeline| or in the |sandbox|, for
6664 security reasons.
6665
6666 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006667'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6668 "2>&1| tee", or
6669 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 {not available when compiled without the |+quickfix|
6672 feature}
6673 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006674 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 including spaces and backslashes.
6676 The name of the temporary file can be represented by "%s" if necessary
6677 (the file name is appended automatically if no %s appears in the value
6678 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006679 For the Amiga the default is ">". For MS-Windows using powershell the
6680 default is "2>&1 | Out-File -Encoding default", otherwise the default
6681 is ">%s 2>&1". The output is directly saved in a file and not echoed
6682 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006683 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 in a file and echoed to the screen. If the 'shell' option is "csh" or
6685 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006686 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006687 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6688 means that stderr is also included. Before using the 'shell' option a
6689 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006690 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6691 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 The initialization of this option is done after reading the ".vimrc"
6693 and the other initializations, so that when the 'shell' option is set
6694 there, the 'shellpipe' option changes automatically, unless it was
6695 explicitly set before.
6696 When 'shellpipe' is set to an empty string, no redirection of the
6697 ":make" output will be done. This is useful if you use a 'makeprg'
6698 that writes to 'makeef' by itself. If you want no piping, but do
6699 want to include the 'makeef', set 'shellpipe' to a single space.
6700 Don't forget to precede the space with a backslash: ":set sp=\ ".
6701 In the future pipes may be used for filtering and this option will
6702 become obsolete (at least for Unix).
6703 This option cannot be set from a |modeline| or in the |sandbox|, for
6704 security reasons.
6705
6706 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006707'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 Quoting character(s), put around the command passed to the shell, for
6710 the "!" and ":!" commands. The redirection is kept outside of the
6711 quoting. See 'shellxquote' to include the redirection. It's
6712 probably not useful to set both options.
6713 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006714 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006715 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 This option cannot be set from a |modeline| or in the |sandbox|, for
6717 security reasons.
6718
6719 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006720'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6721 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 String to be used to put the output of a filter command in a temporary
6724 file. See also |:!|. See |option-backslash| about including spaces
6725 and backslashes.
6726 The name of the temporary file can be represented by "%s" if necessary
6727 (the file name is appended automatically if no %s appears in the value
6728 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006729 The default is ">". For Unix, if the 'shell' option is "csh" or
6730 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006731 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006732 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6733 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006734 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6735 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006736 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6737 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 The initialization of this option is done after reading the ".vimrc"
6739 and the other initializations, so that when the 'shell' option is set
6740 there, the 'shellredir' option changes automatically unless it was
6741 explicitly set before.
6742 In the future pipes may be used for filtering and this option will
6743 become obsolete (at least for Unix).
6744 This option cannot be set from a |modeline| or in the |sandbox|, for
6745 security reasons.
6746
6747 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6748'shellslash' 'ssl' boolean (default off)
6749 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006750 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006752 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006753 powershell.exe. Backward slashes can still be typed, but they are
6754 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 Note that setting or resetting this option has no effect for some
6756 existing file names, thus this option needs to be set before opening
6757 any file for best results. This might change in the future.
6758 'shellslash' only works when a backslash can be used as a path
6759 separator. To test if this is so use: >
6760 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006761< Also see 'completeslash'.
6762
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006763 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6764'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6765 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006766 When on, use temp files for shell commands. When off use a pipe.
6767 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006768 Currently a pipe is only supported on Unix and MS-Windows 2K and
6769 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006770 :if has("filterpipe")
6771< The advantage of using a pipe is that nobody can read the temp file
6772 and the 'shell' command does not need to support redirection.
6773 The advantage of using a temp file is that the file type and encoding
6774 can be detected.
6775 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6776 |FilterWritePost| autocommands event are not triggered when
6777 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006778 The `system()` function does not respect this option and always uses
6779 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006780 NOTE: This option is set to the Vim default value when 'compatible'
6781 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006782
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 *'shelltype'* *'st'*
6784'shelltype' 'st' number (default 0)
6785 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006786 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 On the Amiga this option influences the way how the commands work
6788 which use a shell.
6789 0 and 1: always use the shell
6790 2 and 3: use the shell only to filter lines
6791 4 and 5: use shell only for ':sh' command
6792 When not using the shell, the command is executed directly.
6793
6794 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6795 1 and 3: use "shell cmd" to start external commands
6796
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006797 *'shellxescape'* *'sxe'*
6798'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006799 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006800 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006801 When 'shellxquote' is set to "(" then the characters listed in this
6802 option will be escaped with a '^' character. This makes it possible
6803 to execute most external commands with cmd.exe.
6804
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 *'shellxquote'* *'sxq'*
6806'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006807 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006808 for Win32, when 'shell' is
6809 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006810 for Win32, when 'shell' contains "sh"
6811 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812 for Unix, when using system(): "\"")
6813 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 Quoting character(s), put around the command passed to the shell, for
6815 the "!" and ":!" commands. Includes the redirection. See
6816 'shellquote' to exclude the redirection. It's probably not useful
6817 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006818 When the value is '(' then ')' is appended. When the value is '"('
6819 then ')"' is appended.
6820 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006821 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006822 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6823 pwsh.exe which automatically strips off the first and last quote on a
6824 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6825 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006826 'shell', to reduce the need to set this option by the user. See
6827 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 This option cannot be set from a |modeline| or in the |sandbox|, for
6829 security reasons.
6830
6831 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6832'shiftround' 'sr' boolean (default off)
6833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 Round indent to multiple of 'shiftwidth'. Applies to > and <
6835 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6836 a multiple of 'shiftwidth' (this is Vi compatible).
6837 NOTE: This option is reset when 'compatible' is set.
6838
6839 *'shiftwidth'* *'sw'*
6840'shiftwidth' 'sw' number (default 8)
6841 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006842 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006844 When zero the 'ts' value will be used. Use the |shiftwidth()|
6845 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846
6847 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006848'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6849 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 This option helps to avoid all the |hit-enter| prompts caused by file
6852 messages, for example with CTRL-G, and to avoid some other messages.
6853 It is a list of flags:
6854 flag meaning when present ~
6855 f use "(3 of 5)" instead of "(file 3 of 5)"
6856 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006857 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 m use "[+]" instead of "[Modified]"
6859 n use "[New]" instead of "[New File]"
6860 r use "[RO]" instead of "[readonly]"
6861 w use "[w]" instead of "written" for file write message
6862 and "[a]" instead of "appended" for ':w >> file' command
6863 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6864 "[unix format]" and "[mac]" instead of "[mac format]".
6865 a all of the above abbreviations
6866
6867 o overwrite message for writing a file with subsequent message
6868 for reading a file (useful for ":wn" or when 'autowrite' on)
6869 O message for reading a file overwrites any previous message.
6870 Also for quickfix message (e.g., ":cn").
6871 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006872 hit TOP, continuing at BOTTOM" messages; when using the search
6873 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 t truncate file message at the start if it is too long to fit
6875 on the command-line, "<" will appear in the left most column.
6876 Ignored in Ex mode.
6877 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006878 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 Ignored in Ex mode.
6880 W don't give "written" or "[w]" when writing a file
6881 A don't give the "ATTENTION" message when an existing swap file
6882 is found.
6883 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006884 c don't give |ins-completion-menu| messages. For example,
6885 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6886 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006887 q use "recording" instead of "recording @a"
6888 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006889 was used for the command; note that this also affects messages
6890 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006891 S do not show search count message when searching, e.g.
6892 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893
6894 This gives you the opportunity to avoid that a change between buffers
6895 requires you to hit <Enter>, but still gives as useful a message as
6896 possible for the space available. To get the whole message that you
6897 would have got with 'shm' empty, use ":file!"
6898 Useful values:
6899 shm= No abbreviation of message.
6900 shm=a Abbreviation, but no loss of information.
6901 shm=at Abbreviation, and truncate message when necessary.
6902
6903 NOTE: This option is set to the Vi default value when 'compatible' is
6904 set and to the Vim default value when 'compatible' is reset.
6905
6906 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6907'shortname' 'sn' boolean (default off)
6908 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 Filenames are assumed to be 8 characters plus one extension of 3
6910 characters. Multiple dots in file names are not allowed. When this
6911 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006912 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006914 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915
6916 *'showbreak'* *'sbr'* *E595*
6917'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006918 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006919 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 feature}
6921 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006922 values are "> " or "+++ ": >
6923 :set showbreak=>\
6924< Note the backslash to escape the trailing space. It's easier like
6925 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006926 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006927< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 comma (in a future version the comma might be used to separate the
6929 part that is shown at the end and at the start of a line).
6930 The characters are highlighted according to the '@' flag in
6931 'highlight'.
6932 Note that tabs after the showbreak will be displayed differently.
6933 If you want the 'showbreak' to appear in between line numbers, add the
6934 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006935 A window-local value overrules a global value. If the global value is
6936 set and you want no value in the current window use NONE: >
6937 :setlocal showbreak=NONE
6938<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006940'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6941 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 {not available when compiled without the
6944 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006945 Show (partial) command in the last line of the screen. Set this
6946 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 In Visual mode the size of the selected area is shown:
6948 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006949 If the number of bytes is different it is also displayed: "2-6"
6950 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006952 - When selecting a block, the size in screen characters:
6953 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 NOTE: This option is set to the Vi default value when 'compatible' is
6955 set and to the Vim default value when 'compatible' is reset.
6956
6957 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6958'showfulltag' 'sft' boolean (default off)
6959 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 When completing a word in insert mode (see |ins-completion|) from the
6961 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006962 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 matched a C function, you can see a template for what arguments are
6964 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006965 Note that this doesn't work well together with having "longest" in
6966 'completeopt', because the completion from the search pattern may not
6967 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968
6969 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6970'showmatch' 'sm' boolean (default off)
6971 global
6972 When a bracket is inserted, briefly jump to the matching one. The
6973 jump is only done if the match can be seen on the screen. The time to
6974 show the match can be set with 'matchtime'.
6975 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006976 seen or not).
6977 This option is reset when 'paste' is set and restored when 'paste' is
6978 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 When the 'm' flag is not included in 'cpoptions', typing a character
6980 will immediately move the cursor back to where it belongs.
6981 See the "sm" field in 'guicursor' for setting the cursor shape and
6982 blinking when showing the match.
6983 The 'matchpairs' option can be used to specify the characters to show
6984 matches for. 'rightleft' and 'revins' are used to look for opposite
6985 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006986 Also see the matchparen plugin for highlighting the match when moving
6987 around |pi_paren.txt|.
6988 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989
6990 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6991'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6992 global
6993 If in Insert, Replace or Visual mode put a message on the last line.
6994 Use the 'M' flag in 'highlight' to set the type of highlighting for
6995 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006996 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 doesn't mean XIM is really active, especially when 'imactivatekey' is
6998 not set.
6999 NOTE: This option is set to the Vi default value when 'compatible' is
7000 set and to the Vim default value when 'compatible' is reset.
7001
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007002 *'showtabline'* *'stal'*
7003'showtabline' 'stal' number (default 1)
7004 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007005 The value of this option specifies when the line with tab page labels
7006 will be displayed:
7007 0: never
7008 1: only if there are at least two tab pages
7009 2: always
7010 This is both for the GUI and non-GUI implementation of the tab pages
7011 line.
7012 See |tab-page| for more information about tab pages.
7013
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 *'sidescroll'* *'ss'*
7015'sidescroll' 'ss' number (default 0)
7016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 The minimal number of columns to scroll horizontally. Used only when
7018 the 'wrap' option is off and the cursor is moved off of the screen.
7019 When it is zero the cursor will be put in the middle of the screen.
7020 When using a slow terminal set it to a large number or 0. When using
7021 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7022 commands.
7023
7024 *'sidescrolloff'* *'siso'*
7025'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007026 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007028 right of the cursor if 'nowrap' is set. Setting this option to a
7029 value greater than 0 while having |'sidescroll'| also at a non-zero
7030 value makes some context visible in the line you are scrolling in
7031 horizontally (except at beginning of the line). Setting this option
7032 to a large value (like 999) has the effect of keeping the cursor
7033 horizontally centered in the window, as long as one does not come too
7034 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007035 After using the local value, go back the global value with one of
7036 these two: >
7037 setlocal sidescrolloff<
7038 setlocal sidescrolloff=-1
7039< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040
7041 Example: Try this together with 'sidescroll' and 'listchars' as
7042 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007043 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044
7045 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7046 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007047<
7048 *'signcolumn'* *'scl'*
7049'signcolumn' 'scl' string (default "auto")
7050 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007051 {not available when compiled without the |+signs|
7052 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007053 Whether or not to draw the signcolumn. Valid values are:
7054 "auto" only when there is a sign to display
7055 "no" never
7056 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007057 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007058 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059
7060
7061 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7062'smartcase' 'scs' boolean (default off)
7063 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 Override the 'ignorecase' option if the search pattern contains upper
7065 case characters. Only used when the search pattern is typed and
7066 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007067 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7069 recalling the search pattern from history and hitting <Enter>.
7070 NOTE: This option is reset when 'compatible' is set.
7071
7072 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7073'smartindent' 'si' boolean (default off)
7074 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 {not available when compiled without the
7076 |+smartindent| feature}
7077 Do smart autoindenting when starting a new line. Works for C-like
7078 programs, but can also be used for other languages. 'cindent' does
7079 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007080 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007081 setting 'si' has no effect. 'indentexpr' is a more advanced
7082 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007083 Normally 'autoindent' should also be on when using 'smartindent'.
7084 An indent is automatically inserted:
7085 - After a line ending in '{'.
7086 - After a line starting with a keyword from 'cinwords'.
7087 - Before a line starting with '}' (only with the "O" command).
7088 When typing '}' as the first character in a new line, that line is
7089 given the same indent as the matching '{'.
7090 When typing '#' as the first character in a new line, the indent for
7091 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007092 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7094 When using the ">>" command, lines starting with '#' are not shifted
7095 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007096 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007097 This option is reset when 'paste' is set and restored when 'paste' is
7098 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099
7100 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7101'smarttab' 'sta' boolean (default off)
7102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007104 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7105 <BS> will delete a 'shiftwidth' worth of space at the start of the
7106 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007107 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007108 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7109 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007110 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007112 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007113 This option is reset when 'paste' is set and restored when 'paste' is
7114 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 NOTE: This option is reset when 'compatible' is set.
7116
7117 *'softtabstop'* *'sts'*
7118'softtabstop' 'sts' number (default 0)
7119 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 Number of spaces that a <Tab> counts for while performing editing
7121 operations, like inserting a <Tab> or using <BS>. It "feels" like
7122 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7123 used. This is useful to keep the 'ts' setting at its standard value
7124 of 8, while being able to edit like it is set to 'sts'. However,
7125 commands like "x" still work on the actual characters.
7126 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007127 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007128 'softtabstop' is set to 0 when the 'paste' option is set and restored
7129 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7131 spaces is minimized by using <Tab>s.
7132 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7133 set.
7134 NOTE: This option is set to 0 when 'compatible' is set.
7135
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007136 If Vim is compiled with the |+vartabs| feature then the value of
7137 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7138 anything other than an empty string.
7139
Bram Moolenaar217ad922005-03-20 22:37:15 +00007140 *'spell'* *'nospell'*
7141'spell' boolean (default off)
7142 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007143 {not available when compiled without the |+syntax|
7144 feature}
7145 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007146 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007147
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007148 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007149'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007150 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007151 {not available when compiled without the |+syntax|
7152 feature}
7153 Pattern to locate the end of a sentence. The following word will be
7154 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007155 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007156 When this check is not wanted make this option empty.
7157 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007158 Be careful with special characters, see |option-backslash| about
7159 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007160 To set this option automatically depending on the language, see
7161 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007162
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007163 *'spellfile'* *'spf'*
7164'spellfile' 'spf' string (default empty)
7165 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007166 {not available when compiled without the |+syntax|
7167 feature}
7168 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007169 commands. It must end in ".{encoding}.add". You need to include the
7170 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007171 *E765*
7172 It may also be a comma separated list of names. A count before the
7173 |zg| and |zw| commands can be used to access each. This allows using
7174 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007175 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007176 you: Using the first directory in 'runtimepath' that is writable. If
7177 there is no "spell" directory yet it will be created. For the file
7178 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007179 ignoring the region.
7180 The resulting ".spl" file will be used for spell checking, it does not
7181 have to appear in 'spelllang'.
7182 Normally one file is used for all regions, but you can add the region
7183 name if you want to. However, it will then only be used when
7184 'spellfile' is set to it, for entries in 'spelllang' only files
7185 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007186 This option cannot be set from a |modeline| or in the |sandbox|, for
7187 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007188
Bram Moolenaar217ad922005-03-20 22:37:15 +00007189 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007190'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007191 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007192 {not available when compiled without the |+syntax|
7193 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007194 A comma separated list of word list names. When the 'spell' option is
7195 on spellchecking will be done for these languages. Example: >
7196 set spelllang=en_us,nl,medical
7197< This means US English, Dutch and medical words are recognized. Words
7198 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007199 The word list name must consist of alphanumeric characters, a dash or
7200 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007201 recommended to separate the two letter language name from a
7202 specification. Thus "en-rare" is used for rare English words.
7203 A region name must come last and have the form "_xx", where "xx" is
7204 the two-letter, lower case region name. You can use more than one
7205 region by listing them: "en_us,en_ca" supports both US and Canadian
7206 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007207 Britain. (Note: currently en_au and en_nz dictionaries are older than
7208 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007209 If the name "cjk" is included East Asian characters are excluded from
7210 spell checking. This is useful when editing text that also has Asian
7211 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007212 Note that the "medical" dictionary does not exist, it is just an
7213 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007214 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007215 As a special case the name of a .spl file can be given as-is. The
7216 first "_xx" in the name is removed and used as the region name
7217 (_xx is an underscore, two letters and followed by a non-letter).
7218 This is mainly for testing purposes. You must make sure the correct
7219 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007220 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007221 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7222 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007223 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007224
Bram Moolenaar98692072006-02-04 00:57:42 +00007225 If the |spellfile.vim| plugin is active and you use a language name
7226 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7227 will ask you if you want to download the file.
7228
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007229 After this option has been set successfully, Vim will source the files
7230 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007231 up to the first character that is not an ASCII letter or number and
7232 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007233
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007234 *'spelloptions'* *'spo'*
7235'spelloptions' 'spo' string (default "")
7236 local to buffer
7237 {not available when compiled without the |+syntax|
7238 feature}
7239 A comma separated list of options for spell checking:
7240 camel When a word is CamelCased, assume "Cased" is a
7241 separate word: every upper-case character in a word
7242 that comes after a lower case character indicates the
7243 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007244
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007245 *'spellsuggest'* *'sps'*
7246'spellsuggest' 'sps' string (default "best")
7247 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007248 {not available when compiled without the |+syntax|
7249 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007250 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007251 the |spellsuggest()| function. This is a comma-separated list of
7252 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007253
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007254 best Internal method that works best for English. Finds
7255 changes like "fast" and uses a bit of sound-a-like
7256 scoring to improve the ordering.
7257
7258 double Internal method that uses two methods and mixes the
7259 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007260 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007261 word. That only works when the language specifies
7262 sound folding. Can be slow and doesn't always give
7263 better results.
7264
7265 fast Internal method that only checks for simple changes:
7266 character inserts/deletes/swaps. Works well for
7267 simple typing mistakes.
7268
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007269 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007270 Not used for |spellsuggest()|. The number of
7271 suggestions is never more than the value of 'lines'
7272 minus two.
7273
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007274 file:{filename} Read file {filename}, which must have two columns,
7275 separated by a slash. The first column contains the
7276 bad word, the second column the suggested good word.
7277 Example:
7278 theribal/terrible ~
7279 Use this for common mistakes that do not appear at the
7280 top of the suggestion list with the internal methods.
7281 Lines without a slash are ignored, use this for
7282 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007283 The word in the second column must be correct,
7284 otherwise it will not be used. Add the word to an
7285 ".add" file if it is currently flagged as a spelling
7286 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007287 The file is used for all languages.
7288
7289 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7290 trouble with spaces. |v:val| holds the badly spelled
7291 word. The expression must evaluate to a List of
7292 Lists, each with a suggestion and a score.
7293 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007294 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007295 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007296 internal methods use. A lower score is better.
7297 This may invoke |spellsuggest()| if you temporarily
7298 set 'spellsuggest' to exclude the "expr:" part.
7299 Errors are silently ignored, unless you set the
7300 'verbose' option to a non-zero value.
7301
7302 Only one of "best", "double" or "fast" may be used. The others may
7303 appear several times in any order. Example: >
7304 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7305<
7306 This option cannot be set from a |modeline| or in the |sandbox|, for
7307 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007308
7309
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7311'splitbelow' 'sb' boolean (default off)
7312 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 When on, splitting a window will put the new window below the current
7314 one. |:split|
7315
7316 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7317'splitright' 'spr' boolean (default off)
7318 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 When on, splitting a window will put the new window right of the
7320 current one. |:vsplit|
7321
7322 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7323'startofline' 'sol' boolean (default on)
7324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007326 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007327 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007328 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 with a linewise operator, with "%" with a count and to buffer changing
7330 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7331 only has a line number, e.g., ":25" or ":+".
7332 In case of buffer changing commands the cursor is placed at the column
7333 where it was the last time the buffer was edited.
7334 NOTE: This option is set when 'compatible' is set.
7335
Bram Moolenaar00654022011-02-25 14:42:19 +01007336 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007338 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 {not available when compiled without the |+statusline|
7340 feature}
7341 When nonempty, this option determines the content of the status line.
7342 Also see |status-line|.
7343
7344 The option consists of printf style '%' items interspersed with
7345 normal text. Each status line item is of the form:
7346 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007347 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007348 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349
Bram Moolenaar238a5642006-02-21 22:12:05 +00007350 When the option starts with "%!" then it is used as an expression,
7351 evaluated and the result is used as the option value. Example: >
7352 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007353< The *g:statusline_winid* variable will be set to the |window-ID| of the
7354 window that the status line belongs to.
7355 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007356 Note that the "%!" expression is evaluated in the context of the
7357 current window and buffer, while %{} items are evaluated in the
7358 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007359
7360 When there is error while evaluating the option then it will be made
7361 empty to avoid further errors. Otherwise screen updating would loop.
7362
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 Note that the only effect of 'ruler' when this option is set (and
7364 'laststatus' is 2) is controlling the output of |CTRL-G|.
7365
7366 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007367 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007369 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 minwid Minimum width of the item, padding as set by '-' & '0'.
7371 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007372 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 on the left for text items. Numeric items will be
7374 shifted down to maxwid-2 digits followed by '>'number
7375 where number is the amount of missing digits, much like
7376 an exponential notation.
7377 item A one letter code as described below.
7378
7379 Following is a description of the possible statusline items. The
7380 second character in "item" is the type:
7381 N for number
7382 S for string
7383 F for flags as described below
7384 - not applicable
7385
7386 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007387 f S Path to the file in the buffer, as typed or relative to current
7388 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 F S Full path to the file in the buffer.
7390 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007391 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007393 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007395 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007397 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007399 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007401 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7403 being used: "<keymap>"
7404 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007405 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 B N As above, in hexadecimal.
7407 o N Byte number in file of byte under cursor, first byte is 1.
7408 Mnemonic: Offset from start of file (with one added)
7409 {not available when compiled without |+byte_offset| feature}
7410 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007411 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 l N Line number.
7413 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007414 c N Column number (byte index).
7415 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007416 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 p N Percentage through file in lines as in |CTRL-G|.
7418 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007419 percentage described for 'ruler'. Always 3 in length, unless
7420 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007421 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007423 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007424 Note that there is no '%' before the closing '}'. The
7425 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007426 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007427 {% - This is almost same as { except the result of the expression is
7428 re-evaluated as a statusline format string. Thus if the
7429 return value of expr contains % items they will get expanded.
7430 The expression can contain the } character, the end of
7431 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007432 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007433 func! Stl_filename() abort
7434 return "%t"
7435 endfunc
7436< `stl=%{Stl_filename()}` results in `"%t"`
7437 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007438 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 ( - Start of item group. Can be used for setting the width and
7440 alignment of a section. Must be followed by %) somewhere.
7441 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007442 T N For 'tabline': start of tab page N label. Use %T after the last
7443 label. This information is used for mouse clicks.
7444 X N For 'tabline': start of close tab N label. Use %X after the
7445 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7446 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 < - Where to truncate line if too long. Default is at the start.
7448 No width fields allowed.
7449 = - Separation point between left and right aligned items.
7450 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007451 # - Set highlight group. The name must follow and then a # again.
7452 Thus use %#HLname# for highlight group HLname. The same
7453 highlighting is used, also for the statusline of non-current
7454 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007456 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 The difference between User{N} and StatusLine will be applied
7458 to StatusLineNC for the statusline of non-current windows.
7459 The number N must be between 1 and 9. See |hl-User1..9|
7460
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007461 When displaying a flag, Vim removes the leading comma, if any, when
7462 that flag comes right after plaintext. This will make a nice display
7463 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464
Bram Moolenaar582fd852005-03-28 20:58:01 +00007465 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 not set) and a minwid is not set for the group, the whole group will
7467 become empty. This will make a group like the following disappear
7468 completely from the statusline when none of the flags are set. >
7469 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007470< Beware that an expression is evaluated each and every time the status
7471 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007472 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007473 While evaluating %{} the current buffer and current window will be set
7474 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007475 currently being drawn. The expression will evaluate in this context.
7476 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7477 real current buffer and "g:actual_curwin" to the |window-ID| of the
7478 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007479
Bram Moolenaar30b65812012-07-12 22:01:11 +02007480 The 'statusline' option will be evaluated in the |sandbox| if set from
7481 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007482 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007483
7484 It is not allowed to change text or jump to another window while
7485 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486
7487 If the statusline is not updated when you want it (e.g., after setting
7488 a variable that's used in an expression), you can force an update by
7489 setting an option without changing its value. Example: >
7490 :let &ro = &ro
7491
7492< A result of all digits is regarded a number for display purposes.
7493 Otherwise the result is taken as flag text and applied to the rules
7494 described above.
7495
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007496 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007498 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499
7500 Examples:
7501 Emulate standard status line with 'ruler' set >
7502 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7503< Similar, but add ASCII value of char under the cursor (like "ga") >
7504 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7505< Display byte count and byte value, modified flag in red. >
7506 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7507 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7508< Display a ,GZ flag if a compressed file is loaded >
7509 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7510< In the |:autocmd|'s: >
7511 :let b:gzflag = 1
7512< And: >
7513 :unlet b:gzflag
7514< And define this function: >
7515 :function VarExists(var, val)
7516 : if exists(a:var) | return a:val | else | return '' | endif
7517 :endfunction
7518<
7519 *'suffixes'* *'su'*
7520'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 Files with these suffixes get a lower priority when multiple files
7523 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007524 suffixes. Spaces after the comma are ignored. A dot is also seen as
7525 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 separator, precede it with a backslash (see |option-backslash| about
7527 including spaces and backslashes).
7528 See 'wildignore' for completely ignoring files.
7529 The use of |:set+=| and |:set-=| is preferred when adding or removing
7530 suffixes from the list. This avoids problems when a future version
7531 uses another default.
7532
7533 *'suffixesadd'* *'sua'*
7534'suffixesadd' 'sua' string (default "")
7535 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 {not available when compiled without the
7537 |+file_in_path| feature}
7538 Comma separated list of suffixes, which are used when searching for a
7539 file for the "gf", "[I", etc. commands. Example: >
7540 :set suffixesadd=.java
7541<
7542 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7543'swapfile' 'swf' boolean (default on)
7544 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007545 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 swapfile is not wanted for a specific buffer. For example, with
7547 confidential information that even root must not be able to access.
7548 Careful: All text will be in memory:
7549 - Don't use this for big files.
7550 - Recovery will be impossible!
7551 A swapfile will only be present when |'updatecount'| is non-zero and
7552 'swapfile' is set.
7553 When 'swapfile' is reset, the swap file for the current buffer is
7554 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7555 non-zero, a swap file is immediately created.
7556 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007557 If you want to open a new buffer without creating a swap file for it,
7558 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007559 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560
7561 This option is used together with 'bufhidden' and 'buftype' to
7562 specify special kinds of buffers. See |special-buffers|.
7563
7564 *'swapsync'* *'sws'*
7565'swapsync' 'sws' string (default "fsync")
7566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007568 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 When this option is empty parts of the swap file may be in memory and
7570 not written to disk. When the system crashes you may lose more work.
7571 On Unix the system does a sync now and then without Vim asking for it,
7572 so the disadvantage of setting this option off is small. On some
7573 systems the swap file will not be written at all. For a unix system
7574 setting it to "sync" will use the sync() call instead of the default
7575 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007576 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577
7578 *'switchbuf'* *'swb'*
7579'switchbuf' 'swb' string (default "")
7580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007582 Mostly for |quickfix| commands some values are also used for other
7583 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 Possible values (comma separated list):
7585 useopen If included, jump to the first open window that
7586 contains the specified buffer (if there is one).
7587 Otherwise: Do not examine other windows.
7588 This setting is checked with |quickfix| commands, when
7589 jumping to errors (":cc", ":cn", "cp", etc.). It is
7590 also used in all buffer related split commands, for
7591 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007592 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007593 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007595 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007596 Otherwise: do not split, use current window (when used
7597 in the quickfix window: the previously used window or
7598 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007599 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007600 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007601 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007602 uselast If included, jump to the previously used window when
7603 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007605 *'synmaxcol'* *'smc'*
7606'synmaxcol' 'smc' number (default 3000)
7607 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007608 {not available when compiled without the |+syntax|
7609 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007610 Maximum column in which to search for syntax items. In long lines the
7611 text after this column is not highlighted and following lines may not
7612 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007613 This helps to avoid very slow redrawing for an XML file that is one
7614 long line.
7615 Set to zero to remove the limit.
7616
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 *'syntax'* *'syn'*
7618'syntax' 'syn' string (default empty)
7619 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 {not available when compiled without the |+syntax|
7621 feature}
7622 When this option is set, the syntax with this name is loaded, unless
7623 syntax highlighting has been switched off with ":syntax off".
7624 Otherwise this option does not always reflect the current syntax (the
7625 b:current_syntax variable does).
7626 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007627 not automatically recognized. Example, in an IDL file:
7628 /* vim: set syntax=idl : */ ~
7629 When a dot appears in the value then this separates two filetype
7630 names. Example:
7631 /* vim: set syntax=c.doxygen : */ ~
7632 This will use the "c" syntax first, then the "doxygen" syntax.
7633 Note that the second one must be prepared to be loaded as an addition,
7634 otherwise it will be skipped. More than one dot may appear.
7635 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 :set syntax=OFF
7637< To switch syntax highlighting on according to the current value of the
7638 'filetype' option: >
7639 :set syntax=ON
7640< What actually happens when setting the 'syntax' option is that the
7641 Syntax autocommand event is triggered with the value as argument.
7642 This option is not copied to another buffer, independent of the 's' or
7643 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007644 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007646 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007647'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007648 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007649 When nonempty, this option determines the content of the tab pages
7650 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007651 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007652
7653 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007654 option and only when there is no GUI tab line. When 'e' is in
7655 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007656 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007657
7658 The value is evaluated like with 'statusline'. You can use
7659 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007660 the text to be displayed. Use "%1T" for the first label, "%2T" for
7661 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007662
Bram Moolenaare12bab32019-01-08 22:02:56 +01007663 When changing something that is used in 'tabline' that does not
7664 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007665 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007666
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007667 Keep in mind that only one of the tab pages is the current one, others
7668 are invisible and you can't jump to their windows.
7669
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007670
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007671 *'tabpagemax'* *'tpm'*
7672'tabpagemax' 'tpm' number (default 10)
7673 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007674 Maximum number of tab pages to be opened by the |-p| command line
7675 argument or the ":tab all" command. |tabpage|
7676
7677
7678 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679'tabstop' 'ts' number (default 8)
7680 local to buffer
7681 Number of spaces that a <Tab> in the file counts for. Also see
7682 |:retab| command, and 'softtabstop' option.
7683
7684 Note: Setting 'tabstop' to any other value than 8 can make your file
7685 appear wrong in many places (e.g., when printing it).
7686
7687 There are four main ways to use tabs in Vim:
7688 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7689 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007690 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691 behave like a tab appears every 4 (or 3) characters.
7692 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7693 'expandtab'. This way you will always insert spaces. The
7694 formatting will never be messed up when 'tabstop' is changed.
7695 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007696 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697 works when using Vim to edit the file.
7698 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7699 'noexpandtab'. This should then work (for initial indents only)
7700 for any tabstop setting that people use. It might be nice to have
7701 tabs after the first non-blank inserted as spaces if you do this
7702 though. Otherwise aligned comments will be wrong when 'tabstop' is
7703 changed.
7704
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007705 If Vim is compiled with the |+vartabs| feature then the value of
7706 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7707 than an empty string.
7708
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7710'tagbsearch' 'tbs' boolean (default on)
7711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007713 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 searching makes searching for a tag a LOT faster, but a linear search
7715 will find more tags if the tags file wasn't properly sorted.
7716 Vim normally assumes that your tags files are sorted, or indicate that
7717 they are not sorted. Only when this is not the case does the
7718 'tagbsearch' option need to be switched off.
7719
7720 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007721 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 certain files, or retry all files with a linear search. When
7723 'tagbsearch' is off, only a linear search is done.
7724
7725 Linear searching is done anyway, for one file, when Vim finds a line
7726 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007727 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728< [The whitespace before and after the '0' must be a single <Tab>]
7729
7730 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007731 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 instead of a normal tag name, a retry is done with a linear search.
7733 Tags in unsorted tags files, and matches with different case will only
7734 be found in the retry.
7735
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007736 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007737 linear search can be avoided when case is ignored. Use a value of '2'
7738 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7739 sorted with the -f switch to "sort" in most unices, as in the command:
7740 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7741 (at least 5.5) the --sort=foldcase switch can be used for this as
7742 well. Note that case must be folded to uppercase for this to work.
7743
7744 By default, tag searches are case-sensitive. Case is ignored when
7745 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7746 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007747 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7748 'tagcase' is "smart", and the pattern contains only lowercase
7749 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750
7751 When 'tagbsearch' is off, tags searching is slower when a full match
7752 exists, but faster when no full match exists. Tags in unsorted tags
7753 files may only be found with 'tagbsearch' off.
7754 When the tags file is not sorted, or sorted in a wrong way (not on
7755 ASCII byte value), 'tagbsearch' should be off, or the line given above
7756 must be included in the tags file.
7757 This option doesn't affect commands that find all matching tags (e.g.,
7758 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007760 *'tagcase'* *'tc'*
7761'tagcase' 'tc' string (default "followic")
7762 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007763 This option specifies how case is handled when searching the tags
7764 file:
7765 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007766 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007767 ignore Ignore case
7768 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007769 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007770 NOTE: This option is set to the Vi default value when 'compatible' is
7771 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007772
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007773 *'tagfunc'* *'tfu'*
7774'tagfunc' 'tfu' string (default: empty)
7775 local to buffer
7776 {not available when compiled without the |+eval|
7777 feature}
7778 This option specifies a function to be used to perform tag searches.
7779 The function gets the tag pattern and should return a List of matching
7780 tags. See |tag-function| for an explanation of how to write the
7781 function and an example.
7782
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783 *'taglength'* *'tl'*
7784'taglength' 'tl' number (default 0)
7785 global
7786 If non-zero, tags are significant up to this number of characters.
7787
7788 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7789'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7790 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007791 If on and using a tags file in another directory, file names in that
7792 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 NOTE: This option is set to the Vi default value when 'compatible' is
7794 set and to the Vim default value when 'compatible' is reset.
7795
7796 *'tags'* *'tag'* *E433*
7797'tags' 'tag' string (default "./tags,tags", when compiled with
7798 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7799 global or local to buffer |global-local|
7800 Filenames for the tag command, separated by spaces or commas. To
7801 include a space or comma in a file name, precede it with a backslash
7802 (see |option-backslash| about including spaces and backslashes).
7803 When a file name starts with "./", the '.' is replaced with the path
7804 of the current file. But only when the 'd' flag is not included in
7805 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7806 |tags-option|.
7807 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007808 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7809 find all files named "tags" below "/lib". The filename itself cannot
7810 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7811 files called "tags?". {not available when compiled without the
7812 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007813 The |tagfiles()| function can be used to get a list of the file names
7814 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7816 files are also supported. They are automatically recognized. The
7817 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7818 differences are ignored (MS-Windows). |emacs-tags|
7819 The use of |:set+=| and |:set-=| is preferred when adding or removing
7820 file names from the list. This avoids problems when a future version
7821 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822
7823 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7824'tagstack' 'tgst' boolean (default on)
7825 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 When on, the |tagstack| is used normally. When off, a ":tag" or
7827 ":tselect" command with an argument will not push the tag onto the
7828 tagstack. A following ":tag" without an argument, a ":pop" command or
7829 any other command that uses the tagstack will use the unmodified
7830 tagstack, but does change the pointer to the active entry.
7831 Resetting this option is useful when using a ":tag" command in a
7832 mapping which should not change the tagstack.
7833
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007834 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007835'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007836 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007837 {only available when compiled with the |+tcl/dyn|
7838 feature}
7839 Specifies the name of the Tcl shared library. The default is
7840 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007841 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007842 This option cannot be set from a |modeline| or in the |sandbox|, for
7843 security reasons.
7844
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 *'term'* *E529* *E530* *E531*
7846'term' string (default is $TERM, if that fails:
7847 in the GUI: "builtin_gui"
7848 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007849 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 on Unix: "ansi"
7852 on VMS: "ansi"
7853 on Win 32: "win32")
7854 global
7855 Name of the terminal. Used for choosing the terminal control
7856 characters. Environment variables are expanded |:set_env|.
7857 For example: >
7858 :set term=$TERM
7859< See |termcap|.
7860
7861 *'termbidi'* *'tbidi'*
7862 *'notermbidi'* *'notbidi'*
7863'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 {only available when compiled with the |+arabic|
7866 feature}
7867 The terminal is in charge of Bi-directionality of text (as specified
7868 by Unicode). The terminal is also expected to do the required shaping
7869 that some languages (such as Arabic) require.
7870 Setting this option implies that 'rightleft' will not be set when
7871 'arabic' is set and the value of 'arabicshape' will be ignored.
7872 Note that setting 'termbidi' has the immediate effect that
7873 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7874 This option is reset when the GUI is started.
7875 For further details see |arabic.txt|.
7876
7877 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007878'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007880 Encoding used for the terminal. This specifies what character
7881 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007882 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007883 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007884 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007885 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7887 Any attempts to set a different value will be rejected, and an error
7888 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007889 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890 because the Win32 system always passes Unicode characters.
7891 When empty, the same encoding is used as for the 'encoding' option.
7892 This is the normal value.
7893 Not all combinations for 'termencoding' and 'encoding' are valid. See
7894 |encoding-table|.
7895 The value for this option must be supported by internal conversions or
7896 iconv(). When this is not possible no conversion will be done and you
7897 will probably experience problems with non-ASCII characters.
7898 Example: You are working with the locale set to euc-jp (Japanese) and
7899 want to edit a UTF-8 file: >
7900 :let &termencoding = &encoding
7901 :set encoding=utf-8
7902< You need to do this when your system has no locale support for UTF-8.
7903
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007904 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007905'termguicolors' 'tgc' boolean (default off)
7906 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007907 {not available when compiled without the
7908 |+termguicolors| feature}
7909 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007910 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007911
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007912 Requires a ISO-8613-3 compatible terminal. If setting this option
7913 does not work (produces a colorless UI) reading |xterm-true-color|
7914 might help.
7915
7916 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7917 is required. Use this check to find out: >
7918 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007919< This requires Vim to be built with the |+vtp| feature.
7920
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007921 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007922 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007923
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007924 *'termwinkey'* *'twk'*
7925'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007926 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007927 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007928 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007929 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007930 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007931< The string must be one key stroke but can be multiple bytes.
7932 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007933 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007934 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007935
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007936 *'termwinscroll'* *'twsl'*
7937'termwinscroll' 'twsl' number (default 10000)
7938 local to buffer
7939 {not available when compiled without the
7940 |+terminal| feature}
7941 Number of scrollback lines to keep. When going over this limit the
7942 first 10% of the scrollback lines are deleted. This is just to reduce
7943 the memory usage. See |Terminal-Normal|.
Bram Moolenaar36968af2021-11-15 17:13:11 +00007944 Also used as a limit for text sent to the terminal in one write,
7945 multiplied by the number of columns times 3 (average number of bytes
7946 per cell).
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007947
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007948 *'termwinsize'* *'tws'*
7949'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007950 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007951 Size used when opening the |terminal| window. Format:
7952 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007953 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007954 - When set with a "x" (e.g., "24x80") the terminal size is not
7955 adjusted to the window size. If the window is smaller only the
7956 top-left part is displayed.
7957 - When set with a "*" (e.g., "10*50") the terminal size follows the
7958 window size, but will not be smaller than the specified rows and/or
7959 columns.
7960 - When rows is zero then use the height of the window.
7961 - When columns is zero then use the width of the window.
7962 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007963 - Can be overruled in the |term_start()| options with "term_rows" and
7964 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007965
7966 Examples:
7967 "30x0" uses 30 rows and the current window width.
7968 "20*0" uses at least 20 rows and the current window width.
7969 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007970 Note that the command running in the terminal window may still change
7971 the size of the terminal. In that case the Vim window will be
7972 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007973
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007974 *'termwintype'* *'twt'*
7975'termwintype' 'twt' string (default "")
7976 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007977 {only available when compiled with the |terminal|
7978 feature on MS-Windows}
7979 Specify the virtual console (pty) used when opening the terminal
7980 window.
7981
7982 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007983 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007984 "winpty" use winpty, fail if not supported
7985 "conpty" use |ConPTY|, fail if not supported
7986
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007987 |ConPTY| support depends on the platform. Windows 10 October 2018
7988 Update is the first version that supports ConPTY, however it is still
7989 considered unstable. ConPTY might become stable in the next release
7990 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007991 supported then you cannot open a terminal window.
7992
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 *'terse'* *'noterse'*
7994'terse' boolean (default off)
7995 global
7996 When set: Add 's' flag to 'shortmess' option (this makes the message
7997 for a search that hits the start or end of the file not being
7998 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7999 shortens a lot of messages}
8000
8001 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8002'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 This option is obsolete. Use 'fileformats'.
8005 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8006 set to the default value for the current system. When 'textauto' is
8007 reset, 'fileformats' is made empty.
8008 NOTE: This option is set to the Vi default value when 'compatible' is
8009 set and to the Vim default value when 'compatible' is reset.
8010
8011 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008012'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 others: default off)
8014 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 This option is obsolete. Use 'fileformat'.
8016 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8017 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8018 "unix".
8019
8020 *'textwidth'* *'tw'*
8021'textwidth' 'tw' number (default 0)
8022 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 Maximum width of text that is being inserted. A longer line will be
8024 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008025 this.
8026 'textwidth' is set to 0 when the 'paste' option is set and restored
8027 when 'paste' is reset.
8028 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008030 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 NOTE: This option is set to 0 when 'compatible' is set.
8032
8033 *'thesaurus'* *'tsr'*
8034'thesaurus' 'tsr' string (default "")
8035 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008037 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8038 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008039
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008040 This option is not used if 'thesaurusfunc' is set, either for the
8041 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008042
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008043 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008045 name. See |option-backslash| about using backslashes. The use of
8046 |:set+=| and |:set-=| is preferred when adding or removing directories
8047 from the list. This avoids problems when a future version uses
8048 another default. Backticks cannot be used in this option for security
8049 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008051 *'thesaurusfunc'* *tsrfu'*
8052'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008053 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008054 {not available when compiled without the |+eval|
8055 feature}
8056 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008057 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
8058
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008059 This option cannot be set from a |modeline| or in the |sandbox|, for
8060 security reasons.
8061
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8063'tildeop' 'top' boolean (default off)
8064 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 When on: The tilde command "~" behaves like an operator.
8066 NOTE: This option is reset when 'compatible' is set.
8067
8068 *'timeout'* *'to'* *'notimeout'* *'noto'*
8069'timeout' 'to' boolean (default on)
8070 global
8071 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008072'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 These two options together determine the behavior when part of a
8075 mapped key sequence or keyboard code has been received:
8076
8077 'timeout' 'ttimeout' action ~
8078 off off do not time out
8079 on on or off time out on :mappings and key codes
8080 off on time out on key codes
8081
8082 If both options are off, Vim will wait until either the complete
8083 mapping or key sequence has been received, or it is clear that there
8084 is no mapping or key sequence for the received characters. For
8085 example: if you have mapped "vl" and Vim has received 'v', the next
8086 character is needed to see if the 'v' is followed by an 'l'.
8087 When one of the options is on, Vim will wait for about 1 second for
8088 the next character to arrive. After that the already received
8089 characters are interpreted as single characters. The waiting time can
8090 be changed with the 'timeoutlen' option.
8091 On slow terminals or very busy systems timing out may cause
8092 malfunctioning cursor keys. If both options are off, Vim waits
8093 forever after an entered <Esc> if there are key codes that start
8094 with <Esc>. You will have to type <Esc> twice. If you do not have
8095 problems with key codes, but would like to have :mapped key
8096 sequences not timing out in 1 second, set the 'ttimeout' option and
8097 reset the 'timeout' option.
8098
8099 NOTE: 'ttimeout' is reset when 'compatible' is set.
8100
8101 *'timeoutlen'* *'tm'*
8102'timeoutlen' 'tm' number (default 1000)
8103 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008104
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008106'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 The time in milliseconds that is waited for a key code or mapped key
8109 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8110 when part of a command has been typed.
8111 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8112 different timeout value for key codes is desired set 'ttimeoutlen' to
8113 a non-negative number.
8114
8115 ttimeoutlen mapping delay key code delay ~
8116 < 0 'timeoutlen' 'timeoutlen'
8117 >= 0 'timeoutlen' 'ttimeoutlen'
8118
8119 The timeout only happens when the 'timeout' and 'ttimeout' options
8120 tell so. A useful setting would be >
8121 :set timeout timeoutlen=3000 ttimeoutlen=100
8122< (time out on mapping after three seconds, time out on key codes after
8123 a tenth of a second).
8124
8125 *'title'* *'notitle'*
8126'title' boolean (default off, on when title can be restored)
8127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 {not available when compiled without the |+title|
8129 feature}
8130 When on, the title of the window will be set to the value of
8131 'titlestring' (if it is not empty), or to:
8132 filename [+=-] (path) - VIM
8133 Where:
8134 filename the name of the file being edited
8135 - indicates the file cannot be modified, 'ma' off
8136 + indicates the file was modified
8137 = indicates the file is read-only
8138 =+ indicates the file is read-only and modified
8139 (path) is the path of the file being edited
8140 - VIM the server name |v:servername| or "VIM"
8141 Only works if the terminal supports setting window titles
8142 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008143 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8145 *X11*
8146 When Vim was compiled with HAVE_X11 defined, the original title will
8147 be restored if possible. The output of ":version" will include "+X11"
8148 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8149 works for the icon name |'icon'|.
8150 But: When Vim was started with the |-X| argument, restoring the title
8151 will not work (except in the GUI).
8152 If the title cannot be restored, it is set to the value of 'titleold'.
8153 You might want to restore the title outside of Vim then.
8154 When using an xterm from a remote machine you can use this command:
8155 rsh machine_name xterm -display $DISPLAY &
8156 then the WINDOWID environment variable should be inherited and the
8157 title of the window should change back to what it should be after
8158 exiting Vim.
8159
8160 *'titlelen'*
8161'titlelen' number (default 85)
8162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 {not available when compiled without the |+title|
8164 feature}
8165 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008166 title. When the title is longer, only the end of the path name is
8167 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168 Using a percentage makes this adapt to the width of the window. But
8169 it won't work perfectly, because the actual number of characters
8170 available also depends on the font used and other things in the title
8171 bar. When 'titlelen' is zero the full path is used. Otherwise,
8172 values from 1 to 30000 percent can be used.
8173 'titlelen' is also used for the 'titlestring' option.
8174
8175 *'titleold'*
8176'titleold' string (default "Thanks for flying Vim")
8177 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 {only available when compiled with the |+title|
8179 feature}
8180 This option will be used for the window title when exiting Vim if the
8181 original title cannot be restored. Only happens if 'title' is on or
8182 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008183 This option cannot be set from a |modeline| or in the |sandbox|, for
8184 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 *'titlestring'*
8186'titlestring' string (default "")
8187 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 {not available when compiled without the |+title|
8189 feature}
8190 When this option is not empty, it will be used for the title of the
8191 window. This happens only when the 'title' option is on.
8192 Only works if the terminal supports setting window titles (currently
8193 Amiga console, Win32 console, all GUI versions and terminals with a
8194 non-empty 't_ts' option).
8195 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008196 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008197
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 When this option contains printf-style '%' items, they will be
8199 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008200 This option cannot be set in a modeline when 'modelineexpr' is off.
8201
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 Example: >
8203 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8204 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8205< The value of 'titlelen' is used to align items in the middle or right
8206 of the available space.
8207 Some people prefer to have the file name first: >
8208 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8209< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008210 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 separating space only when needed.
8212 NOTE: Use of special characters in 'titlestring' may cause the display
8213 to be garbled (e.g., when it contains a CR or NL character).
8214 {not available when compiled without the |+statusline| feature}
8215
8216 *'toolbar'* *'tb'*
8217'toolbar' 'tb' string (default "icons,tooltips")
8218 global
8219 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8220 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008221 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 possible values are:
8223 icons Toolbar buttons are shown with icons.
8224 text Toolbar buttons shown with text.
8225 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008226 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 tooltips Tooltips are active for toolbar buttons.
8228 Tooltips refer to the popup help text which appears after the mouse
8229 cursor is placed over a toolbar button for a brief moment.
8230
8231 If you want the toolbar to be shown with icons as well as text, do the
8232 following: >
8233 :set tb=icons,text
8234< Motif and Athena cannot display icons and text at the same time. They
8235 will show icons if both are requested.
8236
8237 If none of the strings specified in 'toolbar' are valid or if
8238 'toolbar' is empty, this option is ignored. If you want to disable
8239 the toolbar, you need to set the 'guioptions' option. For example: >
8240 :set guioptions-=T
8241< Also see |gui-toolbar|.
8242
8243 *'toolbariconsize'* *'tbis'*
8244'toolbariconsize' 'tbis' string (default "small")
8245 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008246 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008247 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008248 tiny Use tiny icons.
8249 small Use small icons (default).
8250 medium Use medium-sized icons.
8251 large Use large icons.
8252 huge Use even larger icons.
8253 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008255 the current theme. Common dimensions are giant=48x48, huge=32x32,
8256 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257
8258 If 'toolbariconsize' is empty, the global default size as determined
8259 by user preferences or the current theme is used.
8260
8261 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8262'ttybuiltin' 'tbi' boolean (default on)
8263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264 When on, the builtin termcaps are searched before the external ones.
8265 When off the builtin termcaps are searched after the external ones.
8266 When this option is changed, you should set the 'term' option next for
8267 the change to take effect, for example: >
8268 :set notbi term=$TERM
8269< See also |termcap|.
8270 Rationale: The default for this option is "on", because the builtin
8271 termcap entries are generally better (many systems contain faulty
8272 xterm entries...).
8273
8274 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8275'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8276 sun-cmd, screen, rxvt, dtterm or
8277 iris-ansi; also on when running Vim in
8278 a DOS console)
8279 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280 Indicates a fast terminal connection. More characters will be sent to
8281 the screen for redrawing, instead of using insert/delete line
8282 commands. Improves smoothness of redrawing when there are multiple
8283 windows and the terminal does not support a scrolling region.
8284 Also enables the extra writing of characters at the end of each screen
8285 line for lines that wrap. This helps when using copy/paste with the
8286 mouse in an xterm and other terminals.
8287
8288 *'ttymouse'* *'ttym'*
8289'ttymouse' 'ttym' string (default depends on 'term')
8290 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 {only in Unix and VMS, doesn't work in the GUI; not
8292 available when compiled without |+mouse|}
8293 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008294 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295 *xterm-mouse*
8296 xterm xterm-like mouse handling. The mouse generates
8297 "<Esc>[Mscr", where "scr" is three bytes:
8298 "s" = button state
8299 "c" = column plus 33
8300 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008301 This only works up to 223 columns! See "dec",
8302 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 xterm2 Works like "xterm", but with the xterm reporting the
8304 mouse position while the mouse is dragged. This works
8305 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008306 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 work. See below for how Vim detects this
8308 automatically.
8309 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008310 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008312 for the row and column. No other mouse events are
8313 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 *dec-mouse*
8315 dec DEC terminal mouse handling. The mouse generates a
8316 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008317 This is also available for an Xterm, if it was
8318 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 *jsbterm-mouse*
8320 jsbterm JSB term mouse handling.
8321 *pterm-mouse*
8322 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008323 *urxvt-mouse*
8324 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008325 The mouse works only if the terminal supports this
8326 encoding style, but it does not have 223 columns limit
8327 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008328 *sgr-mouse*
8329 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008330 mouse reporting. The mouse works even in columns
8331 beyond 223. This option is backward compatible with
8332 "xterm2" because it can also decode "xterm2" style
8333 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334
8335 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008336 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8337 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8339 recognized, if enabled at compile time. DEC terminal mouse codes
8340 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008341 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8342 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008344 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8345 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8346 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008347 Additionally, if vim is compiled with the |+termresponse| feature and
8348 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008349 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008351 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8352 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8353 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008354 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8355 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356 :set t_RV=
8357<
8358 *'ttyscroll'* *'tsl'*
8359'ttyscroll' 'tsl' number (default 999)
8360 global
8361 Maximum number of lines to scroll the screen. If there are more lines
8362 to scroll the window is redrawn. For terminals where scrolling is
8363 very slow and redrawing is not slow this can be set to a small number,
8364 e.g., 3, to speed up displaying.
8365
8366 *'ttytype'* *'tty'*
8367'ttytype' 'tty' string (default from $TERM)
8368 global
8369 Alias for 'term', see above.
8370
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008371 *'undodir'* *'udir'*
8372'undodir' 'udir' string (default ".")
8373 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008374 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008375 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008376 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008377 "." means using the directory of the file. The undo file name for
8378 "file.txt" is ".file.txt.un~".
8379 For other directories the file name is the full path of the edited
8380 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008381 When writing: The first directory that exists is used. "." always
8382 works, no directories after "." will be used for writing.
8383 When reading all entries are tried to find an undo file. The first
8384 undo file that exists is used. When it cannot be read an error is
8385 given, no further entry is used.
8386 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008387 This option cannot be set from a |modeline| or in the |sandbox|, for
8388 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008389
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008390 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008391'undofile' 'udf' boolean (default off)
8392 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008393 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008394 When on, Vim automatically saves undo history to an undo file when
8395 writing a buffer to a file, and restores undo history from the same
8396 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008397 The directory where the undo file is stored is specified by 'undodir'.
8398 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008399 The undo file is not read when 'undoreload' causes the buffer from
8400 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008401 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008402 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008403
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008405'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008406 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008408 is kept in memory, higher numbers will cause more memory to be used.
8409 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8411 itself: >
8412 set ul=0
8413< But you can also get Vi compatibility by including the 'u' flag in
8414 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008415 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008416 Set to -1 for no undo at all. You might want to do this only for the
8417 current buffer: >
8418 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008420
8421 The local value is set to -123456 when the global value is to be used.
8422
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008423 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008425 *'undoreload'* *'ur'*
8426'undoreload' 'ur' number (default 10000)
8427 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008428 Save the whole buffer for undo when reloading it. This applies to the
8429 ":e!" command and reloading for when the buffer changed outside of
8430 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008431 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008432 of lines is smaller than the value of this option.
8433 Set this option to zero to disable undo for a reload.
8434
8435 When saving undo for a reload, any undo file is not read.
8436
8437 Note that this causes the whole buffer to be stored in memory. Set
8438 this option to a lower value if you run out of memory.
8439
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 *'updatecount'* *'uc'*
8441'updatecount' 'uc' number (default: 200)
8442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 After typing this many characters the swap file will be written to
8444 disk. When zero, no swap file will be created at all (see chapter on
8445 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8446 Vim with the "-n" option, see |startup|. When editing in readonly
8447 mode this option will be initialized to 10000.
8448 The swapfile can be disabled per buffer with |'swapfile'|.
8449 When 'updatecount' is set from zero to non-zero, swap files are
8450 created for all buffers that have 'swapfile' set. When 'updatecount'
8451 is set to zero, existing swap files are not deleted.
8452 Also see |'swapsync'|.
8453 This option has no meaning in buffers where |'buftype'| is "nofile"
8454 or "nowrite".
8455
8456 *'updatetime'* *'ut'*
8457'updatetime' 'ut' number (default 4000)
8458 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 If this many milliseconds nothing is typed the swap file will be
8460 written to disk (see |crash-recovery|). Also used for the
8461 |CursorHold| autocommand event.
8462
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008463 *'varsofttabstop'* *'vsts'*
8464'varsofttabstop' 'vsts' string (default "")
8465 local to buffer
8466 {only available when compiled with the |+vartabs|
8467 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008468 A list of the number of spaces that a <Tab> counts for while editing,
8469 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8470 width <Tab>s are being inserted, while in fact a mixture of spaces
8471 and <Tab>s is used. Tab widths are separated with commas, with the
8472 final value applying to all subsequent tabs.
8473
8474 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008475 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008476 to use the following: >
8477 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008478< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8479 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008480
8481 Note that the value of |'softtabstop'| will be ignored while
8482 'varsofttabstop' is set.
8483
8484 *'vartabstop'* *'vts'*
8485'vartabstop' 'vts' string (default "")
8486 local to buffer
8487 {only available when compiled with the |+vartabs|
8488 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008489 A list of the number of spaces that a <Tab> in the file counts for,
8490 separated by commas. Each value corresponds to one tab, with the
8491 final value applying to all subsequent tabs. For example: >
8492 :set vartabstop=4,20,10,8
8493< This will make the first tab 4 spaces wide, the second 20 spaces,
8494 the third 10 spaces, and all following tabs 8 spaces.
8495
8496 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8497 is set.
8498
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499 *'verbose'* *'vbs'*
8500'verbose' 'vbs' number (default 0)
8501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 When bigger than zero, Vim will give messages about what it is doing.
8503 Currently, these messages are given:
8504 >= 1 When the viminfo file is read or written.
8505 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008506 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008507 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 >= 8 Files for which a group of autocommands is executed.
8509 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008510 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 >= 12 Every executed function.
8512 >= 13 When an exception is thrown, caught, finished, or discarded.
8513 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008514 >= 15 Every executed Ex command from a script (truncated at 200
8515 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008516 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517
8518 This option can also be set with the "-V" argument. See |-V|.
8519 This option is also set by the |:verbose| command.
8520
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008521 When the 'verbosefile' option is set then the verbose messages are not
8522 displayed.
8523
8524 *'verbosefile'* *'vfile'*
8525'verbosefile' 'vfile' string (default empty)
8526 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008527 When not empty all messages are written in a file with this name.
8528 When the file exists messages are appended.
8529 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008530 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008531 Setting 'verbosefile' to a new value is like making it empty first.
8532 The difference with |:redir| is that verbose messages are not
8533 displayed when 'verbosefile' is set.
8534
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008536'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008537 "$VIM/vimfiles/view",
8538 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008539 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008540 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008542 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008543 feature}
8544 Name of the directory where to store files for |:mkview|.
8545 This option cannot be set from a |modeline| or in the |sandbox|, for
8546 security reasons.
8547
8548 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008549'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008550 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008551 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 feature}
8553 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008554 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 word save and restore ~
8556 cursor cursor position in file and in window
8557 folds manually created folds, opened/closed folds and local
8558 fold options
8559 options options and mappings local to a window or buffer (not
8560 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008561 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 slash backslashes in file names replaced with forward
8563 slashes
8564 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008565 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008566 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008568 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008570 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008571
8572 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008573'viminfo' 'vi' string (Vi default: "", Vim default for
8574 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008575 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8576 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008578 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 feature}
8580 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008581 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8582 "NONE".
8583 The string should be a comma separated list of parameters, each
8584 consisting of a single character identifying the particular parameter,
8585 followed by a number or string which specifies the value of that
8586 parameter. If a particular character is left out, then the default
8587 value is used for that parameter. The following is a list of the
8588 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008590 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008591 ! When included, save and restore global variables that start
8592 with an uppercase letter, and don't contain a lowercase
8593 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008594 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008595 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008596 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 " Maximum number of lines saved for each register. Old name of
8598 the '<' item, with the disadvantage that you need to put a
8599 backslash before the ", otherwise it will be recognized as the
8600 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008601 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 % When included, save and restore the buffer list. If Vim is
8603 started with a file name argument, the buffer list is not
8604 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008605 buffer list is restored from the viminfo file. Quickfix
8606 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8607 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008608 When followed by a number, the number specifies the maximum
8609 number of buffers that are stored. Without a number all
8610 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008611 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 ' Maximum number of previously edited files for which the marks
8613 are remembered. This parameter must always be included when
8614 'viminfo' is non-empty.
8615 Including this item also means that the |jumplist| and the
8616 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008617 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008619 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620 patterns are also saved. When not included, the value of
8621 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008622 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008623 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008624 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008625 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008626 < Maximum number of lines saved for each register. If zero then
8627 registers are not saved. When not included, all lines are
8628 saved. '"' is the old name for this item.
8629 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008630 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008632 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008633 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634 c When included, convert the text in the viminfo file from the
8635 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008636 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008637 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 f Whether file marks need to be stored. If zero, file marks ('0
8639 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008640 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008642 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 h Disable the effect of 'hlsearch' when loading the viminfo
8644 file. When not included, it depends on whether ":nohlsearch"
8645 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008646 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008648 the 'n'. Must be at the end of the option! If the
8649 'viminfofile' option is set, that file name overrides the one
8650 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008651 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008652 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 r Removable media. The argument is a string (up to the next
8654 ','). This parameter can be given several times. Each
8655 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008656 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8658 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8659 ignored. Maximum length of each 'r' argument is 50
8660 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008661 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 s Maximum size of an item in Kbyte. If zero then registers are
8663 not saved. Currently only applies to registers. The default
8664 "s10" will exclude registers with more than 10 Kbyte of text.
8665 Also see the '<' item above: line count limit.
8666
8667 Example: >
8668 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8669<
8670 '50 Marks will be remembered for the last 50 files you
8671 edited.
8672 <1000 Contents of registers (up to 1000 lines each) will be
8673 remembered.
8674 s100 Registers with more than 100 Kbyte text are skipped.
8675 :0 Command-line history will not be saved.
8676 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8677 no / Since '/' is not specified, the default will be used,
8678 that is, save all of the search history, and also the
8679 previous search and substitute patterns.
8680 no % The buffer list will not be saved nor read back.
8681 no h 'hlsearch' highlighting will be restored.
8682
8683 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8684 load the contents of the file, this is not done automatically.
8685
8686 This option cannot be set from a |modeline| or in the |sandbox|, for
8687 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008688 NOTE: This option is set to the Vim default value when 'compatible'
8689 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008690
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008691 *'viminfofile'* *'vif'*
8692'viminfofile' 'vif' string (default: "")
8693 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008694 {not available when compiled without the |+viminfo|
8695 feature}
8696 When non-empty, overrides the file name used for viminfo.
8697 When equal to "NONE" no viminfo file will be read or written.
8698 This option can be set with the |-i| command line flag. The |--clean|
8699 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008700 This option cannot be set from a |modeline| or in the |sandbox|, for
8701 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008702
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 *'virtualedit'* *'ve'*
8704'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008705 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 A comma separated list of these words:
8707 block Allow virtual editing in Visual block mode.
8708 insert Allow virtual editing in Insert mode.
8709 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008710 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008711 none When used as the local value, do not allow virtual
8712 editing even when the global value is set. When used
8713 as the global value, "none" is the same as "".
8714 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008715
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008717 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 of the line. Useful for selecting a rectangle in Visual mode and
8719 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008720 "onemore" is not the same, it will only allow moving the cursor just
8721 after the last character of the line. This makes some commands more
8722 consistent. Previously the cursor was always past the end of the line
8723 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008724 break some plugins or Vim scripts. For example because |l| can move
8725 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008726 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008727 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008728 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008729 It doesn't make sense to combine "all" with "onemore", but you will
8730 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008731 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008732 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008733
8734 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8735'visualbell' 'vb' boolean (default off)
8736 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008737 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008739 use: >
8740 :set vb t_vb=
8741< If you want a short flash, you can use this on many terminals: >
8742 :set vb t_vb=[?5h$<100>[?5l
8743< Here $<100> specifies the time, you can use a smaller or bigger value
8744 to get a shorter or longer flash.
8745
8746 Note: Vim will limit the bell to once per half a second. This avoids
8747 having to wait for the flashing to finish when there are lots of
8748 bells, e.g. on key repeat. This also happens without 'visualbell'
8749 set.
8750
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8752 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8753 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008754
8755 Note: When the GUI starts, 't_vb' is reset to its default value. You
8756 might want to set it again in your |gvimrc|.
8757
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 Does not work on the Amiga, you always get a screen flash.
8759 Also see 'errorbells'.
8760
8761 *'warn'* *'nowarn'*
8762'warn' boolean (default on)
8763 global
8764 Give a warning message when a shell command is used while the buffer
8765 has been changed.
8766
8767 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8768'weirdinvert' 'wiv' boolean (default off)
8769 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008770 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 It is provided for backwards compatibility with version 4.x.
8772 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8773 vice versa. Has no effect when the GUI is running.
8774
8775 *'whichwrap'* *'ww'*
8776'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8777 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 Allow specified keys that move the cursor left/right to move to the
8779 previous/next line when the cursor is on the first/last character in
8780 the line. Concatenate characters to allow this for these keys:
8781 char key mode ~
8782 b <BS> Normal and Visual
8783 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008784 h "h" Normal and Visual (not recommended)
8785 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 < <Left> Normal and Visual
8787 > <Right> Normal and Visual
8788 ~ "~" Normal
8789 [ <Left> Insert and Replace
8790 ] <Right> Insert and Replace
8791 For example: >
8792 :set ww=<,>,[,]
8793< allows wrap only when cursor keys are used.
8794 When the movement keys are used in combination with a delete or change
8795 operator, the <EOL> also counts for a character. This makes "3h"
8796 different from "3dh" when the cursor crosses the end of a line. This
8797 is also true for "x" and "X", because they do the same as "dl" and
8798 "dh". If you use this, you may also want to use the mapping
8799 ":map <BS> X" to make backspace delete the character in front of the
8800 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008801 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008802 line (not an empty line) then it will not move to the next line. This
8803 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 NOTE: This option is set to the Vi default value when 'compatible' is
8805 set and to the Vim default value when 'compatible' is reset.
8806
8807 *'wildchar'* *'wc'*
8808'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 Character you have to type to start wildcard expansion in the
8811 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008812 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008813 The character is not recognized when used inside a macro. See
8814 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008815 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008816 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008817 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818< NOTE: This option is set to the Vi default value when 'compatible' is
8819 set and to the Vim default value when 'compatible' is reset.
8820
8821 *'wildcharm'* *'wcm'*
8822'wildcharm' 'wcm' number (default: none (0))
8823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008824 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008825 recognized when used inside a macro. You can find "spare" command-line
8826 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008827 you'll never actually type 'wildcharm', just use it in mappings that
8828 automatically invoke completion mode, e.g.: >
8829 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008830 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831< Then after typing :ss you can use CTRL-P & CTRL-N.
8832
8833 *'wildignore'* *'wig'*
8834'wildignore' 'wig' string (default "")
8835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 {not available when compiled without the |+wildignore|
8837 feature}
8838 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008839 patterns is ignored when expanding |wildcards|, completing file or
8840 directory names, and influences the result of |expand()|, |glob()| and
8841 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8843 Also see 'suffixes'.
8844 Example: >
8845 :set wildignore=*.o,*.obj
8846< The use of |:set+=| and |:set-=| is preferred when adding or removing
8847 a pattern from the list. This avoids problems when a future version
8848 uses another default.
8849
Bram Moolenaar94950a92010-12-02 16:01:29 +01008850
Bram Moolenaar81af9252010-12-10 20:35:50 +01008851 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008852'wildignorecase' 'wic' boolean (default off)
8853 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008854 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008855 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008856 Does not apply when the shell is used to expand wildcards, which
8857 happens when there are special characters.
8858
8859
Bram Moolenaar071d4272004-06-13 20:20:40 +00008860 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008861'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863 {not available if compiled without the |+wildmenu|
8864 feature}
8865 When 'wildmenu' is on, command-line completion operates in an enhanced
8866 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8867 the possible matches are shown just above the command line, with the
8868 first match highlighted (overwriting the status line, if there is
8869 one). Keys that show the previous/next match, such as <Tab> or
8870 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8871 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8872 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008873 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874 If there are more matches than can fit in the line, a ">" is shown on
8875 the right and/or a "<" is shown on the left. The status line scrolls
8876 as needed.
8877 The "wildmenu" mode is abandoned when a key is hit that is not used
8878 for selecting a completion.
8879 While the "wildmenu" is active the following keys have special
8880 meanings:
8881
8882 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8883 <Down> - in filename/menu name completion: move into a
8884 subdirectory or submenu.
8885 <CR> - in menu completion, when the cursor is just after a
8886 dot: move into a submenu.
8887 <Up> - in filename/menu name completion: move up into
8888 parent directory or parent menu.
8889
8890 This makes the menus accessible from the console |console-menus|.
8891
8892 If you prefer the <Left> and <Right> keys to move the cursor instead
8893 of selecting a different match, use this: >
8894 :cnoremap <Left> <Space><BS><Left>
8895 :cnoremap <Right> <Space><BS><Right>
8896<
8897 The "WildMenu" highlighting is used for displaying the current match
8898 |hl-WildMenu|.
8899
8900 *'wildmode'* *'wim'*
8901'wildmode' 'wim' string (Vim default: "full")
8902 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008904 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008905 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906 first part specifies the behavior for the first use of 'wildchar',
8907 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008908
8909 Each part consists of a colon separated list consisting of the
8910 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008911 "" Complete only the first match.
8912 "full" Complete the next full match. After the last match,
8913 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008914 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 "longest" Complete till longest common string. If this doesn't
8916 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008917 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008918 "lastused" When completing buffer names and more than one buffer
8919 matches, sort buffers by time last used (other than
8920 the current buffer).
8921 When there is only a single match, it is fully completed in all cases.
8922
8923 Examples of useful colon-separated values:
8924 "longest:full" Like "longest", but also start 'wildmenu' if it is
8925 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 "list:full" When more than one match, list all matches and
8927 complete first match.
8928 "list:longest" When more than one match, list all matches and
8929 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008930 "list:lastused" When more than one buffer matches, list all matches
8931 and sort buffers by time last used (other than the
8932 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008933
8934 Examples: >
8935 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008936< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937 :set wildmode=longest,full
8938< Complete longest common string, then each full match >
8939 :set wildmode=list:full
8940< List all matches and complete each full match >
8941 :set wildmode=list,full
8942< List all matches without completing, then each full match >
8943 :set wildmode=longest,list
8944< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008945 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008947 *'wildoptions'* *'wop'*
8948'wildoptions' 'wop' string (default "")
8949 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008950 {not available when compiled without the |+wildignore|
8951 feature}
8952 A list of words that change how command line completion is done.
8953 Currently only one word is allowed:
8954 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008955 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008956 is displayed per line. Often used tag kinds are:
8957 d #define
8958 f function
8959 Also see |cmdline-completion|.
8960
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 *'winaltkeys'* *'wak'*
8962'winaltkeys' 'wak' string (default "menu")
8963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 {only used in Win32, Motif, GTK and Photon GUI}
8965 Some GUI versions allow the access to menu entries by using the ALT
8966 key in combination with a character that appears underlined in the
8967 menu. This conflicts with the use of the ALT key for mappings and
8968 entering special characters. This option tells what to do:
8969 no Don't use ALT keys for menus. ALT key combinations can be
8970 mapped, but there is no automatic handling. This can then be
8971 done with the |:simalt| command.
8972 yes ALT key handling is done by the windowing system. ALT key
8973 combinations cannot be mapped.
8974 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008975 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008976 keys can be mapped.
8977 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8978 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008979 This option is not used for <F10>; on Win32 and with GTK <F10> will
8980 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008981
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008982 *'wincolor'* *'wcr'*
8983'wincolor' 'wcr' string (default empty)
8984 local to window
8985 Highlight group name to use for this window instead of the Normal
8986 color |hl-Normal|.
8987
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008988 *'window'* *'wi'*
8989'window' 'wi' number (default screen height - 1)
8990 global
Bram Moolenaardad44732021-03-31 20:07:33 +02008991 Window height used for |CTRL-F| and |CTRL-B| when there is only one
8992 window and the value is smaller than 'lines' minus one. The screen
8993 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008994 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8995 in a much smarter way, taking care of wrapping lines.
8996 When resizing the Vim window, the value is smaller than 1 or more than
8997 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02008998 Note: Do not confuse this with the height of the Vim window, use
8999 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009000
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 *'winheight'* *'wh'* *E591*
9002'winheight' 'wh' number (default 1)
9003 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009005 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009006 focus goes to a window that is smaller, its size is increased, at the
9007 cost of the height of other windows.
9008 Set 'winheight' to a small number for normal editing.
9009 Set it to 999 to make the current window fill most of the screen.
9010 Other windows will be only 'winminheight' high. This has the drawback
9011 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9012 to create only two windows, set the option after startup is done,
9013 using the |VimEnter| event: >
9014 au VimEnter * set winheight=999
9015< Minimum value is 1.
9016 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 height of the current window.
9018 'winheight' applies to the current window. Use 'winminheight' to set
9019 the minimal height for other windows.
9020
9021 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9022'winfixheight' 'wfh' boolean (default off)
9023 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009025 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9026 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009027 The height may be changed anyway when running out of room.
9028
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009029 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9030'winfixwidth' 'wfw' boolean (default off)
9031 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009032 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009033 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009034 The width may be changed anyway when running out of room.
9035
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 *'winminheight'* *'wmh'*
9037'winminheight' 'wmh' number (default 1)
9038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009039 The minimal height of a window, when it's not the current window.
9040 This is a hard minimum, windows will never become smaller.
9041 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9042 status bar) if necessary. They will return to at least one line when
9043 they become active (since the cursor has to have somewhere to go.)
9044 Use 'winheight' to set the minimal height of the current window.
9045 This option is only checked when making a window smaller. Don't use a
9046 large number, it will cause errors when opening more than a few
9047 windows. A value of 0 to 3 is reasonable.
9048
9049 *'winminwidth'* *'wmw'*
9050'winminwidth' 'wmw' number (default 1)
9051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 The minimal width of a window, when it's not the current window.
9053 This is a hard minimum, windows will never become smaller.
9054 When set to zero, windows may be "squashed" to zero columns (i.e. just
9055 a vertical separator) if necessary. They will return to at least one
9056 line when they become active (since the cursor has to have somewhere
9057 to go.)
9058 Use 'winwidth' to set the minimal width of the current window.
9059 This option is only checked when making a window smaller. Don't use a
9060 large number, it will cause errors when opening more than a few
9061 windows. A value of 0 to 12 is reasonable.
9062
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009063 *'winptydll'*
9064'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9065 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009066 {only available when compiled with the |terminal|
9067 feature on MS-Windows}
9068 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009069 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009070 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009071 a fallback.
9072 Environment variables are expanded |:set_env|.
9073 This option cannot be set from a |modeline| or in the |sandbox|, for
9074 security reasons.
9075
Bram Moolenaar071d4272004-06-13 20:20:40 +00009076 *'winwidth'* *'wiw'* *E592*
9077'winwidth' 'wiw' number (default 20)
9078 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009079 Minimal number of columns for the current window. This is not a hard
9080 minimum, Vim will use fewer columns if there is not enough room. If
9081 the current window is smaller, its size is increased, at the cost of
9082 the width of other windows. Set it to 999 to make the current window
9083 always fill the screen. Set it to a small number for normal editing.
9084 The width is not adjusted after one of the commands to change the
9085 width of the current window.
9086 'winwidth' applies to the current window. Use 'winminwidth' to set
9087 the minimal width for other windows.
9088
9089 *'wrap'* *'nowrap'*
9090'wrap' boolean (default on)
9091 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009092 This option changes how text is displayed. It doesn't change the text
9093 in the buffer, see 'textwidth' for that.
9094 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009095 displaying continues on the next line. When off lines will not wrap
9096 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 moved to a part that is not shown, the screen will scroll
9098 horizontally.
9099 The line will be broken in the middle of a word if necessary. See
9100 'linebreak' to get the break at a word boundary.
9101 To make scrolling horizontally a bit more useful, try this: >
9102 :set sidescroll=5
9103 :set listchars+=precedes:<,extends:>
9104< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009105 This option can't be set from a |modeline| when the 'diff' option is
9106 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009107
9108 *'wrapmargin'* *'wm'*
9109'wrapmargin' 'wm' number (default 0)
9110 local to buffer
9111 Number of characters from the right window border where wrapping
9112 starts. When typing text beyond this limit, an <EOL> will be inserted
9113 and inserting continues on the next line.
9114 Options that add a margin, such as 'number' and 'foldcolumn', cause
9115 the text width to be further reduced. This is Vi compatible.
9116 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009117 This option is set to 0 when 'paste' is set and restored when 'paste'
9118 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009119 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120
9121 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9122'wrapscan' 'ws' boolean (default on) *E384* *E385*
9123 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009124 Searches wrap around the end of the file. Also applies to |]s| and
9125 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009126
9127 *'write'* *'nowrite'*
9128'write' boolean (default on)
9129 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009130 Allows writing files. When not set, writing a file is not allowed.
9131 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009132 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009133 argument. Filtering text is still possible, even though this requires
9134 writing a temporary file.
9135
9136 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9137'writeany' 'wa' boolean (default off)
9138 global
9139 Allows writing to any file with no need for "!" override.
9140
9141 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9142'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9143 otherwise)
9144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009145 Make a backup before overwriting a file. The backup is removed after
9146 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009147 also on.
9148 WARNING: Switching this option off means that when Vim fails to write
9149 your buffer correctly and then, for whatever reason, Vim exits, you
9150 lose both the original file and what you were writing. Only reset
9151 this option if your file system is almost full and it makes the write
9152 fail (and make sure not to exit Vim until the write was successful).
9153 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009154 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009155 Depending on 'backupcopy' the backup is a new file or the original
9156 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157 NOTE: This option is set to the default value when 'compatible' is
9158 set.
9159
9160 *'writedelay'* *'wd'*
9161'writedelay' 'wd' number (default 0)
9162 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009163 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009164 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009165 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009166
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009167 vim:tw=78:ts=8:noet:ft=help:norl: