blob: aed0ad41c135d391b0ff868773c9d977f3b489bf [file] [log] [blame]
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02001*options.txt* For Vim version 8.2. Last change: 2021 Sep 21
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 Moolenaar1c6737b2020-09-07 22:18:52 +0200720 contains a character that would be double width.
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200721
722 The values are overruled for characters specified with
723 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724
725 There are a number of CJK fonts for which the width of glyphs for
726 those characters are solely based on how many octets they take in
727 legacy/traditional CJK encodings. In those encodings, Euro,
728 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000729 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000731 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732 Vim is running inside a terminal (emulators) that uses a CJK font
733 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
734 this option should be set to "double" to match the width perceived
735 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100736 to be set to "double" under CJK MS-Windows when the system locale is
737 set to one of CJK locales. See Unicode Standard Annex #11
738 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100740 Vim may set this option automatically at startup time when Vim is
741 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200742 escape sequence to request cursor position report. The response can
743 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100744
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
746'antialias' 'anti' boolean (default: off)
747 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200749 on macOS}
750 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
752 which can be easier to read at certain sizes on certain displays.
753 Setting this option can sometimes cause problems if 'guifont' is set
754 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100755 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756
757 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
758'autochdir' 'acd' boolean (default off)
759 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200760 {only available when compiled with it, use
761 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000762 When on, Vim will change the current working directory whenever you
763 open a file, switch buffers, delete a buffer or open/close a window.
764 It will change to the directory containing the file which was opened
765 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000766 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200768 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
769'autoshelldir' 'asd' boolean (default off)
770 global
771 When on, Vim will change the current working directory whenever you
772 change the directory of the shell running in a terminal window. You
773 need proper setting-up, so whenever the shell's pwd changes an OSC 7
774 escape sequence will be emitted. For example, on Linux, you can source
775 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
776
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
778'arabic' 'arab' boolean (default off)
779 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 {only available when compiled with the |+arabic|
781 feature}
782 This option can be set to start editing Arabic text.
783 Setting this option will:
784 - Set the 'rightleft' option, unless 'termbidi' is set.
785 - Set the 'arabicshape' option, unless 'termbidi' is set.
786 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
787 between typing English and Arabic key mapping.
788 - Set the 'delcombine' option
789 Note that 'encoding' must be "utf-8" for working with Arabic text.
790
791 Resetting this option will:
792 - Reset the 'rightleft' option.
793 - Disable the use of 'keymap' (without changing its value).
794 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200795 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100796 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 Also see |arabic.txt|.
798
799 *'arabicshape'* *'arshape'*
800 *'noarabicshape'* *'noarshape'*
801'arabicshape' 'arshape' boolean (default on)
802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 {only available when compiled with the |+arabic|
804 feature}
805 When on and 'termbidi' is off, the required visual character
806 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200807 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 one which encompasses:
809 a) the changing/morphing of characters based on their location
810 within a word (initial, medial, final and stand-alone).
811 b) the enabling of the ability to compose characters
812 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100813 When disabled the display shows each character's true stand-alone
814 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 Arabic is a complex language which requires other settings, for
816 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100817 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818
819 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
820'autoindent' 'ai' boolean (default off)
821 local to buffer
822 Copy indent from current line when starting a new line (typing <CR>
823 in Insert mode or when using the "o" or "O" command). If you do not
824 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000825 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
826 to another line has the same effect, unless the 'I' flag is included
827 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000828 When autoindent is on, formatting (with the "gq" command or when you
829 reach 'textwidth' in Insert mode) uses the indentation of the first
830 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 When 'smartindent' or 'cindent' is on the indent is changed in
832 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200833 The 'autoindent' option is reset when the 'paste' option is set and
834 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835
836 *'autoread'* *'ar'* *'noautoread'* *'noar'*
837'autoread' 'ar' boolean (default off)
838 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 When a file has been detected to have been changed outside of Vim and
840 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200841 When the file has been deleted this is not done, so you have the text
842 from before it was deleted. When it appears again then it is read.
843 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 If this option has a local value, use this command to switch back to
845 using the global value: >
846 :set autoread<
847<
848 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
849'autowrite' 'aw' boolean (default off)
850 global
851 Write the contents of the file, if it has been modified, on each
852 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000853 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
855 Note that for some commands the 'autowrite' option is not used, see
856 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200857 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200858 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
860 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
861'autowriteall' 'awa' boolean (default off)
862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
864 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
865 Setting this option also implies that Vim behaves like 'autowrite' has
866 been set.
867
868 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200869'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 When set to "dark", Vim will try to use colors that look good on a
872 dark background. When set to "light", Vim will try to use colors that
873 look good on a light background. Any other value is illegal.
874 Vim tries to set the default value according to the terminal used.
875 This will not always be correct.
876 Setting this option does not change the background color, it tells Vim
877 what the background color looks like. For changing the background
878 color, see |:hi-normal|.
879
880 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000881 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000882 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100883 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884 setting 'background' will cause the color scheme to be reloaded. If
885 the color scheme adjusts to the value of 'background' this will work.
886 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100887 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888
889 When setting 'background' to the default value with: >
890 :set background&
891< Vim will guess the value. In the GUI this should work correctly,
892 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200893 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200894 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200896 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200897 color from the terminal. If the returned RGB value is dark/light and
898 'background' is not dark/light, 'background' will be set and the
899 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200900 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100901 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200902
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 When starting the GUI, the default value for 'background' will be
904 "light". When the value is not set in the .gvimrc, and Vim detects
905 that the background is actually quite dark, 'background' is set to
906 "dark". But this happens only AFTER the .gvimrc file has been read
907 (because the window needs to be opened to find the actual background
908 color). To get around this, force the GUI window to be opened by
909 putting a ":gui" command in the .gvimrc file, before where the value
910 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200911
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100912 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200913 For other systems "dark" is used when 'term' is "linux",
914 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
915 background. Otherwise the default is "light".
916
Bram Moolenaarc572da52017-08-27 16:52:01 +0200917 The |:terminal| command and the |term_start()| function use the
918 'background' value to decide whether the terminal window will start
919 with a white or black background.
920
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 Normally this option would be set in the .vimrc file. Possibly
922 depending on the terminal name. Example: >
923 :if &term == "pcterm"
924 : set background=dark
925 :endif
926< When this option is set, the default settings for the highlight groups
927 will change. To use other settings, place ":highlight" commands AFTER
928 the setting of the 'background' option.
929 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
930 to select the colors for syntax highlighting. After changing this
931 option, you must load syntax.vim again to see the result. This can be
932 done with ":syntax on".
933
934 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200935'backspace' 'bs' string (default "", set to "indent,eol,start"
936 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
939 mode. This is a list of items, separated by commas. Each item allows
940 a way to backspace over something:
941 value effect ~
942 indent allow backspacing over autoindent
943 eol allow backspacing over line breaks (join lines)
944 start allow backspacing over the start of insert; CTRL-W and CTRL-U
945 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200946 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
947 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948
949 When the value is empty, Vi compatible backspacing is used.
950
951 For backwards compatibility with version 5.4 and earlier:
952 value effect ~
953 0 same as ":set backspace=" (Vi compatible)
954 1 same as ":set backspace=indent,eol"
955 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200956 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957
958 See |:fixdel| if your <BS> or <Del> key does not do what you want.
959 NOTE: This option is set to "" when 'compatible' is set.
960
961 *'backup'* *'bk'* *'nobackup'* *'nobk'*
962'backup' 'bk' boolean (default off)
963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964 Make a backup before overwriting a file. Leave it around after the
965 file has been successfully written. If you do not want to keep the
966 backup file, but you do want a backup while the file is being
967 written, reset this option and set the 'writebackup' option (this is
968 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000969 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 |backup-table| for more explanations.
971 When the 'backupskip' pattern matches, a backup is not made anyway.
972 When 'patchmode' is set, the backup may be renamed to become the
973 oldest version of a file.
974 NOTE: This option is reset when 'compatible' is set.
975
976 *'backupcopy'* *'bkc'*
977'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200978 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 When writing a file and a backup is made, this option tells how it's
980 done. This is a comma separated list of words.
981
982 The main values are:
983 "yes" make a copy of the file and overwrite the original one
984 "no" rename the file and write a new one
985 "auto" one of the previous, what works best
986
987 Extra values that can be combined with the ones above are:
988 "breaksymlink" always break symlinks when writing
989 "breakhardlink" always break hardlinks when writing
990
991 Making a copy and overwriting the original file:
992 - Takes extra time to copy the file.
993 + When the file has special attributes, is a (hard/symbolic) link or
994 has a resource fork, all this is preserved.
995 - When the file is a link the backup will have the name of the link,
996 not of the real file.
997
998 Renaming the file and writing a new one:
999 + It's fast.
1000 - Sometimes not all attributes of the file can be copied to the new
1001 file.
1002 - When the file is a link the new file will not be a link.
1003
1004 The "auto" value is the middle way: When Vim sees that renaming file
1005 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001006 the file is not a link) that is used. When problems are expected, a
1007 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008
1009 The "breaksymlink" and "breakhardlink" values can be used in
1010 combination with any of "yes", "no" and "auto". When included, they
1011 force Vim to always break either symbolic or hard links by doing
1012 exactly what the "no" option does, renaming the original file to
1013 become the backup and writing a new file in its place. This can be
1014 useful for example in source trees where all the files are symbolic or
1015 hard links and any changes should stay in the local source tree, not
1016 be propagated back to the original source.
1017 *crontab*
1018 One situation where "no" and "auto" will cause problems: A program
1019 that opens a file, invokes Vim to edit that file, and then tests if
1020 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001021 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 example.
1023
1024 When a copy is made, the original file is truncated and then filled
1025 with the new text. This means that protection bits, owner and
1026 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001027 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 group of the backup is set to the group of the original file. If this
1029 fails, the protection bits for the group are made the same as for
1030 others.
1031
1032 When the file is renamed this is the other way around: The backup has
1033 the same attributes of the original file, and the newly written file
1034 is owned by the current user. When the file was a (hard/symbolic)
1035 link, the new file will not! That's why the "auto" value doesn't
1036 rename when the file is a link. The owner and group of the newly
1037 written file will be set to the same ones as the original file, but
1038 the system may refuse to do this. In that case the "auto" value will
1039 again not rename the file.
1040
Bram Moolenaar036986f2017-03-16 17:41:02 +01001041 NOTE: This option is set to the Vi default value when 'compatible' is
1042 set and to the Vim default value when 'compatible' is reset.
1043
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044 *'backupdir'* *'bdir'*
1045'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001046 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 for Unix: ".,~/tmp,~/")
1048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 List of directories for the backup file, separated with commas.
1050 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001051 where this is possible. The directory must exist, Vim will not
1052 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001053 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001054 impossible!). Writing may fail because of this.
1055 - A directory "." means to put the backup file in the same directory
1056 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001057 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1058 the backup file relative to where the edited file is. The leading
1059 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 ("." inside a directory name has no special meaning).
1061 - Spaces after the comma are ignored, other spaces are considered part
1062 of the directory name. To have a space at the start of a directory
1063 name, precede it with a backslash.
1064 - To include a comma in a directory name precede it with a backslash.
1065 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001066 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001067 the backup file name will be built from the complete path to the
1068 file with all path separators changed to percent '%' signs. This
1069 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001070 On Win32, it is also possible to end with "\\". However, When a
1071 separating comma is following, you must use "//", since "\\" will
1072 include the comma in the file name. Therefore it is recommended to
1073 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 - Environment variables are expanded |:set_env|.
1075 - Careful with '\' characters, type one before a space, type two to
1076 get one in the option (see |option-backslash|), for example: >
1077 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1078< - For backwards compatibility with Vim version 3.0 a '>' at the start
1079 of the option is removed.
1080 See also 'backup' and 'writebackup' options.
1081 If you want to hide your backup files on Unix, consider this value: >
1082 :set backupdir=./.backup,~/.backup,.,/tmp
1083< You must create a ".backup" directory in each directory and in your
1084 home directory for this to work properly.
1085 The use of |:set+=| and |:set-=| is preferred when adding or removing
1086 directories from the list. This avoids problems when a future version
1087 uses another default.
1088 This option cannot be set from a |modeline| or in the |sandbox|, for
1089 security reasons.
1090
1091 *'backupext'* *'bex'* *E589*
1092'backupext' 'bex' string (default "~", for VMS: "_")
1093 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 String which is appended to a file name to make the name of the
1095 backup file. The default is quite unusual, because this avoids
1096 accidentally overwriting existing files with a backup file. You might
1097 prefer using ".bak", but make sure that you don't have files with
1098 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001099 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001101 If you like to keep a lot of backups, you could use a BufWritePre
1102 autocommand to change 'backupext' just before writing the file to
1103 include a timestamp. >
1104 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1105< Use 'backupdir' to put the backup in a different directory.
1106
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001108'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1109 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1110 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001111 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 {not available when compiled without the |+wildignore|
1113 feature}
1114 A list of file patterns. When one of the patterns matches with the
1115 name of the file which is written, no backup file is created. Both
1116 the specified file name and the full path name of the file are used.
1117 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1118 Watch out for special characters, see |option-backslash|.
1119 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001120 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001121
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001122 WARNING: Not having a backup file means that when Vim fails to write
1123 your buffer correctly and then, for whatever reason, Vim exits, you
1124 lose both the original file and what you were writing. Only disable
1125 backups if you don't care about losing the file.
1126
Bram Moolenaar02467872007-05-06 13:22:01 +00001127 Note that environment variables are not expanded. If you want to use
1128 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001129 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001130
1131< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001132 backup would be made by renaming the original file crontab won't see
1133 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001134
1135 *'balloondelay'* *'bdlay'*
1136'balloondelay' 'bdlay' number (default: 600)
1137 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 {only available when compiled with the |+balloon_eval|
1139 feature}
1140 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1141
1142 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1143'ballooneval' 'beval' boolean (default off)
1144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001146 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001147 Switch on the |balloon-eval| functionality for the GUI.
1148
1149 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1150 *'nobevalterm'*
1151'balloonevalterm' 'bevalterm' boolean (default off)
1152 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001153 {only available when compiled with the
1154 |+balloon_eval_term| feature}
1155 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001157 *'balloonexpr'* *'bexpr'*
1158'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001159 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001160 {only available when compiled with the |+balloon_eval|
1161 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001162 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001163 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1164 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001165
1166 v:beval_bufnr number of the buffer in which balloon is going to show
1167 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001168 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001169 v:beval_lnum line number
1170 v:beval_col column number (byte index)
1171 v:beval_text word under or after the mouse pointer
1172
Bram Moolenaar54775062019-07-31 21:07:14 +02001173 Instead of showing a balloon, which is limited to plain text, consider
1174 using a popup window, see |popup_beval_example|. A popup window can
1175 use highlighting and show a border.
1176
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001177 The evaluation of the expression must not have side effects!
1178 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001179 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001180 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001181 \', column ' . v:beval_col .
1182 \ ' of file ' . bufname(v:beval_bufnr) .
1183 \ ' on word "' . v:beval_text . '"'
1184 endfunction
1185 set bexpr=MyBalloonExpr()
1186 set ballooneval
1187<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001188 Also see |balloon_show()|, it can be used if the content of the balloon
1189 is to be fetched asynchronously. In that case evaluating
1190 'balloonexpr' should result in an empty string. If you get a balloon
1191 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001192
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001193 NOTE: The balloon is displayed only if the cursor is on a text
1194 character. If the result of evaluating 'balloonexpr' is not empty,
1195 Vim does not try to send a message to an external debugger (Netbeans
1196 or Sun Workshop).
1197
Bram Moolenaar30b65812012-07-12 22:01:11 +02001198 The expression will be evaluated in the |sandbox| when set from a
1199 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001200 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001201
1202 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001203 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001204
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001205 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001206 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001207< When they are supported "\n" characters will start a new line. If the
1208 expression evaluates to a |List| this is equal to using each List item
1209 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001210 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001211
Bram Moolenaar165bc692015-07-21 17:53:25 +02001212 *'belloff'* *'bo'*
1213'belloff' 'bo' string (default "")
1214 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001215 Specifies for which events the bell will not be rung. It is a comma
1216 separated list of items. For each item that is present, the bell
1217 will be silenced. This is most useful to specify specific events in
1218 insert mode to be silenced.
1219
1220 item meaning when present ~
1221 all All events.
1222 backspace When hitting <BS> or <Del> and deleting results in an
1223 error.
1224 cursor Fail to move around using the cursor keys or
1225 <PageUp>/<PageDown> in |Insert-mode|.
1226 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1227 |i_CTRL-X_CTRL-T|.
1228 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1229 |i_CTRL-E|.
1230 ctrlg Unknown Char after <C-G> in Insert mode.
1231 error Other Error occurred (e.g. try to join last line)
1232 (mostly used in |Normal-mode| or |Cmdline-mode|).
1233 esc hitting <Esc> in |Normal-mode|.
1234 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001235 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001236 insertmode Pressing <Esc> in 'insertmode'.
1237 lang Calling the beep module for Lua/Mzscheme/TCL.
1238 mess No output available for |g<|.
1239 showmatch Error occurred for 'showmatch' function.
1240 operator Empty region error |cpo-E|.
1241 register Unknown register after <C-R> in |Insert-mode|.
1242 shell Bell from shell output |:!|.
1243 spell Error happened on spell suggest.
1244 wildmode More matches in |cmdline-completion| available
1245 (depends on the 'wildmode' setting).
1246
Bram Moolenaar036986f2017-03-16 17:41:02 +01001247 This is most useful to fine tune when in Insert mode the bell should
1248 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001249 indicate that an error occurred. It can be silenced by adding the
1250 "error" keyword.
1251
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1253'binary' 'bin' boolean (default off)
1254 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 This option should be set before editing a binary file. You can also
1256 use the |-b| Vim argument. When this option is switched on a few
1257 options will be changed (also when it already was on):
1258 'textwidth' will be set to 0
1259 'wrapmargin' will be set to 0
1260 'modeline' will be off
1261 'expandtab' will be off
1262 Also, 'fileformat' and 'fileformats' options will not be used, the
1263 file is read and written like 'fileformat' was "unix" (a single <NL>
1264 separates lines).
1265 The 'fileencoding' and 'fileencodings' options will not be used, the
1266 file is read without conversion.
1267 NOTE: When you start editing a(nother) file while the 'bin' option is
1268 on, settings from autocommands may change the settings again (e.g.,
1269 'textwidth'), causing trouble when editing. You might want to set
1270 'bin' again when the file has been loaded.
1271 The previous values of these options are remembered and restored when
1272 'bin' is switched from on to off. Each buffer has its own set of
1273 saved option values.
1274 To edit a file with 'binary' set you can use the |++bin| argument.
1275 This avoids you have to do ":set bin", which would have effect for all
1276 files you edit.
1277 When writing a file the <EOL> for the last line is only written if
1278 there was one in the original file (normally Vim appends an <EOL> to
1279 the last line if there is none; this would make the file longer). See
1280 the 'endofline' option.
1281
1282 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1283'bioskey' 'biosk' boolean (default on)
1284 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001285 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001286 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287
1288 *'bomb'* *'nobomb'*
1289'bomb' boolean (default off)
1290 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001291 When writing a file and the following conditions are met, a BOM (Byte
1292 Order Mark) is prepended to the file:
1293 - this option is on
1294 - the 'binary' option is off
1295 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1296 endian variants.
1297 Some applications use the BOM to recognize the encoding of the file.
1298 Often used for UCS-2 files on MS-Windows. For other applications it
1299 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001300 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1302 check for the presence of the BOM is done and 'bomb' set accordingly.
1303 Unless 'binary' is set, it is removed from the first line, so that you
1304 don't see it when editing. When you don't change the options, the BOM
1305 will be restored when writing the file.
1306
1307 *'breakat'* *'brk'*
1308'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1309 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001310 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 feature}
1312 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001313 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1314 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001316 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001317'breakindent' 'bri' boolean (default off)
1318 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001319 {not available when compiled without the |+linebreak|
1320 feature}
1321 Every wrapped line will continue visually indented (same amount of
1322 space as the beginning of that line), thus preserving horizontal blocks
1323 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001324 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001325
1326 *'breakindentopt'* *'briopt'*
1327'breakindentopt' 'briopt' string (default empty)
1328 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001329 {not available when compiled without the |+linebreak|
1330 feature}
1331 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001332 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001333 min:{n} Minimum text width that will be kept after
1334 applying 'breakindent', even if the resulting
1335 text should normally be narrower. This prevents
1336 text indented almost to the right window border
1337 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001338 shift:{n} After applying 'breakindent', the wrapped line's
1339 beginning will be shifted by the given number of
1340 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001341 indentation (negative) or emphasizing the line
1342 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001343 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001344 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001345 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001346 numbered or bulleted list (using the
1347 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001348 list:-1 Uses the length of a match with 'formatlistpat'
1349 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001350 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001351
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001353'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001355 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001357 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001358 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001359 buffer Use the directory of the related buffer.
1360 current Use the current directory.
1361 {path} Use the specified directory
1362
1363 *'bufhidden'* *'bh'*
1364'bufhidden' 'bh' string (default: "")
1365 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 This option specifies what happens when a buffer is no longer
1367 displayed in a window:
1368 <empty> follow the global 'hidden' option
1369 hide hide the buffer (don't unload it), also when 'hidden'
1370 is not set
1371 unload unload the buffer, also when 'hidden' is set or using
1372 |:hide|
1373 delete delete the buffer from the buffer list, also when
1374 'hidden' is set or using |:hide|, like using
1375 |:bdelete|
1376 wipe wipe out the buffer from the buffer list, also when
1377 'hidden' is set or using |:hide|, like using
1378 |:bwipeout|
1379
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001380 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001381 are lost without a warning. Also, these values may break autocommands
1382 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383 This option is used together with 'buftype' and 'swapfile' to specify
1384 special kinds of buffers. See |special-buffers|.
1385
1386 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1387'buflisted' 'bl' boolean (default: on)
1388 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 When this option is set, the buffer shows up in the buffer list. If
1390 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1391 This option is reset by Vim for buffers that are only used to remember
1392 a file name or marks. Vim sets it when starting to edit a buffer.
1393 But not when moving to a buffer with ":buffer".
1394
1395 *'buftype'* *'bt'* *E382*
1396'buftype' 'bt' string (default: "")
1397 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 The value of this option specifies the type of a buffer:
1399 <empty> normal buffer
1400 nofile buffer which is not related to a file and will not be
1401 written
1402 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001403 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001404 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001406 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 help help buffer (you are not supposed to set this
1408 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001409 terminal buffer for a |terminal| (you are not supposed to set
1410 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001411 prompt buffer where only the last line can be edited, meant
1412 to be used by a plugin, see |prompt-buffer|
1413 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001414 popup buffer used in a popup window, see |popup|.
1415 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416
1417 This option is used together with 'bufhidden' and 'swapfile' to
1418 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001419 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001420
1421 Be careful with changing this option, it can have many side effects!
1422
Bram Moolenaar280f1262006-01-30 00:14:18 +00001423 A "quickfix" buffer is only used for the error list and the location
1424 list. This value is set by the |:cwindow| and |:lwindow| commands and
1425 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426
1427 "nofile" and "nowrite" buffers are similar:
1428 both: The buffer is not to be written to disk, ":w" doesn't
1429 work (":w filename" does work though).
1430 both: The buffer is never considered to be |'modified'|.
1431 There is no warning when the changes will be lost, for
1432 example when you quit Vim.
1433 both: A swap file is only created when using too much memory
1434 (when 'swapfile' has been reset there is never a swap
1435 file).
1436 nofile only: The buffer name is fixed, it is not handled like a
1437 file name. It is not modified in response to a |:cd|
1438 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001439 both: When using ":e bufname" and already editing "bufname"
1440 the buffer is made empty and autocommands are
1441 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001442 *E676*
1443 "acwrite" implies that the buffer name is not related to a file, like
1444 "nofile", but it will be written. Thus, in contrast to "nofile" and
1445 "nowrite", ":w" does work and a modified buffer can't be abandoned
1446 without saving. For writing there must be matching |BufWriteCmd|,
1447 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
1449 *'casemap'* *'cmp'*
1450'casemap' 'cmp' string (default: "internal,keepascii")
1451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452 Specifies details about changing the case of letters. It may contain
1453 these words, separated by a comma:
1454 internal Use internal case mapping functions, the current
1455 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001456 matters when 'encoding' is a Unicode encoding,
1457 "latin1" or "iso-8859-15". When "internal" is
1458 omitted, the towupper() and towlower() system library
1459 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1461 case mapping, the current locale is not effective.
1462 This probably only matters for Turkish.
1463
1464 *'cdpath'* *'cd'* *E344* *E346*
1465'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1466 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 {not available when compiled without the
1468 |+file_in_path| feature}
1469 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001470 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1471 searched for has a relative path, not an absolute part starting with
1472 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 The 'cdpath' option's value has the same form and semantics as
1474 |'path'|. Also see |file-searching|.
1475 The default value is taken from $CDPATH, with a "," prepended to look
1476 in the current directory first.
1477 If the default value taken from $CDPATH is not what you want, include
1478 a modified version of the following command in your vimrc file to
1479 override it: >
1480 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1481< This option cannot be set from a |modeline| or in the |sandbox|, for
1482 security reasons.
1483 (parts of 'cdpath' can be passed to the shell to expand file names).
1484
1485 *'cedit'*
1486'cedit' string (Vi default: "", Vim default: CTRL-F)
1487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 The key used in Command-line Mode to open the command-line window.
1489 The default is CTRL-F when 'compatible' is off.
1490 Only non-printable keys are allowed.
1491 The key can be specified as a single character, but it is difficult to
1492 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001493 :exe "set cedit=\<C-Y>"
1494 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495< |Nvi| also has this option, but it only uses the first character.
1496 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001497 NOTE: This option is set to the Vim default value when 'compatible'
1498 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499
1500 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1501'charconvert' 'ccv' string (default "")
1502 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001503 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 An expression that is used for character encoding conversion. It is
1505 evaluated when a file that is to be read or has been written has a
1506 different encoding from what is desired.
1507 'charconvert' is not used when the internal iconv() function is
1508 supported and is able to do the conversion. Using iconv() is
1509 preferred, because it is much faster.
1510 'charconvert' is not used when reading stdin |--|, because there is no
1511 file to convert from. You will have to save the text in a file first.
1512 The expression must return zero or an empty string for success,
1513 non-zero for failure.
1514 The possible encoding names encountered are in 'encoding'.
1515 Additionally, names given in 'fileencodings' and 'fileencoding' are
1516 used.
1517 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1518 is done internally by Vim, 'charconvert' is not used for this.
1519 'charconvert' is also used to convert the viminfo file, if the 'c'
1520 flag is present in 'viminfo'. Also used for Unicode conversion.
1521 Example: >
1522 set charconvert=CharConvert()
1523 fun CharConvert()
1524 system("recode "
1525 \ . v:charconvert_from . ".." . v:charconvert_to
1526 \ . " <" . v:fname_in . " >" v:fname_out)
1527 return v:shell_error
1528 endfun
1529< The related Vim variables are:
1530 v:charconvert_from name of the current encoding
1531 v:charconvert_to name of the desired encoding
1532 v:fname_in name of the input file
1533 v:fname_out name of the output file
1534 Note that v:fname_in and v:fname_out will never be the same.
1535 Note that v:charconvert_from and v:charconvert_to may be different
1536 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1537 Encryption is not done by Vim when using 'charconvert'. If you want
1538 to encrypt the file after conversion, 'charconvert' should take care
1539 of this.
1540 This option cannot be set from a |modeline| or in the |sandbox|, for
1541 security reasons.
1542
1543 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1544'cindent' 'cin' boolean (default off)
1545 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 {not available when compiled without the |+cindent|
1547 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001548 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 that trigger reindenting in insert mode and 'cinoptions' to set your
1550 preferred indent style.
1551 If 'indentexpr' is not empty, it overrules 'cindent'.
1552 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1553 the "=" operator indents using this algorithm rather than calling an
1554 external program.
1555 See |C-indenting|.
1556 When you don't like the way 'cindent' works, try the 'smartindent'
1557 option or 'indentexpr'.
1558 This option is not used when 'paste' is set.
1559 NOTE: This option is reset when 'compatible' is set.
1560
1561 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001562'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 {not available when compiled without the |+cindent|
1565 feature}
1566 A list of keys that, when typed in Insert mode, cause reindenting of
1567 the current line. Only used if 'cindent' is on and 'indentexpr' is
1568 empty.
1569 For the format of this option see |cinkeys-format|.
1570 See |C-indenting|.
1571
1572 *'cinoptions'* *'cino'*
1573'cinoptions' 'cino' string (default "")
1574 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575 {not available when compiled without the |+cindent|
1576 feature}
1577 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1578 program. See |cinoptions-values| for the values of this option, and
1579 |C-indenting| for info on C indenting in general.
1580
1581
1582 *'cinwords'* *'cinw'*
1583'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1584 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585 {not available when compiled without both the
1586 |+cindent| and the |+smartindent| features}
1587 These keywords start an extra indent in the next line when
1588 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1589 an appropriate place (inside {}).
1590 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1591 matter, include the keyword both the uppercase and lowercase:
1592 "if,If,IF".
1593
1594 *'clipboard'* *'cb'*
1595'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1596 for X-windows, "" otherwise)
1597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598 {only in GUI versions or when the |+xterm_clipboard|
1599 feature is included}
1600 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001601 Note: if one of the items is "exclude:", then you can't add an item
1602 after that. Therefore do append an item with += but use ^= to
1603 prepend, e.g.: >
1604 set clipboard^=unnamed
1605< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001607 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 unnamed When included, Vim will use the clipboard register '*'
1609 for all yank, delete, change and put operations which
1610 would normally go to the unnamed register. When a
1611 register is explicitly specified, it will always be
1612 used regardless of whether "unnamed" is in 'clipboard'
1613 or not. The clipboard register can always be
1614 explicitly accessed using the "* notation. Also see
1615 |gui-clipboard|.
1616
Bram Moolenaar30b65812012-07-12 22:01:11 +02001617 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001618 unnamedplus A variant of the "unnamed" flag which uses the
1619 clipboard register '+' (|quoteplus|) instead of
1620 register '*' for all yank, delete, change and put
1621 operations which would normally go to the unnamed
1622 register. When "unnamed" is also included to the
1623 option, yank operations (but not delete, change or
1624 put) will additionally copy the text into register
1625 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001626 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001627 Availability can be checked with: >
1628 if has('unnamedplus')
1629<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001630 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 autoselect Works like the 'a' flag in 'guioptions': If present,
1632 then whenever Visual mode is started, or the Visual
1633 area extended, Vim tries to become the owner of the
1634 windowing system's global selection or put the
1635 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001636 register "*. See |'go-a'| and |quotestar| for details.
1637 When the GUI is active, the 'a' flag in 'guioptions'
1638 is used, when the GUI is not active, this "autoselect"
1639 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 Also applies to the modeless selection.
1641
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001642 *clipboard-autoselectplus*
1643 autoselectplus Like "autoselect" but using the + register instead of
1644 the * register. Compare to the 'P' flag in
1645 'guioptions'.
1646
1647 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648 autoselectml Like "autoselect", but for the modeless selection
1649 only. Compare to the 'A' flag in 'guioptions'.
1650
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001651 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001652 html When the clipboard contains HTML, use this when
1653 pasting. When putting text on the clipboard, mark it
1654 as HTML. This works to copy rendered HTML from
1655 Firefox, paste it as raw HTML in Vim, select the HTML
1656 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001657 You probably want to add this only temporarily,
1658 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001659 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001660
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001661 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 exclude:{pattern}
1663 Defines a pattern that is matched against the name of
1664 the terminal 'term'. If there is a match, no
1665 connection will be made to the X server. This is
1666 useful in this situation:
1667 - Running Vim in a console.
1668 - $DISPLAY is set to start applications on another
1669 display.
1670 - You do not want to connect to the X server in the
1671 console, but do want this in a terminal emulator.
1672 To never connect to the X server use: >
1673 exclude:.*
1674< This has the same effect as using the |-X| argument.
1675 Note that when there is no connection to the X server
1676 the window title won't be restored and the clipboard
1677 cannot be accessed.
1678 The value of 'magic' is ignored, {pattern} is
1679 interpreted as if 'magic' was on.
1680 The rest of the option value will be used for
1681 {pattern}, this must be the last entry.
1682
1683 *'cmdheight'* *'ch'*
1684'cmdheight' 'ch' number (default 1)
1685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 Number of screen lines to use for the command-line. Helps avoiding
1687 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001688 The value of this option is stored with the tab page, so that each tab
1689 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001690
1691 *'cmdwinheight'* *'cwh'*
1692'cmdwinheight' 'cwh' number (default 7)
1693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 Number of screen lines to use for the command-line window. |cmdwin|
1695
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001696 *'colorcolumn'* *'cc'*
1697'colorcolumn' 'cc' string (default "")
1698 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001699 {not available when compiled without the |+syntax|
1700 feature}
1701 'colorcolumn' is a comma separated list of screen columns that are
1702 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1703 text. Will make screen redrawing slower.
1704 The screen column can be an absolute number, or a number preceded with
1705 '+' or '-', which is added to or subtracted from 'textwidth'. >
1706
1707 :set cc=+1 " highlight column after 'textwidth'
1708 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1709 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1710<
1711 When 'textwidth' is zero then the items with '-' and '+' are not used.
1712 A maximum of 256 columns are highlighted.
1713
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 *'columns'* *'co'* *E594*
1715'columns' 'co' number (default 80 or terminal width)
1716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001718 initialization and does not have to be set by hand. Also see
1719 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 When Vim is running in the GUI or in a resizable window, setting this
1721 option will cause the window size to be changed. When you only want
1722 to use the size for the GUI, put the command in your |gvimrc| file.
1723 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001724 number of columns of the display, the display may be messed up. For
1725 the GUI it is always possible and Vim limits the number of columns to
1726 what fits on the screen. You can use this command to get the widest
1727 window possible: >
1728 :set columns=9999
1729< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730
1731 *'comments'* *'com'* *E524* *E525*
1732'comments' 'com' string (default
1733 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1734 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 A comma separated list of strings that can start a comment line. See
1736 |format-comments|. See |option-backslash| about using backslashes to
1737 insert a space.
1738
1739 *'commentstring'* *'cms'* *E537*
1740'commentstring' 'cms' string (default "/*%s*/")
1741 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 {not available when compiled without the |+folding|
1743 feature}
1744 A template for a comment. The "%s" in the value is replaced with the
1745 comment text. Currently only used to add markers for folding, see
1746 |fold-marker|.
1747
1748 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001749'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001750 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 This option has the effect of making Vim either more Vi-compatible, or
1753 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001754
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001756 other options are also changed as a side effect.
1757 NOTE: Setting or resetting this option can have a lot of unexpected
1758 effects: Mappings are interpreted in another way, undo behaves
1759 differently, etc. If you set this option in your vimrc file, you
1760 should probably put it at the very start.
1761
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 By default this option is on and the Vi defaults are used for the
1763 options. This default was chosen for those people who want to use Vim
1764 just like Vi, and don't even (want to) know about the 'compatible'
1765 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001766 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001767 this option is switched off, and all options that have not been
1768 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001769 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001770 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001771 happen for the system-wide vimrc or gvimrc file, nor for a file given
1772 with the |-u| argument). Also see |compatible-default| and
1773 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 You can also set this option with the "-C" argument, and reset it with
1775 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001776 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777
Bram Moolenaar214641f2017-03-05 17:04:09 +01001778 When this option is set, numerous other options are set to make Vim as
1779 Vi-compatible as possible. When this option is unset, various options
1780 are set to make Vim more useful. The table below lists all the
1781 options affected.
1782 The {?} column indicates when the options are affected:
1783 + Means that the option is set to the value given in {set value} when
1784 'compatible' is set.
1785 & Means that the option is set to the value given in {set value} when
1786 'compatible' is set AND is set to its Vim default value when
1787 'compatible' is unset.
1788 - Means the option is NOT changed when setting 'compatible' but IS
1789 set to its Vim default when 'compatible' is unset.
1790 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791
Bram Moolenaar036986f2017-03-16 17:41:02 +01001792 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001793
1794 'allowrevins' + off no CTRL-_ command
1795 'antialias' + off don't use antialiased fonts
1796 'arabic' + off reset arabic-related options
1797 'arabicshape' + on correct character shapes
1798 'backspace' + "" normal backspace
1799 'backup' + off no backup file
1800 'backupcopy' & Unix: "yes" backup file is a copy
1801 else: "auto" copy or rename backup file
1802 'balloonexpr' + "" text to show in evaluation balloon
1803 'breakindent' + off don't indent when wrapping lines
1804 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1805 'cindent' + off no C code indentation
1806 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1807 'copyindent' + off don't copy indent structure
1808 'cpoptions' & (all flags) Vi-compatible flags
1809 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001810 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001811 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001812 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001813 'cscopeverbose' + off see |cscopeverbose|
1814 'delcombine' + off unicode: delete whole char combination
1815 'digraph' + off no digraphs
1816 'esckeys' & off no <Esc>-keys in Insert mode
1817 'expandtab' + off tabs not expanded to spaces
1818 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001819 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001820 'formatexpr' + "" use 'formatprg' for auto-formatting
1821 'formatoptions' & "vt" Vi compatible formatting
1822 'gdefault' + off no default 'g' flag for ":s"
1823 'history' & 0 no commandline history
1824 'hkmap' + off no Hebrew keyboard mapping
1825 'hkmapp' + off no phonetic Hebrew keyboard mapping
1826 'hlsearch' + off no highlighting of search matches
1827 'incsearch' + off no incremental searching
1828 'indentexpr' + "" no indenting by expression
1829 'insertmode' + off do not start in Insert mode
1830 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001832 'joinspaces' + on insert 2 spaces after period
1833 'modeline' & off no modelines
1834 'more' & off no pauses in listings
1835 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1836 'numberwidth' & 8 min number of columns for line number
1837 'preserveindent'+ off don't preserve current indent structure
1838 when changing it
1839 'revins' + off no reverse insert
1840 'ruler' + off no ruler
1841 'scrolljump' + 1 no jump scroll
1842 'scrolloff' + 0 no scroll offset
1843 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1844 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001845 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001846 'showcmd' & off command characters not shown
1847 'showmode' & off current mode not shown
1848 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1849 'smartcase' + off no automatic ignore case switch
1850 'smartindent' + off no smart indentation
1851 'smarttab' + off no smart tab size
1852 'softtabstop' + 0 tabs are always 'tabstop' positions
1853 'startofline' + on goto startofline with some commands
1854 'tagcase' & "followic" 'ignorecase' when searching tags file
1855 'tagrelative' & off tag file names are not relative
1856 'termguicolors' + off don't use highlight-(guifg|guibg)
1857 'textauto' & off no automatic textmode detection
1858 'textwidth' + 0 no automatic line wrap
1859 'tildeop' + off tilde is not an operator
1860 'ttimeout' + off no terminal timeout
1861 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001862 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001863 'virtualedit' + "" cursor can only be placed on characters
1864 'whichwrap' & "" left-right movements don't wrap
1865 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001867 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868
1869 *'complete'* *'cpt'* *E535*
1870'complete' 'cpt' string (default: ".,w,b,u,t,i")
1871 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 This option specifies how keyword completion |ins-completion| works
1873 when CTRL-P or CTRL-N are used. It is also used for whole-line
1874 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1875 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001876 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877 w scan buffers from other windows
1878 b scan other loaded buffers that are in the buffer list
1879 u scan the unloaded buffers that are in the buffer list
1880 U scan the buffers that are not in the buffer list
1881 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001882 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 k{dict} scan the file {dict}. Several "k" flags can be given,
1884 patterns are valid too. For example: >
1885 :set cpt=k/usr/dict/*,k~/spanish
1886< s scan the files given with the 'thesaurus' option
1887 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1888 are valid too.
1889 i scan current and included files
1890 d scan current and included files for defined name or macro
1891 |i_CTRL-X_CTRL-D|
1892 ] tag completion
1893 t same as "]"
1894
1895 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1896 not executed, this may lead to unexpected completions from some files
1897 (gzipped files for example). Unloaded buffers are not scanned for
1898 whole-line completion.
1899
1900 The default is ".,w,b,u,t,i", which means to scan:
1901 1. the current buffer
1902 2. buffers in other windows
1903 3. other loaded buffers
1904 4. unloaded buffers
1905 5. tags
1906 6. included files
1907
1908 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001909 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1910 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001912 *'completefunc'* *'cfu'*
1913'completefunc' 'cfu' string (default: empty)
1914 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001915 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001916 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001917 This option specifies a function to be used for Insert mode completion
1918 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001919 See |complete-functions| for an explanation of how the function is
1920 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001921 This option cannot be set from a |modeline| or in the |sandbox|, for
1922 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001923
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001924 *'completeslash'* *'csl'*
1925'completeslash' 'csl' string (default: "")
1926 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001927 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001928 When this option is set it overrules 'shellslash' for completion:
1929 - When this option is set to "slash", a forward slash is used for path
1930 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001931 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001932 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001933 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001934 - When this option is empty, same character is used as for
1935 'shellslash'.
1936 For Insert mode completion the buffer-local value is used. For
1937 command line completion the global value is used.
1938
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001939 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001940'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001941 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001942 A comma separated list of options for Insert mode completion
1943 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001944
1945 menu Use a popup menu to show the possible completions. The
1946 menu is only shown when there is more than one match and
1947 sufficient colors are available. |ins-completion-menu|
1948
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001949 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001950 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001951 match, e.g., what file it comes from.
1952
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001953 longest Only insert the longest common text of the matches. If
1954 the menu is displayed you can use CTRL-L to add more
1955 characters. Whether case is ignored depends on the kind
1956 of completion. For buffer text the 'ignorecase' option is
1957 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001958
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001959 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001960 completion in the preview window. Only works in
1961 combination with "menu" or "menuone".
1962
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001963 popup Show extra information about the currently selected
1964 completion in a popup window. Only works in combination
1965 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001966 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001967 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001968
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001969 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001970 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001971 |CompleteChanged| autocommand to fetch the info and call
1972 |popup_show()| once the popup has been filled.
1973 See the example at |complete-popuphidden|.
1974 {only works when compiled with the |+textprop| feature}
1975
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001976 noinsert Do not insert any text for a match until the user selects
1977 a match from the menu. Only works in combination with
1978 "menu" or "menuone". No effect if "longest" is present.
1979
1980 noselect Do not select a match in the menu, force the user to
1981 select one from the menu. Only works in combination with
1982 "menu" or "menuone".
1983
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001984
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001985 *'completepopup'* *'cpp'*
1986'completepopup' 'cpp' string (default empty)
1987 global
1988 {not available when compiled without the |+textprop|
1989 or |+quickfix| feature}
1990 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001991 properties of the info popup when it is created. If an info popup
1992 window already exists it is closed, so that the option value is
1993 applied when it is created again.
1994 You can also use |popup_findinfo()| and then set properties for an
1995 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001996
1997
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001998 *'concealcursor'* *'cocu'*
1999'concealcursor' 'cocu' string (default: "")
2000 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002001 {not available when compiled without the |+conceal|
2002 feature}
2003 Sets the modes in which text in the cursor line can also be concealed.
2004 When the current mode is listed then concealing happens just like in
2005 other lines.
2006 n Normal mode
2007 v Visual mode
2008 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002009 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002010
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002011 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002012 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002013 are moving around text is concealed, but when starting to insert text
2014 or selecting a Visual area the concealed text is displayed, so that
2015 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002016 Keep in mind that the cursor position is not always where it's
2017 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002018
2019
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002020 *'conceallevel'* *'cole'*
2021'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002022 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002023 {not available when compiled without the |+conceal|
2024 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002025 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2026 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002027
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002028 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002029 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002030 1 Each block of concealed text is replaced with one
2031 character. If the syntax item does not have a custom
2032 replacement character defined (see |:syn-cchar|) the
2033 character defined in 'listchars' is used (default is a
2034 space).
2035 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002036 2 Concealed text is completely hidden unless it has a
2037 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002038 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002039 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002040
Bram Moolenaara7781e02010-07-19 20:13:22 +02002041 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002042 edit and copy the text. This can be changed with the 'concealcursor'
2043 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002044
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2046'confirm' 'cf' boolean (default off)
2047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 When 'confirm' is on, certain operations that would normally
2049 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2050 instead raise a |dialog| asking if you wish to save the current
2051 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2052 If 'confirm' is off you can still activate confirmation for one
2053 command only (this is most useful in mappings) with the |:confirm|
2054 command.
2055 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2056
2057 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2058'conskey' 'consk' boolean (default off)
2059 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002060 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061
2062 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2063'copyindent' 'ci' boolean (default off)
2064 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 Copy the structure of the existing lines indent when autoindenting a
2066 new line. Normally the new indent is reconstructed by a series of
2067 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2068 in which case only spaces are used). Enabling this option makes the
2069 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002070 existing line. 'expandtab' has no effect on these characters, a Tab
2071 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002073 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 Also see 'preserveindent'.
2075
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002076 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002077'cpoptions' 'cpo' string (Vim default: "aABceFs",
2078 Vi default: all flags)
2079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002081 this indicates Vi-compatible behavior. This is used for things where
2082 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 'cpoptions' stands for "compatible-options".
2084 Commas can be added for readability.
2085 To avoid problems with flags that are added in the future, use the
2086 "+=" and "-=" feature of ":set" |add-option-flags|.
2087 NOTE: This option is set to the Vi default value when 'compatible' is
2088 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002089 NOTE: This option is set to the POSIX default value at startup when
2090 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002091 variable exists |posix|. This means Vim tries to behave like the
2092 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093
2094 contains behavior ~
2095 *cpo-a*
2096 a When included, a ":read" command with a file name
2097 argument will set the alternate file name for the
2098 current window.
2099 *cpo-A*
2100 A When included, a ":write" command with a file name
2101 argument will set the alternate file name for the
2102 current window.
2103 *cpo-b*
2104 b "\|" in a ":map" command is recognized as the end of
2105 the map command. The '\' is included in the mapping,
2106 the text after the '|' is interpreted as the next
2107 command. Use a CTRL-V instead of a backslash to
2108 include the '|' in the mapping. Applies to all
2109 mapping, abbreviation, menu and autocmd commands.
2110 See also |map_bar|.
2111 *cpo-B*
2112 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002113 abbreviations, user commands and the "to" part of the
2114 menu commands. Remove this flag to be able to use a
2115 backslash like a CTRL-V. For example, the command
2116 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 'B' included: "\^[" (^[ is a real <Esc>)
2118 'B' excluded: "<Esc>" (5 characters)
2119 ('<' excluded in both cases)
2120 *cpo-c*
2121 c Searching continues at the end of any match at the
2122 cursor position, but not further than the start of the
2123 next line. When not present searching continues
2124 one character from the cursor position. With 'c'
2125 "abababababab" only gets three matches when repeating
2126 "/abab", without 'c' there are five matches.
2127 *cpo-C*
2128 C Do not concatenate sourced lines that start with a
2129 backslash. See |line-continuation|.
2130 *cpo-d*
2131 d Using "./" in the 'tags' option doesn't mean to use
2132 the tags file relative to the current file, but the
2133 tags file in the current directory.
2134 *cpo-D*
2135 D Can't use CTRL-K to enter a digraph after Normal mode
2136 commands with a character argument, like |r|, |f| and
2137 |t|.
2138 *cpo-e*
2139 e When executing a register with ":@r", always add a
2140 <CR> to the last line, also when the register is not
2141 linewise. If this flag is not present, the register
2142 is not linewise and the last line does not end in a
2143 <CR>, then the last line is put on the command-line
2144 and can be edited before hitting <CR>.
2145 *cpo-E*
2146 E It is an error when using "y", "d", "c", "g~", "gu" or
2147 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002148 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 This makes "y0" fail in the first column.
2150 *cpo-f*
2151 f When included, a ":read" command with a file name
2152 argument will set the file name for the current buffer,
2153 if the current buffer doesn't have a file name yet.
2154 *cpo-F*
2155 F When included, a ":write" command with a file name
2156 argument will set the file name for the current
2157 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002158 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 *cpo-g*
2160 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002161 *cpo-H*
2162 H When using "I" on a line with only blanks, insert
2163 before the last blank. Without this flag insert after
2164 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 *cpo-i*
2166 i When included, interrupting the reading of a file will
2167 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002168 *cpo-I*
2169 I When moving the cursor up or down just after inserting
2170 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 *cpo-j*
2172 j When joining lines, only add two spaces after a '.',
2173 not after '!' or '?'. Also see 'joinspaces'.
2174 *cpo-J*
2175 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002176 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 white space.
2178 *cpo-k*
2179 k Disable the recognition of raw key codes in
2180 mappings, abbreviations, and the "to" part of menu
2181 commands. For example, if <Key> sends ^[OA (where ^[
2182 is <Esc>), the command ":map X ^[OA" results in X
2183 being mapped to:
2184 'k' included: "^[OA" (3 characters)
2185 'k' excluded: "<Key>" (one key code)
2186 Also see the '<' flag below.
2187 *cpo-K*
2188 K Don't wait for a key code to complete when it is
2189 halfway a mapping. This breaks mapping <F1><F1> when
2190 only part of the second <F1> has been read. It
2191 enables cancelling the mapping by typing <F1><Esc>.
2192 *cpo-l*
2193 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002194 literally, only "\]", "\^", "\-" and "\\" are special.
2195 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2197 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002198 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 *cpo-L*
2200 L When the 'list' option is set, 'wrapmargin',
2201 'textwidth', 'softtabstop' and Virtual Replace mode
2202 (see |gR|) count a <Tab> as two characters, instead of
2203 the normal behavior of a <Tab>.
2204 *cpo-m*
2205 m When included, a showmatch will always wait half a
2206 second. When not included, a showmatch will wait half
2207 a second or until a character is typed. |'showmatch'|
2208 *cpo-M*
2209 M When excluded, "%" matching will take backslashes into
2210 account. Thus in "( \( )" and "\( ( \)" the outer
2211 parenthesis match. When included "%" ignores
2212 backslashes, which is Vi compatible.
2213 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002214 n When included, the column used for 'number' and
2215 'relativenumber' will also be used for text of wrapped
2216 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 *cpo-o*
2218 o Line offset to search command is not remembered for
2219 next search.
2220 *cpo-O*
2221 O Don't complain if a file is being overwritten, even
2222 when it didn't exist when editing it. This is a
2223 protection against a file unexpectedly created by
2224 someone else. Vi didn't complain about this.
2225 *cpo-p*
2226 p Vi compatible Lisp indenting. When not present, a
2227 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002228 *cpo-P*
2229 P When included, a ":write" command that appends to a
2230 file will set the file name for the current buffer, if
2231 the current buffer doesn't have a file name yet and
2232 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002233 *cpo-q*
2234 q When joining multiple lines leave the cursor at the
2235 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 *cpo-r*
2237 r Redo ("." command) uses "/" to repeat a search
2238 command, instead of the actually used search string.
2239 *cpo-R*
2240 R Remove marks from filtered lines. Without this flag
2241 marks are kept like |:keepmarks| was used.
2242 *cpo-s*
2243 s Set buffer options when entering the buffer for the
2244 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002245 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 set when the buffer is created.
2247 *cpo-S*
2248 S Set buffer options always when entering a buffer
2249 (except 'readonly', 'fileformat', 'filetype' and
2250 'syntax'). This is the (most) Vi compatible setting.
2251 The options are set to the values in the current
2252 buffer. When you change an option and go to another
2253 buffer, the value is copied. Effectively makes the
2254 buffer options global to all buffers.
2255
2256 's' 'S' copy buffer options
2257 no no when buffer created
2258 yes no when buffer first entered (default)
2259 X yes each time when buffer entered (vi comp.)
2260 *cpo-t*
2261 t Search pattern for the tag command is remembered for
2262 "n" command. Otherwise Vim only puts the pattern in
2263 the history for search pattern, but doesn't change the
2264 last used search pattern.
2265 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002266 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 *cpo-v*
2268 v Backspaced characters remain visible on the screen in
2269 Insert mode. Without this flag the characters are
2270 erased from the screen right away. With this flag the
2271 screen newly typed text overwrites backspaced
2272 characters.
2273 *cpo-w*
2274 w When using "cw" on a blank character, only change one
2275 character and not all blanks until the start of the
2276 next word.
2277 *cpo-W*
2278 W Don't overwrite a readonly file. When omitted, ":w!"
2279 overwrites a readonly file, if possible.
2280 *cpo-x*
2281 x <Esc> on the command-line executes the command-line.
2282 The default in Vim is to abandon the command-line,
2283 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002284 *cpo-X*
2285 X When using a count with "R" the replaced text is
2286 deleted only once. Also when repeating "R" with "."
2287 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002289 y A yank command can be redone with ".". Think twice if
2290 you really want to use this, it may break some
2291 plugins, since most people expect "." to only repeat a
2292 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002293 *cpo-Z*
2294 Z When using "w!" while the 'readonly' option is set,
2295 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 *cpo-!*
2297 ! When redoing a filter command, use the last used
2298 external command, whatever it was. Otherwise the last
2299 used -filter- command is used.
2300 *cpo-$*
2301 $ When making a change to one line, don't redisplay the
2302 line, but put a '$' at the end of the changed text.
2303 The changed text will be overwritten when you type the
2304 new text. The line is redisplayed if you type any
2305 command that moves the cursor from the insertion
2306 point.
2307 *cpo-%*
2308 % Vi-compatible matching is done for the "%" command.
2309 Does not recognize "#if", "#endif", etc.
2310 Does not recognize "/*" and "*/".
2311 Parens inside single and double quotes are also
2312 counted, causing a string that contains a paren to
2313 disturb the matching. For example, in a line like
2314 "if (strcmp("foo(", s))" the first paren does not
2315 match the last one. When this flag is not included,
2316 parens inside single and double quotes are treated
2317 specially. When matching a paren outside of quotes,
2318 everything inside quotes is ignored. When matching a
2319 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002320 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002321 This flag is also used for other features, such as
2322 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002323 *cpo--*
2324 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002325 it would go above the first line or below the last
2326 line. Without it the cursor moves to the first or
2327 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002328 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002329 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002330 *cpo-+*
2331 + When included, a ":write file" command will reset the
2332 'modified' flag of the buffer, even though the buffer
2333 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002334 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 * Use ":*" in the same way as ":@". When not included,
2336 ":*" is an alias for ":'<,'>", select the Visual area.
2337 *cpo-<*
2338 < Disable the recognition of special key codes in |<>|
2339 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002340 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 ":map X <Tab>" results in X being mapped to:
2342 '<' included: "<Tab>" (5 characters)
2343 '<' excluded: "^I" (^I is a real <Tab>)
2344 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002345 *cpo->*
2346 > When appending to a register, put a line break before
2347 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002348 *cpo-;*
2349 ; When using |,| or |;| to repeat the last |t| search
2350 and the cursor is right in front of the searched
2351 character, the cursor won't move. When not included,
2352 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002353 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002354
2355 POSIX flags. These are not included in the Vi default value, except
2356 when $VIM_POSIX was set on startup. |posix|
2357
2358 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002359 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002360 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002361 *cpo-&*
2362 & When ":preserve" was used keep the swap file when
2363 exiting normally while this buffer is still loaded.
2364 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002365 *cpo-\*
2366 \ Backslash in a [] range in a search pattern is taken
2367 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002368 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2369 '\' excluded: "/[ \-]" finds <Space> and '-'
2370 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002371 *cpo-/*
2372 / When "%" is used as the replacement string in a |:s|
2373 command, use the previous replacement string. |:s%|
2374 *cpo-{*
2375 { The |{| and |}| commands also stop at a "{" character
2376 at the start of a line.
2377 *cpo-.*
2378 . The ":chdir" and ":cd" commands fail if the current
2379 buffer is modified, unless ! is used. Vim doesn't
2380 need this, since it remembers the full path of an
2381 opened file.
2382 *cpo-bar*
2383 | The value of the $LINES and $COLUMNS environment
2384 variables overrule the terminal size values obtained
2385 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002386
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002388 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002389'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002390 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002391 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002392 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002393 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002394 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002395 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002396 blowfish Blowfish method. Medium strong encryption but it has
2397 an implementation flaw. Requires Vim 7.3 or later,
2398 files can NOT be read by Vim 7.2 and older. This adds
2399 a "seed" to the file, every time you write the file
2400 the encrypted bytes will be different.
2401 *blowfish2*
2402 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002403 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002404 and older. This adds a "seed" to the file, every time
2405 you write the file the encrypted bytes will be
2406 different. The whole undo file is encrypted, not just
2407 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002408 *E1193* *E1194* *E1195* *E1196*
2409 *E1197* *E1198* *E1199* *E1200* *E1201*
2410 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2411 Code. Medium strong till strong encryption.
2412 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002413 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002414 It adds a seed and a message authentication code (MAC)
2415 to the file. This needs at least a Vim 8.2.3022 to
2416 read the encrypted file.
2417 Encryption of swap files is not supported, therefore
2418 no swap file will be used when xchacha20 encryption is
2419 enabled.
2420 Encryption of undo files is not yet supported,
2421 therefore no undo file will currently be written.
2422 CURRENTLY EXPERIMENTAL: Files written with this method
2423 might have to be read back with the same version of
2424 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002425
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002426 You should use "blowfish2", also to re-encrypt older files.
2427
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002428 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002429 to the detected method of the file being read. Thus if you write it
2430 without changing 'cryptmethod' the same method will be used.
2431 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002432 explicitly write it, you don't get a warning unless there are other
2433 modifications. Also see |:X|.
2434
2435 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002436 the value "blowfish2". When setting the local value to an empty
2437 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002438
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002439 When a new encryption method is added in a later version of Vim, and
2440 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002441 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002442
2443
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 *'cscopepathcomp'* *'cspc'*
2445'cscopepathcomp' 'cspc' number (default 0)
2446 global
2447 {not available when compiled without the |+cscope|
2448 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 Determines how many components of the path to show in a list of tags.
2450 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002451 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452
2453 *'cscopeprg'* *'csprg'*
2454'cscopeprg' 'csprg' string (default "cscope")
2455 global
2456 {not available when compiled without the |+cscope|
2457 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 Specifies the command to execute cscope. See |cscopeprg|.
2459 This option cannot be set from a |modeline| or in the |sandbox|, for
2460 security reasons.
2461
2462 *'cscopequickfix'* *'csqf'*
2463'cscopequickfix' 'csqf' string (default "")
2464 global
2465 {not available when compiled without the |+cscope|
2466 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 Specifies whether to use quickfix window to show cscope results.
2468 See |cscopequickfix|.
2469
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002470 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002471'cscoperelative' 'csre' boolean (default off)
2472 global
2473 {not available when compiled without the |+cscope|
2474 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002475 In the absence of a prefix (-P) for cscope. setting this option enables
2476 to use the basename of cscope.out path as the prefix.
2477 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002478 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002479
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2481'cscopetag' 'cst' boolean (default off)
2482 global
2483 {not available when compiled without the |+cscope|
2484 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 Use cscope for tag commands. See |cscope-options|.
2486 NOTE: This option is reset when 'compatible' is set.
2487
2488 *'cscopetagorder'* *'csto'*
2489'cscopetagorder' 'csto' number (default 0)
2490 global
2491 {not available when compiled without the |+cscope|
2492 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 Determines the order in which ":cstag" performs a search. See
2494 |cscopetagorder|.
2495 NOTE: This option is set to 0 when 'compatible' is set.
2496
2497 *'cscopeverbose'* *'csverb'*
2498 *'nocscopeverbose'* *'nocsverb'*
2499'cscopeverbose' 'csverb' boolean (default off)
2500 global
2501 {not available when compiled without the |+cscope|
2502 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 Give messages when adding a cscope database. See |cscopeverbose|.
2504 NOTE: This option is reset when 'compatible' is set.
2505
Bram Moolenaar860cae12010-06-05 23:22:07 +02002506 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2507'cursorbind' 'crb' boolean (default off)
2508 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002509 When this option is set, as the cursor in the current
2510 window moves other cursorbound windows (windows that also have
2511 this option set) move their cursors to the corresponding line and
2512 column. This option is useful for viewing the
2513 differences between two versions of a file (see 'diff'); in diff mode,
2514 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002515 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002516
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002517
2518 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2519'cursorcolumn' 'cuc' boolean (default off)
2520 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002521 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002522 feature}
2523 Highlight the screen column of the cursor with CursorColumn
2524 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2525 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002526 If you only want the highlighting in the current window you can use
2527 these autocommands: >
2528 au WinLeave * set nocursorline nocursorcolumn
2529 au WinEnter * set cursorline cursorcolumn
2530<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002531
2532 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2533'cursorline' 'cul' boolean (default off)
2534 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002535 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002536 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002537 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2538 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002539 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002540 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002541
2542
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002543 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002544'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002545 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002546 {not available when compiled without the |+syntax|
2547 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002548 Comma separated list of settings for how 'cursorline' is displayed.
2549 Valid values:
2550 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002551 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002552 "screenline" Highlight only the screen line of the cursor with
2553 CursorLine |hl-CursorLine|.
2554 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002555 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002556
2557 Special value:
2558 "both" Alias for the values "line,number".
2559
2560 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002561
2562
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 *'debug'*
2564'debug' string (default "")
2565 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002566 These values can be used:
2567 msg Error messages that would otherwise be omitted will be given
2568 anyway.
2569 throw Error messages that would otherwise be omitted will be given
2570 anyway and also throw an exception and set |v:errmsg|.
2571 beep A message will be given when otherwise only a beep would be
2572 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002573 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002574 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2575 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576
2577 *'define'* *'def'*
2578'define' 'def' string (default "^\s*#\s*define")
2579 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002580 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 pattern, just like for the "/" command. This option is used for the
2582 commands like "[i" and "[d" |include-search|. The 'isident' option is
2583 used to recognize the defined name after the match:
2584 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2585 See |option-backslash| about inserting backslashes to include a space
2586 or backslash.
2587 The default value is for C programs. For C++ this value would be
2588 useful, to include const type declarations: >
2589 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002590< You can also use "\ze" just before the name and continue the pattern
2591 to check what is following. E.g. for Javascript, if a function is
2592 defined with "func_name = function(args)": >
2593 ^\s*\ze\i\+\s*=\s*function(
2594< If the function is defined with "func_name : function() {...": >
2595 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002597 To avoid that use `:let` with a single quote string: >
2598 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002599<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600
2601 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2602'delcombine' 'deco' boolean (default off)
2603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 If editing Unicode and this option is set, backspace and Normal mode
2605 "x" delete each combining character on its own. When it is off (the
2606 default) the character along with its combining characters are
2607 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002608 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609
2610 This is useful for Arabic, Hebrew and many other languages where one
2611 may have combining characters overtop of base characters, and want
2612 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002613 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614
2615 *'dictionary'* *'dict'*
2616'dictionary' 'dict' string (default "")
2617 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 List of file names, separated by commas, that are used to lookup words
2619 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2620 contain a list of words. This can be one word per line, or several
2621 words per line, separated by non-keyword characters (white space is
2622 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002623
2624 When this option is empty or an entry "spell" is present, and spell
2625 checking is enabled, words in the word lists for the currently active
2626 'spelllang' are used. See |spell|.
2627
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002628 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 after a comma are ignored, otherwise spaces are included in the file
2630 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002631 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 Where to find a list of words?
2633 - On FreeBSD, there is the file "/usr/share/dict/words".
2634 - In the Simtel archive, look in the "msdos/linguist" directory.
2635 - In "miscfiles" of the GNU collection.
2636 The use of |:set+=| and |:set-=| is preferred when adding or removing
2637 directories from the list. This avoids problems when a future version
2638 uses another default.
2639 Backticks cannot be used in this option for security reasons.
2640
2641 *'diff'* *'nodiff'*
2642'diff' boolean (default off)
2643 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 {not available when compiled without the |+diff|
2645 feature}
2646 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002647 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648
2649 *'dex'* *'diffexpr'*
2650'diffexpr' 'dex' string (default "")
2651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 {not available when compiled without the |+diff|
2653 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002654 Expression which is evaluated to obtain a diff file (either ed-style
2655 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 This option cannot be set from a |modeline| or in the |sandbox|, for
2657 security reasons.
2658
2659 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002660'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 {not available when compiled without the |+diff|
2663 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002664 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 All are optional. Items must be separated by a comma.
2666
2667 filler Show filler lines, to keep the text
2668 synchronized with a window that has inserted
2669 lines at the same position. Mostly useful
2670 when windows are side-by-side and 'scrollbind'
2671 is set.
2672
2673 context:{n} Use a context of {n} lines between a change
2674 and a fold that contains unchanged lines.
2675 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002676 When using zero the context is actually one,
2677 since folds require a line in between, also
2678 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 See |fold-diff|.
2680
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002681 iblank Ignore changes where lines are all blank. Adds
2682 the "-B" flag to the "diff" command if
2683 'diffexpr' is empty. Check the documentation
2684 of the "diff" command for what this does
2685 exactly.
2686 NOTE: the diff windows will get out of sync,
2687 because no differences between blank lines are
2688 taken into account.
2689
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 icase Ignore changes in case of text. "a" and "A"
2691 are considered the same. Adds the "-i" flag
2692 to the "diff" command if 'diffexpr' is empty.
2693
2694 iwhite Ignore changes in amount of white space. Adds
2695 the "-b" flag to the "diff" command if
2696 'diffexpr' is empty. Check the documentation
2697 of the "diff" command for what this does
2698 exactly. It should ignore adding trailing
2699 white space, but not leading white space.
2700
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002701 iwhiteall Ignore all white space changes. Adds
2702 the "-w" flag to the "diff" command if
2703 'diffexpr' is empty. Check the documentation
2704 of the "diff" command for what this does
2705 exactly.
2706
2707 iwhiteeol Ignore white space changes at end of line.
2708 Adds the "-Z" flag to the "diff" command if
2709 'diffexpr' is empty. Check the documentation
2710 of the "diff" command for what this does
2711 exactly.
2712
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002713 horizontal Start diff mode with horizontal splits (unless
2714 explicitly specified otherwise).
2715
2716 vertical Start diff mode with vertical splits (unless
2717 explicitly specified otherwise).
2718
Bram Moolenaarc8234772019-11-10 21:00:27 +01002719 closeoff When a window is closed where 'diff' is set
2720 and there is only one window remaining in the
2721 same tab page with 'diff' set, execute
2722 `:diffoff` in that window. This undoes a
2723 `:diffsplit` command.
2724
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002725 hiddenoff Do not use diff mode for a buffer when it
2726 becomes hidden.
2727
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002728 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2729 starting diff mode. Without this 2 is used.
2730
Bram Moolenaar4223d432021-02-10 13:18:17 +01002731 followwrap Follow the 'wrap' option and leave as it is.
2732
Bram Moolenaare828b762018-09-10 17:51:58 +02002733 internal Use the internal diff library. This is
2734 ignored when 'diffexpr' is set. *E960*
2735 When running out of memory when writing a
2736 buffer this item will be ignored for diffs
2737 involving that buffer. Set the 'verbose'
2738 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739
Bram Moolenaare828b762018-09-10 17:51:58 +02002740 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002741 Use the indent heuristic for the internal
2742 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002743
2744 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002745 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002746 algorithms are:
2747 myers the default algorithm
2748 minimal spend extra time to generate the
2749 smallest possible diff
2750 patience patience diff algorithm
2751 histogram histogram diff algorithm
2752
2753 Examples: >
2754 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002756 :set diffopt=internal,filler,foldcolumn:3
2757 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758<
2759 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2760'digraph' 'dg' boolean (default off)
2761 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 {not available when compiled without the |+digraphs|
2763 feature}
2764 Enable the entering of digraphs in Insert mode with {char1} <BS>
2765 {char2}. See |digraphs|.
2766 NOTE: This option is reset when 'compatible' is set.
2767
2768 *'directory'* *'dir'*
2769'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002770 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 for Unix: ".,~/tmp,/var/tmp,/tmp")
2772 global
2773 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002774 Recommended value: ".,~/vimswap//" - this will put the swap file next
2775 to the edited file if possible, and in your personal swap directory
2776 otherwise. Make sure "~/vimswap//" is only readable for you.
2777
2778 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 - The swap file will be created in the first directory where this is
2780 possible.
2781 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002782 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 - A directory "." means to put the swap file in the same directory as
2784 the edited file. On Unix, a dot is prepended to the file name, so
2785 it doesn't show in a directory listing. On MS-Windows the "hidden"
2786 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002787 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2788 the swap file relative to where the edited file is. The leading "."
2789 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002790 - For Unix and Win32, if a directory ends in two path separators "//",
2791 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002792 with all path separators replaced by percent '%' signs (including
2793 the colon following the drive letter on Win32). This will ensure
2794 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002795 On Win32, it is also possible to end with "\\". However, When a
2796 separating comma is following, you must use "//", since "\\" will
2797 include the comma in the file name. Therefore it is recommended to
2798 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 - Spaces after the comma are ignored, other spaces are considered part
2800 of the directory name. To have a space at the start of a directory
2801 name, precede it with a backslash.
2802 - To include a comma in a directory name precede it with a backslash.
2803 - A directory name may end in an ':' or '/'.
2804 - Environment variables are expanded |:set_env|.
2805 - Careful with '\' characters, type one before a space, type two to
2806 get one in the option (see |option-backslash|), for example: >
2807 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2808< - For backwards compatibility with Vim version 3.0 a '>' at the start
2809 of the option is removed.
2810 Using "." first in the list is recommended. This means that editing
2811 the same file twice will result in a warning. Using "/tmp" on Unix is
2812 discouraged: When the system crashes you lose the swap file.
2813 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002814 choice than "/tmp". But others on the computer may be able to see the
2815 files, and it can contain a lot of files, your swap files get lost in
2816 the crowd. That is why a "tmp" directory in your home directory is
2817 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 The use of |:set+=| and |:set-=| is preferred when adding or removing
2819 directories from the list. This avoids problems when a future version
2820 uses another default.
2821 This option cannot be set from a |modeline| or in the |sandbox|, for
2822 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823
2824 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002825'display' 'dy' string (default "", set to "truncate" in
2826 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 Change the way text is displayed. This is comma separated list of
2829 flags:
2830 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002831 in a window will be displayed. "@@@" is put in the
2832 last columns of the last screen line to indicate the
2833 rest of the line is not displayed.
2834 truncate Like "lastline", but "@@@" is displayed in the first
2835 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 uhex Show unprintable characters hexadecimal as <xx>
2837 instead of using ^C and ~C.
2838
Bram Moolenaard0796902016-09-16 20:02:31 +02002839 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002840 doesn't fit is replaced with "@" lines.
2841
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 *'eadirection'* *'ead'*
2843'eadirection' 'ead' string (default "both")
2844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 Tells when the 'equalalways' option applies:
2846 ver vertically, width of windows is not affected
2847 hor horizontally, height of windows is not affected
2848 both width and height of windows is affected
2849
2850 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2851'edcompatible' 'ed' boolean (default off)
2852 global
2853 Makes the 'g' and 'c' flags of the ":substitute" command to be
2854 toggled each time the flag is given. See |complex-change|. See
2855 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002856 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002857 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858
Bram Moolenaar03413f42016-04-12 21:07:15 +02002859 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002860'emoji' 'emo' boolean (default: on)
2861 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002862 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002863 This excludes "text emoji" characters, which are normally displayed as
2864 single width. Unfortunately there is no good specification for this
2865 and it has been determined on trial-and-error basis. Use the
2866 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002867
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002869'encoding' 'enc' string (default for MS-Windows: "utf-8",
2870 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 Sets the character encoding used inside Vim. It applies to text in
2873 the buffers, registers, Strings in expressions, text stored in the
2874 viminfo file, etc. It sets the kind of characters which Vim can work
2875 with. See |encoding-names| for the possible values.
2876
2877 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002878 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002880 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881
Bram Moolenaar865242e2010-07-14 21:12:05 +02002882 This option cannot be set from a |modeline|. It would most likely
2883 corrupt the text.
2884
Bram Moolenaar3df01732017-02-17 22:47:16 +01002885 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2886 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 'encoding', "utf-8" is the natural choice for the environment and
2888 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002889 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 versions, and to avoid changing the encoding of newly created files
2891 without your knowledge (in case 'fileencodings' is empty).
2892
2893 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002894 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 iconv() or as specified with 'charconvert'.
2896
Bram Moolenaar207f0092020-08-30 17:20:20 +02002897 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002898 can use: >
2899 if has("multi_byte_encoding")
2900<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 Normally 'encoding' will be equal to your current locale. This will
2902 be the default if Vim recognizes your environment settings. If
2903 'encoding' is not set to the current locale, 'termencoding' must be
2904 set to convert typed and displayed text. See |encoding-table|.
2905
2906 When you set this option, it fires the |EncodingChanged| autocommand
2907 event so that you can set up fonts if necessary.
2908
2909 When the option is set, the value is converted to lowercase. Thus
2910 you can set it with uppercase values too. Underscores are translated
2911 to '-' signs.
2912 When the encoding is recognized, it is changed to the standard name.
2913 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2914 "iso-8859-2" and "utf8" becomes "utf-8".
2915
2916 Note: "latin1" is also used when the encoding could not be detected.
2917 This only works when editing files in the same encoding! When the
2918 actual character set is not latin1, make sure 'fileencoding' and
2919 'fileencodings' are empty. When conversion is needed, switch to using
2920 utf-8.
2921
2922 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2923 You don't notice this while editing, but it does matter for the
2924 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2925 setting 'encoding' to one of these values instead of utf-8 only has
2926 effect for encoding used for files when 'fileencoding' is empty.
2927
Bram Moolenaar661b1822005-07-28 22:36:45 +00002928 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2929 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930
2931 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2932'endofline' 'eol' boolean (default on)
2933 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002935 is on, or 'fixeol' option is off, no <EOL> will be written for the
2936 last line in the file. This option is automatically set or reset when
2937 starting to edit a new file, depending on whether file has an <EOL>
2938 for the last line in the file. Normally you don't have to set or
2939 reset this option.
2940 When 'binary' is off and 'fixeol' is on the value is not used when
2941 writing the file. When 'binary' is on or 'fixeol' is off it is used
2942 to remember the presence of a <EOL> for the last line in the file, so
2943 that when you write the file the situation from the original file can
2944 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945
2946 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2947'equalalways' 'ea' boolean (default on)
2948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002950 splitting or closing a window. This also happens the moment the
2951 option is switched on. When off, splitting a window will reduce the
2952 size of the current window and leave the other windows the same. When
2953 closing a window the extra lines are given to the window next to it
2954 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 When mixing vertically and horizontally split windows, a minimal size
2956 is computed and some windows may be larger if there is room. The
2957 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002958 Changing the height and width of a window can be avoided by setting
2959 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002960 If a window size is specified when creating a new window sizes are
2961 currently not equalized (it's complicated, but may be implemented in
2962 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963
2964 *'equalprg'* *'ep'*
2965'equalprg' 'ep' string (default "")
2966 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002968 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002969 or 'indentexpr'. When Vim was compiled without internal formatting,
2970 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002971 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 about including spaces and backslashes.
2973 This option cannot be set from a |modeline| or in the |sandbox|, for
2974 security reasons.
2975
2976 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2977'errorbells' 'eb' boolean (default off)
2978 global
2979 Ring the bell (beep or screen flash) for error messages. This only
2980 makes a difference for error messages, the bell will be used always
2981 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002982 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002983 screen flash or do nothing. See 'belloff' to finetune when to ring the
2984 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985
2986 *'errorfile'* *'ef'*
2987'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2988 others: "errors.err")
2989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 {not available when compiled without the |+quickfix|
2991 feature}
2992 Name of the errorfile for the QuickFix mode (see |:cf|).
2993 When the "-q" command-line argument is used, 'errorfile' is set to the
2994 following argument. See |-q|.
2995 NOT used for the ":make" command. See 'makeef' for that.
2996 Environment variables are expanded |:set_env|.
2997 See |option-backslash| about including spaces and backslashes.
2998 This option cannot be set from a |modeline| or in the |sandbox|, for
2999 security reasons.
3000
3001 *'errorformat'* *'efm'*
3002'errorformat' 'efm' string (default is very long)
3003 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 {not available when compiled without the |+quickfix|
3005 feature}
3006 Scanf-like description of the format for the lines in the error file
3007 (see |errorformat|).
3008
3009 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3010'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 Function keys that start with an <Esc> are recognized in Insert
3013 mode. When this option is off, the cursor and function keys cannot be
3014 used in Insert mode if they start with an <Esc>. The advantage of
3015 this is that the single <Esc> is recognized immediately, instead of
3016 after one second. Instead of resetting this option, you might want to
3017 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3018 when 'esckeys' is off, you can still map anything, but the cursor keys
3019 won't work by default.
3020 NOTE: This option is set to the Vi default value when 'compatible' is
3021 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003022 NOTE: when this option is off then the |modifyOtherKeys| functionality
3023 is disabled while in Insert mode to avoid ending Insert mode with any
3024 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025
3026 *'eventignore'* *'ei'*
3027'eventignore' 'ei' string (default "")
3028 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003030 When set to "all" or when "all" is one of the items, all autocommand
3031 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 Otherwise this is a comma separated list of event names. Example: >
3033 :set ei=WinEnter,WinLeave
3034<
3035 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3036'expandtab' 'et' boolean (default off)
3037 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003039 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3041 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003042 This option is reset when the 'paste' option is set and restored when
3043 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 NOTE: This option is reset when 'compatible' is set.
3045
3046 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3047'exrc' 'ex' boolean (default off)
3048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003050 directory.
3051
3052 Setting this option is a potential security leak. E.g., consider
3053 unpacking a package or fetching files from github, a .vimrc in there
3054 might be a trojan horse. BETTER NOT SET THIS OPTION!
3055 Instead, define an autocommand in your .vimrc to set options for a
3056 matching directory.
3057
3058 If you do switch this option on you should also consider setting the
3059 'secure' option (see |initialization|).
3060 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 This option cannot be set from a |modeline| or in the |sandbox|, for
3062 security reasons.
3063
3064 *'fileencoding'* *'fenc'* *E213*
3065'fileencoding' 'fenc' string (default: "")
3066 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003068
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003070 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 When 'fileencoding' is empty, the same value as 'encoding' will be
3072 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003073 No error will be given when the value is set, only when it is used,
3074 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003075 Conversion will also be done when 'encoding' and 'fileencoding' are
3076 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3077 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003079 'encoding' is "utf-8" or another Unicode encoding, conversion
3080 is most likely done in a way that the reverse conversion
3081 results in the same text. When 'encoding' is not "utf-8" some
3082 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003083
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 See 'encoding' for the possible values. Additionally, values may be
3085 specified that can be handled by the converter, see
3086 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003087
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 When reading a file 'fileencoding' will be set from 'fileencodings'.
3089 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003090 'fileencoding', use the |++enc| argument. One exception: when
3091 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003092 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003093
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3095 When the option is set, the value is converted to lowercase. Thus
3096 you can set it with uppercase values too. '_' characters are
3097 replaced with '-'. If a name is recognized from the list for
3098 'encoding', it is replaced by the standard name. For example
3099 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003100
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 When this option is set, after starting to edit a file, the 'modified'
3102 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003103
3104 Keep in mind that changing 'fenc' from a modeline happens
3105 AFTER the text has been read, thus it applies to when the file will be
3106 written. If you do set 'fenc' in a modeline, you might want to set
3107 'nomodified' to avoid not being able to ":q".
3108
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 This option can not be changed when 'modifiable' is off.
3110
3111 *'fe'*
3112 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003113 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 old short name was 'fe', which is no longer used.
3115
3116 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003117'fileencodings' 'fencs' string (default: "ucs-bom",
3118 "ucs-bom,utf-8,default,latin1" when
3119 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 This is a list of character encodings considered when starting to edit
3122 an existing file. When a file is read, Vim tries to use the first
3123 mentioned character encoding. If an error is detected, the next one
3124 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003125 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 an empty string, which means the value of 'encoding' is used.
3127 WARNING: Conversion can cause loss of information! When
3128 'encoding' is "utf-8" (or one of the other Unicode variants)
3129 conversion is most likely done in a way that the reverse
3130 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003131 "utf-8" some non-ASCII characters may be lost! You can use
3132 the |++bad| argument to specify what is done with characters
3133 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 For an empty file or a file with only ASCII characters most encodings
3135 will work and the first entry of 'fileencodings' will be used (except
3136 "ucs-bom", which requires the BOM to be present). If you prefer
3137 another encoding use an BufReadPost autocommand event to test if your
3138 preferred encoding is to be used. Example: >
3139 au BufReadPost * if search('\S', 'w') == 0 |
3140 \ set fenc=iso-2022-jp | endif
3141< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3142 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003143 When the |++enc| argument is used then the value of 'fileencodings' is
3144 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003145 Note that 'fileencodings' is not used for a new file, the global value
3146 of 'fileencoding' is used instead. You can set it with: >
3147 :setglobal fenc=iso-8859-2
3148< This means that a non-existing file may get a different encoding than
3149 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 The special value "ucs-bom" can be used to check for a Unicode BOM
3151 (Byte Order Mark) at the start of the file. It must not be preceded
3152 by "utf-8" or another Unicode encoding for this to work properly.
3153 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3154 because Vim cannot detect an error, thus the encoding is always
3155 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003156 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003157 environment. On MS-Windows this is the system encoding. Otherwise
3158 this is the default value for 'encoding'. It is useful when
3159 'encoding' is set to "utf-8" and your environment uses a non-latin1
3160 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003161 When 'encoding' is "utf-8" and a file contains an illegal byte
3162 sequence it won't be recognized as UTF-8. You can use the |8g8|
3163 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 WRONG VALUES: WHAT'S WRONG:
3165 latin1,utf-8 "latin1" will always be used
3166 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3167 file
3168 cp1250,latin1 "cp1250" will always be used
3169 If 'fileencodings' is empty, 'fileencoding' is not modified.
3170 See 'fileencoding' for the possible values.
3171 Setting this option does not have an effect until the next time a file
3172 is read.
3173
3174 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003175'fileformat' 'ff' string (MS-Windows default: "dos",
3176 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 This gives the <EOL> of the current buffer, which is used for
3179 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003180 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 unix <NL>
3182 mac <CR>
3183 When "dos" is used, CTRL-Z at the end of a file is ignored.
3184 See |file-formats| and |file-read|.
3185 For the character encoding of the file see 'fileencoding'.
3186 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003187 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 This option is set automatically when starting to edit a file and
3189 'fileformats' is not empty and 'binary' is off.
3190 When this option is set, after starting to edit a file, the 'modified'
3191 option is set, because the file would be different when written.
3192 This option can not be changed when 'modifiable' is off.
3193 For backwards compatibility: When this option is set to "dos",
3194 'textmode' is set, otherwise 'textmode' is reset.
3195
3196 *'fileformats'* *'ffs'*
3197'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003198 Vim+Vi MS-Windows: "dos,unix",
3199 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 Vi Cygwin: "unix,dos",
3201 Vi others: "")
3202 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 This gives the end-of-line (<EOL>) formats that will be tried when
3204 starting to edit a new buffer and when reading a file into an existing
3205 buffer:
3206 - When empty, the format defined with 'fileformat' will be used
3207 always. It is not set automatically.
3208 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003209 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 'fileformats' name will be used when a file is read into an existing
3211 buffer, no matter what 'fileformat' for that buffer is set to.
3212 - When more than one name is present, separated by commas, automatic
3213 <EOL> detection will be done when reading a file. When starting to
3214 edit a file, a check is done for the <EOL>:
3215 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3216 'fileformat' is set to "dos".
3217 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003218 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003220 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3221 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003222 This means that "mac" is only chosen when:
3223 "unix" is not present or no <NL> is found in the file, and
3224 "dos" is not present or no <CR><NL> is found in the file.
3225 Except: if "unix" was chosen, but there is a <CR> before
3226 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003227 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 4. If 'fileformat' is still not set, the first name from
3229 'fileformats' is used.
3230 When reading a file into an existing buffer, the same is done, but
3231 this happens like 'fileformat' has been set appropriately for that
3232 file only, the option is not changed.
3233 When 'binary' is set, the value of 'fileformats' is not used.
3234
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003235 When Vim starts up with an empty buffer the first item is used. You
3236 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003237
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3239 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3240 done:
3241 - When 'fileformats' is empty, there is no automatic detection. Dos
3242 format will be used.
3243 - When 'fileformats' is set to one or more names, automatic detection
3244 is done. This is based on the first <NL> in the file: If there is a
3245 <CR> in front of it, Dos format is used, otherwise Unix format is
3246 used.
3247 Also see |file-formats|.
3248 For backwards compatibility: When this option is set to an empty
3249 string or one format (no comma is included), 'textauto' is reset,
3250 otherwise 'textauto' is set.
3251 NOTE: This option is set to the Vi default value when 'compatible' is
3252 set and to the Vim default value when 'compatible' is reset.
3253
Bram Moolenaarbf884932013-04-05 22:26:15 +02003254 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3255'fileignorecase' 'fic' boolean (default on for systems where case in file
3256 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003257 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003258 When set case is ignored when using file names and directories.
3259 See 'wildignorecase' for only ignoring case when doing completion.
3260
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 *'filetype'* *'ft'*
3262'filetype' 'ft' string (default: "")
3263 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 When this option is set, the FileType autocommand event is triggered.
3265 All autocommands that match with the value of this option will be
3266 executed. Thus the value of 'filetype' is used in place of the file
3267 name.
3268 Otherwise this option does not always reflect the current file type.
3269 This option is normally set when the file type is detected. To enable
3270 this use the ":filetype on" command. |:filetype|
3271 Setting this option to a different value is most useful in a modeline,
3272 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003273 Example, for in an IDL file:
3274 /* vim: set filetype=idl : */ ~
3275 |FileType| |filetypes|
3276 When a dot appears in the value then this separates two filetype
3277 names. Example:
3278 /* vim: set filetype=c.doxygen : */ ~
3279 This will use the "c" filetype first, then the "doxygen" filetype.
3280 This works both for filetype plugins and for syntax files. More than
3281 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 This option is not copied to another buffer, independent of the 's' or
3283 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003284 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285
3286 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003287'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003289 {not available when compiled without the |+folding|
3290 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 Characters to fill the statuslines and vertical separators.
3292 It is a comma separated list of items:
3293
3294 item default Used for ~
3295 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003296 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 vert:c '|' vertical separators |:vsplit|
3298 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003299 foldopen:c '-' mark the beginning of a fold
3300 foldclose:c '+' show a closed fold
3301 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003303 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003305 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003306 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 otherwise.
3308
3309 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003310 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311< This is similar to the default, except that these characters will also
3312 be used when there is highlighting.
3313
Bram Moolenaar008bff92021-03-04 21:55:58 +01003314 For "stl" and "stlnc" single-byte and multibyte characters are
3315 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003316
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 The highlighting used for these items:
3318 item highlight group ~
3319 stl:c StatusLine |hl-StatusLine|
3320 stlnc:c StatusLineNC |hl-StatusLineNC|
3321 vert:c VertSplit |hl-VertSplit|
3322 fold:c Folded |hl-Folded|
3323 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003324 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003326 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3327'fixendofline' 'fixeol' boolean (default on)
3328 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003329 When writing a file and this option is on, <EOL> at the end of file
3330 will be restored if missing. Turn this option off if you want to
3331 preserve the situation from the original file.
3332 When the 'binary' option is set the value of this option doesn't
3333 matter.
3334 See the 'endofline' option.
3335
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003337'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 {only available when compiled with the |+rightleft|
3340 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003341 This option was for using Farsi, which has been removed. See
3342 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343
3344 *'foldclose'* *'fcl'*
3345'foldclose' 'fcl' string (default "")
3346 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 {not available when compiled without the |+folding|
3348 feature}
3349 When set to "all", a fold is closed when the cursor isn't in it and
3350 its level is higher than 'foldlevel'. Useful if you want folds to
3351 automatically close when moving out of them.
3352
3353 *'foldcolumn'* *'fdc'*
3354'foldcolumn' 'fdc' number (default 0)
3355 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 {not available when compiled without the |+folding|
3357 feature}
3358 When non-zero, a column with the specified width is shown at the side
3359 of the window which indicates open and closed folds. The maximum
3360 value is 12.
3361 See |folding|.
3362
3363 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3364'foldenable' 'fen' boolean (default on)
3365 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 {not available when compiled without the |+folding|
3367 feature}
3368 When off, all folds are open. This option can be used to quickly
3369 switch between showing all text unfolded and viewing the text with
3370 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003371 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 'foldenable' is off.
3373 This option is set by commands that create a new fold or close a fold.
3374 See |folding|.
3375
3376 *'foldexpr'* *'fde'*
3377'foldexpr' 'fde' string (default: "0")
3378 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003380 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003382 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003383
Bram Moolenaar30b65812012-07-12 22:01:11 +02003384 The expression will be evaluated in the |sandbox| if set from a
3385 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003386 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003387 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003388
3389 It is not allowed to change text or jump to another window while
3390 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391
3392 *'foldignore'* *'fdi'*
3393'foldignore' 'fdi' string (default: "#")
3394 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 {not available when compiled without the |+folding|
3396 feature}
3397 Used only when 'foldmethod' is "indent". Lines starting with
3398 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003399 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 The default "#" works well for C programs. See |fold-indent|.
3401
3402 *'foldlevel'* *'fdl'*
3403'foldlevel' 'fdl' number (default: 0)
3404 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 {not available when compiled without the |+folding|
3406 feature}
3407 Sets the fold level: Folds with a higher level will be closed.
3408 Setting this option to zero will close all folds. Higher numbers will
3409 close fewer folds.
3410 This option is set by commands like |zm|, |zM| and |zR|.
3411 See |fold-foldlevel|.
3412
3413 *'foldlevelstart'* *'fdls'*
3414'foldlevelstart' 'fdls' number (default: -1)
3415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 {not available when compiled without the |+folding|
3417 feature}
3418 Sets 'foldlevel' when starting to edit another buffer in a window.
3419 Useful to always start editing with all folds closed (value zero),
3420 some folds closed (one) or no folds closed (99).
3421 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003422 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 ignores this option and closes all folds.
3424 It is also done before BufReadPre autocommands, to allow an autocmd to
3425 overrule the 'foldlevel' value for specific files.
3426 When the value is negative, it is not used.
3427
3428 *'foldmarker'* *'fmr'* *E536*
3429'foldmarker' 'fmr' string (default: "{{{,}}}")
3430 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 {not available when compiled without the |+folding|
3432 feature}
3433 The start and end marker used when 'foldmethod' is "marker". There
3434 must be one comma, which separates the start and end marker. The
3435 marker is a literal string (a regular expression would be too slow).
3436 See |fold-marker|.
3437
3438 *'foldmethod'* *'fdm'*
3439'foldmethod' 'fdm' string (default: "manual")
3440 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 {not available when compiled without the |+folding|
3442 feature}
3443 The kind of folding used for the current window. Possible values:
3444 |fold-manual| manual Folds are created manually.
3445 |fold-indent| indent Lines with equal indent form a fold.
3446 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3447 |fold-marker| marker Markers are used to specify folds.
3448 |fold-syntax| syntax Syntax highlighting items specify folds.
3449 |fold-diff| diff Fold text that is not changed.
3450
3451 *'foldminlines'* *'fml'*
3452'foldminlines' 'fml' number (default: 1)
3453 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 {not available when compiled without the |+folding|
3455 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003456 Sets the number of screen lines above which a fold can be displayed
3457 closed. Also for manually closed folds. With the default value of
3458 one a fold can only be closed if it takes up two or more screen lines.
3459 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003460 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 "zc" to close a fold, which is displayed open because it's smaller
3462 than 'foldminlines', a following "zc" may close a containing fold.
3463
3464 *'foldnestmax'* *'fdn'*
3465'foldnestmax' 'fdn' number (default: 20)
3466 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 {not available when compiled without the |+folding|
3468 feature}
3469 Sets the maximum nesting of folds for the "indent" and "syntax"
3470 methods. This avoids that too many folds will be created. Using more
3471 than 20 doesn't work, because the internal limit is 20.
3472
3473 *'foldopen'* *'fdo'*
3474'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3475 search,tag,undo")
3476 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 {not available when compiled without the |+folding|
3478 feature}
3479 Specifies for which type of commands folds will be opened, if the
3480 command moves the cursor into a closed fold. It is a comma separated
3481 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003482 NOTE: When the command is part of a mapping this option is not used.
3483 Add the |zv| command to the mapping to get the same effect.
3484 (rationale: the mapping may want to control opening folds itself)
3485
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 item commands ~
3487 all any
3488 block "(", "{", "[[", "[{", etc.
3489 hor horizontal movements: "l", "w", "fx", etc.
3490 insert any command in Insert mode
3491 jump far jumps: "G", "gg", etc.
3492 mark jumping to a mark: "'m", CTRL-O, etc.
3493 percent "%"
3494 quickfix ":cn", ":crew", ":make", etc.
3495 search search for a pattern: "/", "n", "*", "gd", etc.
3496 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003497 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 tag jumping to a tag: ":ta", CTRL-T, etc.
3499 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 When a movement command is used for an operator (e.g., "dl" or "y%")
3501 this option is not used. This means the operator will include the
3502 whole closed fold.
3503 Note that vertical movements are not here, because it would make it
3504 very difficult to move onto a closed fold.
3505 In insert mode the folds containing the cursor will always be open
3506 when text is inserted.
3507 To close folds you can re-apply 'foldlevel' with the |zx| command or
3508 set the 'foldclose' option to "all".
3509
3510 *'foldtext'* *'fdt'*
3511'foldtext' 'fdt' string (default: "foldtext()")
3512 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 {not available when compiled without the |+folding|
3514 feature}
3515 An expression which is used to specify the text displayed for a closed
3516 fold. See |fold-foldtext|.
3517
Bram Moolenaar30b65812012-07-12 22:01:11 +02003518 The expression will be evaluated in the |sandbox| if set from a
3519 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003520 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003521
3522 It is not allowed to change text or jump to another window while
3523 evaluating 'foldtext' |textlock|.
3524
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003525 *'formatexpr'* *'fex'*
3526'formatexpr' 'fex' string (default "")
3527 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003528 {not available when compiled without the |+eval|
3529 feature}
3530 Expression which is evaluated to format a range of lines for the |gq|
3531 operator or automatic formatting (see 'formatoptions'). When this
3532 option is empty 'formatprg' is used.
3533
3534 The |v:lnum| variable holds the first line to be formatted.
3535 The |v:count| variable holds the number of lines to be formatted.
3536 The |v:char| variable holds the character that is going to be
3537 inserted if the expression is being evaluated due to
3538 automatic formatting. This can be empty. Don't insert
3539 it yet!
3540
3541 Example: >
3542 :set formatexpr=mylang#Format()
3543< This will invoke the mylang#Format() function in the
3544 autoload/mylang.vim file in 'runtimepath'. |autoload|
3545
3546 The expression is also evaluated when 'textwidth' is set and adding
3547 text beyond that limit. This happens under the same conditions as
3548 when internal formatting is used. Make sure the cursor is kept in the
3549 same spot relative to the text then! The |mode()| function will
3550 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003551
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003552 When the expression evaluates to non-zero Vim will fall back to using
3553 the internal format mechanism.
3554
3555 The expression will be evaluated in the |sandbox| when set from a
3556 modeline, see |sandbox-option|. That stops the option from working,
3557 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003558 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003559 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003560
Bram Moolenaar86b68352004-12-27 21:59:20 +00003561 *'formatlistpat'* *'flp'*
3562'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3563 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003564 A pattern that is used to recognize a list header. This is used for
3565 the "n" flag in 'formatoptions'.
3566 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003567 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003568 while still checking more characters. There must be a character
3569 following the pattern, when it matches the whole line it is handled
3570 like there is no match.
3571 The default recognizes a number, followed by an optional punctuation
3572 character and white space.
3573
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003574 *'formatoptions'* *'fo'*
3575'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3576 local to buffer
3577 This is a sequence of letters which describes how automatic
3578 formatting is to be done. See |fo-table|. When the 'paste' option is
3579 on, no formatting is done (like 'formatoptions' is empty). Commas can
3580 be inserted for readability.
3581 To avoid problems with flags that are added in the future, use the
3582 "+=" and "-=" feature of ":set" |add-option-flags|.
3583 NOTE: This option is set to the Vi default value when 'compatible' is
3584 set and to the Vim default value when 'compatible' is reset.
3585
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 *'formatprg'* *'fp'*
3587'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003588 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003590 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003592 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003593 If the 'formatexpr' option is not empty it will be used instead.
3594 Otherwise, if 'formatprg' option is an empty string, the internal
3595 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003596 Environment variables are expanded |:set_env|. See |option-backslash|
3597 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003598 This option cannot be set from a |modeline| or in the |sandbox|, for
3599 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600
Bram Moolenaard94464e2015-11-02 15:28:18 +01003601 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003602'fsync' 'fs' boolean (default on)
3603 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003604 When on, the library function fsync() will be called after writing a
3605 file. This will flush a file to disk, ensuring that it is safely
3606 written even on filesystems which do metadata-only journaling. This
3607 will force the harddrive to spin up on Linux systems running in laptop
3608 mode, so it may be undesirable in some situations. Be warned that
3609 turning this off increases the chances of data loss after a crash. On
3610 systems without an fsync() implementation, this variable is always
3611 off.
3612 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003613 'fsync' also applies to |writefile()| (unless a flag is used to
3614 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003615 This option cannot be set from a |modeline| or in the |sandbox|, for
3616 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003617
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3619'gdefault' 'gd' boolean (default off)
3620 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 When on, the ":substitute" flag 'g' is default on. This means that
3622 all matches in a line are substituted instead of one. When a 'g' flag
3623 is given to a ":substitute" command, this will toggle the substitution
3624 of all or one match. See |complex-change|.
3625
3626 command 'gdefault' on 'gdefault' off ~
3627 :s/// subst. all subst. one
3628 :s///g subst. one subst. all
3629 :s///gg subst. all subst. one
3630
3631 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003632 DEPRECATED: Setting this option may break plugins that are not aware
3633 of this option. Also, many users get confused that adding the /g flag
3634 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003635 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636
3637 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003638'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 Format to recognize for the ":grep" command output.
3641 This is a scanf-like string that uses the same format as the
3642 'errorformat' option: see |errorformat|.
3643
3644 *'grepprg'* *'gp'*
3645'grepprg' 'gp' string (default "grep -n ",
3646 Unix: "grep -n $* /dev/null",
3647 Win32: "findstr /n" or "grep -n",
3648 VMS: "SEARCH/NUMBERS ")
3649 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003650 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 and '#' characters, which are expanded like when used in a command-
3652 line. The placeholder "$*" is allowed to specify where the arguments
3653 will be included. Environment variables are expanded |:set_env|. See
3654 |option-backslash| about including spaces and backslashes.
3655 When your "grep" accepts the "-H" argument, use this to make ":grep"
3656 also work well with a single file: >
3657 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003658< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003659 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3660 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003661 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 apply equally to 'grepprg'.
3663 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3664 otherwise it's "grep -n".
3665 This option cannot be set from a |modeline| or in the |sandbox|, for
3666 security reasons.
3667
3668 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3669'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3670 ve:ver35-Cursor,
3671 o:hor50-Cursor,
3672 i-ci:ver25-Cursor/lCursor,
3673 r-cr:hor20-Cursor/lCursor,
3674 sm:block-Cursor
3675 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003676 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 "n-v-c:block,o:hor50,i-ci:hor15,
3678 r-cr:hor30,sm:block")
3679 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003681 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003683 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003684 height of the cursor can be changed. This can be done by specifying a
3685 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003686 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3687 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003689 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 mode-list and an argument-list:
3691 mode-list:argument-list,mode-list:argument-list,..
3692 The mode-list is a dash separated list of these modes:
3693 n Normal mode
3694 v Visual mode
3695 ve Visual mode with 'selection' "exclusive" (same as 'v',
3696 if not specified)
3697 o Operator-pending mode
3698 i Insert mode
3699 r Replace mode
3700 c Command-line Normal (append) mode
3701 ci Command-line Insert mode
3702 cr Command-line Replace mode
3703 sm showmatch in Insert mode
3704 a all modes
3705 The argument-list is a dash separated list of these arguments:
3706 hor{N} horizontal bar, {N} percent of the character height
3707 ver{N} vertical bar, {N} percent of the character width
3708 block block cursor, fills the whole character
3709 [only one of the above three should be present]
3710 blinkwait{N} *cursor-blinking*
3711 blinkon{N}
3712 blinkoff{N}
3713 blink times for cursor: blinkwait is the delay before
3714 the cursor starts blinking, blinkon is the time that
3715 the cursor is shown and blinkoff is the time that the
3716 cursor is not shown. The times are in msec. When one
3717 of the numbers is zero, there is no blinking. The
3718 default is: "blinkwait700-blinkon400-blinkoff250".
3719 These numbers are used for a missing entry. This
3720 means that blinking is enabled by default. To switch
3721 blinking off you can use "blinkon0". The cursor only
3722 blinks when Vim is waiting for input, not while
3723 executing a command.
3724 To make the cursor blink in an xterm, see
3725 |xterm-blink|.
3726 {group-name}
3727 a highlight group name, that sets the color and font
3728 for the cursor
3729 {group-name}/{group-name}
3730 Two highlight group names, the first is used when
3731 no language mappings are used, the other when they
3732 are. |language-mapping|
3733
3734 Examples of parts:
3735 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3736 block cursor with colors from the "nCursor"
3737 highlight group
3738 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3739 In Insert and Command-line Insert mode, use a
3740 30% vertical bar cursor with colors from the
3741 "iCursor" highlight group. Blink a bit
3742 faster.
3743
3744 The 'a' mode is different. It will set the given argument-list for
3745 all modes. It does not reset anything to defaults. This can be used
3746 to do a common setting for all modes. For example, to switch off
3747 blinking: "a:blinkon0"
3748
3749 Examples of cursor highlighting: >
3750 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3751 :highlight Cursor gui=NONE guifg=bg guibg=fg
3752<
3753 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003754 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755'guifont' 'gfn' string (default "")
3756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 {only available when compiled with GUI enabled}
3758 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003759 In its simplest form the value is just one font name.
3760 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761
3762 *'guifontset'* *'gfs'*
3763 *E250* *E252* *E234* *E597* *E598*
3764'guifontset' 'gfs' string (default "")
3765 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 {only available when compiled with GUI enabled and
3767 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003768 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 When not empty, specifies two (or more) fonts to be used. The first
3770 one for normal English, the second one for your special language. See
3771 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003772
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3774'guifontwide' 'gfw' string (default "")
3775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 {only available when compiled with GUI enabled}
3777 When not empty, specifies a comma-separated list of fonts to be used
3778 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003779 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003780
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 *'guiheadroom'* *'ghr'*
3782'guiheadroom' 'ghr' number (default 50)
3783 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003784 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 The number of pixels subtracted from the screen height when fitting
3786 the GUI window on the screen. Set this before the GUI is started,
3787 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003788 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 lines will be left for window decorations and other items on the
3790 screen. Set it to a negative value to allow windows taller than the
3791 screen.
3792
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003793 *'guiligatures'* *'gli'* *E1243*
3794'guiligatures' 'gli' string (default "")
3795 global
3796 {only for GTK GUI}
3797 List of ASCII characters that, when combined together, can create more
3798 complex shapes. Each character must be a printable ASCII character
3799 with a value in the 32-127 range.
3800 Example: >
3801 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3802< Changing this option updates screen output immediately. Set it to an
3803 empty string to disable ligatures.
3804
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003806'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3807 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003808 "aegimrLtT" (GTK, Motif and Athena),
3809 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003812 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 sequence of letters which describes what components and options of the
3814 GUI should be used.
3815 To avoid problems with flags that are added in the future, use the
3816 "+=" and "-=" feature of ":set" |add-option-flags|.
3817
Bram Moolenaar13568252018-03-16 20:46:58 +01003818 Valid characters are as follows:
3819 *'go-!'*
3820 '!' External commands are executed in a terminal window. Without
3821 this flag the MS-Windows GUI will open a console window to
3822 execute the command. The Unix GUI will simulate a dumb
3823 terminal to list the command output.
3824 The terminal window will be positioned at the bottom, and grow
3825 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003826 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 'a' Autoselect: If present, then whenever VISUAL mode is started,
3828 or the Visual area extended, Vim tries to become the owner of
3829 the windowing system's global selection. This means that the
3830 Visually highlighted text is available for pasting into other
3831 applications as well as into Vim itself. When the Visual mode
3832 ends, possibly due to an operation on the text, or when an
3833 application wants to paste the selection, the highlighted text
3834 is automatically yanked into the "* selection register.
3835 Thus the selection is still available for pasting into other
3836 applications after the VISUAL mode has ended.
3837 If not present, then Vim won't become the owner of the
3838 windowing system's global selection unless explicitly told to
3839 by a yank or delete operation for the "* register.
3840 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003841 *'go-P'*
3842 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003843 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003844 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003845 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 applies to the modeless selection.
3847
3848 'guioptions' autoselect Visual autoselect modeless ~
3849 "" - -
3850 "a" yes yes
3851 "A" - yes
3852 "aA" yes yes
3853
Bram Moolenaar02467872007-05-06 13:22:01 +00003854 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 'c' Use console dialogs instead of popup dialogs for simple
3856 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003857 *'go-d'*
3858 'd' Use dark theme variant if available. Currently only works for
3859 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003860 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003861 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003862 'guitablabel' can be used to change the text in the labels.
3863 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003864 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003865 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003866 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 'f' Foreground: Don't use fork() to detach the GUI from the shell
3868 where it was started. Use this for programs that wait for the
3869 editor to finish (e.g., an e-mail program). Alternatively you
3870 can use "gvim -f" or ":gui -f" to start the GUI in the
3871 foreground. |gui-fork|
3872 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003873 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003874 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3876 corner of the window. It's black&white on non-GTK, because of
3877 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003878 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003880 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003881 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003883 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003885 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003886 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 'g' Grey menu items: Make menu items that are not active grey. If
3888 'g' is not included inactive menu items are not shown at all.
3889 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003890 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 't' Include tearoff menu items. Currently only works for Win32,
3892 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003893 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003894 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003895 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003896 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003898 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 'R' Right-hand scrollbar is present when there is a vertically
3900 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003901 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003903 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 'L' Left-hand scrollbar is present when there is a vertically
3905 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003906 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3908 the longest visible line, or on the cursor line if the 'h'
3909 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003910 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 'h' Limit horizontal scrollbar size to the length of the cursor
3912 line. Reduces computations. |gui-horiz-scroll|
3913
3914 And yes, you may even have scrollbars on the left AND the right if
3915 you really want to :-). See |gui-scrollbars| for more information.
3916
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003917 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 'v' Use a vertical button layout for dialogs. When not included,
3919 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003920 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003921 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 'p' Use Pointer callbacks for X11 GUI. This is required for some
3923 window managers. If the cursor is not blinking or hollow at
3924 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003925 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003927 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003928 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003929 *'go-k'*
3930 'k' Keep the GUI window size when adding/removing a scrollbar, or
3931 toolbar, tabline, etc. Instead, the behavior is similar to
3932 when the window is maximized and will adjust 'lines' and
3933 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003934 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003935 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003936
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 *'guipty'* *'noguipty'*
3938'guipty' boolean (default on)
3939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 {only available when compiled with GUI enabled}
3941 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3942 I/O to/from shell commands. See |gui-pty|.
3943
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003944 *'guitablabel'* *'gtl'*
3945'guitablabel' 'gtl' string (default empty)
3946 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003947 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003948 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003949 pages line. When empty and when the result is empty Vim will use a
3950 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003951
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003952 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003953 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003954 The expression will be evaluated in the |sandbox| when set from a
3955 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003956 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003957
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003958 Only used when the GUI tab pages line is displayed. 'e' must be
3959 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3960 used.
3961
Bram Moolenaar57657d82006-04-21 22:12:41 +00003962 *'guitabtooltip'* *'gtt'*
3963'guitabtooltip' 'gtt' string (default empty)
3964 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003965 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003966 When nonempty describes the text to use in a tooltip for the GUI tab
3967 pages line. When empty Vim will use a default tooltip.
3968 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003969 You can include a line break. Simplest method is to use |:let|: >
3970 :let &guitabtooltip = "line one\nline two"
3971<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003972
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003974'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 (others) "$VIMRUNTIME/doc/help.txt")
3976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 Name of the main help file. All distributed help files should be
3978 placed together in one directory. Additionally, all "doc" directories
3979 in 'runtimepath' will be used.
3980 Environment variables are expanded |:set_env|. For example:
3981 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003982 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 spaces and backslashes.
3984 This option cannot be set from a |modeline| or in the |sandbox|, for
3985 security reasons.
3986
3987 *'helpheight'* *'hh'*
3988'helpheight' 'hh' number (default 20)
3989 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 Minimal initial height of the help window when it is opened with the
3991 ":help" command. The initial height of the help window is half of the
3992 current window, or (when the 'ea' option is on) the same as other
3993 windows. When the height is less than 'helpheight', the height is
3994 set to 'helpheight'. Set to zero to disable.
3995
3996 *'helplang'* *'hlg'*
3997'helplang' 'hlg' string (default: messages language or empty)
3998 global
3999 {only available when compiled with the |+multi_lang|
4000 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 Comma separated list of languages. Vim will use the first language
4002 for which the desired help can be found. The English help will always
4003 be used as a last resort. You can add "en" to prefer English over
4004 another language, but that will only find tags that exist in that
4005 language and not in the English help.
4006 Example: >
4007 :set helplang=de,it
4008< This will first search German, then Italian and finally English help
4009 files.
4010 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4011 try to find the tag in the current language before using this option.
4012 See |help-translated|.
4013
4014 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4015'hidden' 'hid' boolean (default off)
4016 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 When off a buffer is unloaded when it is |abandon|ed. When on a
4018 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4019 displayed in another window, it does not become hidden, of course.
4020 The commands that move through the buffer list sometimes make a buffer
4021 hidden although the 'hidden' option is off: When the buffer is
4022 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004023 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004024 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 This option is set for one command with ":hide {command}" |:hide|.
4026 WARNING: It's easy to forget that you have changes in hidden buffers.
4027 Think twice when using ":q!" or ":qa!".
4028
4029 *'highlight'* *'hl'*
4030'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004031 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4032 d:Directory,e:ErrorMsg,i:IncSearch,
4033 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004034 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004035 N:CursorLineNr,r:Question,s:StatusLine,
4036 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004037 v:Visual,V:VisualNOS,w:WarningMsg,
4038 W:WildMenu,f:Folded,F:FoldColumn,
4039 A:DiffAdd,C:DiffChange,D:DiffDelete,
4040 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004041 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004042 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004043 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4044 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004045 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004046 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 This option can be used to set highlighting mode for various
4049 occasions. It is a comma separated list of character pairs. The
4050 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004051 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004053 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4054 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 characters from 'showbreak'
4056 |hl-Directory| d directories in CTRL-D listing and other special
4057 things in listings
4058 |hl-ErrorMsg| e error messages
4059 h (obsolete, ignored)
4060 |hl-IncSearch| i 'incsearch' highlighting
4061 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4062 |hl-MoreMsg| m |more-prompt|
4063 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004064 |hl-LineNr| n line number for ":number" and ":#" commands, and
4065 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004066 |hl-LineNrAbove| a line number above the cursor for when the
4067 'relativenumber' option is set.
4068 |hl-LineNrBelow| b line number below the cursor for when the
4069 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004070 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4071 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 |hl-Question| r |hit-enter| prompt and yes/no questions
4073 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004074 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4076 |hl-VertSplit| c column used to separate vertically split windows
4077 |hl-Visual| v Visual mode
4078 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4079 Selection" Only X11 Gui's |gui-x11| and
4080 |xterm-clipboard|.
4081 |hl-WarningMsg| w warning messages
4082 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4083 |hl-Folded| f line used for closed folds
4084 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004085 |hl-DiffAdd| A added line in diff mode
4086 |hl-DiffChange| C changed line in diff mode
4087 |hl-DiffDelete| D deleted line in diff mode
4088 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004090 |hl-Conceal| - the placeholders used for concealed characters
4091 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004092 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004093 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004094 |hl-SpellRare| R rare word |spell|
4095 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004096 |hl-Pmenu| + popup menu normal line
4097 |hl-PmenuSel| = popup menu selected line
4098 |hl-PmenuSbar| x popup menu scrollbar
4099 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100
4101 The display modes are:
4102 r reverse (termcap entry "mr" and "me")
4103 i italic (termcap entry "ZH" and "ZR")
4104 b bold (termcap entry "md" and "me")
4105 s standout (termcap entry "so" and "se")
4106 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004107 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004108 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 n no highlighting
4110 - no highlighting
4111 : use a highlight group
4112 The default is used for occasions that are not included.
4113 If you want to change what the display modes do, see |dos-colors|
4114 for an example.
4115 When using the ':' display mode, this must be followed by the name of
4116 a highlight group. A highlight group can be used to define any type
4117 of highlighting, including using color. See |:highlight| on how to
4118 define one. The default uses a different group for each occasion.
4119 See |highlight-default| for the default highlight groups.
4120
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004122'history' 'hi' number (Vim default: 50, Vi default: 0,
4123 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004126 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004128 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 NOTE: This option is set to the Vi default value when 'compatible' is
4130 set and to the Vim default value when 'compatible' is reset.
4131
4132 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4133'hkmap' 'hk' boolean (default off)
4134 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 {only available when compiled with the |+rightleft|
4136 feature}
4137 When on, the keyboard is mapped for the Hebrew character set.
4138 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4139 toggle this option. See |rileft.txt|.
4140 NOTE: This option is reset when 'compatible' is set.
4141
4142 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4143'hkmapp' 'hkp' boolean (default off)
4144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 {only available when compiled with the |+rightleft|
4146 feature}
4147 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4148 This is useful if you have a non-Hebrew keyboard.
4149 See |rileft.txt|.
4150 NOTE: This option is reset when 'compatible' is set.
4151
Bram Moolenaar036986f2017-03-16 17:41:02 +01004152 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4153'hlsearch' 'hls' boolean (default off)
4154 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004155 {not available when compiled without the
4156 |+extra_search| feature}
4157 When there is a previous search pattern, highlight all its matches.
4158 The type of highlighting used can be set with the 'l' occasion in the
4159 'highlight' option. This uses the "Search" highlight group by
4160 default. Note that only the matching text is highlighted, any offsets
4161 are not applied.
4162 See also: 'incsearch' and |:match|.
4163 When you get bored looking at the highlighted matches, you can turn it
4164 off with |:nohlsearch|. This does not change the option value, as
4165 soon as you use a search command, the highlighting comes back.
4166 'redrawtime' specifies the maximum time spent on finding matches.
4167 When the search pattern can match an end-of-line, Vim will try to
4168 highlight all of the matched text. However, this depends on where the
4169 search starts. This will be the first line in the window or the first
4170 line below a closed fold. A match in a previous line which is not
4171 drawn may not continue in a newly drawn line.
4172 You can specify whether the highlight status is restored on startup
4173 with the 'h' flag in 'viminfo' |viminfo-h|.
4174 NOTE: This option is reset when 'compatible' is set.
4175
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 *'icon'* *'noicon'*
4177'icon' boolean (default off, on when title can be restored)
4178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 {not available when compiled without the |+title|
4180 feature}
4181 When on, the icon text of the window will be set to the value of
4182 'iconstring' (if it is not empty), or to the name of the file
4183 currently being edited. Only the last part of the name is used.
4184 Overridden by the 'iconstring' option.
4185 Only works if the terminal supports setting window icons (currently
4186 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4187 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4188 builtin termcap).
4189 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004190 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004192 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193
4194 *'iconstring'*
4195'iconstring' string (default "")
4196 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 {not available when compiled without the |+title|
4198 feature}
4199 When this option is not empty, it will be used for the icon text of
4200 the window. This happens only when the 'icon' option is on.
4201 Only works if the terminal supports setting window icon text
4202 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004203 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 When Vim was compiled with HAVE_X11 defined, the original icon will be
4205 restored if possible |X11|.
4206 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004207 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004209 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 {not available when compiled without the |+statusline| feature}
4211
4212 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4213'ignorecase' 'ic' boolean (default off)
4214 global
4215 Ignore case in search patterns. Also used when searching in the tags
4216 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004217 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 Can be overruled by using "\c" or "\C" in the pattern, see
4219 |/ignorecase|.
4220
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004221 *'imactivatefunc'* *'imaf'*
4222'imactivatefunc' 'imaf' string (default "")
4223 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004224 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004225 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004226 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004227 The expression will be evaluated in the |sandbox| when set from a
4228 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004229
4230 Example: >
4231 function ImActivateFunc(active)
4232 if a:active
4233 ... do something
4234 else
4235 ... do something
4236 endif
4237 " return value is not used
4238 endfunction
4239 set imactivatefunc=ImActivateFunc
4240<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241 *'imactivatekey'* *'imak'*
4242'imactivatekey' 'imak' string (default "")
4243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004245 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 Specifies the key that your Input Method in X-Windows uses for
4247 activation. When this is specified correctly, vim can fully control
4248 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4249 You can't use this option to change the activation key, the option
4250 tells Vim what the key is.
4251 Format:
4252 [MODIFIER_FLAG-]KEY_STRING
4253
4254 These characters can be used for MODIFIER_FLAG (case is ignored):
4255 S Shift key
4256 L Lock key
4257 C Control key
4258 1 Mod1 key
4259 2 Mod2 key
4260 3 Mod3 key
4261 4 Mod4 key
4262 5 Mod5 key
4263 Combinations are allowed, for example "S-C-space" or "SC-space" are
4264 both shift+ctrl+space.
4265 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4266
4267 Example: >
4268 :set imactivatekey=S-space
4269< "S-space" means shift+space. This is the activation key for kinput2 +
4270 canna (Japanese), and ami (Korean).
4271
4272 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4273'imcmdline' 'imc' boolean (default off)
4274 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 When set the Input Method is always on when starting to edit a command
4276 line, unless entering a search pattern (see 'imsearch' for that).
4277 Setting this option is useful when your input method allows entering
4278 English characters directly, e.g., when it's used to type accented
4279 characters with dead keys.
4280
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004281 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4283 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 When set the Input Method is never used. This is useful to disable
4285 the IM when it doesn't work properly.
4286 Currently this option is on by default for SGI/IRIX machines. This
4287 may change in later releases.
4288
4289 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004290'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 Specifies whether :lmap or an Input Method (IM) is to be used in
4293 Insert mode. Valid values:
4294 0 :lmap is off and IM is off
4295 1 :lmap is ON and IM is off
4296 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 To always reset the option to zero when leaving Insert mode with <Esc>
4298 this can be used: >
4299 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4300< This makes :lmap and IM turn off automatically when leaving Insert
4301 mode.
4302 Note that this option changes when using CTRL-^ in Insert mode
4303 |i_CTRL-^|.
4304 The value is set to 1 when setting 'keymap' to a valid keymap name.
4305 It is also used for the argument of commands like "r" and "f".
4306 The value 0 may not work correctly with Athena and Motif with some XIM
4307 methods. Use 'imdisable' to disable XIM then.
4308
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004309 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004310 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004311 |+multi_byte_ime| or |global-ime|.
4312
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004314'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 Specifies whether :lmap or an Input Method (IM) is to be used when
4317 entering a search pattern. Valid values:
4318 -1 the value of 'iminsert' is used, makes it look like
4319 'iminsert' is also used when typing a search pattern
4320 0 :lmap is off and IM is off
4321 1 :lmap is ON and IM is off
4322 2 :lmap is off and IM is ON
4323 Note that this option changes when using CTRL-^ in Command-line mode
4324 |c_CTRL-^|.
4325 The value is set to 1 when it is not -1 and setting the 'keymap'
4326 option to a valid keymap name.
4327 The value 0 may not work correctly with Athena and Motif with some XIM
4328 methods. Use 'imdisable' to disable XIM then.
4329
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004330 *'imstatusfunc'* *'imsf'*
4331'imstatusfunc' 'imsf' string (default "")
4332 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004333 This option specifies a function that is called to obtain the status
4334 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004335 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004336
4337 Example: >
4338 function ImStatusFunc()
4339 let is_active = ...do something
4340 return is_active ? 1 : 0
4341 endfunction
4342 set imstatusfunc=ImStatusFunc
4343<
4344 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004345 The expression will be evaluated in the |sandbox| when set from a
4346 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004347
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004348 *'imstyle'* *'imst'*
4349'imstyle' 'imst' number (default 1)
4350 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004351 {only available when compiled with |+xim| and
4352 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004353 This option specifies the input style of Input Method:
4354 0 use on-the-spot style
4355 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004356 See: |xim-input-style|
4357
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004358 For a long time on-the-spot style had been used in the GTK version of
4359 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004360 |single-repeat|, etc. Therefore over-the-spot style becomes the
4361 default now. This should work fine for most people, however if you
4362 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004363 The expression will be evaluated in the |sandbox| when set from a
4364 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004365
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 *'include'* *'inc'*
4367'include' 'inc' string (default "^\s*#\s*include")
4368 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 {not available when compiled without the
4370 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004371 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 pattern, just like for the "/" command (See |pattern|). The default
4373 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004374 "]I", "[d", etc.
4375 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004376 comes after the matched pattern. But if "\zs" appears in the pattern
4377 then the text matched from "\zs" to the end, or until "\ze" if it
4378 appears, is used as the file name. Use this to include characters
4379 that are not in 'isfname', such as a space. You can then use
4380 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004381 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382
4383 *'includeexpr'* *'inex'*
4384'includeexpr' 'inex' string (default "")
4385 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004387 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004389 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 :set includeexpr=substitute(v:fname,'\\.','/','g')
4391< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004392
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004394 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 Also used for |<cfile>|.
4396
Bram Moolenaar30b65812012-07-12 22:01:11 +02004397 The expression will be evaluated in the |sandbox| when set from a
4398 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004399 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004400
4401 It is not allowed to change text or jump to another window while
4402 evaluating 'includeexpr' |textlock|.
4403
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004405'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4406 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004409 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004410 While typing a search command, show where the pattern, as it was typed
4411 so far, matches. The matched string is highlighted. If the pattern
4412 is invalid or not found, nothing is shown. The screen will be updated
4413 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004414 Also applies to the pattern in commands: >
4415 :global
4416 :lvimgrep
4417 :lvimgrepadd
4418 :smagic
4419 :snomagic
4420 :sort
4421 :substitute
4422 :vglobal
4423 :vimgrep
4424 :vimgrepadd
4425< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004426 original position when no match is found and when pressing <Esc>. You
4427 still need to finish the search command with <Enter> to move the
4428 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004429 You can use the CTRL-G and CTRL-T keys to move to the next and
4430 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004431 When compiled with the |+reltime| feature Vim only searches for about
4432 half a second. With a complicated pattern and/or a lot of text the
4433 match may not be found. This is to avoid that Vim hangs while you
4434 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004435 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004436 When 'hlsearch' is on, all matched strings are highlighted too while
4437 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004438 If you don't want to turn 'hlsearch' on, but want to highlight all
4439 matches while searching, you can turn on and off 'hlsearch' with
4440 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004441 augroup vimrc-incsearch-highlight
4442 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004443 autocmd CmdlineEnter /,\? :set hlsearch
4444 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004445 augroup END
4446<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004447 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004448 to the command line. If 'ignorecase' and 'smartcase' are set and the
4449 command line has no uppercase characters, the added character is
4450 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004451 CTRL-R CTRL-W can be used to add the word at the end of the current
4452 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 NOTE: This option is reset when 'compatible' is set.
4454
4455 *'indentexpr'* *'inde'*
4456'indentexpr' 'inde' string (default "")
4457 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 {not available when compiled without the |+cindent|
4459 or |+eval| features}
4460 Expression which is evaluated to obtain the proper indent for a line.
4461 It is used when a new line is created, for the |=| operator and
4462 in Insert mode as specified with the 'indentkeys' option.
4463 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004464 'smartindent' indenting. When 'lisp' is set, this option is
4465 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 When 'paste' is set this option is not used for indenting.
4467 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004468 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 when the expression is evaluated (but it may be moved around).
4470 The expression must return the number of spaces worth of indent. It
4471 can return "-1" to keep the current indent (this means 'autoindent' is
4472 used for the indent).
4473 Functions useful for computing the indent are |indent()|, |cindent()|
4474 and |lispindent()|.
4475 The evaluation of the expression must not have side effects! It must
4476 not change the text, jump to another window, etc. Afterwards the
4477 cursor position is always restored, thus the cursor may be moved.
4478 Normally this option would be set to call a function: >
4479 :set indentexpr=GetMyIndent()
4480< Error messages will be suppressed, unless the 'debug' option contains
4481 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004482 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004483 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484
Bram Moolenaar30b65812012-07-12 22:01:11 +02004485 The expression will be evaluated in the |sandbox| when set from a
4486 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004487 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004488
4489 It is not allowed to change text or jump to another window while
4490 evaluating 'indentexpr' |textlock|.
4491
4492
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004494'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 {not available when compiled without the |+cindent|
4497 feature}
4498 A list of keys that, when typed in Insert mode, cause reindenting of
4499 the current line. Only happens if 'indentexpr' isn't empty.
4500 The format is identical to 'cinkeys', see |indentkeys-format|.
4501 See |C-indenting| and |indent-expression|.
4502
4503 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4504'infercase' 'inf' boolean (default off)
4505 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004507 'ignorecase' is also on, the case of the match is adjusted depending
4508 on the typed text. If the typed text contains a lowercase letter
4509 where the match has an upper case letter, the completed part is made
4510 lowercase. If the typed text has no lowercase letters and the match
4511 has a lowercase letter where the typed text has an uppercase letter,
4512 and there is a letter before it, the completed part is made uppercase.
4513 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514
4515 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4516'insertmode' 'im' boolean (default off)
4517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 Makes Vim work in a way that Insert mode is the default mode. Useful
4519 if you want to use Vim as a modeless editor. Used for |evim|.
4520 These Insert mode commands will be useful:
4521 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004522 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 this is a mapping, it is executed as if 'insertmode' was off.
4524 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004526 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4527 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528
4529 These items change when 'insertmode' is set:
4530 - when starting to edit of a file, Vim goes to Insert mode.
4531 - <Esc> in Insert mode is a no-op and beeps.
4532 - <Esc> in Normal mode makes Vim go to Insert mode.
4533 - CTRL-L in Insert mode is a command, it is not inserted.
4534 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4535 However, when <Esc> is used inside a mapping, it behaves like
4536 'insertmode' was not set. This was done to be able to use the same
4537 mappings with 'insertmode' set or not set.
4538 When executing commands with |:normal| 'insertmode' is not used.
4539
4540 NOTE: This option is reset when 'compatible' is set.
4541
4542 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004543'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4545 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4546 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4547 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4548 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 The characters specified by this option are included in file names and
4551 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004552 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 Multi-byte characters 256 and above are always included, only the
4554 characters up to 255 are specified with this option.
4555 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004556 Think twice before adding white space to this option. Although a
4557 space may appear inside a file name, the effect will be that Vim
4558 doesn't know where a file name starts or ends when doing completion.
4559 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560
4561 Note that on systems using a backslash as path separator, Vim tries to
4562 do its best to make it work as you would expect. That is a bit
4563 tricky, since Vi originally used the backslash to escape special
4564 characters. Vim will not remove a backslash in front of a normal file
4565 name character on these systems, but it will on Unix and alikes. The
4566 '&' and '^' are not included by default, because these are special for
4567 cmd.exe.
4568
4569 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004570 Each part can be a single character number or a range. A range is two
4571 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 decimal number between 0 and 255 or the ASCII character itself (does
4573 not work for digits). Example:
4574 "_,-,128-140,#-43" (include '_' and '-' and the range
4575 128 to 140 and '#' to 43)
4576 If a part starts with '^', the following character number or range
4577 will be excluded from the option. The option is interpreted from left
4578 to right. Put the excluded character after the range where it is
4579 included. To include '^' itself use it as the last character of the
4580 option or the end of a range. Example:
4581 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4582 If the character is '@', all characters where isalpha() returns TRUE
4583 are included. Normally these are the characters a to z and A to Z,
4584 plus accented characters. To include '@' itself use "@-@". Examples:
4585 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004586 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 "a-z,A-Z,@-@" All letters plus the '@' character.
4588 A comma can be included by using it where a character number is
4589 expected. Example:
4590 "48-57,,,_" Digits, comma and underscore.
4591 A comma can be excluded by prepending a '^'. Example:
4592 " -~,^,,9" All characters from space to '~', excluding
4593 comma, plus <Tab>.
4594 See |option-backslash| about including spaces and backslashes.
4595
4596 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004597'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 "@,48-57,_,128-167,224-235"
4599 otherwise: "@,48-57,_,192-255")
4600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 The characters given by this option are included in identifiers.
4602 Identifiers are used in recognizing environment variables and after a
4603 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004604 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004605 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004607 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4609
4610 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004611'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 "@,48-57,_,128-167,224-235"
4613 otherwise: "@,48-57,_,192-255"
4614 Vi default: "@,48-57,_")
4615 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004617 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004618 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004619 characters above 255 check the "word" character class (any character
4620 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004621 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 For a help file it is set to all non-blank printable characters except
4623 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4624 command).
4625 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004626 This option also influences syntax highlighting, unless the syntax
4627 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 NOTE: This option is set to the Vi default value when 'compatible' is
4629 set and to the Vim default value when 'compatible' is reset.
4630
4631 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004632'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 "@,~-255"; otherwise: "@,161-255")
4634 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 The characters given by this option are displayed directly on the
4636 screen. It is also used for "\p" in a |pattern|. The characters from
4637 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4638 even when they are not included in 'isprint' or excluded. See
4639 'isfname' for a description of the format of this option.
4640
4641 Non-printable characters are displayed with two characters:
4642 0 - 31 "^@" - "^_"
4643 32 - 126 always single characters
4644 127 "^?"
4645 128 - 159 "~@" - "~_"
4646 160 - 254 "| " - "|~"
4647 255 "~?"
4648 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4649 displayed as <xx>, with the hexadecimal value of the byte.
4650 When 'display' contains "uhex" all unprintable characters are
4651 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004652 The SpecialKey highlighting will be used for unprintable characters.
4653 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654
4655 Multi-byte characters 256 and above are always included, only the
4656 characters up to 255 are specified with this option. When a character
4657 is printable but it is not available in the current font, a
4658 replacement character will be shown.
4659 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4660 There is no option to specify these characters.
4661
4662 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4663'joinspaces' 'js' boolean (default on)
4664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 Insert two spaces after a '.', '?' and '!' with a join command.
4666 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4667 Otherwise only one space is inserted.
4668 NOTE: This option is set when 'compatible' is set.
4669
4670 *'key'*
4671'key' string (default "")
4672 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004673 {only available when compiled with the |+cryptv|
4674 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004676 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 Careful: Do not set the key value by hand, someone might see the typed
4678 key. Use the |:X| command. But you can make 'key' empty: >
4679 :set key=
4680< It is not possible to get the value of this option with ":set key" or
4681 "echo &key". This is to avoid showing it to someone who shouldn't
4682 know. It also means you cannot see it yourself once you have set it,
4683 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004684 You can use "&key" in an expression to detect whether encryption is
4685 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686
4687 *'keymap'* *'kmp'* *E544*
4688'keymap' 'kmp' string (default "")
4689 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 {only available when compiled with the |+keymap|
4691 feature}
4692 Name of a keyboard mapping. See |mbyte-keymap|.
4693 Setting this option to a valid keymap name has the side effect of
4694 setting 'iminsert' to one, so that the keymap becomes effective.
4695 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004696 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697
4698 *'keymodel'* *'km'*
4699'keymodel' 'km' string (default "")
4700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 List of comma separated words, which enable special things that keys
4702 can do. These values can be used:
4703 startsel Using a shifted special key starts selection (either
4704 Select mode or Visual mode, depending on "key" being
4705 present in 'selectmode').
4706 stopsel Using a not-shifted special key stops selection.
4707 Special keys in this context are the cursor keys, <End>, <Home>,
4708 <PageUp> and <PageDown>.
4709 The 'keymodel' option is set by the |:behave| command.
4710
4711 *'keywordprg'* *'kp'*
4712'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004713 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 Program to use for the |K| command. Environment variables are
4716 expanded |:set_env|. ":help" may be used to access the Vim internal
4717 help. (Note that previously setting the global option to the empty
4718 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004719 When the first character is ":", the command is invoked as a Vim
4720 Ex command prefixed with [count].
4721 When "man", "man -s" or an Ex command is used, Vim will automatically
4722 translate a count for the "K" command and pass it as the first
4723 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 See |option-backslash| about including spaces and backslashes.
4725 Example: >
4726 :set keywordprg=man\ -s
4727< This option cannot be set from a |modeline| or in the |sandbox|, for
4728 security reasons.
4729
4730 *'langmap'* *'lmap'* *E357* *E358*
4731'langmap' 'lmap' string (default "")
4732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 {only available when compiled with the |+langmap|
4734 feature}
4735 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004736 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004737 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 care of translating these special characters to the original meaning
4739 of the key. This means you don't have to change the keyboard mode to
4740 be able to execute Normal mode commands.
4741 This is the opposite of the 'keymap' option, where characters are
4742 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004743 Also consider setting 'langremap' to off, to prevent 'langmap' from
4744 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004745 This option cannot be set from a |modeline| or in the |sandbox|, for
4746 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004748 Example (for Greek, in UTF-8): *greek* >
4749 :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 +00004750< Example (exchanges meaning of z and y for commands): >
4751 :set langmap=zy,yz,ZY,YZ
4752<
4753 The 'langmap' option is a list of parts, separated with commas. Each
4754 part can be in one of two forms:
4755 1. A list of pairs. Each pair is a "from" character immediately
4756 followed by the "to" character. Examples: "aA", "aAbBcC".
4757 2. A list of "from" characters, a semi-colon and a list of "to"
4758 characters. Example: "abc;ABC"
4759 Example: "aA,fgh;FGH,cCdDeE"
4760 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004761 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762
4763 This will allow you to activate vim actions without having to switch
4764 back and forth between the languages. Your language characters will
4765 be understood as normal vim English characters (according to the
4766 langmap mappings) in the following cases:
4767 o Normal/Visual mode (commands, buffer/register names, user mappings)
4768 o Insert/Replace Mode: Register names after CTRL-R
4769 o Insert/Replace Mode: Mappings
4770 Characters entered in Command-line mode will NOT be affected by
4771 this option. Note that this option can be changed at any time
4772 allowing to switch between mappings for different languages/encodings.
4773 Use a mapping to avoid having to type it each time!
4774
4775 *'langmenu'* *'lm'*
4776'langmenu' 'lm' string (default "")
4777 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 {only available when compiled with the |+menu| and
4779 |+multi_lang| features}
4780 Language to use for menu translation. Tells which file is loaded
4781 from the "lang" directory in 'runtimepath': >
4782 "lang/menu_" . &langmenu . ".vim"
4783< (without the spaces). For example, to always use the Dutch menus, no
4784 matter what $LANG is set to: >
4785 :set langmenu=nl_NL.ISO_8859-1
4786< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004787 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 If your $LANG is set to a non-English language but you do want to use
4789 the English menus: >
4790 :set langmenu=none
4791< This option must be set before loading menus, switching on filetype
4792 detection or syntax highlighting. Once the menus are defined setting
4793 this option has no effect. But you could do this: >
4794 :source $VIMRUNTIME/delmenu.vim
4795 :set langmenu=de_DE.ISO_8859-1
4796 :source $VIMRUNTIME/menu.vim
4797< Warning: This deletes all menus that you defined yourself!
4798
Bram Moolenaard94464e2015-11-02 15:28:18 +01004799 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004800'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004801 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004802 {only available when compiled with the |+langmap|
4803 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004804 This is just like 'langremap' but with the value inverted. It only
4805 exists for backwards compatibility. When setting 'langremap' then
4806 'langnoremap' is set to the inverted value, and the other way around.
4807
4808 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004809'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004810 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004811 {only available when compiled with the |+langmap|
4812 feature}
4813 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004814 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004815 'langmap' disables some of your mappings, try resetting this option.
4816 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004817 that works for you to avoid mappings to break.
4818
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 *'laststatus'* *'ls'*
4820'laststatus' 'ls' number (default 1)
4821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 The value of this option influences when the last window will have a
4823 status line:
4824 0: never
4825 1: only if there are at least two windows
4826 2: always
4827 The screen looks nicer with a status line if you have several
4828 windows, but it takes another screen line. |status-line|
4829
4830 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4831'lazyredraw' 'lz' boolean (default off)
4832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 When this option is set, the screen will not be redrawn while
4834 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004835 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 update use |:redraw|.
4837
4838 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4839'linebreak' 'lbr' boolean (default off)
4840 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004841 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004843 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 than at the last character that fits on the screen. Unlike
4845 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004846 it only affects the way the file is displayed, not its contents.
4847 If 'breakindent' is set, line is visually indented. Then, the value
4848 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004849 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 Note that <Tab> characters after an <EOL> are mostly not displayed
4851 with the right amount of white space.
4852
4853 *'lines'* *E593*
4854'lines' number (default 24 or terminal height)
4855 global
4856 Number of lines of the Vim window.
4857 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004858 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 When Vim is running in the GUI or in a resizable window, setting this
4860 option will cause the window size to be changed. When you only want
4861 to use the size for the GUI, put the command in your |gvimrc| file.
4862 Vim limits the number of lines to what fits on the screen. You can
4863 use this command to get the tallest window possible: >
4864 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004865< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004866 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 When you set this option and Vim is unable to change the physical
4868 number of lines of the display, the display may be messed up.
4869
4870 *'linespace'* *'lsp'*
4871'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 {only in the GUI}
4874 Number of pixel lines inserted between characters. Useful if the font
4875 uses the full character cell height, making lines touch each other.
4876 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004877 With some fonts there can be too much room between lines (to have
4878 space for ascents and descents). Then it makes sense to set
4879 'linespace' to a negative value. This may cause display problems
4880 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881
4882 *'lisp'* *'nolisp'*
4883'lisp' boolean (default off)
4884 local to buffer
4885 {not available when compiled without the |+lispindent|
4886 feature}
4887 Lisp mode: When <Enter> is typed in insert mode set the indent for
4888 the next line to Lisp standards (well, sort of). Also happens with
4889 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4890 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4891 better. Also see 'lispwords'.
4892 The '-' character is included in keyword characters. Redefines the
4893 "=" operator to use this same indentation algorithm rather than
4894 calling an external program if 'equalprg' is empty.
4895 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896
4897 *'lispwords'* *'lw'*
4898'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004899 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 {not available when compiled without the |+lispindent|
4901 feature}
4902 Comma separated list of words that influence the Lisp indenting.
4903 |'lisp'|
4904
4905 *'list'* *'nolist'*
4906'list' boolean (default off)
4907 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004908 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4909 line. Useful to see the difference between tabs and spaces and for
4910 trailing blanks. Further changed by the 'listchars' option.
4911
4912 The cursor is displayed at the start of the space a Tab character
4913 occupies, not at the end as usual in Normal mode. To get this cursor
4914 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004915 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004916<
4917 Note that list mode will also affect formatting (set with 'textwidth'
4918 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 changing the way tabs are displayed.
4920
4921 *'listchars'* *'lcs'*
4922'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004923 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004924 Strings to use in 'list' mode and for the |:list| command. It is a
4925 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004926 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 eol:c Character to show at the end of each line. When
4928 omitted, there is no extra character at the end of the
4929 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004930 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004931 tab:xy[z] Two or three characters to be used to show a tab.
4932 The third character is optional.
4933
4934 tab:xy The 'x' is always used, then 'y' as many times as will
4935 fit. Thus "tab:>-" displays:
4936 >
4937 >-
4938 >--
4939 etc.
4940
4941 tab:xyz The 'z' is always used, then 'x' is prepended, and
4942 then 'y' is used as many times as will fit. Thus
4943 "tab:<->" displays:
4944 >
4945 <>
4946 <->
4947 <-->
4948 etc.
4949
4950 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004951 *lcs-space*
4952 space:c Character to show for a space. When omitted, spaces
4953 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004954 *lcs-multispace*
4955 multispace:c...
4956 One or more characters to use cyclically to show for
4957 multiple consecutive spaces. Overrides the "space"
4958 setting, except for single spaces. When omitted, the
4959 "space" setting is used. For example,
4960 `:set listchars=multispace:---+` shows ten consecutive
4961 spaces as:
4962 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004963 *lcs-lead*
4964 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004965 leading spaces are blank. Overrides the "space" and
4966 "multispace" settings for leading spaces. You can
4967 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01004968 :set listchars+=tab:>-,lead:.
4969< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004970 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004971 trailing spaces are blank. Overrides the "space" and
4972 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02004973 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 extends:c Character to show in the last column, when 'wrap' is
4975 off and the line continues beyond the right of the
4976 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004977 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004978 precedes:c Character to show in the first visible column of the
4979 physical line, when there is text preceding the
4980 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004981 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004982 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004983 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004984 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004985 nbsp:c Character to show for a non-breakable space character
4986 (0xA0 (160 decimal) and U+202F). Left blank when
4987 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004989 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004991 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992
Bram Moolenaar93ff6722021-10-16 17:51:40 +01004993 Each character can be specified as hex: >
4994 set listchars=eol:\\x24
4995 set listchars=eol:\\u21b5
4996 set listchars=eol:\\U000021b5
4997< Note that a double backslash is used. The number of hex characters
4998 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
4999
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 Examples: >
5001 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005002 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 :set lcs=extends:>,precedes:<
5004< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005005 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5006 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005007 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008
5009 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5010'loadplugins' 'lpl' boolean (default on)
5011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 When on the plugin scripts are loaded when starting up |load-plugins|.
5013 This option can be reset in your |vimrc| file to disable the loading
5014 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005015 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5016 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017
Bram Moolenaard94464e2015-11-02 15:28:18 +01005018 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005019'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005020 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005021 {only available when compiled with the |+lua/dyn|
5022 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005023 Specifies the name of the Lua shared library. The default is
5024 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005025 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005026 This option cannot be set from a |modeline| or in the |sandbox|, for
5027 security reasons.
5028
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005029 *'macatsui'* *'nomacatsui'*
5030'macatsui' boolean (default on)
5031 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005032 {not supported}
5033 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005034
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 *'magic'* *'nomagic'*
5036'magic' boolean (default on)
5037 global
5038 Changes the special characters that can be used in search patterns.
5039 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005040 WARNING: Switching this option off most likely breaks plugins! That
5041 is because many patterns assume it's on and will fail when it's off.
5042 Only switch it off when working with old Vi scripts. In any other
5043 situation write patterns that work when 'magic' is on. Include "\M"
5044 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005045 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5046 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047
5048 *'makeef'* *'mef'*
5049'makeef' 'mef' string (default: "")
5050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 {not available when compiled without the |+quickfix|
5052 feature}
5053 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5054 and the |:grep| command.
5055 When it is empty, an internally generated temp file will be used.
5056 When "##" is included, it is replaced by a number to make the name
5057 unique. This makes sure that the ":make" command doesn't overwrite an
5058 existing file.
5059 NOT used for the ":cf" command. See 'errorfile' for that.
5060 Environment variables are expanded |:set_env|.
5061 See |option-backslash| about including spaces and backslashes.
5062 This option cannot be set from a |modeline| or in the |sandbox|, for
5063 security reasons.
5064
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005065 *'makeencoding'* *'menc'*
5066'makeencoding' 'menc' string (default "")
5067 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005068 Encoding used for reading the output of external commands. When empty,
5069 encoding is not converted.
5070 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5071 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5072 and `:laddfile`.
5073
5074 This would be mostly useful when you use MS-Windows and set 'encoding'
5075 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5076 'makeencoding' to "char" has the same effect as setting to the system
5077 locale encoding. Example: >
5078 :set encoding=utf-8
5079 :set makeencoding=char " system locale is used
5080<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 *'makeprg'* *'mp'*
5082'makeprg' 'mp' string (default "make", VMS: "MMS")
5083 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005084 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005085 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5086 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005087 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005088 Environment variables are expanded |:set_env|. See |option-backslash|
5089 about including spaces and backslashes.
5090 Note that a '|' must be escaped twice: once for ":set" and once for
5091 the interpretation of a command. When you use a filter called
5092 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 :set makeprg=gmake\ \\\|\ myfilter
5094< The placeholder "$*" can be given (even multiple times) to specify
5095 where the arguments will be included, for example: >
5096 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5097< This option cannot be set from a |modeline| or in the |sandbox|, for
5098 security reasons.
5099
5100 *'matchpairs'* *'mps'*
5101'matchpairs' 'mps' string (default "(:),{:},[:]")
5102 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005104 other.
5105 Only character pairs are allowed that are different, thus you cannot
5106 jump between two double quotes.
5107 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005108 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005109 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 :set mps+=<:>
5111
5112< A more exotic example, to jump between the '=' and ';' in an
5113 assignment, useful for languages like C and Java: >
5114 :au FileType c,cpp,java set mps+==:;
5115
5116< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005117 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118
5119 *'matchtime'* *'mat'*
5120'matchtime' 'mat' number (default 5)
5121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 Tenths of a second to show the matching paren, when 'showmatch' is
5123 set. Note that this is not in milliseconds, like other options that
5124 set a time. This is to be compatible with Nvi.
5125
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005126 *'maxcombine'* *'mco'*
5127'maxcombine' 'mco' number (default 2)
5128 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005129 The maximum number of combining characters supported for displaying.
5130 Only used when 'encoding' is "utf-8".
5131 The default is OK for most languages. Hebrew may require 4.
5132 Maximum value is 6.
5133 Even when this option is set to 2 you can still edit text with more
5134 combining characters, you just can't see them. Use |g8| or |ga|.
5135 See |mbyte-combining|.
5136
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 *'maxfuncdepth'* *'mfd'*
5138'maxfuncdepth' 'mfd' number (default 100)
5139 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005140 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005141 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 Maximum depth of function calls for user functions. This normally
5143 catches endless recursion. When using a recursive function with
5144 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5145 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005146 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005147 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 See also |:function|.
5149
5150 *'maxmapdepth'* *'mmd'* *E223*
5151'maxmapdepth' 'mmd' number (default 1000)
5152 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 Maximum number of times a mapping is done without resulting in a
5154 character to be used. This normally catches endless mappings, like
5155 ":map x y" with ":map y x". It still does not catch ":map g wg",
5156 because the 'w' is used before the next mapping is done. See also
5157 |key-mapping|.
5158
5159 *'maxmem'* *'mm'*
5160'maxmem' 'mm' number (default between 256 to 5120 (system
5161 dependent) or half the amount of memory
5162 available)
5163 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5165 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005166 other memory to be freed.
5167 The maximum usable value is about 2000000. Use this to work without a
5168 limit.
5169 The value is ignored when 'swapfile' is off.
5170 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005172 *'maxmempattern'* *'mmp'*
5173'maxmempattern' 'mmp' number (default 1000)
5174 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005175 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005176 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005177 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005178 When Vim runs into the limit it gives an error message and mostly
5179 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005180 Running into the limit often means that the pattern is very
5181 inefficient or too complex. This may already happen with the pattern
5182 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005183 Might also happen on redraw, when syntax rules try to match a complex
5184 text structure.
5185 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5186 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005187
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 *'maxmemtot'* *'mmt'*
5189'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5190 dependent) or half the amount of memory
5191 available)
5192 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005193 Maximum amount of memory in Kbyte to use for all buffers together.
5194 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005195 without a limit.
5196 On 64 bit machines higher values might work. But hey, do you really
5197 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005198 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005199 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005200 Buffers with 'swapfile' off still count to the total amount of memory
5201 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005202 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203
5204 *'menuitems'* *'mis'*
5205'menuitems' 'mis' number (default 25)
5206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 {not available when compiled without the |+menu|
5208 feature}
5209 Maximum number of items to use in a menu. Used for menus that are
5210 generated from a list of items, e.g., the Buffers menu. Changing this
5211 option has no direct effect, the menu must be refreshed first.
5212
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005213 *'mkspellmem'* *'msm'*
5214'mkspellmem' 'msm' string (default "460000,2000,500")
5215 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005216 {not available when compiled without the |+syntax|
5217 feature}
5218 Parameters for |:mkspell|. This tunes when to start compressing the
5219 word tree. Compression can be slow when there are many words, but
5220 it's needed to avoid running out of memory. The amount of memory used
5221 per word depends very much on how similar the words are, that's why
5222 this tuning is complicated.
5223
5224 There are three numbers, separated by commas:
5225 {start},{inc},{added}
5226
5227 For most languages the uncompressed word tree fits in memory. {start}
5228 gives the amount of memory in Kbyte that can be used before any
5229 compression is done. It should be a bit smaller than the amount of
5230 memory that is available to Vim.
5231
5232 When going over the {start} limit the {inc} number specifies the
5233 amount of memory in Kbyte that can be allocated before another
5234 compression is done. A low number means compression is done after
5235 less words are added, which is slow. A high number means more memory
5236 will be allocated.
5237
5238 After doing compression, {added} times 1024 words can be added before
5239 the {inc} limit is ignored and compression is done when any extra
5240 amount of memory is needed. A low number means there is a smaller
5241 chance of hitting the {inc} limit, less memory is used but it's
5242 slower.
5243
5244 The languages for which these numbers are important are Italian and
5245 Hungarian. The default works for when you have about 512 Mbyte. If
5246 you have 1 Gbyte you could use: >
5247 :set mkspellmem=900000,3000,800
5248< If you have less than 512 Mbyte |:mkspell| may fail for some
5249 languages, no matter what you set 'mkspellmem' to.
5250
Bram Moolenaar07607392019-05-26 19:20:43 +02005251 This option cannot be set from a |modeline| or in the |sandbox|.
5252
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005254'modeline' 'ml' boolean (Vim default: on (off for root),
5255 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005257 If 'modeline' is on 'modelines' gives the number of lines that is
5258 checked for set commands. If 'modeline' is off or 'modelines' is zero
5259 no lines are checked. See |modeline|.
5260
5261 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5262'modelineexpr' 'mle' boolean (default: off)
5263 global
5264 When on allow some options that are an expression to be set in the
5265 modeline. Check the option for whether it is affected by
5266 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005267 This option cannot be set from a |modeline| or in the |sandbox|, for
5268 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005269
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 *'modelines'* *'mls'*
5271'modelines' 'mls' number (default 5)
5272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 If 'modeline' is on 'modelines' gives the number of lines that is
5274 checked for set commands. If 'modeline' is off or 'modelines' is zero
5275 no lines are checked. See |modeline|.
5276 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5277 set and to the Vim default value when 'compatible' is reset.
5278
5279 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005280 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281'modifiable' 'ma' boolean (default on)
5282 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 When off the buffer contents cannot be changed. The 'fileformat' and
5284 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005285 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286
5287 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5288'modified' 'mod' boolean (default off)
5289 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005290 When on, the buffer is considered to be modified. This option is set
5291 when:
5292 1. A change was made to the text since it was last written. Using the
5293 |undo| command to go back to the original text will reset the
5294 option. But undoing changes that were made before writing the
5295 buffer will set the option again, since the text is different from
5296 when it was written.
5297 2. 'fileformat' or 'fileencoding' is different from its original
5298 value. The original value is set when the buffer is read or
5299 written. A ":set nomodified" command also resets the original
5300 values to the current values and the 'modified' option will be
5301 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005302 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005303 This option is not set when a change is made to the buffer as the
5304 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5305 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5306 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5308 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005309 Note that the text may actually be the same, e.g. 'modified' is set
5310 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311
5312 *'more'* *'nomore'*
5313'more' boolean (Vim default: on, Vi default: off)
5314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 When on, listings pause when the whole screen is filled. You will get
5316 the |more-prompt|. When this option is off there are no pauses, the
5317 listing continues until finished.
5318 NOTE: This option is set to the Vi default value when 'compatible' is
5319 set and to the Vim default value when 'compatible' is reset.
5320
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005321 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005322'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005323 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005325 Enable the use of the mouse. Works for most terminals (xterm, Win32
5326 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5327 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5328 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005329 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330 v Visual mode
5331 i Insert mode
5332 c Command-line mode
5333 h all previous modes when editing a help file
5334 a all previous modes
5335 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005336 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005338< If your terminal can't overrule the mouse events going to the
5339 application, use: >
5340 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005341< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005342 back to Vim using the mouse events.
5343 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5344 "xterm".
5345
5346 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 modeless selection. This doesn't move the text cursor.
5348
5349 See |mouse-using|. Also see |'clipboard'|.
5350
5351 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005352 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 the mouse buttons can still be used by keeping the shift key pressed.
5354 Also see the 'clipboard' option.
5355
5356 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5357'mousefocus' 'mousef' boolean (default off)
5358 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 {only works in the GUI}
5360 The window that the mouse pointer is on is automatically activated.
5361 When changing the window layout or window focus in another way, the
5362 mouse pointer is moved to the window with keyboard focus. Off is the
5363 default because it makes using the pull down menus a little goofy, as
5364 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005365 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005366 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367
5368 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5369'mousehide' 'mh' boolean (default on)
5370 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 {only works in the GUI}
5372 When on, the mouse pointer is hidden when characters are typed.
5373 The mouse pointer is restored when the mouse is moved.
5374
5375 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005376'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 Sets the model to use for the mouse. The name mostly specifies what
5379 the right mouse button is used for:
5380 extend Right mouse button extends a selection. This works
5381 like in an xterm.
5382 popup Right mouse button pops up a menu. The shifted left
5383 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005384 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 popup_setpos Like "popup", but the cursor will be moved to the
5386 position where the mouse was clicked, and thus the
5387 selected operation will act upon the clicked object.
5388 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005389 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 course, that right clicking outside a selection will
5391 end Visual mode.
5392 Overview of what button does what for each model:
5393 mouse extend popup(_setpos) ~
5394 left click place cursor place cursor
5395 left drag start selection start selection
5396 shift-left search word extend selection
5397 right click extend selection popup menu (place cursor)
5398 right drag extend selection -
5399 middle click paste paste
5400
5401 In the "popup" model the right mouse button produces a pop-up menu.
5402 You need to define this first, see |popup-menu|.
5403
5404 Note that you can further refine the meaning of buttons with mappings.
5405 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5406 selection (because that's handled in the GUI code directly).
5407
5408 The 'mousemodel' option is set by the |:behave| command.
5409
5410 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005411'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5412 vs:leftright,vd:lrsizing,m:no,
5413 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 {only available when compiled with the |+mouseshape|
5416 feature}
5417 This option tells Vim what the mouse pointer should look like in
5418 different modes. The option is a comma separated list of parts, much
5419 like used for 'guicursor'. Each part consist of a mode/location-list
5420 and an argument-list:
5421 mode-list:shape,mode-list:shape,..
5422 The mode-list is a dash separated list of these modes/locations:
5423 In a normal window: ~
5424 n Normal mode
5425 v Visual mode
5426 ve Visual mode with 'selection' "exclusive" (same as 'v',
5427 if not specified)
5428 o Operator-pending mode
5429 i Insert mode
5430 r Replace mode
5431
5432 Others: ~
5433 c appending to the command-line
5434 ci inserting in the command-line
5435 cr replacing in the command-line
5436 m at the 'Hit ENTER' or 'More' prompts
5437 ml idem, but cursor in the last line
5438 e any mode, pointer below last window
5439 s any mode, pointer on a status line
5440 sd any mode, while dragging a status line
5441 vs any mode, pointer on a vertical separator line
5442 vd any mode, while dragging a vertical separator line
5443 a everywhere
5444
5445 The shape is one of the following:
5446 avail name looks like ~
5447 w x arrow Normal mouse pointer
5448 w x blank no pointer at all (use with care!)
5449 w x beam I-beam
5450 w x updown up-down sizing arrows
5451 w x leftright left-right sizing arrows
5452 w x busy The system's usual busy pointer
5453 w x no The system's usual 'no input' pointer
5454 x udsizing indicates up-down resizing
5455 x lrsizing indicates left-right resizing
5456 x crosshair like a big thin +
5457 x hand1 black hand
5458 x hand2 white hand
5459 x pencil what you write with
5460 x question big ?
5461 x rightup-arrow arrow pointing right-up
5462 w x up-arrow arrow pointing up
5463 x <number> any X11 pointer number (see X11/cursorfont.h)
5464
5465 The "avail" column contains a 'w' if the shape is available for Win32,
5466 x for X11.
5467 Any modes not specified or shapes not available use the normal mouse
5468 pointer.
5469
5470 Example: >
5471 :set mouseshape=s:udsizing,m:no
5472< will make the mouse turn to a sizing arrow over the status lines and
5473 indicate no input when the hit-enter prompt is displayed (since
5474 clicking the mouse has no effect in this state.)
5475
5476 *'mousetime'* *'mouset'*
5477'mousetime' 'mouset' number (default 500)
5478 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005479 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 time in msec between two mouse clicks for the second click to be
5481 recognized as a multi click.
5482
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005483 *'mzschemedll'*
5484'mzschemedll' string (default depends on the build)
5485 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005486 {only available when compiled with the |+mzscheme/dyn|
5487 feature}
5488 Specifies the name of the MzScheme shared library. The default is
5489 DYNAMIC_MZSCH_DLL which was specified at compile time.
5490 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005491 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005492 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005493 This option cannot be set from a |modeline| or in the |sandbox|, for
5494 security reasons.
5495
5496 *'mzschemegcdll'*
5497'mzschemegcdll' string (default depends on the build)
5498 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005499 {only available when compiled with the |+mzscheme/dyn|
5500 feature}
5501 Specifies the name of the MzScheme GC shared library. The default is
5502 DYNAMIC_MZGC_DLL which was specified at compile time.
5503 The value can be equal to 'mzschemedll' if it includes the GC code.
5504 Environment variables are expanded |:set_env|.
5505 This option cannot be set from a |modeline| or in the |sandbox|, for
5506 security reasons.
5507
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005508 *'mzquantum'* *'mzq'*
5509'mzquantum' 'mzq' number (default 100)
5510 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005511 {not available when compiled without the |+mzscheme|
5512 feature}
5513 The number of milliseconds between polls for MzScheme threads.
5514 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005515 NOTE: This option is set to the Vim default value when 'compatible'
5516 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005517
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005519'nrformats' 'nf' string (default "bin,octal,hex",
5520 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 This defines what bases Vim will consider for numbers when using the
5523 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5524 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005525 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005527 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005528 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005530 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 considered to be hexadecimal. Example: Using CTRL-X on
5532 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005533 bin If included, numbers starting with "0b" or "0B" will be
5534 considered to be binary. Example: Using CTRL-X on
5535 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005536 unsigned If included, numbers are recognized as unsigned. Thus a
5537 leading dash or negative sign won't be considered as part of
5538 the number. Examples:
5539 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5540 (without "unsigned" it would become "9-2021").
5541 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5542 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005543 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5544 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 Numbers which simply begin with a digit in the range 1-9 are always
5546 considered decimal. This also happens for numbers that are not
5547 recognized as octal or hex.
5548
5549 *'number'* *'nu'* *'nonumber'* *'nonu'*
5550'number' 'nu' boolean (default off)
5551 local to window
5552 Print the line number in front of each line. When the 'n' option is
5553 excluded from 'cpoptions' a wrapped line will not use the column of
5554 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005555 The 'numberwidth' option can be used to set the room used for the line
5556 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 When a long, wrapped line doesn't start with the first character, '-'
5558 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005559 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5560 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005561 *number_relativenumber*
5562 The 'relativenumber' option changes the displayed number to be
5563 relative to the cursor. Together with 'number' there are these
5564 four combinations (cursor in line 3):
5565
Bram Moolenaar3848e002016-03-19 18:42:29 +01005566 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005567 'nornu' 'nornu' 'rnu' 'rnu'
5568
5569 |apple | 1 apple | 2 apple | 2 apple
5570 |pear | 2 pear | 1 pear | 1 pear
5571 |nobody | 3 nobody | 0 nobody |3 nobody
5572 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005574 *'numberwidth'* *'nuw'*
5575'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5576 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005577 {only available when compiled with the |+linebreak|
5578 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005579 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005580 when the 'number' or 'relativenumber' option is set or printing lines
5581 with a line number. Since one space is always between the number and
5582 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005583 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005584 fit the highest line number in the buffer respectively the number of
5585 rows in the window, depending on whether 'number' or 'relativenumber'
5586 is set. Thus with the Vim default of 4 there is room for a line number
5587 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005588 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005589 NOTE: This option is set to the Vi default value when 'compatible' is
5590 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005591
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005592 *'omnifunc'* *'ofu'*
5593'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005594 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005595 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005596 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005597 This option specifies a function to be used for Insert mode omni
5598 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005599 See |complete-functions| for an explanation of how the function is
5600 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005601 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005602 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005603 This option cannot be set from a |modeline| or in the |sandbox|, for
5604 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005605
5606
Bram Moolenaar02467872007-05-06 13:22:01 +00005607 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005608'opendevice' 'odev' boolean (default off)
5609 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005610 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005611 Enable reading and writing from devices. This may get Vim stuck on a
5612 device that can be opened but doesn't actually do the I/O. Therefore
5613 it is off by default.
5614 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5615 result in editing a device.
5616
5617
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005618 *'operatorfunc'* *'opfunc'*
5619'operatorfunc' 'opfunc' string (default: empty)
5620 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005621 This option specifies a function to be called by the |g@| operator.
5622 See |:map-operator| for more info and an example.
5623
5624 This option cannot be set from a |modeline| or in the |sandbox|, for
5625 security reasons.
5626
5627
Bram Moolenaar251e1912011-06-19 05:09:16 +02005628 *'osfiletype'* *'oft'*
5629'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005631 This option was supported on RISC OS, which has been removed.
5632
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005634 *'packpath'* *'pp'*
5635'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005636 Directories used to find packages. See |packages|.
5637
5638
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005640'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 global
5642 Specifies the nroff macros that separate paragraphs. These are pairs
5643 of two letters (see |object-motions|).
5644
5645 *'paste'* *'nopaste'*
5646'paste' boolean (default off)
5647 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005648 Put Vim in Paste mode. This is useful if you want to cut or copy
5649 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 unexpected effects.
5651 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005652 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 knows about pasting and will mostly do the right thing without 'paste'
5654 being set. The same is true for a terminal where Vim handles the
5655 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005656 This option is reset when starting the GUI. Thus if you set it in
5657 your .vimrc it will work in a terminal, but not in the GUI. Setting
5658 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5659 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660 When the 'paste' option is switched on (also when it was already on):
5661 - mapping in Insert mode and Command-line mode is disabled
5662 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005664 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005665 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 - 'revins' is reset
5667 - 'ruler' is reset
5668 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005669 - 'smarttab' is reset
5670 - 'softtabstop' is set to 0
5671 - 'textwidth' is set to 0
5672 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005673 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005676 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005677 - 'indentexpr'
5678 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005679 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 NOTE: When you start editing another file while the 'paste' option is
5681 on, settings from the modelines or autocommands may change the
5682 settings again, causing trouble when pasting text. You might want to
5683 set the 'paste' option again.
5684 When the 'paste' option is reset the mentioned options are restored to
5685 the value before the moment 'paste' was switched from off to on.
5686 Resetting 'paste' before ever setting it does not have any effect.
5687 Since mapping doesn't work while 'paste' is active, you need to use
5688 the 'pastetoggle' option to toggle the 'paste' option with some key.
5689
5690 *'pastetoggle'* *'pt'*
5691'pastetoggle' 'pt' string (default "")
5692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 When non-empty, specifies the key sequence that toggles the 'paste'
5694 option. This is like specifying a mapping: >
5695 :map {keys} :set invpaste<CR>
5696< Where {keys} is the value of 'pastetoggle'.
5697 The difference is that it will work even when 'paste' is set.
5698 'pastetoggle' works in Insert mode and Normal mode, but not in
5699 Command-line mode.
5700 Mappings are checked first, thus overrule 'pastetoggle'. However,
5701 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5702 this: >
5703 :map <F10> :set paste<CR>
5704 :map <F11> :set nopaste<CR>
5705 :imap <F10> <C-O>:set paste<CR>
5706 :imap <F11> <nop>
5707 :set pastetoggle=<F11>
5708< This will make <F10> start paste mode and <F11> stop paste mode.
5709 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5710 mode everything is inserted literally, except the 'pastetoggle' key
5711 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005712 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713
5714 *'pex'* *'patchexpr'*
5715'patchexpr' 'pex' string (default "")
5716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 {not available when compiled without the |+diff|
5718 feature}
5719 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005720 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721
Bram Moolenaardbc28022014-07-26 13:40:44 +02005722 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723'patchmode' 'pm' string (default "")
5724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 When non-empty the oldest version of a file is kept. This can be used
5726 to keep the original version of a file if you are changing files in a
5727 source distribution. Only the first time that a file is written a
5728 copy of the original file will be kept. The name of the copy is the
5729 name of the original file with the string in the 'patchmode' option
5730 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005731 ".orig" or ".org". 'backupdir' must not be empty for this to work
5732 (Detail: The backup file is renamed to the patchmode file after the
5733 new file has been successfully written, that's why it must be possible
5734 to write a backup file). If there was no file to be backed up, an
5735 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 When the 'backupskip' pattern matches, a patchmode file is not made.
5737 Using 'patchmode' for compressed files appends the extension at the
5738 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5739 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005740 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005742 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 other systems: ".,,")
5745 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005747 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5748 provided that the file being searched for has a relative path (not
5749 starting with "/", "./" or "../"). The directories in the 'path'
5750 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 - Use commas to separate directory names: >
5752 :set path=.,/usr/local/include,/usr/include
5753< - Spaces can also be used to separate directory names (for backwards
5754 compatibility with version 3.0). To have a space in a directory
5755 name, precede it with an extra backslash, and escape the space: >
5756 :set path=.,/dir/with\\\ space
5757< - To include a comma in a directory name precede it with an extra
5758 backslash: >
5759 :set path=.,/dir/with\\,comma
5760< - To search relative to the directory of the current file, use: >
5761 :set path=.
5762< - To search in the current directory use an empty string between two
5763 commas: >
5764 :set path=,,
5765< - A directory name may end in a ':' or '/'.
5766 - Environment variables are expanded |:set_env|.
5767 - When using |netrw.vim| URLs can be used. For example, adding
5768 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005769 - Search upwards and downwards in a directory tree using "*", "**" and
5770 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 {not available when compiled without the |+path_extra| feature}
5772 - Careful with '\' characters, type two to get one in the option: >
5773 :set path=.,c:\\include
5774< Or just use '/' instead: >
5775 :set path=.,c:/include
5776< Don't forget "." or files won't even be found in the same directory as
5777 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005778 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 it is something like 256 or 1024 characters.
5780 You can check if all the include files are found, using the value of
5781 'path', see |:checkpath|.
5782 The use of |:set+=| and |:set-=| is preferred when adding or removing
5783 directories from the list. This avoids problems when a future version
5784 uses another default. To remove the current directory use: >
5785 :set path-=
5786< To add the current directory use: >
5787 :set path+=
5788< To use an environment variable, you probably need to replace the
5789 separator. Here is an example to append $INCL, in which directory
5790 names are separated with a semi-colon: >
5791 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5792< Replace the ';' with a ':' or whatever separator is used. Note that
5793 this doesn't work when $INCL contains a comma or white space.
5794
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005795 *'perldll'*
5796'perldll' string (default depends on the build)
5797 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005798 {only available when compiled with the |+perl/dyn|
5799 feature}
5800 Specifies the name of the Perl shared library. The default is
5801 DYNAMIC_PERL_DLL, which was specified at compile time.
5802 Environment variables are expanded |:set_env|.
5803 This option cannot be set from a |modeline| or in the |sandbox|, for
5804 security reasons.
5805
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5807'preserveindent' 'pi' boolean (default off)
5808 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 When changing the indent of the current line, preserve as much of the
5810 indent structure as possible. Normally the indent is replaced by a
5811 series of tabs followed by spaces as required (unless |'expandtab'| is
5812 enabled, in which case only spaces are used). Enabling this option
5813 means the indent will preserve as many existing characters as possible
5814 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005815 'expandtab' does not apply to the preserved white space, a Tab remains
5816 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 NOTE: When using ">>" multiple times the resulting indent is a mix of
5818 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005819 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 Also see 'copyindent'.
5821 Use |:retab| to clean up white space.
5822
5823 *'previewheight'* *'pvh'*
5824'previewheight' 'pvh' number (default 12)
5825 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005826 {not available when compiled without the |+quickfix|
5827 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005829 commands. Used for |CTRL-W_}| when no count is given. Not used when
5830 'previewpopup' is set.
5831
5832 *'previewpopup'* *'pvp'*
5833'previewpopup' 'pvp' string (default empty)
5834 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005835 {not available when compiled without the |+textprop|
5836 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005837 When not empty a popup window is used for commands that would open a
5838 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005839 Not used for the insert completion info, add "popup" to
5840 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841
5842 *'previewwindow'* *'nopreviewwindow'*
5843 *'pvw'* *'nopvw'* *E590*
5844'previewwindow' 'pvw' boolean (default off)
5845 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005846 {not available when compiled without the |+quickfix|
5847 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005848 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 set. It's normally not set directly, but by using one of the commands
5850 |:ptag|, |:pedit|, etc.
5851
5852 *'printdevice'* *'pdev'*
5853'printdevice' 'pdev' string (default empty)
5854 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005855 {only available when compiled with the |+printer|
5856 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005857 The name of the printer to be used for |:hardcopy|.
5858 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005859 This option cannot be set from a |modeline| or in the |sandbox|, for
5860 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861
Bram Moolenaar8299df92004-07-10 09:47:34 +00005862 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005863'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 {only available when compiled with the |+printer|
5866 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005867 Sets the character encoding used when printing.
5868 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869
5870 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005871'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 {only available when compiled with the |+printer|
5874 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005875 Expression used to print the PostScript produced with |:hardcopy|.
5876 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005877 This option cannot be set from a |modeline| or in the |sandbox|, for
5878 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879
Bram Moolenaar8299df92004-07-10 09:47:34 +00005880 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881'printfont' 'pfn' string (default "courier")
5882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 {only available when compiled with the |+printer|
5884 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005885 The name of the font that will be used for |:hardcopy|.
5886 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887
5888 *'printheader'* *'pheader'*
5889'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 {only available when compiled with the |+printer|
5892 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005893 The format of the header produced in |:hardcopy| output.
5894 See |pheader-option|.
5895
5896 *'printmbcharset'* *'pmbcs'*
5897'printmbcharset' 'pmbcs' string (default "")
5898 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005899 {only available when compiled with the |+printer|
5900 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005901 The CJK character set to be used for CJK output from |:hardcopy|.
5902 See |pmbcs-option|.
5903
5904 *'printmbfont'* *'pmbfn'*
5905'printmbfont' 'pmbfn' string (default "")
5906 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005907 {only available when compiled with the |+printer|
5908 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005909 List of font names to be used for CJK output from |:hardcopy|.
5910 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911
5912 *'printoptions'* *'popt'*
5913'printoptions' 'popt' string (default "")
5914 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005916 List of items that control the format of the output of |:hardcopy|.
5917 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005919 *'prompt'* *'noprompt'*
5920'prompt' boolean (default on)
5921 global
5922 When on a ":" prompt is used in Ex mode.
5923
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005924 *'pumheight'* *'ph'*
5925'pumheight' 'ph' number (default 0)
5926 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005927 Determines the maximum number of items to show in the popup menu for
5928 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005929 |ins-completion-menu|.
5930
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005931 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005932'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005933 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005934 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005935 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005936
Bram Moolenaard94464e2015-11-02 15:28:18 +01005937 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005938'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005939 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005940 {only available when compiled with the |+python/dyn|
5941 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005942 Specifies the name of the Python 2.x shared library. The default is
5943 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005944 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005945 This option cannot be set from a |modeline| or in the |sandbox|, for
5946 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005947
Bram Moolenaar94073162018-01-31 21:49:05 +01005948 *'pythonhome'*
5949'pythonhome' string (default "")
5950 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005951 {only available when compiled with the |+python/dyn|
5952 feature}
5953 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5954 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5955 which was specified at compile time, will be used for the Python 2.x
5956 home directory.
5957 Environment variables are expanded |:set_env|.
5958 This option cannot be set from a |modeline| or in the |sandbox|, for
5959 security reasons.
5960
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005961 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005962'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005963 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005964 {only available when compiled with the |+python3/dyn|
5965 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005966 Specifies the name of the Python 3 shared library. The default is
5967 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005968 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005969 This option cannot be set from a |modeline| or in the |sandbox|, for
5970 security reasons.
5971
Bram Moolenaar94073162018-01-31 21:49:05 +01005972 *'pythonthreehome'*
5973'pythonthreehome' string (default "")
5974 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005975 {only available when compiled with the |+python3/dyn|
5976 feature}
5977 Specifies the name of the Python 3 home directory. When
5978 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5979 PYTHON3_HOME, which was specified at compile time, will be used for
5980 the Python 3 home directory.
5981 Environment variables are expanded |:set_env|.
5982 This option cannot be set from a |modeline| or in the |sandbox|, for
5983 security reasons.
5984
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005985 *'pyxversion'* *'pyx'*
5986'pyxversion' 'pyx' number (default depends on the build)
5987 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005988 {only available when compiled with the |+python| or
5989 the |+python3| feature}
5990 Specifies the python version used for pyx* functions and commands
5991 |python_x|. The default value is as follows:
5992
5993 Compiled with Default ~
5994 |+python| and |+python3| 0
5995 only |+python| 2
5996 only |+python3| 3
5997
5998 Available values are 0, 2 and 3.
5999 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6000 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6001 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6002 to 2 if Python 2 is available.
6003 See also: |has-pythonx|
6004
6005 If Vim is compiled with only |+python| or |+python3| setting
6006 'pyxversion' has no effect. The pyx* functions and commands are
6007 always the same as the compiled version.
6008
6009 This option cannot be set from a |modeline| or in the |sandbox|, for
6010 security reasons.
6011
Bram Moolenaar858ba062020-05-31 23:11:59 +02006012 *'quickfixtextfunc'* *'qftf'*
6013'quickfixtextfunc' 'qftf' string (default "")
6014 global
6015 {only available when compiled with the |+quickfix|
6016 feature}
6017 This option specifies a function to be used to get the text to display
6018 in the quickfix and location list windows. This can be used to
6019 customize the information displayed in the quickfix or location window
6020 for each entry in the corresponding quickfix or location list. See
6021 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02006022 function and an example. The value can be the name of a function or a
6023 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006024
6025 This option cannot be set from a |modeline| or in the |sandbox|, for
6026 security reasons.
6027
Bram Moolenaar677ee682005-01-27 14:41:15 +00006028 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006029'quoteescape' 'qe' string (default "\")
6030 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006031 The characters that are used to escape quotes in a string. Used for
6032 objects like a', a" and a` |a'|.
6033 When one of the characters in this option is found inside a string,
6034 the following character will be skipped. The default value makes the
6035 text "foo\"bar\\" considered to be one string.
6036
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6038'readonly' 'ro' boolean (default off)
6039 local to buffer
6040 If on, writes fail unless you use a '!'. Protects you from
6041 accidentally overwriting a file. Default on when Vim is started
6042 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006043 When using ":w!" the 'readonly' option is reset for the current
6044 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006045 When using the ":view" command the 'readonly' option is set for the
6046 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006047 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006049 *'redrawtime'* *'rdt'*
6050'redrawtime' 'rdt' number (default 2000)
6051 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006052 {only available when compiled with the |+reltime|
6053 feature}
6054 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006055 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006056 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006057 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006058 matches will be highlighted.
6059 For syntax highlighting the time applies per window. When over the
6060 limit syntax highlighting is disabled until |CTRL-L| is used.
6061 This is used to avoid that Vim hangs when using a very complicated
6062 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006063
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006064 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006065'regexpengine' 're' number (default 0)
6066 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006067 This selects the default regexp engine. |two-engines|
6068 The possible values are:
6069 0 automatic selection
6070 1 old engine
6071 2 NFA engine
6072 Note that when using the NFA engine and the pattern contains something
6073 that is not supported the pattern will not match. This is only useful
6074 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006075 Using automatic selection enables Vim to switch the engine, if the
6076 default engine becomes too costly. E.g., when the NFA engine uses too
6077 many states. This should prevent Vim from hanging on a combination of
6078 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006079
Bram Moolenaar64486672010-05-16 15:46:46 +02006080 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6081'relativenumber' 'rnu' boolean (default off)
6082 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006083 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006084 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006085 precede some vertical motion commands (e.g. j k + -) with, without
6086 having to calculate it yourself. Especially useful in combination with
6087 other commands (e.g. y d c < > gq gw =).
6088 When the 'n' option is excluded from 'cpoptions' a wrapped
6089 line will not use the column of line numbers (this is the default when
6090 'compatible' isn't set).
6091 The 'numberwidth' option can be used to set the room used for the line
6092 number.
6093 When a long, wrapped line doesn't start with the first character, '-'
6094 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006095 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6096 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006097
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006098 The number in front of the cursor line also depends on the value of
6099 'number', see |number_relativenumber| for all combinations of the two
6100 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006101
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 *'remap'* *'noremap'*
6103'remap' boolean (default on)
6104 global
6105 Allows for mappings to work recursively. If you do not want this for
6106 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006107 NOTE: To avoid portability problems with Vim scripts, always keep
6108 this option at the default "on". Only switch it off when working with
6109 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006111 *'renderoptions'* *'rop'*
6112'renderoptions' 'rop' string (default: empty)
6113 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006114 {only available when compiled with GUI and DIRECTX on
6115 MS-Windows}
6116 Select a text renderer and set its options. The options depend on the
6117 renderer.
6118
6119 Syntax: >
6120 set rop=type:{renderer}(,{name}:{value})*
6121<
6122 Currently, only one optional renderer is available.
6123
6124 render behavior ~
6125 directx Vim will draw text using DirectX (DirectWrite). It makes
6126 drawn glyphs more beautiful than default GDI.
6127 It requires 'encoding' is "utf-8", and only works on
6128 MS-Windows Vista or newer version.
6129
6130 Options:
6131 name meaning type value ~
6132 gamma gamma float 1.0 - 2.2 (maybe)
6133 contrast enhancedContrast float (unknown)
6134 level clearTypeLevel float (unknown)
6135 geom pixelGeometry int 0 - 2 (see below)
6136 renmode renderingMode int 0 - 6 (see below)
6137 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006138 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006139
Bram Moolenaar92467d32017-12-05 13:22:16 +01006140 See this URL for detail (except for scrlines):
6141 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006142
6143 For geom: structure of a device pixel.
6144 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6145 1 - DWRITE_PIXEL_GEOMETRY_RGB
6146 2 - DWRITE_PIXEL_GEOMETRY_BGR
6147
6148 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006149 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006150
6151 For renmode: method of rendering glyphs.
6152 0 - DWRITE_RENDERING_MODE_DEFAULT
6153 1 - DWRITE_RENDERING_MODE_ALIASED
6154 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6155 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6156 4 - DWRITE_RENDERING_MODE_NATURAL
6157 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6158 6 - DWRITE_RENDERING_MODE_OUTLINE
6159
6160 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006161 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006162
6163 For taamode: antialiasing mode used for drawing text.
6164 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6165 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6166 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6167 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6168
6169 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006170 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6171
Bram Moolenaara338adc2018-01-31 20:51:47 +01006172 For scrlines:
6173 This was used for optimizing scrolling behavior, however this
6174 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006175
6176 Example: >
6177 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006178 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006179 set rop=type:directx
6180<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006181 If select a raster font (Courier, Terminal or FixedSys which
6182 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006183 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006184
6185 NOTE: It is known that some fonts and options combination
6186 causes trouble on drawing glyphs.
6187
Bram Moolenaar92467d32017-12-05 13:22:16 +01006188 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006189 special made fonts (True-Type fonts which includes only
6190 bitmap glyphs).
6191 - 'taamode:3' will not work with some vector fonts.
6192
6193 NOTE: With this option, you can display colored emoji
6194 (emoticon) in Windows 8.1 or later. To display colored emoji,
6195 there are some conditions which you should notice.
6196
6197 - If your font includes non-colored emoji already, it will
6198 be used.
6199 - If your font doesn't have emoji, the system chooses an
6200 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6201 will be used.
6202 - When this alternative font didn't have fixed width glyph,
6203 emoji might be rendered beyond the bounding box of drawing
6204 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006205
6206 Other render types are currently not supported.
6207
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 *'report'*
6209'report' number (default 2)
6210 global
6211 Threshold for reporting number of lines changed. When the number of
6212 changed lines is more than 'report' a message will be given for most
6213 ":" commands. If you want it always, set 'report' to 0.
6214 For the ":substitute" command the number of substitutions is used
6215 instead of the number of lines.
6216
6217 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6218'restorescreen' 'rs' boolean (default on)
6219 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006220 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221 When set, the screen contents is restored when exiting Vim. This also
6222 happens when executing external commands.
6223
6224 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6225 options in your .vimrc. To disable restoring:
6226 set t_ti= t_te=
6227 To enable restoring (for an xterm):
6228 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6229 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6230
6231 *'revins'* *'ri'* *'norevins'* *'nori'*
6232'revins' 'ri' boolean (default off)
6233 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 {only available when compiled with the |+rightleft|
6235 feature}
6236 Inserting characters in Insert mode will work backwards. See "typing
6237 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6238 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006239 NOTE: This option is reset when 'compatible' is set.
6240 This option is reset when 'paste' is set and restored when 'paste' is
6241 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242
6243 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6244'rightleft' 'rl' boolean (default off)
6245 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 {only available when compiled with the |+rightleft|
6247 feature}
6248 When on, display orientation becomes right-to-left, i.e., characters
6249 that are stored in the file appear from the right to the left.
6250 Using this option, it is possible to edit files for languages that
6251 are written from the right to the left such as Hebrew and Arabic.
6252 This option is per window, so it is possible to edit mixed files
6253 simultaneously, or to view the same file in both ways (this is
6254 useful whenever you have a mixed text file with both right-to-left
6255 and left-to-right strings so that both sets are displayed properly
6256 in different windows). Also see |rileft.txt|.
6257
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006258 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259'rightleftcmd' 'rlc' string (default "search")
6260 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 {only available when compiled with the |+rightleft|
6262 feature}
6263 Each word in this option enables the command line editing to work in
6264 right-to-left mode for a group of commands:
6265
6266 search "/" and "?" commands
6267
6268 This is useful for languages such as Hebrew, Arabic and Farsi.
6269 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6270
Bram Moolenaard94464e2015-11-02 15:28:18 +01006271 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006272'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006273 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006274 {only available when compiled with the |+ruby/dyn|
6275 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006276 Specifies the name of the Ruby shared library. The default is
6277 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006278 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006279 This option cannot be set from a |modeline| or in the |sandbox|, for
6280 security reasons.
6281
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006283'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 {not available when compiled without the
6286 |+cmdline_info| feature}
6287 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006288 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 text in the file is shown on the far right:
6290 Top first line is visible
6291 Bot last line is visible
6292 All first and last line are visible
6293 45% relative position in the file
6294 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006295 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006297 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 this option takes precedence over 'ruler' and 'rulerformat'
6299 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006300 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 the text column (byte number) and the screen column are shown,
6302 separated with a dash.
6303 For an empty line "0-1" is shown.
6304 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006305 This option is reset when 'paste' is set and restored when 'paste' is
6306 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 If you don't want to see the ruler all the time but want to know where
6308 you are, use "g CTRL-G" |g_CTRL-G|.
6309 NOTE: This option is reset when 'compatible' is set.
6310
6311 *'rulerformat'* *'ruf'*
6312'rulerformat' 'ruf' string (default empty)
6313 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 {not available when compiled without the |+statusline|
6315 feature}
6316 When this option is not empty, it determines the content of the ruler
6317 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006318 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006319 This option cannot be set in a modeline when 'modelineexpr' is off.
6320
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 The default ruler width is 17 characters. To make the ruler 15
6322 characters wide, put "%15(" at the start and "%)" at the end.
6323 Example: >
6324 :set rulerformat=%15(%c%V\ %p%%%)
6325<
6326 *'runtimepath'* *'rtp'* *vimfiles*
6327'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006328 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 $VIM/vimfiles,
6330 $VIMRUNTIME,
6331 $VIM/vimfiles/after,
6332 $HOME/.vim/after"
6333 Amiga: "home:vimfiles,
6334 $VIM/vimfiles,
6335 $VIMRUNTIME,
6336 $VIM/vimfiles/after,
6337 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006338 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 $VIM/vimfiles,
6340 $VIMRUNTIME,
6341 $VIM/vimfiles/after,
6342 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006343 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 $VIMRUNTIME,
6345 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006346 Haiku: "$BE_USER_SETTINGS/vim,
6347 $VIM/vimfiles,
6348 $VIMRUNTIME,
6349 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006350 $BE_USER_SETTINGS/vim/after"
6351 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 $VIM/vimfiles,
6353 $VIMRUNTIME,
6354 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006355 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 This is a list of directories which will be searched for runtime
6358 files:
6359 filetype.vim filetypes by file name |new-filetype|
6360 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006361 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 colors/ color scheme files |:colorscheme|
6363 compiler/ compiler files |:compiler|
6364 doc/ documentation |write-local-help|
6365 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006366 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 indent/ indent scripts |indent-expression|
6368 keymap/ key mapping files |mbyte-keymap|
6369 lang/ menu translations |:menutrans|
6370 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006371 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 plugin/ plugin scripts |write-plugin|
6373 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006374 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 syntax/ syntax files |mysyntaxfile|
6376 tutor/ files for vimtutor |tutor|
6377
6378 And any other file searched for with the |:runtime| command.
6379
6380 The defaults for most systems are setup to search five locations:
6381 1. In your home directory, for your personal preferences.
6382 2. In a system-wide Vim directory, for preferences from the system
6383 administrator.
6384 3. In $VIMRUNTIME, for files distributed with Vim.
6385 *after-directory*
6386 4. In the "after" directory in the system-wide Vim directory. This is
6387 for the system administrator to overrule or add to the distributed
6388 defaults (rarely needed)
6389 5. In the "after" directory in your home directory. This is for
6390 personal preferences to overrule or add to the distributed defaults
6391 or system-wide settings (rarely needed).
6392
Bram Moolenaard0796902016-09-16 20:02:31 +02006393 More entries are added when using |packages|. If it gets very long
6394 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6395 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006396
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6398 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006399 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400 wildcards.
6401 See |:runtime|.
6402 Example: >
6403 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6404< This will use the directory "~/vimruntime" first (containing your
6405 personal Vim runtime files), then "/mygroup/vim" (shared between a
6406 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6407 files).
6408 You probably should always include $VIMRUNTIME somewhere, to use the
6409 distributed runtime files. You can put a directory before $VIMRUNTIME
6410 to find files which replace a distributed runtime files. You can put
6411 a directory after $VIMRUNTIME to find files which add to distributed
6412 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006413 When Vim is started with |--clean| the home directory entries are not
6414 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 This option cannot be set from a |modeline| or in the |sandbox|, for
6416 security reasons.
6417
6418 *'scroll'* *'scr'*
6419'scroll' 'scr' number (default: half the window height)
6420 local to window
6421 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6422 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006423 changes. This may happen when enabling the |status-line| or
6424 'tabline' option after setting the 'scroll' option.
6425 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006426 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006427 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428
6429 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6430'scrollbind' 'scb' boolean (default off)
6431 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 See also |scroll-binding|. When this option is set, the current
6433 window scrolls as other scrollbind windows (windows that also have
6434 this option set) scroll. This option is useful for viewing the
6435 differences between two versions of a file, see 'diff'.
6436 See |'scrollopt'| for options that determine how this option should be
6437 interpreted.
6438 This option is mostly reset when splitting a window to edit another
6439 file. This means that ":split | edit file" results in two windows
6440 with scroll-binding, but ":split file" does not.
6441
Bram Moolenaarae20f342019-11-05 21:09:23 +01006442 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6443'scrollfocus' 'scf' boolean (default off)
6444 global
6445 {only for MS-Windows GUI}
6446 When using the scroll wheel and this option is set, the window under
6447 the mouse pointer is scrolled. With this option off the current
6448 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006449 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006450
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 *'scrolljump'* *'sj'*
6452'scrolljump' 'sj' number (default 1)
6453 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 Minimal number of lines to scroll when the cursor gets off the
6455 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6456 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006457 When set to a negative number from -1 to -100 this is used as the
6458 percentage of the window height. Thus -50 scrolls half the window
6459 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 NOTE: This option is set to 1 when 'compatible' is set.
6461
6462 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006463'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006464 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 Minimal number of screen lines to keep above and below the cursor.
6466 This will make some context visible around where you are working. If
6467 you set it to a very large value (999) the cursor line will always be
6468 in the middle of the window (except at the start or end of the file or
6469 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006470 After using the local value, go back the global value with one of
6471 these two: >
6472 setlocal scrolloff<
6473 setlocal scrolloff=-1
6474< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 NOTE: This option is set to 0 when 'compatible' is set.
6476
6477 *'scrollopt'* *'sbo'*
6478'scrollopt' 'sbo' string (default "ver,jump")
6479 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006481 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6482 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 The following words are available:
6484 ver Bind vertical scrolling for 'scrollbind' windows
6485 hor Bind horizontal scrolling for 'scrollbind' windows
6486 jump Applies to the offset between two windows for vertical
6487 scrolling. This offset is the difference in the first
6488 displayed line of the bound windows. When moving
6489 around in a window, another 'scrollbind' window may
6490 reach a position before the start or after the end of
6491 the buffer. The offset is not changed though, when
6492 moving back the 'scrollbind' window will try to scroll
6493 to the desired position when possible.
6494 When now making that window the current one, two
6495 things can be done with the relative offset:
6496 1. When "jump" is not included, the relative offset is
6497 adjusted for the scroll position in the new current
6498 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006499 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 2. When "jump" is included, the other windows are
6501 scrolled to keep the same relative offset. When
6502 going back to the other window, it still uses the
6503 same relative offset.
6504 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006505 When 'diff' mode is active there always is vertical scroll binding,
6506 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507
6508 *'sections'* *'sect'*
6509'sections' 'sect' string (default "SHNHH HUnhsh")
6510 global
6511 Specifies the nroff macros that separate sections. These are pairs of
6512 two letters (See |object-motions|). The default makes a section start
6513 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6514
6515 *'secure'* *'nosecure'* *E523*
6516'secure' boolean (default off)
6517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 When on, ":autocmd", shell and write commands are not allowed in
6519 ".vimrc" and ".exrc" in the current directory and map commands are
6520 displayed. Switch it off only if you know that you will not run into
6521 problems, or when the 'exrc' option is off. On Unix this option is
6522 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006523 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 'secure' at the end of your ~/.vimrc then.
6525 This option cannot be set from a |modeline| or in the |sandbox|, for
6526 security reasons.
6527
6528 *'selection'* *'sel'*
6529'selection' 'sel' string (default "inclusive")
6530 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 This option defines the behavior of the selection. It is only used
6532 in Visual and Select mode.
6533 Possible values:
6534 value past line inclusive ~
6535 old no yes
6536 inclusive yes yes
6537 exclusive yes no
6538 "past line" means that the cursor is allowed to be positioned one
6539 character past the line.
6540 "inclusive" means that the last character of the selection is included
6541 in an operation. For example, when "x" is used to delete the
6542 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006543 When "old" is used and 'virtualedit' allows the cursor to move past
6544 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 Note that when "exclusive" is used and selecting from the end
6546 backwards, you cannot include the last character of a line, when
6547 starting in Normal mode and 'virtualedit' empty.
6548
6549 The 'selection' option is set by the |:behave| command.
6550
6551 *'selectmode'* *'slm'*
6552'selectmode' 'slm' string (default "")
6553 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 This is a comma separated list of words, which specifies when to start
6555 Select mode instead of Visual mode, when a selection is started.
6556 Possible values:
6557 mouse when using the mouse
6558 key when using shifted special keys
6559 cmd when using "v", "V" or CTRL-V
6560 See |Select-mode|.
6561 The 'selectmode' option is set by the |:behave| command.
6562
6563 *'sessionoptions'* *'ssop'*
6564'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006565 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006567 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 feature}
6569 Changes the effect of the |:mksession| command. It is a comma
6570 separated list of words. Each word enables saving and restoring
6571 something:
6572 word save and restore ~
6573 blank empty windows
6574 buffers hidden and unloaded buffers, not just those in windows
6575 curdir the current directory
6576 folds manually created folds, opened/closed folds and local
6577 fold options
6578 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006579 and contain at least one lowercase letter. Only
6580 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 help the help window
6582 localoptions options and mappings local to a window or buffer (not
6583 global values for local options)
6584 options all options and mappings (also global values for local
6585 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006586 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 resize size of the Vim window: 'lines' and 'columns'
6588 sesdir the directory in which the session file is located
6589 will become the current directory (useful with
6590 projects accessed over a network from different
6591 systems)
6592 slash backslashes in file names replaced with forward
6593 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006594 tabpages all tab pages; without this only the current tab page
6595 is restored, so that you can make a session for each
6596 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006597 terminal include terminal windows where the command can be
6598 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 unix with Unix end-of-line format (single <NL>), even when
6600 on Windows or DOS
6601 winpos position of the whole Vim window
6602 winsize window sizes
6603
6604 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006605 When neither "curdir" nor "sesdir" is included, file names are stored
6606 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 "slash" and "unix" are useful on Windows when sharing session files
6608 with Unix. The Unix version of Vim cannot source dos format scripts,
6609 but the Windows version of Vim can source unix format scripts.
6610
6611 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006612'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 global
6614 Name of the shell to use for ! and :! commands. When changing the
6615 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6616 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006617 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 See |option-backslash| about including spaces and backslashes.
6619 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006620
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006621 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006622 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6624< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006625 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006627 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006629 Example with escaped space (Vim will do this when initializing the
6630 option from $SHELL): >
6631 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006632< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006633 backslashes are consumed by `:set`.
6634
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 Under MS-Windows, when the executable ends in ".com" it must be
6636 included. Thus setting the shell to "command.com" or "4dos.com"
6637 works, but "command" and "4dos" do not work for all commands (e.g.,
6638 filtering).
6639 For unknown reasons, when using "4dos.com" the current directory is
6640 changed to "C:\". To avoid this set 'shell' like this: >
6641 :set shell=command.com\ /c\ 4dos
6642< This option cannot be set from a |modeline| or in the |sandbox|, for
6643 security reasons.
6644
6645 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006646'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006647 Win32, when 'shell' contains "powershell":
6648 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006649 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006652 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6653 For MS-Windows, the default is set according to the value of 'shell',
6654 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006655 On Unix it can have more than one flag. Each white space separated
6656 part is passed as an argument to the shell command.
6657 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006658 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 This option cannot be set from a |modeline| or in the |sandbox|, for
6660 security reasons.
6661
6662 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006663'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6664 "2>&1| tee", or
6665 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 {not available when compiled without the |+quickfix|
6668 feature}
6669 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006670 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 including spaces and backslashes.
6672 The name of the temporary file can be represented by "%s" if necessary
6673 (the file name is appended automatically if no %s appears in the value
6674 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006675 For the Amiga the default is ">". For MS-Windows using powershell the
6676 default is "2>&1 | Out-File -Encoding default", otherwise the default
6677 is ">%s 2>&1". The output is directly saved in a file and not echoed
6678 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006679 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 in a file and echoed to the screen. If the 'shell' option is "csh" or
6681 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006682 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006683 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6684 means that stderr is also included. Before using the 'shell' option a
6685 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006686 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6687 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 The initialization of this option is done after reading the ".vimrc"
6689 and the other initializations, so that when the 'shell' option is set
6690 there, the 'shellpipe' option changes automatically, unless it was
6691 explicitly set before.
6692 When 'shellpipe' is set to an empty string, no redirection of the
6693 ":make" output will be done. This is useful if you use a 'makeprg'
6694 that writes to 'makeef' by itself. If you want no piping, but do
6695 want to include the 'makeef', set 'shellpipe' to a single space.
6696 Don't forget to precede the space with a backslash: ":set sp=\ ".
6697 In the future pipes may be used for filtering and this option will
6698 become obsolete (at least for Unix).
6699 This option cannot be set from a |modeline| or in the |sandbox|, for
6700 security reasons.
6701
6702 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006703'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 Quoting character(s), put around the command passed to the shell, for
6706 the "!" and ":!" commands. The redirection is kept outside of the
6707 quoting. See 'shellxquote' to include the redirection. It's
6708 probably not useful to set both options.
6709 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006710 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006711 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 This option cannot be set from a |modeline| or in the |sandbox|, for
6713 security reasons.
6714
6715 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006716'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6717 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 String to be used to put the output of a filter command in a temporary
6720 file. See also |:!|. See |option-backslash| about including spaces
6721 and backslashes.
6722 The name of the temporary file can be represented by "%s" if necessary
6723 (the file name is appended automatically if no %s appears in the value
6724 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006725 The default is ">". For Unix, if the 'shell' option is "csh" or
6726 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006727 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006728 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6729 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006730 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6731 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006732 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6733 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 The initialization of this option is done after reading the ".vimrc"
6735 and the other initializations, so that when the 'shell' option is set
6736 there, the 'shellredir' option changes automatically unless it was
6737 explicitly set before.
6738 In the future pipes may be used for filtering and this option will
6739 become obsolete (at least for Unix).
6740 This option cannot be set from a |modeline| or in the |sandbox|, for
6741 security reasons.
6742
6743 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6744'shellslash' 'ssl' boolean (default off)
6745 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006746 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006748 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006749 powershell.exe. Backward slashes can still be typed, but they are
6750 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 Note that setting or resetting this option has no effect for some
6752 existing file names, thus this option needs to be set before opening
6753 any file for best results. This might change in the future.
6754 'shellslash' only works when a backslash can be used as a path
6755 separator. To test if this is so use: >
6756 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006757< Also see 'completeslash'.
6758
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006759 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6760'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6761 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006762 When on, use temp files for shell commands. When off use a pipe.
6763 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006764 Currently a pipe is only supported on Unix and MS-Windows 2K and
6765 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006766 :if has("filterpipe")
6767< The advantage of using a pipe is that nobody can read the temp file
6768 and the 'shell' command does not need to support redirection.
6769 The advantage of using a temp file is that the file type and encoding
6770 can be detected.
6771 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6772 |FilterWritePost| autocommands event are not triggered when
6773 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006774 The `system()` function does not respect this option and always uses
6775 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006776 NOTE: This option is set to the Vim default value when 'compatible'
6777 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006778
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 *'shelltype'* *'st'*
6780'shelltype' 'st' number (default 0)
6781 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006782 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 On the Amiga this option influences the way how the commands work
6784 which use a shell.
6785 0 and 1: always use the shell
6786 2 and 3: use the shell only to filter lines
6787 4 and 5: use shell only for ':sh' command
6788 When not using the shell, the command is executed directly.
6789
6790 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6791 1 and 3: use "shell cmd" to start external commands
6792
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006793 *'shellxescape'* *'sxe'*
6794'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006795 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006796 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006797 When 'shellxquote' is set to "(" then the characters listed in this
6798 option will be escaped with a '^' character. This makes it possible
6799 to execute most external commands with cmd.exe.
6800
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 *'shellxquote'* *'sxq'*
6802'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006803 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006804 for Win32, when 'shell' is
6805 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006806 for Win32, when 'shell' contains "sh"
6807 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 for Unix, when using system(): "\"")
6809 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 Quoting character(s), put around the command passed to the shell, for
6811 the "!" and ":!" commands. Includes the redirection. See
6812 'shellquote' to exclude the redirection. It's probably not useful
6813 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006814 When the value is '(' then ')' is appended. When the value is '"('
6815 then ')"' is appended.
6816 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006817 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006818 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6819 pwsh.exe which automatically strips off the first and last quote on a
6820 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6821 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006822 'shell', to reduce the need to set this option by the user. See
6823 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 This option cannot be set from a |modeline| or in the |sandbox|, for
6825 security reasons.
6826
6827 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6828'shiftround' 'sr' boolean (default off)
6829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 Round indent to multiple of 'shiftwidth'. Applies to > and <
6831 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6832 a multiple of 'shiftwidth' (this is Vi compatible).
6833 NOTE: This option is reset when 'compatible' is set.
6834
6835 *'shiftwidth'* *'sw'*
6836'shiftwidth' 'sw' number (default 8)
6837 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006838 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006840 When zero the 'ts' value will be used. Use the |shiftwidth()|
6841 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842
6843 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006844'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6845 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 This option helps to avoid all the |hit-enter| prompts caused by file
6848 messages, for example with CTRL-G, and to avoid some other messages.
6849 It is a list of flags:
6850 flag meaning when present ~
6851 f use "(3 of 5)" instead of "(file 3 of 5)"
6852 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006853 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 m use "[+]" instead of "[Modified]"
6855 n use "[New]" instead of "[New File]"
6856 r use "[RO]" instead of "[readonly]"
6857 w use "[w]" instead of "written" for file write message
6858 and "[a]" instead of "appended" for ':w >> file' command
6859 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6860 "[unix format]" and "[mac]" instead of "[mac format]".
6861 a all of the above abbreviations
6862
6863 o overwrite message for writing a file with subsequent message
6864 for reading a file (useful for ":wn" or when 'autowrite' on)
6865 O message for reading a file overwrites any previous message.
6866 Also for quickfix message (e.g., ":cn").
6867 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006868 hit TOP, continuing at BOTTOM" messages; when using the search
6869 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 t truncate file message at the start if it is too long to fit
6871 on the command-line, "<" will appear in the left most column.
6872 Ignored in Ex mode.
6873 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006874 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 Ignored in Ex mode.
6876 W don't give "written" or "[w]" when writing a file
6877 A don't give the "ATTENTION" message when an existing swap file
6878 is found.
6879 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006880 c don't give |ins-completion-menu| messages. For example,
6881 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6882 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006883 q use "recording" instead of "recording @a"
6884 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006885 was used for the command; note that this also affects messages
6886 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006887 S do not show search count message when searching, e.g.
6888 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889
6890 This gives you the opportunity to avoid that a change between buffers
6891 requires you to hit <Enter>, but still gives as useful a message as
6892 possible for the space available. To get the whole message that you
6893 would have got with 'shm' empty, use ":file!"
6894 Useful values:
6895 shm= No abbreviation of message.
6896 shm=a Abbreviation, but no loss of information.
6897 shm=at Abbreviation, and truncate message when necessary.
6898
6899 NOTE: This option is set to the Vi default value when 'compatible' is
6900 set and to the Vim default value when 'compatible' is reset.
6901
6902 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6903'shortname' 'sn' boolean (default off)
6904 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 Filenames are assumed to be 8 characters plus one extension of 3
6906 characters. Multiple dots in file names are not allowed. When this
6907 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006908 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006910 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911
6912 *'showbreak'* *'sbr'* *E595*
6913'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006914 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006915 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916 feature}
6917 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006918 values are "> " or "+++ ": >
6919 :set showbreak=>\
6920< Note the backslash to escape the trailing space. It's easier like
6921 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006922 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006923< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 comma (in a future version the comma might be used to separate the
6925 part that is shown at the end and at the start of a line).
6926 The characters are highlighted according to the '@' flag in
6927 'highlight'.
6928 Note that tabs after the showbreak will be displayed differently.
6929 If you want the 'showbreak' to appear in between line numbers, add the
6930 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006931 A window-local value overrules a global value. If the global value is
6932 set and you want no value in the current window use NONE: >
6933 :setlocal showbreak=NONE
6934<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006936'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6937 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 {not available when compiled without the
6940 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006941 Show (partial) command in the last line of the screen. Set this
6942 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 In Visual mode the size of the selected area is shown:
6944 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006945 If the number of bytes is different it is also displayed: "2-6"
6946 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006948 - When selecting a block, the size in screen characters:
6949 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 NOTE: This option is set to the Vi default value when 'compatible' is
6951 set and to the Vim default value when 'compatible' is reset.
6952
6953 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6954'showfulltag' 'sft' boolean (default off)
6955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 When completing a word in insert mode (see |ins-completion|) from the
6957 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006958 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 matched a C function, you can see a template for what arguments are
6960 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006961 Note that this doesn't work well together with having "longest" in
6962 'completeopt', because the completion from the search pattern may not
6963 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964
6965 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6966'showmatch' 'sm' boolean (default off)
6967 global
6968 When a bracket is inserted, briefly jump to the matching one. The
6969 jump is only done if the match can be seen on the screen. The time to
6970 show the match can be set with 'matchtime'.
6971 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006972 seen or not).
6973 This option is reset when 'paste' is set and restored when 'paste' is
6974 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 When the 'm' flag is not included in 'cpoptions', typing a character
6976 will immediately move the cursor back to where it belongs.
6977 See the "sm" field in 'guicursor' for setting the cursor shape and
6978 blinking when showing the match.
6979 The 'matchpairs' option can be used to specify the characters to show
6980 matches for. 'rightleft' and 'revins' are used to look for opposite
6981 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006982 Also see the matchparen plugin for highlighting the match when moving
6983 around |pi_paren.txt|.
6984 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985
6986 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6987'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6988 global
6989 If in Insert, Replace or Visual mode put a message on the last line.
6990 Use the 'M' flag in 'highlight' to set the type of highlighting for
6991 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006992 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 doesn't mean XIM is really active, especially when 'imactivatekey' is
6994 not set.
6995 NOTE: This option is set to the Vi default value when 'compatible' is
6996 set and to the Vim default value when 'compatible' is reset.
6997
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006998 *'showtabline'* *'stal'*
6999'showtabline' 'stal' number (default 1)
7000 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007001 The value of this option specifies when the line with tab page labels
7002 will be displayed:
7003 0: never
7004 1: only if there are at least two tab pages
7005 2: always
7006 This is both for the GUI and non-GUI implementation of the tab pages
7007 line.
7008 See |tab-page| for more information about tab pages.
7009
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 *'sidescroll'* *'ss'*
7011'sidescroll' 'ss' number (default 0)
7012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 The minimal number of columns to scroll horizontally. Used only when
7014 the 'wrap' option is off and the cursor is moved off of the screen.
7015 When it is zero the cursor will be put in the middle of the screen.
7016 When using a slow terminal set it to a large number or 0. When using
7017 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7018 commands.
7019
7020 *'sidescrolloff'* *'siso'*
7021'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007022 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007024 right of the cursor if 'nowrap' is set. Setting this option to a
7025 value greater than 0 while having |'sidescroll'| also at a non-zero
7026 value makes some context visible in the line you are scrolling in
7027 horizontally (except at beginning of the line). Setting this option
7028 to a large value (like 999) has the effect of keeping the cursor
7029 horizontally centered in the window, as long as one does not come too
7030 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007031 After using the local value, go back the global value with one of
7032 these two: >
7033 setlocal sidescrolloff<
7034 setlocal sidescrolloff=-1
7035< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036
7037 Example: Try this together with 'sidescroll' and 'listchars' as
7038 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007039 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040
7041 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7042 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007043<
7044 *'signcolumn'* *'scl'*
7045'signcolumn' 'scl' string (default "auto")
7046 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007047 {not available when compiled without the |+signs|
7048 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007049 Whether or not to draw the signcolumn. Valid values are:
7050 "auto" only when there is a sign to display
7051 "no" never
7052 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007053 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007054 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055
7056
7057 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7058'smartcase' 'scs' boolean (default off)
7059 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 Override the 'ignorecase' option if the search pattern contains upper
7061 case characters. Only used when the search pattern is typed and
7062 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007063 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7065 recalling the search pattern from history and hitting <Enter>.
7066 NOTE: This option is reset when 'compatible' is set.
7067
7068 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7069'smartindent' 'si' boolean (default off)
7070 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 {not available when compiled without the
7072 |+smartindent| feature}
7073 Do smart autoindenting when starting a new line. Works for C-like
7074 programs, but can also be used for other languages. 'cindent' does
7075 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007076 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007077 setting 'si' has no effect. 'indentexpr' is a more advanced
7078 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 Normally 'autoindent' should also be on when using 'smartindent'.
7080 An indent is automatically inserted:
7081 - After a line ending in '{'.
7082 - After a line starting with a keyword from 'cinwords'.
7083 - Before a line starting with '}' (only with the "O" command).
7084 When typing '}' as the first character in a new line, that line is
7085 given the same indent as the matching '{'.
7086 When typing '#' as the first character in a new line, the indent for
7087 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007088 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7090 When using the ">>" command, lines starting with '#' are not shifted
7091 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007092 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007093 This option is reset when 'paste' is set and restored when 'paste' is
7094 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095
7096 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7097'smarttab' 'sta' boolean (default off)
7098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007100 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7101 <BS> will delete a 'shiftwidth' worth of space at the start of the
7102 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007103 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007104 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7105 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007106 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007108 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007109 This option is reset when 'paste' is set and restored when 'paste' is
7110 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 NOTE: This option is reset when 'compatible' is set.
7112
7113 *'softtabstop'* *'sts'*
7114'softtabstop' 'sts' number (default 0)
7115 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 Number of spaces that a <Tab> counts for while performing editing
7117 operations, like inserting a <Tab> or using <BS>. It "feels" like
7118 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7119 used. This is useful to keep the 'ts' setting at its standard value
7120 of 8, while being able to edit like it is set to 'sts'. However,
7121 commands like "x" still work on the actual characters.
7122 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007123 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007124 'softtabstop' is set to 0 when the 'paste' option is set and restored
7125 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7127 spaces is minimized by using <Tab>s.
7128 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7129 set.
7130 NOTE: This option is set to 0 when 'compatible' is set.
7131
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007132 If Vim is compiled with the |+vartabs| feature then the value of
7133 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7134 anything other than an empty string.
7135
Bram Moolenaar217ad922005-03-20 22:37:15 +00007136 *'spell'* *'nospell'*
7137'spell' boolean (default off)
7138 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007139 {not available when compiled without the |+syntax|
7140 feature}
7141 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007142 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007143
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007144 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007145'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007146 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007147 {not available when compiled without the |+syntax|
7148 feature}
7149 Pattern to locate the end of a sentence. The following word will be
7150 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007151 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007152 When this check is not wanted make this option empty.
7153 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007154 Be careful with special characters, see |option-backslash| about
7155 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007156 To set this option automatically depending on the language, see
7157 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007158
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007159 *'spellfile'* *'spf'*
7160'spellfile' 'spf' string (default empty)
7161 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007162 {not available when compiled without the |+syntax|
7163 feature}
7164 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007165 commands. It must end in ".{encoding}.add". You need to include the
7166 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007167 *E765*
7168 It may also be a comma separated list of names. A count before the
7169 |zg| and |zw| commands can be used to access each. This allows using
7170 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007171 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007172 you: Using the first directory in 'runtimepath' that is writable. If
7173 there is no "spell" directory yet it will be created. For the file
7174 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007175 ignoring the region.
7176 The resulting ".spl" file will be used for spell checking, it does not
7177 have to appear in 'spelllang'.
7178 Normally one file is used for all regions, but you can add the region
7179 name if you want to. However, it will then only be used when
7180 'spellfile' is set to it, for entries in 'spelllang' only files
7181 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007182 This option cannot be set from a |modeline| or in the |sandbox|, for
7183 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007184
Bram Moolenaar217ad922005-03-20 22:37:15 +00007185 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007186'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007187 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007188 {not available when compiled without the |+syntax|
7189 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007190 A comma separated list of word list names. When the 'spell' option is
7191 on spellchecking will be done for these languages. Example: >
7192 set spelllang=en_us,nl,medical
7193< This means US English, Dutch and medical words are recognized. Words
7194 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007195 The word list name must consist of alphanumeric characters, a dash or
7196 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007197 recommended to separate the two letter language name from a
7198 specification. Thus "en-rare" is used for rare English words.
7199 A region name must come last and have the form "_xx", where "xx" is
7200 the two-letter, lower case region name. You can use more than one
7201 region by listing them: "en_us,en_ca" supports both US and Canadian
7202 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007203 Britain. (Note: currently en_au and en_nz dictionaries are older than
7204 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007205 If the name "cjk" is included East Asian characters are excluded from
7206 spell checking. This is useful when editing text that also has Asian
7207 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007208 Note that the "medical" dictionary does not exist, it is just an
7209 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007210 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007211 As a special case the name of a .spl file can be given as-is. The
7212 first "_xx" in the name is removed and used as the region name
7213 (_xx is an underscore, two letters and followed by a non-letter).
7214 This is mainly for testing purposes. You must make sure the correct
7215 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007216 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007217 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7218 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007219 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007220
Bram Moolenaar98692072006-02-04 00:57:42 +00007221 If the |spellfile.vim| plugin is active and you use a language name
7222 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7223 will ask you if you want to download the file.
7224
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007225 After this option has been set successfully, Vim will source the files
7226 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007227 up to the first character that is not an ASCII letter or number and
7228 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007229
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007230 *'spelloptions'* *'spo'*
7231'spelloptions' 'spo' string (default "")
7232 local to buffer
7233 {not available when compiled without the |+syntax|
7234 feature}
7235 A comma separated list of options for spell checking:
7236 camel When a word is CamelCased, assume "Cased" is a
7237 separate word: every upper-case character in a word
7238 that comes after a lower case character indicates the
7239 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007240
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007241 *'spellsuggest'* *'sps'*
7242'spellsuggest' 'sps' string (default "best")
7243 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007244 {not available when compiled without the |+syntax|
7245 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007246 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007247 the |spellsuggest()| function. This is a comma-separated list of
7248 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007249
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007250 best Internal method that works best for English. Finds
7251 changes like "fast" and uses a bit of sound-a-like
7252 scoring to improve the ordering.
7253
7254 double Internal method that uses two methods and mixes the
7255 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007256 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007257 word. That only works when the language specifies
7258 sound folding. Can be slow and doesn't always give
7259 better results.
7260
7261 fast Internal method that only checks for simple changes:
7262 character inserts/deletes/swaps. Works well for
7263 simple typing mistakes.
7264
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007265 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007266 Not used for |spellsuggest()|. The number of
7267 suggestions is never more than the value of 'lines'
7268 minus two.
7269
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007270 file:{filename} Read file {filename}, which must have two columns,
7271 separated by a slash. The first column contains the
7272 bad word, the second column the suggested good word.
7273 Example:
7274 theribal/terrible ~
7275 Use this for common mistakes that do not appear at the
7276 top of the suggestion list with the internal methods.
7277 Lines without a slash are ignored, use this for
7278 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007279 The word in the second column must be correct,
7280 otherwise it will not be used. Add the word to an
7281 ".add" file if it is currently flagged as a spelling
7282 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007283 The file is used for all languages.
7284
7285 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7286 trouble with spaces. |v:val| holds the badly spelled
7287 word. The expression must evaluate to a List of
7288 Lists, each with a suggestion and a score.
7289 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007290 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007291 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007292 internal methods use. A lower score is better.
7293 This may invoke |spellsuggest()| if you temporarily
7294 set 'spellsuggest' to exclude the "expr:" part.
7295 Errors are silently ignored, unless you set the
7296 'verbose' option to a non-zero value.
7297
7298 Only one of "best", "double" or "fast" may be used. The others may
7299 appear several times in any order. Example: >
7300 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7301<
7302 This option cannot be set from a |modeline| or in the |sandbox|, for
7303 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007304
7305
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7307'splitbelow' 'sb' boolean (default off)
7308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 When on, splitting a window will put the new window below the current
7310 one. |:split|
7311
7312 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7313'splitright' 'spr' boolean (default off)
7314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 When on, splitting a window will put the new window right of the
7316 current one. |:vsplit|
7317
7318 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7319'startofline' 'sol' boolean (default on)
7320 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007322 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007323 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007324 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 with a linewise operator, with "%" with a count and to buffer changing
7326 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7327 only has a line number, e.g., ":25" or ":+".
7328 In case of buffer changing commands the cursor is placed at the column
7329 where it was the last time the buffer was edited.
7330 NOTE: This option is set when 'compatible' is set.
7331
Bram Moolenaar00654022011-02-25 14:42:19 +01007332 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007334 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 {not available when compiled without the |+statusline|
7336 feature}
7337 When nonempty, this option determines the content of the status line.
7338 Also see |status-line|.
7339
7340 The option consists of printf style '%' items interspersed with
7341 normal text. Each status line item is of the form:
7342 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007343 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007344 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345
Bram Moolenaar238a5642006-02-21 22:12:05 +00007346 When the option starts with "%!" then it is used as an expression,
7347 evaluated and the result is used as the option value. Example: >
7348 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007349< The *g:statusline_winid* variable will be set to the |window-ID| of the
7350 window that the status line belongs to.
7351 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007352 Note that the "%!" expression is evaluated in the context of the
7353 current window and buffer, while %{} items are evaluated in the
7354 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007355
7356 When there is error while evaluating the option then it will be made
7357 empty to avoid further errors. Otherwise screen updating would loop.
7358
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 Note that the only effect of 'ruler' when this option is set (and
7360 'laststatus' is 2) is controlling the output of |CTRL-G|.
7361
7362 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007363 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007365 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 minwid Minimum width of the item, padding as set by '-' & '0'.
7367 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007368 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369 on the left for text items. Numeric items will be
7370 shifted down to maxwid-2 digits followed by '>'number
7371 where number is the amount of missing digits, much like
7372 an exponential notation.
7373 item A one letter code as described below.
7374
7375 Following is a description of the possible statusline items. The
7376 second character in "item" is the type:
7377 N for number
7378 S for string
7379 F for flags as described below
7380 - not applicable
7381
7382 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007383 f S Path to the file in the buffer, as typed or relative to current
7384 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 F S Full path to the file in the buffer.
7386 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007387 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007389 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007391 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007393 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007395 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007397 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7399 being used: "<keymap>"
7400 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007401 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 B N As above, in hexadecimal.
7403 o N Byte number in file of byte under cursor, first byte is 1.
7404 Mnemonic: Offset from start of file (with one added)
7405 {not available when compiled without |+byte_offset| feature}
7406 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007407 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 l N Line number.
7409 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007410 c N Column number (byte index).
7411 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007412 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 p N Percentage through file in lines as in |CTRL-G|.
7414 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007415 percentage described for 'ruler'. Always 3 in length, unless
7416 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007417 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007419 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007420 Note that there is no '%' before the closing '}'. The
7421 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007422 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007423 {% - This is almost same as { except the result of the expression is
7424 re-evaluated as a statusline format string. Thus if the
7425 return value of expr contains % items they will get expanded.
7426 The expression can contain the } character, the end of
7427 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007428 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007429 func! Stl_filename() abort
7430 return "%t"
7431 endfunc
7432< `stl=%{Stl_filename()}` results in `"%t"`
7433 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007434 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 ( - Start of item group. Can be used for setting the width and
7436 alignment of a section. Must be followed by %) somewhere.
7437 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007438 T N For 'tabline': start of tab page N label. Use %T after the last
7439 label. This information is used for mouse clicks.
7440 X N For 'tabline': start of close tab N label. Use %X after the
7441 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7442 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 < - Where to truncate line if too long. Default is at the start.
7444 No width fields allowed.
7445 = - Separation point between left and right aligned items.
7446 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007447 # - Set highlight group. The name must follow and then a # again.
7448 Thus use %#HLname# for highlight group HLname. The same
7449 highlighting is used, also for the statusline of non-current
7450 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007452 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 The difference between User{N} and StatusLine will be applied
7454 to StatusLineNC for the statusline of non-current windows.
7455 The number N must be between 1 and 9. See |hl-User1..9|
7456
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007457 When displaying a flag, Vim removes the leading comma, if any, when
7458 that flag comes right after plaintext. This will make a nice display
7459 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460
Bram Moolenaar582fd852005-03-28 20:58:01 +00007461 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 not set) and a minwid is not set for the group, the whole group will
7463 become empty. This will make a group like the following disappear
7464 completely from the statusline when none of the flags are set. >
7465 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007466< Beware that an expression is evaluated each and every time the status
7467 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007468 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007469 While evaluating %{} the current buffer and current window will be set
7470 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007471 currently being drawn. The expression will evaluate in this context.
7472 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7473 real current buffer and "g:actual_curwin" to the |window-ID| of the
7474 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007475
Bram Moolenaar30b65812012-07-12 22:01:11 +02007476 The 'statusline' option will be evaluated in the |sandbox| if set from
7477 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007478 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007479
7480 It is not allowed to change text or jump to another window while
7481 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482
7483 If the statusline is not updated when you want it (e.g., after setting
7484 a variable that's used in an expression), you can force an update by
7485 setting an option without changing its value. Example: >
7486 :let &ro = &ro
7487
7488< A result of all digits is regarded a number for display purposes.
7489 Otherwise the result is taken as flag text and applied to the rules
7490 described above.
7491
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007492 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007494 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495
7496 Examples:
7497 Emulate standard status line with 'ruler' set >
7498 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7499< Similar, but add ASCII value of char under the cursor (like "ga") >
7500 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7501< Display byte count and byte value, modified flag in red. >
7502 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7503 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7504< Display a ,GZ flag if a compressed file is loaded >
7505 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7506< In the |:autocmd|'s: >
7507 :let b:gzflag = 1
7508< And: >
7509 :unlet b:gzflag
7510< And define this function: >
7511 :function VarExists(var, val)
7512 : if exists(a:var) | return a:val | else | return '' | endif
7513 :endfunction
7514<
7515 *'suffixes'* *'su'*
7516'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 Files with these suffixes get a lower priority when multiple files
7519 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007520 suffixes. Spaces after the comma are ignored. A dot is also seen as
7521 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 separator, precede it with a backslash (see |option-backslash| about
7523 including spaces and backslashes).
7524 See 'wildignore' for completely ignoring files.
7525 The use of |:set+=| and |:set-=| is preferred when adding or removing
7526 suffixes from the list. This avoids problems when a future version
7527 uses another default.
7528
7529 *'suffixesadd'* *'sua'*
7530'suffixesadd' 'sua' string (default "")
7531 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 {not available when compiled without the
7533 |+file_in_path| feature}
7534 Comma separated list of suffixes, which are used when searching for a
7535 file for the "gf", "[I", etc. commands. Example: >
7536 :set suffixesadd=.java
7537<
7538 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7539'swapfile' 'swf' boolean (default on)
7540 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007541 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 swapfile is not wanted for a specific buffer. For example, with
7543 confidential information that even root must not be able to access.
7544 Careful: All text will be in memory:
7545 - Don't use this for big files.
7546 - Recovery will be impossible!
7547 A swapfile will only be present when |'updatecount'| is non-zero and
7548 'swapfile' is set.
7549 When 'swapfile' is reset, the swap file for the current buffer is
7550 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7551 non-zero, a swap file is immediately created.
7552 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007553 If you want to open a new buffer without creating a swap file for it,
7554 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007555 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556
7557 This option is used together with 'bufhidden' and 'buftype' to
7558 specify special kinds of buffers. See |special-buffers|.
7559
7560 *'swapsync'* *'sws'*
7561'swapsync' 'sws' string (default "fsync")
7562 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007564 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 When this option is empty parts of the swap file may be in memory and
7566 not written to disk. When the system crashes you may lose more work.
7567 On Unix the system does a sync now and then without Vim asking for it,
7568 so the disadvantage of setting this option off is small. On some
7569 systems the swap file will not be written at all. For a unix system
7570 setting it to "sync" will use the sync() call instead of the default
7571 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007572 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573
7574 *'switchbuf'* *'swb'*
7575'switchbuf' 'swb' string (default "")
7576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007578 Mostly for |quickfix| commands some values are also used for other
7579 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 Possible values (comma separated list):
7581 useopen If included, jump to the first open window that
7582 contains the specified buffer (if there is one).
7583 Otherwise: Do not examine other windows.
7584 This setting is checked with |quickfix| commands, when
7585 jumping to errors (":cc", ":cn", "cp", etc.). It is
7586 also used in all buffer related split commands, for
7587 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007588 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007589 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007591 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007592 Otherwise: do not split, use current window (when used
7593 in the quickfix window: the previously used window or
7594 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007595 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007596 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007597 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007598 uselast If included, jump to the previously used window when
7599 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007601 *'synmaxcol'* *'smc'*
7602'synmaxcol' 'smc' number (default 3000)
7603 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007604 {not available when compiled without the |+syntax|
7605 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007606 Maximum column in which to search for syntax items. In long lines the
7607 text after this column is not highlighted and following lines may not
7608 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007609 This helps to avoid very slow redrawing for an XML file that is one
7610 long line.
7611 Set to zero to remove the limit.
7612
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 *'syntax'* *'syn'*
7614'syntax' 'syn' string (default empty)
7615 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 {not available when compiled without the |+syntax|
7617 feature}
7618 When this option is set, the syntax with this name is loaded, unless
7619 syntax highlighting has been switched off with ":syntax off".
7620 Otherwise this option does not always reflect the current syntax (the
7621 b:current_syntax variable does).
7622 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007623 not automatically recognized. Example, in an IDL file:
7624 /* vim: set syntax=idl : */ ~
7625 When a dot appears in the value then this separates two filetype
7626 names. Example:
7627 /* vim: set syntax=c.doxygen : */ ~
7628 This will use the "c" syntax first, then the "doxygen" syntax.
7629 Note that the second one must be prepared to be loaded as an addition,
7630 otherwise it will be skipped. More than one dot may appear.
7631 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 :set syntax=OFF
7633< To switch syntax highlighting on according to the current value of the
7634 'filetype' option: >
7635 :set syntax=ON
7636< What actually happens when setting the 'syntax' option is that the
7637 Syntax autocommand event is triggered with the value as argument.
7638 This option is not copied to another buffer, independent of the 's' or
7639 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007640 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007642 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007643'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007644 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007645 When nonempty, this option determines the content of the tab pages
7646 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007647 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007648
7649 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007650 option and only when there is no GUI tab line. When 'e' is in
7651 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007652 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007653
7654 The value is evaluated like with 'statusline'. You can use
7655 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007656 the text to be displayed. Use "%1T" for the first label, "%2T" for
7657 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007658
Bram Moolenaare12bab32019-01-08 22:02:56 +01007659 When changing something that is used in 'tabline' that does not
7660 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007661 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007662
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007663 Keep in mind that only one of the tab pages is the current one, others
7664 are invisible and you can't jump to their windows.
7665
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007666
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007667 *'tabpagemax'* *'tpm'*
7668'tabpagemax' 'tpm' number (default 10)
7669 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007670 Maximum number of tab pages to be opened by the |-p| command line
7671 argument or the ":tab all" command. |tabpage|
7672
7673
7674 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675'tabstop' 'ts' number (default 8)
7676 local to buffer
7677 Number of spaces that a <Tab> in the file counts for. Also see
7678 |:retab| command, and 'softtabstop' option.
7679
7680 Note: Setting 'tabstop' to any other value than 8 can make your file
7681 appear wrong in many places (e.g., when printing it).
7682
7683 There are four main ways to use tabs in Vim:
7684 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7685 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007686 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 behave like a tab appears every 4 (or 3) characters.
7688 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7689 'expandtab'. This way you will always insert spaces. The
7690 formatting will never be messed up when 'tabstop' is changed.
7691 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007692 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 works when using Vim to edit the file.
7694 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7695 'noexpandtab'. This should then work (for initial indents only)
7696 for any tabstop setting that people use. It might be nice to have
7697 tabs after the first non-blank inserted as spaces if you do this
7698 though. Otherwise aligned comments will be wrong when 'tabstop' is
7699 changed.
7700
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007701 If Vim is compiled with the |+vartabs| feature then the value of
7702 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7703 than an empty string.
7704
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7706'tagbsearch' 'tbs' boolean (default on)
7707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007709 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 searching makes searching for a tag a LOT faster, but a linear search
7711 will find more tags if the tags file wasn't properly sorted.
7712 Vim normally assumes that your tags files are sorted, or indicate that
7713 they are not sorted. Only when this is not the case does the
7714 'tagbsearch' option need to be switched off.
7715
7716 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007717 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 certain files, or retry all files with a linear search. When
7719 'tagbsearch' is off, only a linear search is done.
7720
7721 Linear searching is done anyway, for one file, when Vim finds a line
7722 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007723 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724< [The whitespace before and after the '0' must be a single <Tab>]
7725
7726 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007727 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 instead of a normal tag name, a retry is done with a linear search.
7729 Tags in unsorted tags files, and matches with different case will only
7730 be found in the retry.
7731
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007732 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007733 linear search can be avoided when case is ignored. Use a value of '2'
7734 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7735 sorted with the -f switch to "sort" in most unices, as in the command:
7736 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7737 (at least 5.5) the --sort=foldcase switch can be used for this as
7738 well. Note that case must be folded to uppercase for this to work.
7739
7740 By default, tag searches are case-sensitive. Case is ignored when
7741 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7742 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007743 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7744 'tagcase' is "smart", and the pattern contains only lowercase
7745 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746
7747 When 'tagbsearch' is off, tags searching is slower when a full match
7748 exists, but faster when no full match exists. Tags in unsorted tags
7749 files may only be found with 'tagbsearch' off.
7750 When the tags file is not sorted, or sorted in a wrong way (not on
7751 ASCII byte value), 'tagbsearch' should be off, or the line given above
7752 must be included in the tags file.
7753 This option doesn't affect commands that find all matching tags (e.g.,
7754 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007756 *'tagcase'* *'tc'*
7757'tagcase' 'tc' string (default "followic")
7758 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007759 This option specifies how case is handled when searching the tags
7760 file:
7761 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007762 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007763 ignore Ignore case
7764 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007765 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007766 NOTE: This option is set to the Vi default value when 'compatible' is
7767 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007768
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007769 *'tagfunc'* *'tfu'*
7770'tagfunc' 'tfu' string (default: empty)
7771 local to buffer
7772 {not available when compiled without the |+eval|
7773 feature}
7774 This option specifies a function to be used to perform tag searches.
7775 The function gets the tag pattern and should return a List of matching
7776 tags. See |tag-function| for an explanation of how to write the
7777 function and an example.
7778
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 *'taglength'* *'tl'*
7780'taglength' 'tl' number (default 0)
7781 global
7782 If non-zero, tags are significant up to this number of characters.
7783
7784 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7785'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7786 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007787 If on and using a tags file in another directory, file names in that
7788 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 NOTE: This option is set to the Vi default value when 'compatible' is
7790 set and to the Vim default value when 'compatible' is reset.
7791
7792 *'tags'* *'tag'* *E433*
7793'tags' 'tag' string (default "./tags,tags", when compiled with
7794 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7795 global or local to buffer |global-local|
7796 Filenames for the tag command, separated by spaces or commas. To
7797 include a space or comma in a file name, precede it with a backslash
7798 (see |option-backslash| about including spaces and backslashes).
7799 When a file name starts with "./", the '.' is replaced with the path
7800 of the current file. But only when the 'd' flag is not included in
7801 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7802 |tags-option|.
7803 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007804 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7805 find all files named "tags" below "/lib". The filename itself cannot
7806 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7807 files called "tags?". {not available when compiled without the
7808 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007809 The |tagfiles()| function can be used to get a list of the file names
7810 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7812 files are also supported. They are automatically recognized. The
7813 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7814 differences are ignored (MS-Windows). |emacs-tags|
7815 The use of |:set+=| and |:set-=| is preferred when adding or removing
7816 file names from the list. This avoids problems when a future version
7817 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818
7819 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7820'tagstack' 'tgst' boolean (default on)
7821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822 When on, the |tagstack| is used normally. When off, a ":tag" or
7823 ":tselect" command with an argument will not push the tag onto the
7824 tagstack. A following ":tag" without an argument, a ":pop" command or
7825 any other command that uses the tagstack will use the unmodified
7826 tagstack, but does change the pointer to the active entry.
7827 Resetting this option is useful when using a ":tag" command in a
7828 mapping which should not change the tagstack.
7829
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007830 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007831'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007832 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007833 {only available when compiled with the |+tcl/dyn|
7834 feature}
7835 Specifies the name of the Tcl shared library. The default is
7836 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007837 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007838 This option cannot be set from a |modeline| or in the |sandbox|, for
7839 security reasons.
7840
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 *'term'* *E529* *E530* *E531*
7842'term' string (default is $TERM, if that fails:
7843 in the GUI: "builtin_gui"
7844 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007845 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 on Unix: "ansi"
7848 on VMS: "ansi"
7849 on Win 32: "win32")
7850 global
7851 Name of the terminal. Used for choosing the terminal control
7852 characters. Environment variables are expanded |:set_env|.
7853 For example: >
7854 :set term=$TERM
7855< See |termcap|.
7856
7857 *'termbidi'* *'tbidi'*
7858 *'notermbidi'* *'notbidi'*
7859'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 {only available when compiled with the |+arabic|
7862 feature}
7863 The terminal is in charge of Bi-directionality of text (as specified
7864 by Unicode). The terminal is also expected to do the required shaping
7865 that some languages (such as Arabic) require.
7866 Setting this option implies that 'rightleft' will not be set when
7867 'arabic' is set and the value of 'arabicshape' will be ignored.
7868 Note that setting 'termbidi' has the immediate effect that
7869 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7870 This option is reset when the GUI is started.
7871 For further details see |arabic.txt|.
7872
7873 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007874'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 Encoding used for the terminal. This specifies what character
7877 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007878 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007879 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007880 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007881 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7883 Any attempts to set a different value will be rejected, and an error
7884 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007885 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 because the Win32 system always passes Unicode characters.
7887 When empty, the same encoding is used as for the 'encoding' option.
7888 This is the normal value.
7889 Not all combinations for 'termencoding' and 'encoding' are valid. See
7890 |encoding-table|.
7891 The value for this option must be supported by internal conversions or
7892 iconv(). When this is not possible no conversion will be done and you
7893 will probably experience problems with non-ASCII characters.
7894 Example: You are working with the locale set to euc-jp (Japanese) and
7895 want to edit a UTF-8 file: >
7896 :let &termencoding = &encoding
7897 :set encoding=utf-8
7898< You need to do this when your system has no locale support for UTF-8.
7899
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007900 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007901'termguicolors' 'tgc' boolean (default off)
7902 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007903 {not available when compiled without the
7904 |+termguicolors| feature}
7905 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007906 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007907
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007908 Requires a ISO-8613-3 compatible terminal. If setting this option
7909 does not work (produces a colorless UI) reading |xterm-true-color|
7910 might help.
7911
7912 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7913 is required. Use this check to find out: >
7914 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007915< This requires Vim to be built with the |+vtp| feature.
7916
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007917 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007918 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007919
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007920 *'termwinkey'* *'twk'*
7921'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007922 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007923 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007924 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007925 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007926 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007927< The string must be one key stroke but can be multiple bytes.
7928 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007929 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007930 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007931
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007932 *'termwinscroll'* *'twsl'*
7933'termwinscroll' 'twsl' number (default 10000)
7934 local to buffer
7935 {not available when compiled without the
7936 |+terminal| feature}
7937 Number of scrollback lines to keep. When going over this limit the
7938 first 10% of the scrollback lines are deleted. This is just to reduce
7939 the memory usage. See |Terminal-Normal|.
7940
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007941 *'termwinsize'* *'tws'*
7942'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007943 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007944 Size used when opening the |terminal| window. Format:
7945 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007946 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007947 - When set with a "x" (e.g., "24x80") the terminal size is not
7948 adjusted to the window size. If the window is smaller only the
7949 top-left part is displayed.
7950 - When set with a "*" (e.g., "10*50") the terminal size follows the
7951 window size, but will not be smaller than the specified rows and/or
7952 columns.
7953 - When rows is zero then use the height of the window.
7954 - When columns is zero then use the width of the window.
7955 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007956 - Can be overruled in the |term_start()| options with "term_rows" and
7957 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007958
7959 Examples:
7960 "30x0" uses 30 rows and the current window width.
7961 "20*0" uses at least 20 rows and the current window width.
7962 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007963 Note that the command running in the terminal window may still change
7964 the size of the terminal. In that case the Vim window will be
7965 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007966
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007967 *'termwintype'* *'twt'*
7968'termwintype' 'twt' string (default "")
7969 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007970 {only available when compiled with the |terminal|
7971 feature on MS-Windows}
7972 Specify the virtual console (pty) used when opening the terminal
7973 window.
7974
7975 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007976 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007977 "winpty" use winpty, fail if not supported
7978 "conpty" use |ConPTY|, fail if not supported
7979
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007980 |ConPTY| support depends on the platform. Windows 10 October 2018
7981 Update is the first version that supports ConPTY, however it is still
7982 considered unstable. ConPTY might become stable in the next release
7983 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007984 supported then you cannot open a terminal window.
7985
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 *'terse'* *'noterse'*
7987'terse' boolean (default off)
7988 global
7989 When set: Add 's' flag to 'shortmess' option (this makes the message
7990 for a search that hits the start or end of the file not being
7991 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7992 shortens a lot of messages}
7993
7994 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7995'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 This option is obsolete. Use 'fileformats'.
7998 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7999 set to the default value for the current system. When 'textauto' is
8000 reset, 'fileformats' is made empty.
8001 NOTE: This option is set to the Vi default value when 'compatible' is
8002 set and to the Vim default value when 'compatible' is reset.
8003
8004 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008005'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 others: default off)
8007 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 This option is obsolete. Use 'fileformat'.
8009 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8010 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8011 "unix".
8012
8013 *'textwidth'* *'tw'*
8014'textwidth' 'tw' number (default 0)
8015 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 Maximum width of text that is being inserted. A longer line will be
8017 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008018 this.
8019 'textwidth' is set to 0 when the 'paste' option is set and restored
8020 when 'paste' is reset.
8021 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008023 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 NOTE: This option is set to 0 when 'compatible' is set.
8025
8026 *'thesaurus'* *'tsr'*
8027'thesaurus' 'tsr' string (default "")
8028 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008030 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
8031
8032 Each line in the file should contain words with similar meaning,
8033 separated by non-keyword characters (white space is preferred).
8034 Maximum line length is 510 bytes.
8035
Bram Moolenaard47d5222018-12-09 20:43:55 +01008036 An English word list was added to this github issue:
8037 https://github.com/vim/vim/issues/629#issuecomment-443293282
8038 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
8039 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
8040 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008041
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008042 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 after a comma are ignored, otherwise spaces are included in the file
8044 name. See |option-backslash| about using backslashes.
8045 The use of |:set+=| and |:set-=| is preferred when adding or removing
8046 directories from the list. This avoids problems when a future version
8047 uses another default.
8048 Backticks cannot be used in this option for security reasons.
8049
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008050 *'thesaurusfunc'* *tsrfu'*
8051'thesaurusfunc' 'tsrfu' string (default: empty)
8052 local to buffer
8053 {not available when compiled without the |+eval|
8054 feature}
8055 This option specifies a function to be used for thesaurus completion
8056 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T|
8057 See |complete-functions| for an explanation of how the function is
8058 invoked and what it should return.
8059 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: