blob: f210d31e98c26b4c090821b6bd0ee4a713d9ad45 [file] [log] [blame]
Bram Moolenaar079ba762021-10-23 12:08:41 +01001*options.txt* For Vim version 8.2. Last change: 2021 Oct 20
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200198Similarly, in legacy script the double quote character starts a comment. To
199include the '"' in the option value, use '\"' instead. This example sets the
200'titlestring' option to 'hi "there"': >
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000201 :set titlestring=hi\ \"there\"
202
Bram Moolenaar89a9c152021-08-29 21:55:35 +0200203In |Vim9| script it's simpler, comments start with a '#' character, and only
204when preceded by white space. A backslash is needed less often: >
205 vim9script
206 set titlestring=hi\ "there"
207 set titlestring=hi#there#
208 set titlestring=hi\ \#there#
209
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100210For Win32 backslashes in file names are mostly not removed. More precise: For
211options that expect a file name (those where environment variables are
212expanded) a backslash before a normal file name character is not removed. But
213a backslash before a special character (space, backslash, comma, etc.) is used
214like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215There is one special situation, when the value starts with "\\": >
216 :set dir=\\machine\path results in "\\machine\path"
217 :set dir=\\\\machine\\path results in "\\machine\path"
218 :set dir=\\path\\file results in "\\path\file" (wrong!)
219For the first one the start is kept, but for the second one the backslashes
220are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222result which is probably not what you want. Avoid it.
223
224 *add-option-flags* *remove-option-flags*
225 *E539* *E550* *E551* *E552*
226Some options are a list of flags. When you want to add a flag to such an
227option, without changing the existing ones, you can do it like this: >
228 :set guioptions+=a
229Remove a flag from an option like this: >
230 :set guioptions-=a
231This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000232Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
234doesn't appear.
235
236 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000237Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000238environment variable exists the '$' and the following environment variable
239name is replaced with its value. If it does not exist the '$' and the name
240are not modified. Any non-id character (not a letter, digit or '_') may
241follow the environment variable name. That character and what follows is
242appended to the value of the environment variable. Examples: >
243 :set term=$TERM.new
244 :set path=/usr/$INCLUDE,$HOME/include,.
245When adding or removing a string from an option with ":set opt-=val" or ":set
246opt+=val" the expansion is done before the adding or removing.
247
248
249Handling of local options *local-options*
250
251Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100252has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253allows you to set 'list' in one window but not in another. And set
254'shiftwidth' to 3 in one buffer and 4 in another.
255
256The following explains what happens to these local options in specific
257situations. You don't really need to know all of this, since Vim mostly uses
258the option values you would expect. Unfortunately, doing what the user
259expects is a bit complicated...
260
261When splitting a window, the local options are copied to the new window. Thus
262right after the split the contents of the two windows look the same.
263
264When editing a new buffer, its local option values must be initialized. Since
265the local options of the current buffer might be specifically for that buffer,
266these are not used. Instead, for each buffer-local option there also is a
267global value, which is used for new buffers. With ":set" both the local and
268global value is changed. With "setlocal" only the local value is changed,
269thus this value is not used when editing a new buffer.
270
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200271When editing a buffer that has been edited before, the options from the window
272that was last closed are used again. If this buffer has been edited in this
273window, the values from back then are used. Otherwise the values from the
274last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275
276It's possible to set a local window option specifically for a type of buffer.
277When you edit another buffer in the same window, you don't want to keep
278using these local window options. Therefore Vim keeps a global value of the
279local window options, which is used when editing another buffer. Each window
280has its own copy of these values. Thus these are local to the window, but
281global to all buffers in the window. With this you can do: >
282 :e one
283 :set list
284 :e two
285Now the 'list' option will also be set in "two", since with the ":set list"
286command you have also set the global value. >
287 :set nolist
288 :e one
289 :setlocal list
290 :e two
291Now the 'list' option is not set, because ":set nolist" resets the global
292value, ":setlocal list" only changes the local value and ":e two" gets the
293global value. Note that if you do this next: >
294 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200295You will get back the 'list' value as it was the last time you edited "one".
296The options local to a window are remembered for each buffer. This also
297happens when the buffer is not loaded, but they are lost when the buffer is
298wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299
300 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100301:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 current buffer or window. Not all options have a
303 local value. If the option does not have a local
304 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200305 With the "all" argument: display local values for all
306 local options.
307 Without argument: Display local values for all local
308 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000310 local value. For a global/local boolean option, when
311 the global value is being used, "--" is displayed
312 before the option name.
313 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000315
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000316:setl[ocal] {option}< Set the local value of {option} to its global value by
317 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000318
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100319:se[t] {option}< For |global-local| options: Remove the local value of
320 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000321
322 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100323:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324 option without changing the local value.
325 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200326 With the "all" argument: display global values for all
327 local options.
328 Without argument: display global values for all local
329 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330
331For buffer-local and window-local options:
332 Command global value local value ~
333 :set option=value set set
334 :setlocal option=value - set
335:setglobal option=value set -
336 :set option? - display
337 :setlocal option? - display
338:setglobal option? display -
339
340
341Global options with a local value *global-local*
342
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000343Options are global when you mostly use one value for all buffers and windows.
344For some global options it's useful to sometimes have a different local value.
345You can set the local value with ":setlocal". That buffer or window will then
346use the local value, while other buffers and windows continue using the global
347value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348
349For example, you have two windows, both on C source code. They use the global
350'makeprg' option. If you do this in one of the two windows: >
351 :set makeprg=gmake
352then the other window will switch to the same value. There is no need to set
353the 'makeprg' option in the other C source window too.
354However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000355another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000356files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357 :setlocal makeprg=perlmake
358You can switch back to using the global value by making the local value empty: >
359 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100360This only works for a string option. For a number or boolean option you need
361to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100363Note that for non-boolean and non-number options using "<" copies the global
364value to the local value, it doesn't switch back to using the global value
365(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000366 :set path<
367This will make the local value of 'path' empty, so that the global value is
368used. Thus it does the same as: >
369 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370Note: In the future more global options can be made global-local. Using
371":setlocal" on a global option might work differently then.
372
373
374Setting the filetype
375
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200376:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377 Set the 'filetype' option to {filetype}, but only if
378 not done yet in a sequence of (nested) autocommands.
379 This is short for: >
380 :if !did_filetype()
381 : setlocal filetype={filetype}
382 :endif
383< This command is used in a filetype.vim file to avoid
384 setting the 'filetype' option twice, causing different
385 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200386
387 When the optional FALLBACK argument is present, a
388 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100389 'filetype'. This is to be used for filetype
390 detections that are just a guess. |did_filetype()|
391 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200392
Bram Moolenaard58e9292011-02-09 17:07:58 +0100393 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000394:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
395:opt[ions] Open a window for viewing and setting all options.
396 Options are grouped by function.
397 Offers short help for each option. Hit <CR> on the
398 short help to open a help window with more help for
399 the option.
400 Modify the value of the option and hit <CR> on the
401 "set" line to set the new value. For window and
402 buffer specific options, the last accessed window is
403 used to set the option value in, unless this is a help
404 window, in which case the window below help window is
405 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100406 {not available when compiled without the |+eval|
407 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408
409 *$HOME*
410Using "~" is like using "$HOME", but it is only recognized at the start of an
411option and after a space or comma.
412
413On Unix systems "~user" can be used too. It is replaced by the home directory
414of user "user". Example: >
415 :set path=~mool/include,/usr/include,.
416
417On Unix systems the form "${HOME}" can be used too. The name between {} can
418contain non-id characters then. Note that if you want to use this for the
419"gf" command, you need to add the '{' and '}' characters to 'isfname'.
420
421NOTE: expanding environment variables and "~/" is only done with the ":set"
422command, not when assigning a value to an option with ":let".
423
Bram Moolenaarc572da52017-08-27 16:52:01 +0200424 *$HOME-windows*
425On MS-Windows, if $HOME is not defined as an environment variable, then
426at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200427If $HOMEDRIVE is not set then $USERPROFILE is used.
428
429This expanded value is not exported to the environment, this matters when
430running an external command: >
431 :echo system('set | findstr ^HOME=')
432and >
433 :echo luaeval('os.getenv("HOME")')
434should echo nothing (an empty string) despite exists('$HOME') being true.
435When setting $HOME to a non-empty string it will be exported to the
436subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200437
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
439Note the maximum length of an expanded option is limited. How much depends on
440the system, mostly it is something like 256 or 1024 characters.
441
442 *:fix* *:fixdel*
443:fix[del] Set the value of 't_kD':
444 't_kb' is 't_kD' becomes ~
445 CTRL-? CTRL-H
446 not CTRL-? CTRL-?
447
Bram Moolenaar82be4842021-01-11 19:40:15 +0100448 (CTRL-? is 0o177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449
450 If your delete key terminal code is wrong, but the
451 code for backspace is alright, you can put this in
452 your .vimrc: >
453 :fixdel
454< This works no matter what the actual code for
455 backspace is.
456
457 If the backspace key terminal code is wrong you can
458 use this: >
459 :if &term == "termname"
460 : set t_kb=^V<BS>
461 : fixdel
462 :endif
463< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000464 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000465 with your terminal name.
466
467 If your <Delete> key sends a strange key sequence (not
468 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
469 :if &term == "termname"
470 : set t_kD=^V<Delete>
471 :endif
472< Where "^V" is CTRL-V and "<Delete>" is the delete key
473 (don't type eight characters!). Replace "termname"
474 with your terminal name.
475
476 *Linux-backspace*
477 Note about Linux: By default the backspace key
478 produces CTRL-?, which is wrong. You can fix it by
479 putting this line in your rc.local: >
480 echo "keycode 14 = BackSpace" | loadkeys
481<
482 *NetBSD-backspace*
483 Note about NetBSD: If your backspace doesn't produce
484 the right code, try this: >
485 xmodmap -e "keycode 22 = BackSpace"
486< If this works, add this in your .Xmodmap file: >
487 keysym 22 = BackSpace
488< You need to restart for this to take effect.
489
490==============================================================================
4912. Automatically setting options *auto-setting*
492
493Besides changing options with the ":set" command, there are three alternatives
494to set options automatically for one or more files:
495
4961. When starting Vim initializations are read from various places. See
497 |initialization|. Most of them are performed for all editing sessions,
498 and some of them depend on the directory where Vim is started.
499 You can create an initialization file with |:mkvimrc|, |:mkview| and
500 |:mksession|.
5012. If you start editing a new file, the automatic commands are executed.
502 This can be used to set options for files matching a particular pattern and
503 many other things. See |autocommand|.
5043. If you start editing a new file, and the 'modeline' option is on, a
505 number of lines at the beginning and end of the file are checked for
506 modelines. This is explained here.
507
508 *modeline* *vim:* *vi:* *ex:* *E520*
509There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100510 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100512[text{white}] empty or any text followed by at least one blank
513 character (<Space> or <Tab>); "ex:" always requires at
514 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200515{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200516[white] optional white space
517{options} a list of option settings, separated with white space
518 or ':', where each part between ':' is the argument
519 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000520
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200523 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000524
525The second form (this is compatible with some versions of Vi):
526
Bram Moolenaarade0d392020-01-21 22:33:58 +0100527 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
Bram Moolenaarade0d392020-01-21 22:33:58 +0100529[text{white}] empty or any text followed by at least one blank
530 character (<Space> or <Tab>); "ex:" always requires at
531 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
533[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534se[t] the string "set " or "se " (note the space); When
535 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200536{options} a list of options, separated with white space, which
537 is the argument for a ":set" command
538: a colon
539[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
Bram Moolenaar14b69452013-06-29 23:05:20 +0200541Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000542 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200543 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200545The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
546chance that a normal word like "lex:" is caught. There is one exception:
547"vi:" and "vim:" can also be at the start of the line (for compatibility with
548version 3.0). Using "ex:" at the start of the line will be ignored (this
549could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
Hu Jialun9dcd3492021-08-28 20:42:50 +0200551If the modeline is disabled within a modeline, subsequent modelines will be
552ignored. This is to allow turning off modeline on a per-file basis. This is
553useful when a line looks like a modeline but isn't. For example, it would be
554good to start a YAML file containing strings like "vim:" with
555 # vim: nomodeline ~
556so as to avoid modeline misdetection. Following options on the same line
557after modeline deactivation, if any, are still evaluated (but you would
558normally not have any).
559
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560 *modeline-local*
561The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000562buffer and window that contain the file. Although it's possible to set global
563options from a modeline, this is unusual. If you have two windows open and
564the files in it set the same global option to a different value, the result
565depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000567When editing a file that was already loaded, only the window-local options
568from the modeline are used. Thus if you manually changed a buffer-local
569option after opening the file, it won't be changed if you edit the same buffer
570in another window. But window-local options will be set.
571
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572 *modeline-version*
573If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200574number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575 vim{vers}: version {vers} or later
576 vim<{vers}: version before {vers}
577 vim={vers}: version {vers}
578 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100579{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
580For example, to use a modeline only for Vim 7.0:
581 /* vim700: set foldmethod=marker */ ~
582To use a modeline for Vim after version 7.2:
583 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584There can be no blanks between "vim" and the ":".
585
586
587The number of lines that are checked can be set with the 'modelines' option.
588If 'modeline' is off or 'modelines' is 0 no lines are checked.
589
590Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000591like:
592 /* vi:ts=4: */ ~
593will give an error message for the trailing "*/". This line is OK:
594 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595
596If an error is detected the rest of the line is skipped.
597
598If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000599backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100600 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
601This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
602before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200603 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000605might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200606can be set. For some options a flag is set, so that when the value is used
607the |sandbox| is effective. Some options can only be set from the modeline
608when 'modelineexpr' is set (the default is off).
609
610Still, there is always a small risk that a modeline causes trouble. E.g.,
611when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
612So disable modelines before editing untrusted text. The mail ftplugin does
613this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614
615Hint: If you would like to do something else than setting an option, you could
616define an autocommand that checks the file for a specific string. For
617example: >
618 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
619And define a function SetVar() that does something with the line containing
620"VAR".
621
622==============================================================================
6233. Options summary *option-summary*
624
625In the list below all the options are mentioned with their full name and with
626an abbreviation if there is one. Both forms may be used.
627
628In this document when a boolean option is "set" that means that ":set option"
629is entered. When an option is "reset", ":set nooption" is used.
630
631For some options there are two default values: The "Vim default", which is
632used when 'compatible' is not set, and the "Vi default", which is used when
633'compatible' is set.
634
635Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000636are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637different value in each window. For example the 'list' option can be set in
638one window and reset in another for the same text, giving both types of view
639at the same time. There are a few options that are specific to a certain
640file. These can have a different value for each file or buffer. For example
641the 'textwidth' option can be 78 for a normal text file and 0 for a C
642program.
643
644 global one option for all buffers and windows
645 local to window each window has its own copy of this option
646 local to buffer each buffer has its own copy of this option
647
648When creating a new window the option values from the currently active window
649are used as a default value for the window-specific options. For the
650buffer-specific options this depends on the 's' and 'S' flags in the
651'cpoptions' option. If 's' is included (which is the default) the values for
652buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000653first entered. If 'S' is present the options are copied each time the buffer
654is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655present, the options are copied from the currently active buffer when the
656buffer is created.
657
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000658Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000660Not all options are supported in all versions. This depends on the supported
661features and sometimes on the system. A remark about this is in curly braces
662below. When an option is not supported it may still be set without getting an
663error, this is called a hidden option. You can't get the value of a hidden
664option though, it is not stored.
665
666To test if option "foo" can be used with ":set" use something like this: >
667 if exists('&foo')
668This also returns true for a hidden option. To test if option "foo" is really
669supported use something like this: >
670 if exists('+foo')
671<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 *E355*
673A jump table for the options with a short description can be found at |Q_op|.
674
675 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100676'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 {only available when compiled with the |+rightleft|
679 feature}
680 The ASCII code for the first letter of the Hebrew alphabet. The
681 routine that maps the keyboard in Hebrew mode, both in Insert mode
682 (when hkmap is set) and on the command-line (when hitting CTRL-_)
683 outputs the Hebrew characters in the range [aleph..aleph+26].
684 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
685 See |rileft.txt|.
686
687 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
688'allowrevins' 'ari' boolean (default off)
689 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690 {only available when compiled with the |+rightleft|
691 feature}
692 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
693 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
694 into reverse Insert mode, and don't know how to get out. See
695 'revins'.
696 NOTE: This option is reset when 'compatible' is set.
697
698 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
699'altkeymap' 'akm' boolean (default off)
700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701 {only available when compiled with the |+farsi|
702 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100703 This option was for using Farsi, which has been removed. See
704 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705
706 *'ambiwidth'* *'ambw'*
707'ambiwidth' 'ambw' string (default: "single")
708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
710 Tells Vim what to do with characters with East Asian Width Class
711 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
712 letters, Cyrillic letters).
713
714 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000715 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 expected by most users.
717 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200718 *E834* *E835*
719 The value "double" cannot be used if 'listchars' or 'fillchars'
Bram Moolenaar079ba762021-10-23 12:08:41 +0100720 contains a character that would be double width. These errors may
721 also be given when calling setcellwidths().
Bram Moolenaar08aac3c2020-08-28 21:04:24 +0200722
723 The values are overruled for characters specified with
724 |setcellwidths()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725
726 There are a number of CJK fonts for which the width of glyphs for
727 those characters are solely based on how many octets they take in
728 legacy/traditional CJK encodings. In those encodings, Euro,
729 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000730 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000732 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 Vim is running inside a terminal (emulators) that uses a CJK font
734 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
735 this option should be set to "double" to match the width perceived
736 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100737 to be set to "double" under CJK MS-Windows when the system locale is
738 set to one of CJK locales. See Unicode Standard Annex #11
739 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100741 Vim may set this option automatically at startup time when Vim is
742 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200743 escape sequence to request cursor position report. The response can
744 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100745
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
747'antialias' 'anti' boolean (default: off)
748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 {only available when compiled with GUI enabled
Bram Moolenaar3d1cde82020-08-15 18:55:18 +0200750 on macOS}
751 This option only has an effect in the GUI version of Vim on macOS
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
753 which can be easier to read at certain sizes on certain displays.
754 Setting this option can sometimes cause problems if 'guifont' is set
755 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100756 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757
758 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
759'autochdir' 'acd' boolean (default off)
760 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200761 {only available when compiled with it, use
762 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000763 When on, Vim will change the current working directory whenever you
764 open a file, switch buffers, delete a buffer or open/close a window.
765 It will change to the directory containing the file which was opened
766 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000767 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768
Bram Moolenaar8b9abfd2021-03-29 20:49:05 +0200769 *'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
770'autoshelldir' 'asd' boolean (default off)
771 global
772 When on, Vim will change the current working directory whenever you
773 change the directory of the shell running in a terminal window. You
774 need proper setting-up, so whenever the shell's pwd changes an OSC 7
775 escape sequence will be emitted. For example, on Linux, you can source
776 /etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
777
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
779'arabic' 'arab' boolean (default off)
780 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 {only available when compiled with the |+arabic|
782 feature}
783 This option can be set to start editing Arabic text.
784 Setting this option will:
785 - Set the 'rightleft' option, unless 'termbidi' is set.
786 - Set the 'arabicshape' option, unless 'termbidi' is set.
787 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
788 between typing English and Arabic key mapping.
789 - Set the 'delcombine' option
790 Note that 'encoding' must be "utf-8" for working with Arabic text.
791
792 Resetting this option will:
793 - Reset the 'rightleft' option.
794 - Disable the use of 'keymap' (without changing its value).
795 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200796 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100797 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 Also see |arabic.txt|.
799
800 *'arabicshape'* *'arshape'*
801 *'noarabicshape'* *'noarshape'*
802'arabicshape' 'arshape' boolean (default on)
803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 {only available when compiled with the |+arabic|
805 feature}
806 When on and 'termbidi' is off, the required visual character
807 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200808 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809 one which encompasses:
810 a) the changing/morphing of characters based on their location
811 within a word (initial, medial, final and stand-alone).
812 b) the enabling of the ability to compose characters
813 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100814 When disabled the display shows each character's true stand-alone
815 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 Arabic is a complex language which requires other settings, for
817 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100818 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819
820 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
821'autoindent' 'ai' boolean (default off)
822 local to buffer
823 Copy indent from current line when starting a new line (typing <CR>
824 in Insert mode or when using the "o" or "O" command). If you do not
825 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000826 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
827 to another line has the same effect, unless the 'I' flag is included
828 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000829 When autoindent is on, formatting (with the "gq" command or when you
830 reach 'textwidth' in Insert mode) uses the indentation of the first
831 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 When 'smartindent' or 'cindent' is on the indent is changed in
833 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200834 The 'autoindent' option is reset when the 'paste' option is set and
835 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836
837 *'autoread'* *'ar'* *'noautoread'* *'noar'*
838'autoread' 'ar' boolean (default off)
839 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 When a file has been detected to have been changed outside of Vim and
841 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200842 When the file has been deleted this is not done, so you have the text
843 from before it was deleted. When it appears again then it is read.
844 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 If this option has a local value, use this command to switch back to
846 using the global value: >
847 :set autoread<
848<
849 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
850'autowrite' 'aw' boolean (default off)
851 global
852 Write the contents of the file, if it has been modified, on each
853 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000854 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
856 Note that for some commands the 'autowrite' option is not used, see
857 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200858 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200859 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860
861 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
862'autowriteall' 'awa' boolean (default off)
863 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
865 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
866 Setting this option also implies that Vim behaves like 'autowrite' has
867 been set.
868
869 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200870'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 When set to "dark", Vim will try to use colors that look good on a
873 dark background. When set to "light", Vim will try to use colors that
874 look good on a light background. Any other value is illegal.
875 Vim tries to set the default value according to the terminal used.
876 This will not always be correct.
877 Setting this option does not change the background color, it tells Vim
878 what the background color looks like. For changing the background
879 color, see |:hi-normal|.
880
881 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000882 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000883 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100884 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 setting 'background' will cause the color scheme to be reloaded. If
886 the color scheme adjusts to the value of 'background' this will work.
887 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100888 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889
890 When setting 'background' to the default value with: >
891 :set background&
892< Vim will guess the value. In the GUI this should work correctly,
893 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200894 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200895 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200897 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200898 color from the terminal. If the returned RGB value is dark/light and
899 'background' is not dark/light, 'background' will be set and the
900 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200901 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100902 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200903
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 When starting the GUI, the default value for 'background' will be
905 "light". When the value is not set in the .gvimrc, and Vim detects
906 that the background is actually quite dark, 'background' is set to
907 "dark". But this happens only AFTER the .gvimrc file has been read
908 (because the window needs to be opened to find the actual background
909 color). To get around this, force the GUI window to be opened by
910 putting a ":gui" command in the .gvimrc file, before where the value
911 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200912
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100913 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200914 For other systems "dark" is used when 'term' is "linux",
915 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
916 background. Otherwise the default is "light".
917
Bram Moolenaarc572da52017-08-27 16:52:01 +0200918 The |:terminal| command and the |term_start()| function use the
919 'background' value to decide whether the terminal window will start
920 with a white or black background.
921
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 Normally this option would be set in the .vimrc file. Possibly
923 depending on the terminal name. Example: >
924 :if &term == "pcterm"
925 : set background=dark
926 :endif
927< When this option is set, the default settings for the highlight groups
928 will change. To use other settings, place ":highlight" commands AFTER
929 the setting of the 'background' option.
930 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
931 to select the colors for syntax highlighting. After changing this
932 option, you must load syntax.vim again to see the result. This can be
933 done with ":syntax on".
934
935 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200936'backspace' 'bs' string (default "", set to "indent,eol,start"
937 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
940 mode. This is a list of items, separated by commas. Each item allows
941 a way to backspace over something:
942 value effect ~
943 indent allow backspacing over autoindent
944 eol allow backspacing over line breaks (join lines)
945 start allow backspacing over the start of insert; CTRL-W and CTRL-U
946 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200947 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
948 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949
950 When the value is empty, Vi compatible backspacing is used.
951
952 For backwards compatibility with version 5.4 and earlier:
953 value effect ~
954 0 same as ":set backspace=" (Vi compatible)
955 1 same as ":set backspace=indent,eol"
956 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200957 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958
959 See |:fixdel| if your <BS> or <Del> key does not do what you want.
960 NOTE: This option is set to "" when 'compatible' is set.
961
962 *'backup'* *'bk'* *'nobackup'* *'nobk'*
963'backup' 'bk' boolean (default off)
964 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 Make a backup before overwriting a file. Leave it around after the
966 file has been successfully written. If you do not want to keep the
967 backup file, but you do want a backup while the file is being
968 written, reset this option and set the 'writebackup' option (this is
969 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000970 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971 |backup-table| for more explanations.
972 When the 'backupskip' pattern matches, a backup is not made anyway.
973 When 'patchmode' is set, the backup may be renamed to become the
974 oldest version of a file.
975 NOTE: This option is reset when 'compatible' is set.
976
977 *'backupcopy'* *'bkc'*
978'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200979 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980 When writing a file and a backup is made, this option tells how it's
981 done. This is a comma separated list of words.
982
983 The main values are:
984 "yes" make a copy of the file and overwrite the original one
985 "no" rename the file and write a new one
986 "auto" one of the previous, what works best
987
988 Extra values that can be combined with the ones above are:
989 "breaksymlink" always break symlinks when writing
990 "breakhardlink" always break hardlinks when writing
991
992 Making a copy and overwriting the original file:
993 - Takes extra time to copy the file.
994 + When the file has special attributes, is a (hard/symbolic) link or
995 has a resource fork, all this is preserved.
996 - When the file is a link the backup will have the name of the link,
997 not of the real file.
998
999 Renaming the file and writing a new one:
1000 + It's fast.
1001 - Sometimes not all attributes of the file can be copied to the new
1002 file.
1003 - When the file is a link the new file will not be a link.
1004
1005 The "auto" value is the middle way: When Vim sees that renaming file
1006 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +00001007 the file is not a link) that is used. When problems are expected, a
1008 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009
1010 The "breaksymlink" and "breakhardlink" values can be used in
1011 combination with any of "yes", "no" and "auto". When included, they
1012 force Vim to always break either symbolic or hard links by doing
1013 exactly what the "no" option does, renaming the original file to
1014 become the backup and writing a new file in its place. This can be
1015 useful for example in source trees where all the files are symbolic or
1016 hard links and any changes should stay in the local source tree, not
1017 be propagated back to the original source.
1018 *crontab*
1019 One situation where "no" and "auto" will cause problems: A program
1020 that opens a file, invokes Vim to edit that file, and then tests if
1021 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001022 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 example.
1024
1025 When a copy is made, the original file is truncated and then filled
1026 with the new text. This means that protection bits, owner and
1027 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001028 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 group of the backup is set to the group of the original file. If this
1030 fails, the protection bits for the group are made the same as for
1031 others.
1032
1033 When the file is renamed this is the other way around: The backup has
1034 the same attributes of the original file, and the newly written file
1035 is owned by the current user. When the file was a (hard/symbolic)
1036 link, the new file will not! That's why the "auto" value doesn't
1037 rename when the file is a link. The owner and group of the newly
1038 written file will be set to the same ones as the original file, but
1039 the system may refuse to do this. In that case the "auto" value will
1040 again not rename the file.
1041
Bram Moolenaar036986f2017-03-16 17:41:02 +01001042 NOTE: This option is set to the Vi default value when 'compatible' is
1043 set and to the Vim default value when 'compatible' is reset.
1044
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 *'backupdir'* *'bdir'*
1046'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001047 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 for Unix: ".,~/tmp,~/")
1049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050 List of directories for the backup file, separated with commas.
1051 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001052 where this is possible. The directory must exist, Vim will not
1053 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001054 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 impossible!). Writing may fail because of this.
1056 - A directory "." means to put the backup file in the same directory
1057 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001058 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1059 the backup file relative to where the edited file is. The leading
1060 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 ("." inside a directory name has no special meaning).
1062 - Spaces after the comma are ignored, other spaces are considered part
1063 of the directory name. To have a space at the start of a directory
1064 name, precede it with a backslash.
1065 - To include a comma in a directory name precede it with a backslash.
1066 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001067 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001068 the backup file name will be built from the complete path to the
1069 file with all path separators changed to percent '%' signs. This
1070 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001071 On Win32, it is also possible to end with "\\". However, When a
1072 separating comma is following, you must use "//", since "\\" will
1073 include the comma in the file name. Therefore it is recommended to
1074 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 - Environment variables are expanded |:set_env|.
1076 - Careful with '\' characters, type one before a space, type two to
1077 get one in the option (see |option-backslash|), for example: >
1078 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1079< - For backwards compatibility with Vim version 3.0 a '>' at the start
1080 of the option is removed.
1081 See also 'backup' and 'writebackup' options.
1082 If you want to hide your backup files on Unix, consider this value: >
1083 :set backupdir=./.backup,~/.backup,.,/tmp
1084< You must create a ".backup" directory in each directory and in your
1085 home directory for this to work properly.
1086 The use of |:set+=| and |:set-=| is preferred when adding or removing
1087 directories from the list. This avoids problems when a future version
1088 uses another default.
1089 This option cannot be set from a |modeline| or in the |sandbox|, for
1090 security reasons.
1091
1092 *'backupext'* *'bex'* *E589*
1093'backupext' 'bex' string (default "~", for VMS: "_")
1094 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 String which is appended to a file name to make the name of the
1096 backup file. The default is quite unusual, because this avoids
1097 accidentally overwriting existing files with a backup file. You might
1098 prefer using ".bak", but make sure that you don't have files with
1099 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001100 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001102 If you like to keep a lot of backups, you could use a BufWritePre
1103 autocommand to change 'backupext' just before writing the file to
1104 include a timestamp. >
1105 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1106< Use 'backupdir' to put the backup in a different directory.
1107
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001109'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1110 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1111 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 {not available when compiled without the |+wildignore|
1114 feature}
1115 A list of file patterns. When one of the patterns matches with the
1116 name of the file which is written, no backup file is created. Both
1117 the specified file name and the full path name of the file are used.
1118 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1119 Watch out for special characters, see |option-backslash|.
1120 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001121 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001122
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001123 WARNING: Not having a backup file means that when Vim fails to write
1124 your buffer correctly and then, for whatever reason, Vim exits, you
1125 lose both the original file and what you were writing. Only disable
1126 backups if you don't care about losing the file.
1127
Bram Moolenaar02467872007-05-06 13:22:01 +00001128 Note that environment variables are not expanded. If you want to use
1129 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001130 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001131
1132< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001133 backup would be made by renaming the original file crontab won't see
1134 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135
1136 *'balloondelay'* *'bdlay'*
1137'balloondelay' 'bdlay' number (default: 600)
1138 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001139 {only available when compiled with the |+balloon_eval|
1140 feature}
1141 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1142
1143 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1144'ballooneval' 'beval' boolean (default off)
1145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001147 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001148 Switch on the |balloon-eval| functionality for the GUI.
1149
1150 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1151 *'nobevalterm'*
1152'balloonevalterm' 'bevalterm' boolean (default off)
1153 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001154 {only available when compiled with the
1155 |+balloon_eval_term| feature}
1156 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001158 *'balloonexpr'* *'bexpr'*
1159'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001160 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001161 {only available when compiled with the |+balloon_eval|
1162 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001163 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001164 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1165 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001166
1167 v:beval_bufnr number of the buffer in which balloon is going to show
1168 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001169 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001170 v:beval_lnum line number
1171 v:beval_col column number (byte index)
1172 v:beval_text word under or after the mouse pointer
1173
Bram Moolenaar54775062019-07-31 21:07:14 +02001174 Instead of showing a balloon, which is limited to plain text, consider
1175 using a popup window, see |popup_beval_example|. A popup window can
1176 use highlighting and show a border.
1177
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001178 The evaluation of the expression must not have side effects!
1179 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001180 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001181 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001182 \', column ' . v:beval_col .
1183 \ ' of file ' . bufname(v:beval_bufnr) .
1184 \ ' on word "' . v:beval_text . '"'
1185 endfunction
1186 set bexpr=MyBalloonExpr()
1187 set ballooneval
1188<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001189 Also see |balloon_show()|, it can be used if the content of the balloon
1190 is to be fetched asynchronously. In that case evaluating
1191 'balloonexpr' should result in an empty string. If you get a balloon
1192 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001193
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001194 NOTE: The balloon is displayed only if the cursor is on a text
1195 character. If the result of evaluating 'balloonexpr' is not empty,
1196 Vim does not try to send a message to an external debugger (Netbeans
1197 or Sun Workshop).
1198
Bram Moolenaar30b65812012-07-12 22:01:11 +02001199 The expression will be evaluated in the |sandbox| when set from a
1200 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001201 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001202
1203 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001204 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001205
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001206 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001207 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001208< When they are supported "\n" characters will start a new line. If the
1209 expression evaluates to a |List| this is equal to using each List item
1210 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001211 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001212
Bram Moolenaar165bc692015-07-21 17:53:25 +02001213 *'belloff'* *'bo'*
1214'belloff' 'bo' string (default "")
1215 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001216 Specifies for which events the bell will not be rung. It is a comma
1217 separated list of items. For each item that is present, the bell
1218 will be silenced. This is most useful to specify specific events in
1219 insert mode to be silenced.
1220
1221 item meaning when present ~
1222 all All events.
1223 backspace When hitting <BS> or <Del> and deleting results in an
1224 error.
1225 cursor Fail to move around using the cursor keys or
1226 <PageUp>/<PageDown> in |Insert-mode|.
1227 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1228 |i_CTRL-X_CTRL-T|.
1229 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1230 |i_CTRL-E|.
1231 ctrlg Unknown Char after <C-G> in Insert mode.
1232 error Other Error occurred (e.g. try to join last line)
1233 (mostly used in |Normal-mode| or |Cmdline-mode|).
1234 esc hitting <Esc> in |Normal-mode|.
1235 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001236 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001237 insertmode Pressing <Esc> in 'insertmode'.
1238 lang Calling the beep module for Lua/Mzscheme/TCL.
1239 mess No output available for |g<|.
1240 showmatch Error occurred for 'showmatch' function.
1241 operator Empty region error |cpo-E|.
1242 register Unknown register after <C-R> in |Insert-mode|.
1243 shell Bell from shell output |:!|.
1244 spell Error happened on spell suggest.
1245 wildmode More matches in |cmdline-completion| available
1246 (depends on the 'wildmode' setting).
1247
Bram Moolenaar036986f2017-03-16 17:41:02 +01001248 This is most useful to fine tune when in Insert mode the bell should
1249 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001250 indicate that an error occurred. It can be silenced by adding the
1251 "error" keyword.
1252
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1254'binary' 'bin' boolean (default off)
1255 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 This option should be set before editing a binary file. You can also
1257 use the |-b| Vim argument. When this option is switched on a few
1258 options will be changed (also when it already was on):
1259 'textwidth' will be set to 0
1260 'wrapmargin' will be set to 0
1261 'modeline' will be off
1262 'expandtab' will be off
1263 Also, 'fileformat' and 'fileformats' options will not be used, the
1264 file is read and written like 'fileformat' was "unix" (a single <NL>
1265 separates lines).
1266 The 'fileencoding' and 'fileencodings' options will not be used, the
1267 file is read without conversion.
1268 NOTE: When you start editing a(nother) file while the 'bin' option is
1269 on, settings from autocommands may change the settings again (e.g.,
1270 'textwidth'), causing trouble when editing. You might want to set
1271 'bin' again when the file has been loaded.
1272 The previous values of these options are remembered and restored when
1273 'bin' is switched from on to off. Each buffer has its own set of
1274 saved option values.
1275 To edit a file with 'binary' set you can use the |++bin| argument.
1276 This avoids you have to do ":set bin", which would have effect for all
1277 files you edit.
1278 When writing a file the <EOL> for the last line is only written if
1279 there was one in the original file (normally Vim appends an <EOL> to
1280 the last line if there is none; this would make the file longer). See
1281 the 'endofline' option.
1282
1283 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1284'bioskey' 'biosk' boolean (default on)
1285 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001286 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001287 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288
1289 *'bomb'* *'nobomb'*
1290'bomb' boolean (default off)
1291 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 When writing a file and the following conditions are met, a BOM (Byte
1293 Order Mark) is prepended to the file:
1294 - this option is on
1295 - the 'binary' option is off
1296 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1297 endian variants.
1298 Some applications use the BOM to recognize the encoding of the file.
1299 Often used for UCS-2 files on MS-Windows. For other applications it
1300 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001301 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1303 check for the presence of the BOM is done and 'bomb' set accordingly.
1304 Unless 'binary' is set, it is removed from the first line, so that you
1305 don't see it when editing. When you don't change the options, the BOM
1306 will be restored when writing the file.
1307
1308 *'breakat'* *'brk'*
1309'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1310 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001311 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 feature}
1313 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001314 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1315 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001317 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001318'breakindent' 'bri' boolean (default off)
1319 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001320 {not available when compiled without the |+linebreak|
1321 feature}
1322 Every wrapped line will continue visually indented (same amount of
1323 space as the beginning of that line), thus preserving horizontal blocks
1324 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001325 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001326
1327 *'breakindentopt'* *'briopt'*
1328'breakindentopt' 'briopt' string (default empty)
1329 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001330 {not available when compiled without the |+linebreak|
1331 feature}
1332 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001333 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001334 min:{n} Minimum text width that will be kept after
1335 applying 'breakindent', even if the resulting
1336 text should normally be narrower. This prevents
1337 text indented almost to the right window border
1338 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001339 shift:{n} After applying 'breakindent', the wrapped line's
1340 beginning will be shifted by the given number of
1341 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001342 indentation (negative) or emphasizing the line
1343 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001344 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001345 additional indent.
Maxim Kimf674b352021-07-22 11:46:59 +02001346 list:{n} Adds an additional indent for lines that match a
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001347 numbered or bulleted list (using the
1348 'formatlistpat' setting).
Maxim Kimf674b352021-07-22 11:46:59 +02001349 list:-1 Uses the length of a match with 'formatlistpat'
1350 for indentation.
Christian Brabandt4a0b85a2021-07-14 20:00:27 +02001351 The default value for min is 20, shift and list is 0.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001352
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001354'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001356 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001358 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001359 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 buffer Use the directory of the related buffer.
1361 current Use the current directory.
1362 {path} Use the specified directory
1363
1364 *'bufhidden'* *'bh'*
1365'bufhidden' 'bh' string (default: "")
1366 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 This option specifies what happens when a buffer is no longer
1368 displayed in a window:
1369 <empty> follow the global 'hidden' option
1370 hide hide the buffer (don't unload it), also when 'hidden'
1371 is not set
1372 unload unload the buffer, also when 'hidden' is set or using
1373 |:hide|
1374 delete delete the buffer from the buffer list, also when
1375 'hidden' is set or using |:hide|, like using
1376 |:bdelete|
1377 wipe wipe out the buffer from the buffer list, also when
1378 'hidden' is set or using |:hide|, like using
1379 |:bwipeout|
1380
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001381 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001382 are lost without a warning. Also, these values may break autocommands
1383 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 This option is used together with 'buftype' and 'swapfile' to specify
1385 special kinds of buffers. See |special-buffers|.
1386
1387 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1388'buflisted' 'bl' boolean (default: on)
1389 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 When this option is set, the buffer shows up in the buffer list. If
1391 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1392 This option is reset by Vim for buffers that are only used to remember
1393 a file name or marks. Vim sets it when starting to edit a buffer.
1394 But not when moving to a buffer with ":buffer".
1395
1396 *'buftype'* *'bt'* *E382*
1397'buftype' 'bt' string (default: "")
1398 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399 The value of this option specifies the type of a buffer:
1400 <empty> normal buffer
1401 nofile buffer which is not related to a file and will not be
1402 written
1403 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001404 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001405 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001407 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408 help help buffer (you are not supposed to set this
1409 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001410 terminal buffer for a |terminal| (you are not supposed to set
1411 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001412 prompt buffer where only the last line can be edited, meant
1413 to be used by a plugin, see |prompt-buffer|
1414 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001415 popup buffer used in a popup window, see |popup|.
1416 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417
1418 This option is used together with 'bufhidden' and 'swapfile' to
1419 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001420 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421
1422 Be careful with changing this option, it can have many side effects!
1423
Bram Moolenaar280f1262006-01-30 00:14:18 +00001424 A "quickfix" buffer is only used for the error list and the location
1425 list. This value is set by the |:cwindow| and |:lwindow| commands and
1426 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427
1428 "nofile" and "nowrite" buffers are similar:
1429 both: The buffer is not to be written to disk, ":w" doesn't
1430 work (":w filename" does work though).
1431 both: The buffer is never considered to be |'modified'|.
1432 There is no warning when the changes will be lost, for
1433 example when you quit Vim.
1434 both: A swap file is only created when using too much memory
1435 (when 'swapfile' has been reset there is never a swap
1436 file).
1437 nofile only: The buffer name is fixed, it is not handled like a
1438 file name. It is not modified in response to a |:cd|
1439 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001440 both: When using ":e bufname" and already editing "bufname"
1441 the buffer is made empty and autocommands are
1442 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001443 *E676*
1444 "acwrite" implies that the buffer name is not related to a file, like
1445 "nofile", but it will be written. Thus, in contrast to "nofile" and
1446 "nowrite", ":w" does work and a modified buffer can't be abandoned
1447 without saving. For writing there must be matching |BufWriteCmd|,
1448 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001449
1450 *'casemap'* *'cmp'*
1451'casemap' 'cmp' string (default: "internal,keepascii")
1452 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 Specifies details about changing the case of letters. It may contain
1454 these words, separated by a comma:
1455 internal Use internal case mapping functions, the current
1456 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001457 matters when 'encoding' is a Unicode encoding,
1458 "latin1" or "iso-8859-15". When "internal" is
1459 omitted, the towupper() and towlower() system library
1460 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1462 case mapping, the current locale is not effective.
1463 This probably only matters for Turkish.
1464
1465 *'cdpath'* *'cd'* *E344* *E346*
1466'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1467 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468 {not available when compiled without the
1469 |+file_in_path| feature}
1470 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001471 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1472 searched for has a relative path, not an absolute part starting with
1473 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 The 'cdpath' option's value has the same form and semantics as
1475 |'path'|. Also see |file-searching|.
1476 The default value is taken from $CDPATH, with a "," prepended to look
1477 in the current directory first.
1478 If the default value taken from $CDPATH is not what you want, include
1479 a modified version of the following command in your vimrc file to
1480 override it: >
1481 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1482< This option cannot be set from a |modeline| or in the |sandbox|, for
1483 security reasons.
1484 (parts of 'cdpath' can be passed to the shell to expand file names).
1485
1486 *'cedit'*
1487'cedit' string (Vi default: "", Vim default: CTRL-F)
1488 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 The key used in Command-line Mode to open the command-line window.
1490 The default is CTRL-F when 'compatible' is off.
1491 Only non-printable keys are allowed.
1492 The key can be specified as a single character, but it is difficult to
1493 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001494 :exe "set cedit=\<C-Y>"
1495 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496< |Nvi| also has this option, but it only uses the first character.
1497 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001498 NOTE: This option is set to the Vim default value when 'compatible'
1499 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500
1501 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1502'charconvert' 'ccv' string (default "")
1503 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001504 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 An expression that is used for character encoding conversion. It is
1506 evaluated when a file that is to be read or has been written has a
1507 different encoding from what is desired.
1508 'charconvert' is not used when the internal iconv() function is
1509 supported and is able to do the conversion. Using iconv() is
1510 preferred, because it is much faster.
1511 'charconvert' is not used when reading stdin |--|, because there is no
1512 file to convert from. You will have to save the text in a file first.
1513 The expression must return zero or an empty string for success,
1514 non-zero for failure.
1515 The possible encoding names encountered are in 'encoding'.
1516 Additionally, names given in 'fileencodings' and 'fileencoding' are
1517 used.
1518 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1519 is done internally by Vim, 'charconvert' is not used for this.
1520 'charconvert' is also used to convert the viminfo file, if the 'c'
1521 flag is present in 'viminfo'. Also used for Unicode conversion.
1522 Example: >
1523 set charconvert=CharConvert()
1524 fun CharConvert()
1525 system("recode "
1526 \ . v:charconvert_from . ".." . v:charconvert_to
1527 \ . " <" . v:fname_in . " >" v:fname_out)
1528 return v:shell_error
1529 endfun
1530< The related Vim variables are:
1531 v:charconvert_from name of the current encoding
1532 v:charconvert_to name of the desired encoding
1533 v:fname_in name of the input file
1534 v:fname_out name of the output file
1535 Note that v:fname_in and v:fname_out will never be the same.
1536 Note that v:charconvert_from and v:charconvert_to may be different
1537 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1538 Encryption is not done by Vim when using 'charconvert'. If you want
1539 to encrypt the file after conversion, 'charconvert' should take care
1540 of this.
1541 This option cannot be set from a |modeline| or in the |sandbox|, for
1542 security reasons.
1543
1544 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1545'cindent' 'cin' boolean (default off)
1546 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 {not available when compiled without the |+cindent|
1548 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001549 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 that trigger reindenting in insert mode and 'cinoptions' to set your
1551 preferred indent style.
1552 If 'indentexpr' is not empty, it overrules 'cindent'.
1553 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1554 the "=" operator indents using this algorithm rather than calling an
1555 external program.
1556 See |C-indenting|.
1557 When you don't like the way 'cindent' works, try the 'smartindent'
1558 option or 'indentexpr'.
1559 This option is not used when 'paste' is set.
1560 NOTE: This option is reset when 'compatible' is set.
1561
1562 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001563'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001564 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 {not available when compiled without the |+cindent|
1566 feature}
1567 A list of keys that, when typed in Insert mode, cause reindenting of
1568 the current line. Only used if 'cindent' is on and 'indentexpr' is
1569 empty.
1570 For the format of this option see |cinkeys-format|.
1571 See |C-indenting|.
1572
1573 *'cinoptions'* *'cino'*
1574'cinoptions' 'cino' string (default "")
1575 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576 {not available when compiled without the |+cindent|
1577 feature}
1578 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1579 program. See |cinoptions-values| for the values of this option, and
1580 |C-indenting| for info on C indenting in general.
1581
1582
1583 *'cinwords'* *'cinw'*
1584'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1585 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 {not available when compiled without both the
1587 |+cindent| and the |+smartindent| features}
1588 These keywords start an extra indent in the next line when
1589 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1590 an appropriate place (inside {}).
1591 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1592 matter, include the keyword both the uppercase and lowercase:
1593 "if,If,IF".
1594
1595 *'clipboard'* *'cb'*
1596'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1597 for X-windows, "" otherwise)
1598 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 {only in GUI versions or when the |+xterm_clipboard|
1600 feature is included}
1601 This option is a list of comma separated names.
Bram Moolenaar942db232021-02-13 18:14:48 +01001602 Note: if one of the items is "exclude:", then you can't add an item
1603 after that. Therefore do append an item with += but use ^= to
1604 prepend, e.g.: >
1605 set clipboard^=unnamed
1606< These names are recognized:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001608 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 unnamed When included, Vim will use the clipboard register '*'
1610 for all yank, delete, change and put operations which
1611 would normally go to the unnamed register. When a
1612 register is explicitly specified, it will always be
1613 used regardless of whether "unnamed" is in 'clipboard'
1614 or not. The clipboard register can always be
1615 explicitly accessed using the "* notation. Also see
1616 |gui-clipboard|.
1617
Bram Moolenaar30b65812012-07-12 22:01:11 +02001618 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001619 unnamedplus A variant of the "unnamed" flag which uses the
1620 clipboard register '+' (|quoteplus|) instead of
1621 register '*' for all yank, delete, change and put
1622 operations which would normally go to the unnamed
1623 register. When "unnamed" is also included to the
1624 option, yank operations (but not delete, change or
1625 put) will additionally copy the text into register
1626 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001627 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001628 Availability can be checked with: >
1629 if has('unnamedplus')
1630<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001631 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 autoselect Works like the 'a' flag in 'guioptions': If present,
1633 then whenever Visual mode is started, or the Visual
1634 area extended, Vim tries to become the owner of the
1635 windowing system's global selection or put the
1636 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001637 register "*. See |'go-a'| and |quotestar| for details.
1638 When the GUI is active, the 'a' flag in 'guioptions'
1639 is used, when the GUI is not active, this "autoselect"
1640 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 Also applies to the modeless selection.
1642
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001643 *clipboard-autoselectplus*
1644 autoselectplus Like "autoselect" but using the + register instead of
1645 the * register. Compare to the 'P' flag in
1646 'guioptions'.
1647
1648 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 autoselectml Like "autoselect", but for the modeless selection
1650 only. Compare to the 'A' flag in 'guioptions'.
1651
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001652 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001653 html When the clipboard contains HTML, use this when
1654 pasting. When putting text on the clipboard, mark it
1655 as HTML. This works to copy rendered HTML from
1656 Firefox, paste it as raw HTML in Vim, select the HTML
1657 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001658 You probably want to add this only temporarily,
1659 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001660 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001661
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001662 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 exclude:{pattern}
1664 Defines a pattern that is matched against the name of
1665 the terminal 'term'. If there is a match, no
1666 connection will be made to the X server. This is
1667 useful in this situation:
1668 - Running Vim in a console.
1669 - $DISPLAY is set to start applications on another
1670 display.
1671 - You do not want to connect to the X server in the
1672 console, but do want this in a terminal emulator.
1673 To never connect to the X server use: >
1674 exclude:.*
1675< This has the same effect as using the |-X| argument.
1676 Note that when there is no connection to the X server
1677 the window title won't be restored and the clipboard
1678 cannot be accessed.
1679 The value of 'magic' is ignored, {pattern} is
1680 interpreted as if 'magic' was on.
1681 The rest of the option value will be used for
1682 {pattern}, this must be the last entry.
1683
1684 *'cmdheight'* *'ch'*
1685'cmdheight' 'ch' number (default 1)
1686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 Number of screen lines to use for the command-line. Helps avoiding
1688 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001689 The value of this option is stored with the tab page, so that each tab
1690 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691
1692 *'cmdwinheight'* *'cwh'*
1693'cmdwinheight' 'cwh' number (default 7)
1694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 Number of screen lines to use for the command-line window. |cmdwin|
1696
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001697 *'colorcolumn'* *'cc'*
1698'colorcolumn' 'cc' string (default "")
1699 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001700 {not available when compiled without the |+syntax|
1701 feature}
1702 'colorcolumn' is a comma separated list of screen columns that are
1703 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1704 text. Will make screen redrawing slower.
1705 The screen column can be an absolute number, or a number preceded with
1706 '+' or '-', which is added to or subtracted from 'textwidth'. >
1707
1708 :set cc=+1 " highlight column after 'textwidth'
1709 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1710 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1711<
1712 When 'textwidth' is zero then the items with '-' and '+' are not used.
1713 A maximum of 256 columns are highlighted.
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 *'columns'* *'co'* *E594*
1716'columns' 'co' number (default 80 or terminal width)
1717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001719 initialization and does not have to be set by hand. Also see
1720 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 When Vim is running in the GUI or in a resizable window, setting this
1722 option will cause the window size to be changed. When you only want
1723 to use the size for the GUI, put the command in your |gvimrc| file.
1724 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001725 number of columns of the display, the display may be messed up. For
1726 the GUI it is always possible and Vim limits the number of columns to
1727 what fits on the screen. You can use this command to get the widest
1728 window possible: >
1729 :set columns=9999
1730< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731
1732 *'comments'* *'com'* *E524* *E525*
1733'comments' 'com' string (default
1734 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1735 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736 A comma separated list of strings that can start a comment line. See
1737 |format-comments|. See |option-backslash| about using backslashes to
1738 insert a space.
1739
1740 *'commentstring'* *'cms'* *E537*
1741'commentstring' 'cms' string (default "/*%s*/")
1742 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 {not available when compiled without the |+folding|
1744 feature}
1745 A template for a comment. The "%s" in the value is replaced with the
1746 comment text. Currently only used to add markers for folding, see
1747 |fold-marker|.
1748
1749 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001750'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001751 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 This option has the effect of making Vim either more Vi-compatible, or
1754 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001755
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001757 other options are also changed as a side effect.
1758 NOTE: Setting or resetting this option can have a lot of unexpected
1759 effects: Mappings are interpreted in another way, undo behaves
1760 differently, etc. If you set this option in your vimrc file, you
1761 should probably put it at the very start.
1762
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 By default this option is on and the Vi defaults are used for the
1764 options. This default was chosen for those people who want to use Vim
1765 just like Vi, and don't even (want to) know about the 'compatible'
1766 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001767 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001768 this option is switched off, and all options that have not been
1769 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001770 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001771 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001772 happen for the system-wide vimrc or gvimrc file, nor for a file given
1773 with the |-u| argument). Also see |compatible-default| and
1774 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 You can also set this option with the "-C" argument, and reset it with
1776 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001777 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778
Bram Moolenaar214641f2017-03-05 17:04:09 +01001779 When this option is set, numerous other options are set to make Vim as
1780 Vi-compatible as possible. When this option is unset, various options
1781 are set to make Vim more useful. The table below lists all the
1782 options affected.
1783 The {?} column indicates when the options are affected:
1784 + Means that the option is set to the value given in {set value} when
1785 'compatible' is set.
1786 & Means that the option is set to the value given in {set value} when
1787 'compatible' is set AND is set to its Vim default value when
1788 'compatible' is unset.
1789 - Means the option is NOT changed when setting 'compatible' but IS
1790 set to its Vim default when 'compatible' is unset.
1791 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792
Bram Moolenaar036986f2017-03-16 17:41:02 +01001793 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001794
1795 'allowrevins' + off no CTRL-_ command
1796 'antialias' + off don't use antialiased fonts
1797 'arabic' + off reset arabic-related options
1798 'arabicshape' + on correct character shapes
1799 'backspace' + "" normal backspace
1800 'backup' + off no backup file
1801 'backupcopy' & Unix: "yes" backup file is a copy
1802 else: "auto" copy or rename backup file
1803 'balloonexpr' + "" text to show in evaluation balloon
1804 'breakindent' + off don't indent when wrapping lines
1805 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1806 'cindent' + off no C code indentation
1807 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1808 'copyindent' + off don't copy indent structure
1809 'cpoptions' & (all flags) Vi-compatible flags
1810 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001811 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001812 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001813 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001814 'cscopeverbose' + off see |cscopeverbose|
1815 'delcombine' + off unicode: delete whole char combination
1816 'digraph' + off no digraphs
1817 'esckeys' & off no <Esc>-keys in Insert mode
1818 'expandtab' + off tabs not expanded to spaces
1819 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001820 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001821 'formatexpr' + "" use 'formatprg' for auto-formatting
1822 'formatoptions' & "vt" Vi compatible formatting
1823 'gdefault' + off no default 'g' flag for ":s"
1824 'history' & 0 no commandline history
1825 'hkmap' + off no Hebrew keyboard mapping
1826 'hkmapp' + off no phonetic Hebrew keyboard mapping
1827 'hlsearch' + off no highlighting of search matches
1828 'incsearch' + off no incremental searching
1829 'indentexpr' + "" no indenting by expression
1830 'insertmode' + off do not start in Insert mode
1831 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001833 'joinspaces' + on insert 2 spaces after period
1834 'modeline' & off no modelines
1835 'more' & off no pauses in listings
1836 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1837 'numberwidth' & 8 min number of columns for line number
1838 'preserveindent'+ off don't preserve current indent structure
1839 when changing it
1840 'revins' + off no reverse insert
1841 'ruler' + off no ruler
1842 'scrolljump' + 1 no jump scroll
1843 'scrolloff' + 0 no scroll offset
1844 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1845 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001846 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001847 'showcmd' & off command characters not shown
1848 'showmode' & off current mode not shown
1849 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1850 'smartcase' + off no automatic ignore case switch
1851 'smartindent' + off no smart indentation
1852 'smarttab' + off no smart tab size
1853 'softtabstop' + 0 tabs are always 'tabstop' positions
1854 'startofline' + on goto startofline with some commands
1855 'tagcase' & "followic" 'ignorecase' when searching tags file
1856 'tagrelative' & off tag file names are not relative
1857 'termguicolors' + off don't use highlight-(guifg|guibg)
1858 'textauto' & off no automatic textmode detection
1859 'textwidth' + 0 no automatic line wrap
1860 'tildeop' + off tilde is not an operator
1861 'ttimeout' + off no terminal timeout
1862 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001863 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001864 'virtualedit' + "" cursor can only be placed on characters
1865 'whichwrap' & "" left-right movements don't wrap
1866 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001868 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869
1870 *'complete'* *'cpt'* *E535*
1871'complete' 'cpt' string (default: ".,w,b,u,t,i")
1872 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 This option specifies how keyword completion |ins-completion| works
1874 when CTRL-P or CTRL-N are used. It is also used for whole-line
1875 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1876 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001877 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 w scan buffers from other windows
1879 b scan other loaded buffers that are in the buffer list
1880 u scan the unloaded buffers that are in the buffer list
1881 U scan the buffers that are not in the buffer list
1882 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001883 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 k{dict} scan the file {dict}. Several "k" flags can be given,
1885 patterns are valid too. For example: >
1886 :set cpt=k/usr/dict/*,k~/spanish
1887< s scan the files given with the 'thesaurus' option
1888 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1889 are valid too.
1890 i scan current and included files
1891 d scan current and included files for defined name or macro
1892 |i_CTRL-X_CTRL-D|
1893 ] tag completion
1894 t same as "]"
1895
1896 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1897 not executed, this may lead to unexpected completions from some files
1898 (gzipped files for example). Unloaded buffers are not scanned for
1899 whole-line completion.
1900
1901 The default is ".,w,b,u,t,i", which means to scan:
1902 1. the current buffer
1903 2. buffers in other windows
1904 3. other loaded buffers
1905 4. unloaded buffers
1906 5. tags
1907 6. included files
1908
1909 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001910 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1911 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001913 *'completefunc'* *'cfu'*
1914'completefunc' 'cfu' string (default: empty)
1915 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001916 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001917 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001918 This option specifies a function to be used for Insert mode completion
1919 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001920 See |complete-functions| for an explanation of how the function is
1921 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001922 This option cannot be set from a |modeline| or in the |sandbox|, for
1923 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001924
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001925 *'completeslash'* *'csl'*
1926'completeslash' 'csl' string (default: "")
1927 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001928 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001929 When this option is set it overrules 'shellslash' for completion:
1930 - When this option is set to "slash", a forward slash is used for path
1931 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001932 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001933 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001934 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001935 - When this option is empty, same character is used as for
1936 'shellslash'.
1937 For Insert mode completion the buffer-local value is used. For
1938 command line completion the global value is used.
1939
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001940 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001941'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001942 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001943 A comma separated list of options for Insert mode completion
1944 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001945
1946 menu Use a popup menu to show the possible completions. The
1947 menu is only shown when there is more than one match and
1948 sufficient colors are available. |ins-completion-menu|
1949
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001950 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001951 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001952 match, e.g., what file it comes from.
1953
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001954 longest Only insert the longest common text of the matches. If
1955 the menu is displayed you can use CTRL-L to add more
1956 characters. Whether case is ignored depends on the kind
1957 of completion. For buffer text the 'ignorecase' option is
1958 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001959
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001960 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001961 completion in the preview window. Only works in
1962 combination with "menu" or "menuone".
1963
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001964 popup Show extra information about the currently selected
1965 completion in a popup window. Only works in combination
1966 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001967 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001968 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001969
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001970 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001971 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001972 |CompleteChanged| autocommand to fetch the info and call
1973 |popup_show()| once the popup has been filled.
1974 See the example at |complete-popuphidden|.
1975 {only works when compiled with the |+textprop| feature}
1976
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001977 noinsert Do not insert any text for a match until the user selects
1978 a match from the menu. Only works in combination with
1979 "menu" or "menuone". No effect if "longest" is present.
1980
1981 noselect Do not select a match in the menu, force the user to
1982 select one from the menu. Only works in combination with
1983 "menu" or "menuone".
1984
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001985
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001986 *'completepopup'* *'cpp'*
1987'completepopup' 'cpp' string (default empty)
1988 global
1989 {not available when compiled without the |+textprop|
1990 or |+quickfix| feature}
1991 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar447bfba2020-07-18 16:07:16 +02001992 properties of the info popup when it is created. If an info popup
1993 window already exists it is closed, so that the option value is
1994 applied when it is created again.
1995 You can also use |popup_findinfo()| and then set properties for an
1996 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001997
1998
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001999 *'concealcursor'* *'cocu'*
2000'concealcursor' 'cocu' string (default: "")
2001 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002002 {not available when compiled without the |+conceal|
2003 feature}
2004 Sets the modes in which text in the cursor line can also be concealed.
2005 When the current mode is listed then concealing happens just like in
2006 other lines.
2007 n Normal mode
2008 v Visual mode
2009 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002010 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002011
Bram Moolenaare6dc5732010-07-24 23:52:26 +02002012 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02002013 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002014 are moving around text is concealed, but when starting to insert text
2015 or selecting a Visual area the concealed text is displayed, so that
2016 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02002017 Keep in mind that the cursor position is not always where it's
2018 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002019
2020
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002021 *'conceallevel'* *'cole'*
2022'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02002023 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002024 {not available when compiled without the |+conceal|
2025 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002026 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2027 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002028
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002029 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002030 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002031 1 Each block of concealed text is replaced with one
2032 character. If the syntax item does not have a custom
2033 replacement character defined (see |:syn-cchar|) the
2034 character defined in 'listchars' is used (default is a
2035 space).
2036 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002037 2 Concealed text is completely hidden unless it has a
2038 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002039 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002040 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002041
Bram Moolenaara7781e02010-07-19 20:13:22 +02002042 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002043 edit and copy the text. This can be changed with the 'concealcursor'
2044 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002045
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2047'confirm' 'cf' boolean (default off)
2048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 When 'confirm' is on, certain operations that would normally
2050 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2051 instead raise a |dialog| asking if you wish to save the current
2052 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2053 If 'confirm' is off you can still activate confirmation for one
2054 command only (this is most useful in mappings) with the |:confirm|
2055 command.
2056 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2057
2058 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2059'conskey' 'consk' boolean (default off)
2060 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002061 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062
2063 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2064'copyindent' 'ci' boolean (default off)
2065 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 Copy the structure of the existing lines indent when autoindenting a
2067 new line. Normally the new indent is reconstructed by a series of
2068 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2069 in which case only spaces are used). Enabling this option makes the
2070 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002071 existing line. 'expandtab' has no effect on these characters, a Tab
2072 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002074 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 Also see 'preserveindent'.
2076
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002077 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078'cpoptions' 'cpo' string (Vim default: "aABceFs",
2079 Vi default: all flags)
2080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002082 this indicates Vi-compatible behavior. This is used for things where
2083 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 'cpoptions' stands for "compatible-options".
2085 Commas can be added for readability.
2086 To avoid problems with flags that are added in the future, use the
2087 "+=" and "-=" feature of ":set" |add-option-flags|.
2088 NOTE: This option is set to the Vi default value when 'compatible' is
2089 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002090 NOTE: This option is set to the POSIX default value at startup when
2091 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002092 variable exists |posix|. This means Vim tries to behave like the
2093 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094
2095 contains behavior ~
2096 *cpo-a*
2097 a When included, a ":read" command with a file name
2098 argument will set the alternate file name for the
2099 current window.
2100 *cpo-A*
2101 A When included, a ":write" command with a file name
2102 argument will set the alternate file name for the
2103 current window.
2104 *cpo-b*
2105 b "\|" in a ":map" command is recognized as the end of
2106 the map command. The '\' is included in the mapping,
2107 the text after the '|' is interpreted as the next
2108 command. Use a CTRL-V instead of a backslash to
2109 include the '|' in the mapping. Applies to all
2110 mapping, abbreviation, menu and autocmd commands.
2111 See also |map_bar|.
2112 *cpo-B*
2113 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002114 abbreviations, user commands and the "to" part of the
2115 menu commands. Remove this flag to be able to use a
2116 backslash like a CTRL-V. For example, the command
2117 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118 'B' included: "\^[" (^[ is a real <Esc>)
2119 'B' excluded: "<Esc>" (5 characters)
2120 ('<' excluded in both cases)
2121 *cpo-c*
2122 c Searching continues at the end of any match at the
2123 cursor position, but not further than the start of the
2124 next line. When not present searching continues
2125 one character from the cursor position. With 'c'
2126 "abababababab" only gets three matches when repeating
2127 "/abab", without 'c' there are five matches.
2128 *cpo-C*
2129 C Do not concatenate sourced lines that start with a
2130 backslash. See |line-continuation|.
2131 *cpo-d*
2132 d Using "./" in the 'tags' option doesn't mean to use
2133 the tags file relative to the current file, but the
2134 tags file in the current directory.
2135 *cpo-D*
2136 D Can't use CTRL-K to enter a digraph after Normal mode
2137 commands with a character argument, like |r|, |f| and
2138 |t|.
2139 *cpo-e*
2140 e When executing a register with ":@r", always add a
2141 <CR> to the last line, also when the register is not
2142 linewise. If this flag is not present, the register
2143 is not linewise and the last line does not end in a
2144 <CR>, then the last line is put on the command-line
2145 and can be edited before hitting <CR>.
2146 *cpo-E*
2147 E It is an error when using "y", "d", "c", "g~", "gu" or
2148 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002149 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 This makes "y0" fail in the first column.
2151 *cpo-f*
2152 f When included, a ":read" command with a file name
2153 argument will set the file name for the current buffer,
2154 if the current buffer doesn't have a file name yet.
2155 *cpo-F*
2156 F When included, a ":write" command with a file name
2157 argument will set the file name for the current
2158 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002159 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 *cpo-g*
2161 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002162 *cpo-H*
2163 H When using "I" on a line with only blanks, insert
2164 before the last blank. Without this flag insert after
2165 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 *cpo-i*
2167 i When included, interrupting the reading of a file will
2168 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002169 *cpo-I*
2170 I When moving the cursor up or down just after inserting
2171 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 *cpo-j*
2173 j When joining lines, only add two spaces after a '.',
2174 not after '!' or '?'. Also see 'joinspaces'.
2175 *cpo-J*
2176 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002177 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 white space.
2179 *cpo-k*
2180 k Disable the recognition of raw key codes in
2181 mappings, abbreviations, and the "to" part of menu
2182 commands. For example, if <Key> sends ^[OA (where ^[
2183 is <Esc>), the command ":map X ^[OA" results in X
2184 being mapped to:
2185 'k' included: "^[OA" (3 characters)
2186 'k' excluded: "<Key>" (one key code)
2187 Also see the '<' flag below.
2188 *cpo-K*
2189 K Don't wait for a key code to complete when it is
2190 halfway a mapping. This breaks mapping <F1><F1> when
2191 only part of the second <F1> has been read. It
2192 enables cancelling the mapping by typing <F1><Esc>.
2193 *cpo-l*
2194 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002195 literally, only "\]", "\^", "\-" and "\\" are special.
2196 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2198 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002199 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 *cpo-L*
2201 L When the 'list' option is set, 'wrapmargin',
2202 'textwidth', 'softtabstop' and Virtual Replace mode
2203 (see |gR|) count a <Tab> as two characters, instead of
2204 the normal behavior of a <Tab>.
2205 *cpo-m*
2206 m When included, a showmatch will always wait half a
2207 second. When not included, a showmatch will wait half
2208 a second or until a character is typed. |'showmatch'|
2209 *cpo-M*
2210 M When excluded, "%" matching will take backslashes into
2211 account. Thus in "( \( )" and "\( ( \)" the outer
2212 parenthesis match. When included "%" ignores
2213 backslashes, which is Vi compatible.
2214 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002215 n When included, the column used for 'number' and
2216 'relativenumber' will also be used for text of wrapped
2217 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 *cpo-o*
2219 o Line offset to search command is not remembered for
2220 next search.
2221 *cpo-O*
2222 O Don't complain if a file is being overwritten, even
2223 when it didn't exist when editing it. This is a
2224 protection against a file unexpectedly created by
2225 someone else. Vi didn't complain about this.
2226 *cpo-p*
2227 p Vi compatible Lisp indenting. When not present, a
2228 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002229 *cpo-P*
2230 P When included, a ":write" command that appends to a
2231 file will set the file name for the current buffer, if
2232 the current buffer doesn't have a file name yet and
2233 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002234 *cpo-q*
2235 q When joining multiple lines leave the cursor at the
2236 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 *cpo-r*
2238 r Redo ("." command) uses "/" to repeat a search
2239 command, instead of the actually used search string.
2240 *cpo-R*
2241 R Remove marks from filtered lines. Without this flag
2242 marks are kept like |:keepmarks| was used.
2243 *cpo-s*
2244 s Set buffer options when entering the buffer for the
2245 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002246 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 set when the buffer is created.
2248 *cpo-S*
2249 S Set buffer options always when entering a buffer
2250 (except 'readonly', 'fileformat', 'filetype' and
2251 'syntax'). This is the (most) Vi compatible setting.
2252 The options are set to the values in the current
2253 buffer. When you change an option and go to another
2254 buffer, the value is copied. Effectively makes the
2255 buffer options global to all buffers.
2256
2257 's' 'S' copy buffer options
2258 no no when buffer created
2259 yes no when buffer first entered (default)
2260 X yes each time when buffer entered (vi comp.)
2261 *cpo-t*
2262 t Search pattern for the tag command is remembered for
2263 "n" command. Otherwise Vim only puts the pattern in
2264 the history for search pattern, but doesn't change the
2265 last used search pattern.
2266 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002267 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 *cpo-v*
2269 v Backspaced characters remain visible on the screen in
2270 Insert mode. Without this flag the characters are
2271 erased from the screen right away. With this flag the
2272 screen newly typed text overwrites backspaced
2273 characters.
2274 *cpo-w*
2275 w When using "cw" on a blank character, only change one
2276 character and not all blanks until the start of the
2277 next word.
2278 *cpo-W*
2279 W Don't overwrite a readonly file. When omitted, ":w!"
2280 overwrites a readonly file, if possible.
2281 *cpo-x*
2282 x <Esc> on the command-line executes the command-line.
2283 The default in Vim is to abandon the command-line,
2284 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002285 *cpo-X*
2286 X When using a count with "R" the replaced text is
2287 deleted only once. Also when repeating "R" with "."
2288 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002290 y A yank command can be redone with ".". Think twice if
2291 you really want to use this, it may break some
2292 plugins, since most people expect "." to only repeat a
2293 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002294 *cpo-Z*
2295 Z When using "w!" while the 'readonly' option is set,
2296 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 *cpo-!*
2298 ! When redoing a filter command, use the last used
2299 external command, whatever it was. Otherwise the last
2300 used -filter- command is used.
2301 *cpo-$*
2302 $ When making a change to one line, don't redisplay the
2303 line, but put a '$' at the end of the changed text.
2304 The changed text will be overwritten when you type the
2305 new text. The line is redisplayed if you type any
2306 command that moves the cursor from the insertion
2307 point.
2308 *cpo-%*
2309 % Vi-compatible matching is done for the "%" command.
2310 Does not recognize "#if", "#endif", etc.
2311 Does not recognize "/*" and "*/".
2312 Parens inside single and double quotes are also
2313 counted, causing a string that contains a paren to
2314 disturb the matching. For example, in a line like
2315 "if (strcmp("foo(", s))" the first paren does not
2316 match the last one. When this flag is not included,
2317 parens inside single and double quotes are treated
2318 specially. When matching a paren outside of quotes,
2319 everything inside quotes is ignored. When matching a
2320 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002321 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002322 This flag is also used for other features, such as
2323 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002324 *cpo--*
2325 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002326 it would go above the first line or below the last
2327 line. Without it the cursor moves to the first or
2328 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002329 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002330 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002331 *cpo-+*
2332 + When included, a ":write file" command will reset the
2333 'modified' flag of the buffer, even though the buffer
2334 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002335 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336 * Use ":*" in the same way as ":@". When not included,
2337 ":*" is an alias for ":'<,'>", select the Visual area.
2338 *cpo-<*
2339 < Disable the recognition of special key codes in |<>|
2340 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002341 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342 ":map X <Tab>" results in X being mapped to:
2343 '<' included: "<Tab>" (5 characters)
2344 '<' excluded: "^I" (^I is a real <Tab>)
2345 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002346 *cpo->*
2347 > When appending to a register, put a line break before
2348 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002349 *cpo-;*
2350 ; When using |,| or |;| to repeat the last |t| search
2351 and the cursor is right in front of the searched
2352 character, the cursor won't move. When not included,
2353 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002354 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002355
2356 POSIX flags. These are not included in the Vi default value, except
2357 when $VIM_POSIX was set on startup. |posix|
2358
2359 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002360 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002361 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002362 *cpo-&*
2363 & When ":preserve" was used keep the swap file when
2364 exiting normally while this buffer is still loaded.
2365 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002366 *cpo-\*
2367 \ Backslash in a [] range in a search pattern is taken
2368 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002369 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2370 '\' excluded: "/[ \-]" finds <Space> and '-'
2371 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002372 *cpo-/*
2373 / When "%" is used as the replacement string in a |:s|
2374 command, use the previous replacement string. |:s%|
2375 *cpo-{*
2376 { The |{| and |}| commands also stop at a "{" character
2377 at the start of a line.
2378 *cpo-.*
2379 . The ":chdir" and ":cd" commands fail if the current
2380 buffer is modified, unless ! is used. Vim doesn't
2381 need this, since it remembers the full path of an
2382 opened file.
2383 *cpo-bar*
2384 | The value of the $LINES and $COLUMNS environment
2385 variables overrule the terminal size values obtained
2386 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002387
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002389 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002390'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002391 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002392 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002393 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002394 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002395 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002396 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002397 blowfish Blowfish method. Medium strong encryption but it has
2398 an implementation flaw. Requires Vim 7.3 or later,
2399 files can NOT be read by Vim 7.2 and older. This adds
2400 a "seed" to the file, every time you write the file
2401 the encrypted bytes will be different.
2402 *blowfish2*
2403 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002404 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002405 and older. This adds a "seed" to the file, every time
2406 you write the file the encrypted bytes will be
2407 different. The whole undo file is encrypted, not just
2408 the pieces of text.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002409 *E1193* *E1194* *E1195* *E1196*
2410 *E1197* *E1198* *E1199* *E1200* *E1201*
2411 xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
2412 Code. Medium strong till strong encryption.
2413 Encryption is provided by the libsodium library, it
Bram Moolenaar22863042021-10-16 15:23:36 +01002414 requires Vim to be built with |+sodium|.
Christian Brabandtf573c6e2021-06-20 14:02:16 +02002415 It adds a seed and a message authentication code (MAC)
2416 to the file. This needs at least a Vim 8.2.3022 to
2417 read the encrypted file.
2418 Encryption of swap files is not supported, therefore
2419 no swap file will be used when xchacha20 encryption is
2420 enabled.
2421 Encryption of undo files is not yet supported,
2422 therefore no undo file will currently be written.
2423 CURRENTLY EXPERIMENTAL: Files written with this method
2424 might have to be read back with the same version of
2425 Vim if the binary format changes later.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002426
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002427 You should use "blowfish2", also to re-encrypt older files.
2428
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002429 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002430 to the detected method of the file being read. Thus if you write it
2431 without changing 'cryptmethod' the same method will be used.
2432 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002433 explicitly write it, you don't get a warning unless there are other
2434 modifications. Also see |:X|.
2435
2436 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002437 the value "blowfish2". When setting the local value to an empty
2438 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002439
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002440 When a new encryption method is added in a later version of Vim, and
2441 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002442 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002443
2444
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445 *'cscopepathcomp'* *'cspc'*
2446'cscopepathcomp' 'cspc' number (default 0)
2447 global
2448 {not available when compiled without the |+cscope|
2449 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 Determines how many components of the path to show in a list of tags.
2451 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002452 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453
2454 *'cscopeprg'* *'csprg'*
2455'cscopeprg' 'csprg' string (default "cscope")
2456 global
2457 {not available when compiled without the |+cscope|
2458 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 Specifies the command to execute cscope. See |cscopeprg|.
2460 This option cannot be set from a |modeline| or in the |sandbox|, for
2461 security reasons.
2462
2463 *'cscopequickfix'* *'csqf'*
2464'cscopequickfix' 'csqf' string (default "")
2465 global
2466 {not available when compiled without the |+cscope|
2467 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 Specifies whether to use quickfix window to show cscope results.
2469 See |cscopequickfix|.
2470
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002471 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002472'cscoperelative' 'csre' boolean (default off)
2473 global
2474 {not available when compiled without the |+cscope|
2475 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002476 In the absence of a prefix (-P) for cscope. setting this option enables
2477 to use the basename of cscope.out path as the prefix.
2478 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002479 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002480
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2482'cscopetag' 'cst' boolean (default off)
2483 global
2484 {not available when compiled without the |+cscope|
2485 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 Use cscope for tag commands. See |cscope-options|.
2487 NOTE: This option is reset when 'compatible' is set.
2488
2489 *'cscopetagorder'* *'csto'*
2490'cscopetagorder' 'csto' number (default 0)
2491 global
2492 {not available when compiled without the |+cscope|
2493 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 Determines the order in which ":cstag" performs a search. See
2495 |cscopetagorder|.
2496 NOTE: This option is set to 0 when 'compatible' is set.
2497
2498 *'cscopeverbose'* *'csverb'*
2499 *'nocscopeverbose'* *'nocsverb'*
2500'cscopeverbose' 'csverb' boolean (default off)
2501 global
2502 {not available when compiled without the |+cscope|
2503 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 Give messages when adding a cscope database. See |cscopeverbose|.
2505 NOTE: This option is reset when 'compatible' is set.
2506
Bram Moolenaar860cae12010-06-05 23:22:07 +02002507 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2508'cursorbind' 'crb' boolean (default off)
2509 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002510 When this option is set, as the cursor in the current
2511 window moves other cursorbound windows (windows that also have
2512 this option set) move their cursors to the corresponding line and
2513 column. This option is useful for viewing the
2514 differences between two versions of a file (see 'diff'); in diff mode,
2515 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002516 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002517
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002518
2519 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2520'cursorcolumn' 'cuc' boolean (default off)
2521 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002522 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002523 feature}
2524 Highlight the screen column of the cursor with CursorColumn
2525 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2526 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002527 If you only want the highlighting in the current window you can use
2528 these autocommands: >
2529 au WinLeave * set nocursorline nocursorcolumn
2530 au WinEnter * set cursorline cursorcolumn
2531<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002532
2533 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2534'cursorline' 'cul' boolean (default off)
2535 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002536 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002537 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002538 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2539 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002540 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002541 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002542
2543
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002544 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002545'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002546 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002547 {not available when compiled without the |+syntax|
2548 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002549 Comma separated list of settings for how 'cursorline' is displayed.
2550 Valid values:
2551 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002552 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002553 "screenline" Highlight only the screen line of the cursor with
2554 CursorLine |hl-CursorLine|.
2555 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002556 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002557
2558 Special value:
2559 "both" Alias for the values "line,number".
2560
2561 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002562
2563
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 *'debug'*
2565'debug' string (default "")
2566 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002567 These values can be used:
2568 msg Error messages that would otherwise be omitted will be given
2569 anyway.
2570 throw Error messages that would otherwise be omitted will be given
2571 anyway and also throw an exception and set |v:errmsg|.
2572 beep A message will be given when otherwise only a beep would be
2573 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002574 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002575 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2576 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577
2578 *'define'* *'def'*
2579'define' 'def' string (default "^\s*#\s*define")
2580 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002581 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582 pattern, just like for the "/" command. This option is used for the
2583 commands like "[i" and "[d" |include-search|. The 'isident' option is
2584 used to recognize the defined name after the match:
2585 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2586 See |option-backslash| about inserting backslashes to include a space
2587 or backslash.
2588 The default value is for C programs. For C++ this value would be
2589 useful, to include const type declarations: >
2590 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002591< You can also use "\ze" just before the name and continue the pattern
2592 to check what is following. E.g. for Javascript, if a function is
2593 defined with "func_name = function(args)": >
2594 ^\s*\ze\i\+\s*=\s*function(
2595< If the function is defined with "func_name : function() {...": >
2596 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002598 To avoid that use `:let` with a single quote string: >
2599 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002600<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601
2602 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2603'delcombine' 'deco' boolean (default off)
2604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 If editing Unicode and this option is set, backspace and Normal mode
2606 "x" delete each combining character on its own. When it is off (the
2607 default) the character along with its combining characters are
2608 deleted.
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02002609 Note: When 'delcombine' is set "xx" may work differently from "2x"!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610
2611 This is useful for Arabic, Hebrew and many other languages where one
2612 may have combining characters overtop of base characters, and want
2613 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002614 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615
2616 *'dictionary'* *'dict'*
2617'dictionary' 'dict' string (default "")
2618 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 List of file names, separated by commas, that are used to lookup words
2620 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2621 contain a list of words. This can be one word per line, or several
2622 words per line, separated by non-keyword characters (white space is
2623 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002624
2625 When this option is empty or an entry "spell" is present, and spell
2626 checking is enabled, words in the word lists for the currently active
2627 'spelllang' are used. See |spell|.
2628
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002629 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630 after a comma are ignored, otherwise spaces are included in the file
2631 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002632 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 Where to find a list of words?
2634 - On FreeBSD, there is the file "/usr/share/dict/words".
2635 - In the Simtel archive, look in the "msdos/linguist" directory.
2636 - In "miscfiles" of the GNU collection.
2637 The use of |:set+=| and |:set-=| is preferred when adding or removing
2638 directories from the list. This avoids problems when a future version
2639 uses another default.
2640 Backticks cannot be used in this option for security reasons.
2641
2642 *'diff'* *'nodiff'*
2643'diff' boolean (default off)
2644 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 {not available when compiled without the |+diff|
2646 feature}
2647 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002648 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649
2650 *'dex'* *'diffexpr'*
2651'diffexpr' 'dex' string (default "")
2652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 {not available when compiled without the |+diff|
2654 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002655 Expression which is evaluated to obtain a diff file (either ed-style
2656 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 This option cannot be set from a |modeline| or in the |sandbox|, for
2658 security reasons.
2659
2660 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002661'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663 {not available when compiled without the |+diff|
2664 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002665 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002666 All are optional. Items must be separated by a comma.
2667
2668 filler Show filler lines, to keep the text
2669 synchronized with a window that has inserted
2670 lines at the same position. Mostly useful
2671 when windows are side-by-side and 'scrollbind'
2672 is set.
2673
2674 context:{n} Use a context of {n} lines between a change
2675 and a fold that contains unchanged lines.
2676 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002677 When using zero the context is actually one,
2678 since folds require a line in between, also
2679 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 See |fold-diff|.
2681
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002682 iblank Ignore changes where lines are all blank. Adds
2683 the "-B" flag to the "diff" command if
2684 'diffexpr' is empty. Check the documentation
2685 of the "diff" command for what this does
2686 exactly.
2687 NOTE: the diff windows will get out of sync,
2688 because no differences between blank lines are
2689 taken into account.
2690
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 icase Ignore changes in case of text. "a" and "A"
2692 are considered the same. Adds the "-i" flag
2693 to the "diff" command if 'diffexpr' is empty.
2694
2695 iwhite Ignore changes in amount of white space. Adds
2696 the "-b" flag to the "diff" command if
2697 'diffexpr' is empty. Check the documentation
2698 of the "diff" command for what this does
2699 exactly. It should ignore adding trailing
2700 white space, but not leading white space.
2701
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002702 iwhiteall Ignore all white space changes. Adds
2703 the "-w" flag to the "diff" command if
2704 'diffexpr' is empty. Check the documentation
2705 of the "diff" command for what this does
2706 exactly.
2707
2708 iwhiteeol Ignore white space changes at end of line.
2709 Adds the "-Z" flag to the "diff" command if
2710 'diffexpr' is empty. Check the documentation
2711 of the "diff" command for what this does
2712 exactly.
2713
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002714 horizontal Start diff mode with horizontal splits (unless
2715 explicitly specified otherwise).
2716
2717 vertical Start diff mode with vertical splits (unless
2718 explicitly specified otherwise).
2719
Bram Moolenaarc8234772019-11-10 21:00:27 +01002720 closeoff When a window is closed where 'diff' is set
2721 and there is only one window remaining in the
2722 same tab page with 'diff' set, execute
2723 `:diffoff` in that window. This undoes a
2724 `:diffsplit` command.
2725
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002726 hiddenoff Do not use diff mode for a buffer when it
2727 becomes hidden.
2728
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002729 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2730 starting diff mode. Without this 2 is used.
2731
Bram Moolenaar4223d432021-02-10 13:18:17 +01002732 followwrap Follow the 'wrap' option and leave as it is.
2733
Bram Moolenaare828b762018-09-10 17:51:58 +02002734 internal Use the internal diff library. This is
2735 ignored when 'diffexpr' is set. *E960*
2736 When running out of memory when writing a
2737 buffer this item will be ignored for diffs
2738 involving that buffer. Set the 'verbose'
2739 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740
Bram Moolenaare828b762018-09-10 17:51:58 +02002741 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002742 Use the indent heuristic for the internal
2743 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002744
2745 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002746 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002747 algorithms are:
2748 myers the default algorithm
2749 minimal spend extra time to generate the
2750 smallest possible diff
2751 patience patience diff algorithm
2752 histogram histogram diff algorithm
2753
2754 Examples: >
2755 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002757 :set diffopt=internal,filler,foldcolumn:3
2758 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759<
2760 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2761'digraph' 'dg' boolean (default off)
2762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 {not available when compiled without the |+digraphs|
2764 feature}
2765 Enable the entering of digraphs in Insert mode with {char1} <BS>
2766 {char2}. See |digraphs|.
2767 NOTE: This option is reset when 'compatible' is set.
2768
2769 *'directory'* *'dir'*
2770'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002771 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 for Unix: ".,~/tmp,/var/tmp,/tmp")
2773 global
2774 List of directory names for the swap file, separated with commas.
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002775 Recommended value: ".,~/vimswap//" - this will put the swap file next
2776 to the edited file if possible, and in your personal swap directory
2777 otherwise. Make sure "~/vimswap//" is only readable for you.
2778
2779 Possible items:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 - The swap file will be created in the first directory where this is
2781 possible.
2782 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002783 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 - A directory "." means to put the swap file in the same directory as
2785 the edited file. On Unix, a dot is prepended to the file name, so
2786 it doesn't show in a directory listing. On MS-Windows the "hidden"
2787 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002788 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2789 the swap file relative to where the edited file is. The leading "."
2790 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002791 - For Unix and Win32, if a directory ends in two path separators "//",
2792 the swap file name will be built from the complete path to the file
Bram Moolenaar207f0092020-08-30 17:20:20 +02002793 with all path separators replaced by percent '%' signs (including
2794 the colon following the drive letter on Win32). This will ensure
2795 file name uniqueness in the preserve directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002796 On Win32, it is also possible to end with "\\". However, When a
2797 separating comma is following, you must use "//", since "\\" will
2798 include the comma in the file name. Therefore it is recommended to
2799 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 - Spaces after the comma are ignored, other spaces are considered part
2801 of the directory name. To have a space at the start of a directory
2802 name, precede it with a backslash.
2803 - To include a comma in a directory name precede it with a backslash.
2804 - A directory name may end in an ':' or '/'.
2805 - Environment variables are expanded |:set_env|.
2806 - Careful with '\' characters, type one before a space, type two to
2807 get one in the option (see |option-backslash|), for example: >
2808 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2809< - For backwards compatibility with Vim version 3.0 a '>' at the start
2810 of the option is removed.
2811 Using "." first in the list is recommended. This means that editing
2812 the same file twice will result in a warning. Using "/tmp" on Unix is
2813 discouraged: When the system crashes you lose the swap file.
2814 "/var/tmp" is often not cleared when rebooting, thus is a better
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02002815 choice than "/tmp". But others on the computer may be able to see the
2816 files, and it can contain a lot of files, your swap files get lost in
2817 the crowd. That is why a "tmp" directory in your home directory is
2818 tried first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 The use of |:set+=| and |:set-=| is preferred when adding or removing
2820 directories from the list. This avoids problems when a future version
2821 uses another default.
2822 This option cannot be set from a |modeline| or in the |sandbox|, for
2823 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824
2825 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002826'display' 'dy' string (default "", set to "truncate" in
2827 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 Change the way text is displayed. This is comma separated list of
2830 flags:
2831 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002832 in a window will be displayed. "@@@" is put in the
2833 last columns of the last screen line to indicate the
2834 rest of the line is not displayed.
2835 truncate Like "lastline", but "@@@" is displayed in the first
2836 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 uhex Show unprintable characters hexadecimal as <xx>
2838 instead of using ^C and ~C.
2839
Bram Moolenaard0796902016-09-16 20:02:31 +02002840 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002841 doesn't fit is replaced with "@" lines.
2842
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 *'eadirection'* *'ead'*
2844'eadirection' 'ead' string (default "both")
2845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 Tells when the 'equalalways' option applies:
2847 ver vertically, width of windows is not affected
2848 hor horizontally, height of windows is not affected
2849 both width and height of windows is affected
2850
2851 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2852'edcompatible' 'ed' boolean (default off)
2853 global
2854 Makes the 'g' and 'c' flags of the ":substitute" command to be
2855 toggled each time the flag is given. See |complex-change|. See
2856 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002857 Switching this option on may break plugins!
Bram Moolenaar4072ba52020-12-23 13:56:35 +01002858 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859
Bram Moolenaar03413f42016-04-12 21:07:15 +02002860 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002861'emoji' 'emo' boolean (default: on)
2862 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002863 When on all Unicode emoji characters are considered to be full width.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02002864 This excludes "text emoji" characters, which are normally displayed as
2865 single width. Unfortunately there is no good specification for this
2866 and it has been determined on trial-and-error basis. Use the
2867 |setcellwidths()| function to change the behavior.
Bram Moolenaar3848e002016-03-19 18:42:29 +01002868
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 *'encoding'* *'enc'* *E543*
K.Takataf883d902021-05-30 18:04:19 +02002870'encoding' 'enc' string (default for MS-Windows: "utf-8",
2871 otherwise: value from $LANG or "latin1")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 Sets the character encoding used inside Vim. It applies to text in
2874 the buffers, registers, Strings in expressions, text stored in the
2875 viminfo file, etc. It sets the kind of characters which Vim can work
2876 with. See |encoding-names| for the possible values.
2877
2878 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002879 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002881 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882
Bram Moolenaar865242e2010-07-14 21:12:05 +02002883 This option cannot be set from a |modeline|. It would most likely
2884 corrupt the text.
2885
Bram Moolenaar3df01732017-02-17 22:47:16 +01002886 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2887 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 'encoding', "utf-8" is the natural choice for the environment and
2889 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002890 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 versions, and to avoid changing the encoding of newly created files
2892 without your knowledge (in case 'fileencodings' is empty).
2893
2894 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002895 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 iconv() or as specified with 'charconvert'.
2897
Bram Moolenaar207f0092020-08-30 17:20:20 +02002898 If you need to know whether 'encoding' is a multibyte encoding, you
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002899 can use: >
2900 if has("multi_byte_encoding")
2901<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 Normally 'encoding' will be equal to your current locale. This will
2903 be the default if Vim recognizes your environment settings. If
2904 'encoding' is not set to the current locale, 'termencoding' must be
2905 set to convert typed and displayed text. See |encoding-table|.
2906
2907 When you set this option, it fires the |EncodingChanged| autocommand
2908 event so that you can set up fonts if necessary.
2909
2910 When the option is set, the value is converted to lowercase. Thus
2911 you can set it with uppercase values too. Underscores are translated
2912 to '-' signs.
2913 When the encoding is recognized, it is changed to the standard name.
2914 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2915 "iso-8859-2" and "utf8" becomes "utf-8".
2916
2917 Note: "latin1" is also used when the encoding could not be detected.
2918 This only works when editing files in the same encoding! When the
2919 actual character set is not latin1, make sure 'fileencoding' and
2920 'fileencodings' are empty. When conversion is needed, switch to using
2921 utf-8.
2922
2923 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2924 You don't notice this while editing, but it does matter for the
2925 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2926 setting 'encoding' to one of these values instead of utf-8 only has
2927 effect for encoding used for files when 'fileencoding' is empty.
2928
Bram Moolenaar661b1822005-07-28 22:36:45 +00002929 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2930 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931
2932 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2933'endofline' 'eol' boolean (default on)
2934 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002936 is on, or 'fixeol' option is off, no <EOL> will be written for the
2937 last line in the file. This option is automatically set or reset when
2938 starting to edit a new file, depending on whether file has an <EOL>
2939 for the last line in the file. Normally you don't have to set or
2940 reset this option.
2941 When 'binary' is off and 'fixeol' is on the value is not used when
2942 writing the file. When 'binary' is on or 'fixeol' is off it is used
2943 to remember the presence of a <EOL> for the last line in the file, so
2944 that when you write the file the situation from the original file can
2945 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946
2947 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2948'equalalways' 'ea' boolean (default on)
2949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002951 splitting or closing a window. This also happens the moment the
2952 option is switched on. When off, splitting a window will reduce the
2953 size of the current window and leave the other windows the same. When
2954 closing a window the extra lines are given to the window next to it
2955 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 When mixing vertically and horizontally split windows, a minimal size
2957 is computed and some windows may be larger if there is room. The
2958 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002959 Changing the height and width of a window can be avoided by setting
2960 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002961 If a window size is specified when creating a new window sizes are
2962 currently not equalized (it's complicated, but may be implemented in
2963 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964
2965 *'equalprg'* *'ep'*
2966'equalprg' 'ep' string (default "")
2967 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002969 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002970 or 'indentexpr'. When Vim was compiled without internal formatting,
2971 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002972 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 about including spaces and backslashes.
2974 This option cannot be set from a |modeline| or in the |sandbox|, for
2975 security reasons.
2976
2977 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2978'errorbells' 'eb' boolean (default off)
2979 global
2980 Ring the bell (beep or screen flash) for error messages. This only
2981 makes a difference for error messages, the bell will be used always
2982 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002983 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002984 screen flash or do nothing. See 'belloff' to finetune when to ring the
2985 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986
2987 *'errorfile'* *'ef'*
2988'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2989 others: "errors.err")
2990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 {not available when compiled without the |+quickfix|
2992 feature}
2993 Name of the errorfile for the QuickFix mode (see |:cf|).
2994 When the "-q" command-line argument is used, 'errorfile' is set to the
2995 following argument. See |-q|.
2996 NOT used for the ":make" command. See 'makeef' for that.
2997 Environment variables are expanded |:set_env|.
2998 See |option-backslash| about including spaces and backslashes.
2999 This option cannot be set from a |modeline| or in the |sandbox|, for
3000 security reasons.
3001
3002 *'errorformat'* *'efm'*
3003'errorformat' 'efm' string (default is very long)
3004 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 {not available when compiled without the |+quickfix|
3006 feature}
3007 Scanf-like description of the format for the lines in the error file
3008 (see |errorformat|).
3009
3010 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3011'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
3012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 Function keys that start with an <Esc> are recognized in Insert
3014 mode. When this option is off, the cursor and function keys cannot be
3015 used in Insert mode if they start with an <Esc>. The advantage of
3016 this is that the single <Esc> is recognized immediately, instead of
3017 after one second. Instead of resetting this option, you might want to
3018 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
3019 when 'esckeys' is off, you can still map anything, but the cursor keys
3020 won't work by default.
3021 NOTE: This option is set to the Vi default value when 'compatible' is
3022 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01003023 NOTE: when this option is off then the |modifyOtherKeys| functionality
3024 is disabled while in Insert mode to avoid ending Insert mode with any
3025 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026
3027 *'eventignore'* *'ei'*
3028'eventignore' 'ei' string (default "")
3029 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003031 When set to "all" or when "all" is one of the items, all autocommand
3032 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 Otherwise this is a comma separated list of event names. Example: >
3034 :set ei=WinEnter,WinLeave
3035<
3036 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3037'expandtab' 'et' boolean (default off)
3038 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003040 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 when 'autoindent' is on. To insert a real tab when 'expandtab' is
3042 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02003043 This option is reset when the 'paste' option is set and restored when
3044 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 NOTE: This option is reset when 'compatible' is set.
3046
3047 *'exrc'* *'ex'* *'noexrc'* *'noex'*
3048'exrc' 'ex' boolean (default off)
3049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003051 directory.
3052
3053 Setting this option is a potential security leak. E.g., consider
3054 unpacking a package or fetching files from github, a .vimrc in there
3055 might be a trojan horse. BETTER NOT SET THIS OPTION!
3056 Instead, define an autocommand in your .vimrc to set options for a
3057 matching directory.
3058
3059 If you do switch this option on you should also consider setting the
3060 'secure' option (see |initialization|).
3061 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 This option cannot be set from a |modeline| or in the |sandbox|, for
3063 security reasons.
3064
3065 *'fileencoding'* *'fenc'* *E213*
3066'fileencoding' 'fenc' string (default: "")
3067 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003069
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003071 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 When 'fileencoding' is empty, the same value as 'encoding' will be
3073 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003074 No error will be given when the value is set, only when it is used,
3075 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003076 Conversion will also be done when 'encoding' and 'fileencoding' are
3077 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3078 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003080 'encoding' is "utf-8" or another Unicode encoding, conversion
3081 is most likely done in a way that the reverse conversion
3082 results in the same text. When 'encoding' is not "utf-8" some
3083 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003084
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 See 'encoding' for the possible values. Additionally, values may be
3086 specified that can be handled by the converter, see
3087 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003088
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 When reading a file 'fileencoding' will be set from 'fileencodings'.
3090 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003091 'fileencoding', use the |++enc| argument. One exception: when
3092 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003093 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003094
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3096 When the option is set, the value is converted to lowercase. Thus
3097 you can set it with uppercase values too. '_' characters are
3098 replaced with '-'. If a name is recognized from the list for
3099 'encoding', it is replaced by the standard name. For example
3100 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003101
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 When this option is set, after starting to edit a file, the 'modified'
3103 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003104
3105 Keep in mind that changing 'fenc' from a modeline happens
3106 AFTER the text has been read, thus it applies to when the file will be
3107 written. If you do set 'fenc' in a modeline, you might want to set
3108 'nomodified' to avoid not being able to ":q".
3109
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 This option can not be changed when 'modifiable' is off.
3111
3112 *'fe'*
3113 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003114 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 old short name was 'fe', which is no longer used.
3116
3117 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003118'fileencodings' 'fencs' string (default: "ucs-bom",
3119 "ucs-bom,utf-8,default,latin1" when
3120 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 This is a list of character encodings considered when starting to edit
3123 an existing file. When a file is read, Vim tries to use the first
3124 mentioned character encoding. If an error is detected, the next one
3125 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003126 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 an empty string, which means the value of 'encoding' is used.
3128 WARNING: Conversion can cause loss of information! When
3129 'encoding' is "utf-8" (or one of the other Unicode variants)
3130 conversion is most likely done in a way that the reverse
3131 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003132 "utf-8" some non-ASCII characters may be lost! You can use
3133 the |++bad| argument to specify what is done with characters
3134 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 For an empty file or a file with only ASCII characters most encodings
3136 will work and the first entry of 'fileencodings' will be used (except
3137 "ucs-bom", which requires the BOM to be present). If you prefer
3138 another encoding use an BufReadPost autocommand event to test if your
3139 preferred encoding is to be used. Example: >
3140 au BufReadPost * if search('\S', 'w') == 0 |
3141 \ set fenc=iso-2022-jp | endif
3142< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3143 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003144 When the |++enc| argument is used then the value of 'fileencodings' is
3145 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003146 Note that 'fileencodings' is not used for a new file, the global value
3147 of 'fileencoding' is used instead. You can set it with: >
3148 :setglobal fenc=iso-8859-2
3149< This means that a non-existing file may get a different encoding than
3150 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 The special value "ucs-bom" can be used to check for a Unicode BOM
3152 (Byte Order Mark) at the start of the file. It must not be preceded
3153 by "utf-8" or another Unicode encoding for this to work properly.
3154 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3155 because Vim cannot detect an error, thus the encoding is always
3156 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003157 The special value "default" can be used for the encoding from the
K.Takataef8706f2021-05-31 18:40:49 +02003158 environment. On MS-Windows this is the system encoding. Otherwise
3159 this is the default value for 'encoding'. It is useful when
3160 'encoding' is set to "utf-8" and your environment uses a non-latin1
3161 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003162 When 'encoding' is "utf-8" and a file contains an illegal byte
3163 sequence it won't be recognized as UTF-8. You can use the |8g8|
3164 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 WRONG VALUES: WHAT'S WRONG:
3166 latin1,utf-8 "latin1" will always be used
3167 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3168 file
3169 cp1250,latin1 "cp1250" will always be used
3170 If 'fileencodings' is empty, 'fileencoding' is not modified.
3171 See 'fileencoding' for the possible values.
3172 Setting this option does not have an effect until the next time a file
3173 is read.
3174
3175 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003176'fileformat' 'ff' string (MS-Windows default: "dos",
3177 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 This gives the <EOL> of the current buffer, which is used for
3180 reading/writing the buffer from/to a file:
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003181 dos <CR><NL>
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 unix <NL>
3183 mac <CR>
3184 When "dos" is used, CTRL-Z at the end of a file is ignored.
3185 See |file-formats| and |file-read|.
3186 For the character encoding of the file see 'fileencoding'.
3187 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003188 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 This option is set automatically when starting to edit a file and
3190 'fileformats' is not empty and 'binary' is off.
3191 When this option is set, after starting to edit a file, the 'modified'
3192 option is set, because the file would be different when written.
3193 This option can not be changed when 'modifiable' is off.
3194 For backwards compatibility: When this option is set to "dos",
3195 'textmode' is set, otherwise 'textmode' is reset.
3196
3197 *'fileformats'* *'ffs'*
3198'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003199 Vim+Vi MS-Windows: "dos,unix",
3200 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 Vi Cygwin: "unix,dos",
3202 Vi others: "")
3203 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 This gives the end-of-line (<EOL>) formats that will be tried when
3205 starting to edit a new buffer and when reading a file into an existing
3206 buffer:
3207 - When empty, the format defined with 'fileformat' will be used
3208 always. It is not set automatically.
3209 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003210 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 'fileformats' name will be used when a file is read into an existing
3212 buffer, no matter what 'fileformat' for that buffer is set to.
3213 - When more than one name is present, separated by commas, automatic
3214 <EOL> detection will be done when reading a file. When starting to
3215 edit a file, a check is done for the <EOL>:
3216 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3217 'fileformat' is set to "dos".
3218 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003219 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003221 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3222 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003223 This means that "mac" is only chosen when:
3224 "unix" is not present or no <NL> is found in the file, and
3225 "dos" is not present or no <CR><NL> is found in the file.
3226 Except: if "unix" was chosen, but there is a <CR> before
3227 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003228 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 4. If 'fileformat' is still not set, the first name from
3230 'fileformats' is used.
3231 When reading a file into an existing buffer, the same is done, but
3232 this happens like 'fileformat' has been set appropriately for that
3233 file only, the option is not changed.
3234 When 'binary' is set, the value of 'fileformats' is not used.
3235
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003236 When Vim starts up with an empty buffer the first item is used. You
3237 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003238
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3240 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3241 done:
3242 - When 'fileformats' is empty, there is no automatic detection. Dos
3243 format will be used.
3244 - When 'fileformats' is set to one or more names, automatic detection
3245 is done. This is based on the first <NL> in the file: If there is a
3246 <CR> in front of it, Dos format is used, otherwise Unix format is
3247 used.
3248 Also see |file-formats|.
3249 For backwards compatibility: When this option is set to an empty
3250 string or one format (no comma is included), 'textauto' is reset,
3251 otherwise 'textauto' is set.
3252 NOTE: This option is set to the Vi default value when 'compatible' is
3253 set and to the Vim default value when 'compatible' is reset.
3254
Bram Moolenaarbf884932013-04-05 22:26:15 +02003255 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3256'fileignorecase' 'fic' boolean (default on for systems where case in file
3257 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003258 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003259 When set case is ignored when using file names and directories.
3260 See 'wildignorecase' for only ignoring case when doing completion.
3261
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 *'filetype'* *'ft'*
3263'filetype' 'ft' string (default: "")
3264 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 When this option is set, the FileType autocommand event is triggered.
3266 All autocommands that match with the value of this option will be
3267 executed. Thus the value of 'filetype' is used in place of the file
3268 name.
3269 Otherwise this option does not always reflect the current file type.
3270 This option is normally set when the file type is detected. To enable
3271 this use the ":filetype on" command. |:filetype|
3272 Setting this option to a different value is most useful in a modeline,
3273 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003274 Example, for in an IDL file:
3275 /* vim: set filetype=idl : */ ~
3276 |FileType| |filetypes|
3277 When a dot appears in the value then this separates two filetype
3278 names. Example:
3279 /* vim: set filetype=c.doxygen : */ ~
3280 This will use the "c" filetype first, then the "doxygen" filetype.
3281 This works both for filetype plugins and for syntax files. More than
3282 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 This option is not copied to another buffer, independent of the 's' or
3284 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003285 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286
3287 *'fillchars'* *'fcs'*
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003288'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003290 {not available when compiled without the |+folding|
3291 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 Characters to fill the statuslines and vertical separators.
3293 It is a comma separated list of items:
3294
3295 item default Used for ~
3296 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003297 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 vert:c '|' vertical separators |:vsplit|
3299 fold:c '-' filling 'foldtext'
Bram Moolenaar3aca5a62021-02-17 13:14:07 +01003300 foldopen:c '-' mark the beginning of a fold
3301 foldclose:c '+' show a closed fold
3302 foldsep:c '|' open fold middle character
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 diff:c '-' deleted lines of the 'diff' option
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003304 eob:c '~' empty lines below the end of a buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003306 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003307 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 otherwise.
3309
3310 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003311 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312< This is similar to the default, except that these characters will also
3313 be used when there is highlighting.
3314
Bram Moolenaar008bff92021-03-04 21:55:58 +01003315 For "stl" and "stlnc" single-byte and multibyte characters are
3316 supported. But double-width characters are not supported.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003317
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 The highlighting used for these items:
3319 item highlight group ~
3320 stl:c StatusLine |hl-StatusLine|
3321 stlnc:c StatusLineNC |hl-StatusLineNC|
3322 vert:c VertSplit |hl-VertSplit|
3323 fold:c Folded |hl-Folded|
3324 diff:c DiffDelete |hl-DiffDelete|
Bram Moolenaara98f8a22021-02-13 18:24:23 +01003325 eob:c EndOfBuffer |hl-EndOfBuffer|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003327 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3328'fixendofline' 'fixeol' boolean (default on)
3329 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003330 When writing a file and this option is on, <EOL> at the end of file
3331 will be restored if missing. Turn this option off if you want to
3332 preserve the situation from the original file.
3333 When the 'binary' option is set the value of this option doesn't
3334 matter.
3335 See the 'endofline' option.
3336
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
Bram Moolenaar98a29d02021-01-18 19:55:44 +01003338'fkmap' 'fk' boolean (default off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 {only available when compiled with the |+rightleft|
3341 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003342 This option was for using Farsi, which has been removed. See
3343 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344
3345 *'foldclose'* *'fcl'*
3346'foldclose' 'fcl' string (default "")
3347 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 {not available when compiled without the |+folding|
3349 feature}
3350 When set to "all", a fold is closed when the cursor isn't in it and
3351 its level is higher than 'foldlevel'. Useful if you want folds to
3352 automatically close when moving out of them.
3353
3354 *'foldcolumn'* *'fdc'*
3355'foldcolumn' 'fdc' number (default 0)
3356 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 {not available when compiled without the |+folding|
3358 feature}
3359 When non-zero, a column with the specified width is shown at the side
3360 of the window which indicates open and closed folds. The maximum
3361 value is 12.
3362 See |folding|.
3363
3364 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3365'foldenable' 'fen' boolean (default on)
3366 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 {not available when compiled without the |+folding|
3368 feature}
3369 When off, all folds are open. This option can be used to quickly
3370 switch between showing all text unfolded and viewing the text with
3371 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003372 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 'foldenable' is off.
3374 This option is set by commands that create a new fold or close a fold.
3375 See |folding|.
3376
3377 *'foldexpr'* *'fde'*
3378'foldexpr' 'fde' string (default: "0")
3379 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003381 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003383 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003384
Bram Moolenaar30b65812012-07-12 22:01:11 +02003385 The expression will be evaluated in the |sandbox| if set from a
3386 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003387 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003388 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003389
3390 It is not allowed to change text or jump to another window while
3391 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392
3393 *'foldignore'* *'fdi'*
3394'foldignore' 'fdi' string (default: "#")
3395 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 {not available when compiled without the |+folding|
3397 feature}
3398 Used only when 'foldmethod' is "indent". Lines starting with
3399 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003400 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 The default "#" works well for C programs. See |fold-indent|.
3402
3403 *'foldlevel'* *'fdl'*
3404'foldlevel' 'fdl' number (default: 0)
3405 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 {not available when compiled without the |+folding|
3407 feature}
3408 Sets the fold level: Folds with a higher level will be closed.
3409 Setting this option to zero will close all folds. Higher numbers will
3410 close fewer folds.
3411 This option is set by commands like |zm|, |zM| and |zR|.
3412 See |fold-foldlevel|.
3413
3414 *'foldlevelstart'* *'fdls'*
3415'foldlevelstart' 'fdls' number (default: -1)
3416 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 {not available when compiled without the |+folding|
3418 feature}
3419 Sets 'foldlevel' when starting to edit another buffer in a window.
3420 Useful to always start editing with all folds closed (value zero),
3421 some folds closed (one) or no folds closed (99).
3422 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003423 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 ignores this option and closes all folds.
3425 It is also done before BufReadPre autocommands, to allow an autocmd to
3426 overrule the 'foldlevel' value for specific files.
3427 When the value is negative, it is not used.
3428
3429 *'foldmarker'* *'fmr'* *E536*
3430'foldmarker' 'fmr' string (default: "{{{,}}}")
3431 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 {not available when compiled without the |+folding|
3433 feature}
3434 The start and end marker used when 'foldmethod' is "marker". There
3435 must be one comma, which separates the start and end marker. The
3436 marker is a literal string (a regular expression would be too slow).
3437 See |fold-marker|.
3438
3439 *'foldmethod'* *'fdm'*
3440'foldmethod' 'fdm' string (default: "manual")
3441 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 {not available when compiled without the |+folding|
3443 feature}
3444 The kind of folding used for the current window. Possible values:
3445 |fold-manual| manual Folds are created manually.
3446 |fold-indent| indent Lines with equal indent form a fold.
3447 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3448 |fold-marker| marker Markers are used to specify folds.
3449 |fold-syntax| syntax Syntax highlighting items specify folds.
3450 |fold-diff| diff Fold text that is not changed.
3451
3452 *'foldminlines'* *'fml'*
3453'foldminlines' 'fml' number (default: 1)
3454 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 {not available when compiled without the |+folding|
3456 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003457 Sets the number of screen lines above which a fold can be displayed
3458 closed. Also for manually closed folds. With the default value of
3459 one a fold can only be closed if it takes up two or more screen lines.
3460 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003461 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 "zc" to close a fold, which is displayed open because it's smaller
3463 than 'foldminlines', a following "zc" may close a containing fold.
3464
3465 *'foldnestmax'* *'fdn'*
3466'foldnestmax' 'fdn' number (default: 20)
3467 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 {not available when compiled without the |+folding|
3469 feature}
3470 Sets the maximum nesting of folds for the "indent" and "syntax"
3471 methods. This avoids that too many folds will be created. Using more
3472 than 20 doesn't work, because the internal limit is 20.
3473
3474 *'foldopen'* *'fdo'*
3475'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3476 search,tag,undo")
3477 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 {not available when compiled without the |+folding|
3479 feature}
3480 Specifies for which type of commands folds will be opened, if the
3481 command moves the cursor into a closed fold. It is a comma separated
3482 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003483 NOTE: When the command is part of a mapping this option is not used.
3484 Add the |zv| command to the mapping to get the same effect.
3485 (rationale: the mapping may want to control opening folds itself)
3486
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 item commands ~
3488 all any
3489 block "(", "{", "[[", "[{", etc.
3490 hor horizontal movements: "l", "w", "fx", etc.
3491 insert any command in Insert mode
3492 jump far jumps: "G", "gg", etc.
3493 mark jumping to a mark: "'m", CTRL-O, etc.
3494 percent "%"
3495 quickfix ":cn", ":crew", ":make", etc.
3496 search search for a pattern: "/", "n", "*", "gd", etc.
3497 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003498 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 tag jumping to a tag: ":ta", CTRL-T, etc.
3500 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 When a movement command is used for an operator (e.g., "dl" or "y%")
3502 this option is not used. This means the operator will include the
3503 whole closed fold.
3504 Note that vertical movements are not here, because it would make it
3505 very difficult to move onto a closed fold.
3506 In insert mode the folds containing the cursor will always be open
3507 when text is inserted.
3508 To close folds you can re-apply 'foldlevel' with the |zx| command or
3509 set the 'foldclose' option to "all".
3510
3511 *'foldtext'* *'fdt'*
3512'foldtext' 'fdt' string (default: "foldtext()")
3513 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 {not available when compiled without the |+folding|
3515 feature}
3516 An expression which is used to specify the text displayed for a closed
3517 fold. See |fold-foldtext|.
3518
Bram Moolenaar30b65812012-07-12 22:01:11 +02003519 The expression will be evaluated in the |sandbox| if set from a
3520 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003521 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003522
3523 It is not allowed to change text or jump to another window while
3524 evaluating 'foldtext' |textlock|.
3525
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003526 *'formatexpr'* *'fex'*
3527'formatexpr' 'fex' string (default "")
3528 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003529 {not available when compiled without the |+eval|
3530 feature}
3531 Expression which is evaluated to format a range of lines for the |gq|
3532 operator or automatic formatting (see 'formatoptions'). When this
3533 option is empty 'formatprg' is used.
3534
3535 The |v:lnum| variable holds the first line to be formatted.
3536 The |v:count| variable holds the number of lines to be formatted.
3537 The |v:char| variable holds the character that is going to be
3538 inserted if the expression is being evaluated due to
3539 automatic formatting. This can be empty. Don't insert
3540 it yet!
3541
3542 Example: >
3543 :set formatexpr=mylang#Format()
3544< This will invoke the mylang#Format() function in the
3545 autoload/mylang.vim file in 'runtimepath'. |autoload|
3546
3547 The expression is also evaluated when 'textwidth' is set and adding
3548 text beyond that limit. This happens under the same conditions as
3549 when internal formatting is used. Make sure the cursor is kept in the
3550 same spot relative to the text then! The |mode()| function will
3551 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003552
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003553 When the expression evaluates to non-zero Vim will fall back to using
3554 the internal format mechanism.
3555
3556 The expression will be evaluated in the |sandbox| when set from a
3557 modeline, see |sandbox-option|. That stops the option from working,
3558 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003559 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003560 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003561
Bram Moolenaar86b68352004-12-27 21:59:20 +00003562 *'formatlistpat'* *'flp'*
3563'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3564 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003565 A pattern that is used to recognize a list header. This is used for
3566 the "n" flag in 'formatoptions'.
3567 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003568 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003569 while still checking more characters. There must be a character
3570 following the pattern, when it matches the whole line it is handled
3571 like there is no match.
3572 The default recognizes a number, followed by an optional punctuation
3573 character and white space.
3574
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003575 *'formatoptions'* *'fo'*
3576'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3577 local to buffer
3578 This is a sequence of letters which describes how automatic
3579 formatting is to be done. See |fo-table|. When the 'paste' option is
3580 on, no formatting is done (like 'formatoptions' is empty). Commas can
3581 be inserted for readability.
3582 To avoid problems with flags that are added in the future, use the
3583 "+=" and "-=" feature of ":set" |add-option-flags|.
3584 NOTE: This option is set to the Vi default value when 'compatible' is
3585 set and to the Vim default value when 'compatible' is reset.
3586
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 *'formatprg'* *'fp'*
3588'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003589 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003591 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003593 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003594 If the 'formatexpr' option is not empty it will be used instead.
3595 Otherwise, if 'formatprg' option is an empty string, the internal
3596 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003597 Environment variables are expanded |:set_env|. See |option-backslash|
3598 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003599 This option cannot be set from a |modeline| or in the |sandbox|, for
3600 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601
Bram Moolenaard94464e2015-11-02 15:28:18 +01003602 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003603'fsync' 'fs' boolean (default on)
3604 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003605 When on, the library function fsync() will be called after writing a
3606 file. This will flush a file to disk, ensuring that it is safely
3607 written even on filesystems which do metadata-only journaling. This
3608 will force the harddrive to spin up on Linux systems running in laptop
3609 mode, so it may be undesirable in some situations. Be warned that
3610 turning this off increases the chances of data loss after a crash. On
3611 systems without an fsync() implementation, this variable is always
3612 off.
3613 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar340dd0f2021-10-14 17:52:23 +01003614 'fsync' also applies to |writefile()| (unless a flag is used to
3615 overrule it) and when writing undo files (see |undo-persistence|).
Bram Moolenaar110289e2019-05-23 15:38:06 +02003616 This option cannot be set from a |modeline| or in the |sandbox|, for
3617 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003618
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3620'gdefault' 'gd' boolean (default off)
3621 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 When on, the ":substitute" flag 'g' is default on. This means that
3623 all matches in a line are substituted instead of one. When a 'g' flag
3624 is given to a ":substitute" command, this will toggle the substitution
3625 of all or one match. See |complex-change|.
3626
3627 command 'gdefault' on 'gdefault' off ~
3628 :s/// subst. all subst. one
3629 :s///g subst. one subst. all
3630 :s///gg subst. all subst. one
3631
3632 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003633 DEPRECATED: Setting this option may break plugins that are not aware
3634 of this option. Also, many users get confused that adding the /g flag
3635 has the opposite effect of that it normally does.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01003636 This option is not used in |Vim9| script.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637
3638 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003639'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 Format to recognize for the ":grep" command output.
3642 This is a scanf-like string that uses the same format as the
3643 'errorformat' option: see |errorformat|.
3644
3645 *'grepprg'* *'gp'*
3646'grepprg' 'gp' string (default "grep -n ",
3647 Unix: "grep -n $* /dev/null",
3648 Win32: "findstr /n" or "grep -n",
3649 VMS: "SEARCH/NUMBERS ")
3650 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003651 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 and '#' characters, which are expanded like when used in a command-
3653 line. The placeholder "$*" is allowed to specify where the arguments
3654 will be included. Environment variables are expanded |:set_env|. See
3655 |option-backslash| about including spaces and backslashes.
3656 When your "grep" accepts the "-H" argument, use this to make ":grep"
3657 also work well with a single file: >
3658 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003659< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003660 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3661 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003662 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 apply equally to 'grepprg'.
3664 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3665 otherwise it's "grep -n".
3666 This option cannot be set from a |modeline| or in the |sandbox|, for
3667 security reasons.
3668
3669 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3670'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3671 ve:ver35-Cursor,
3672 o:hor50-Cursor,
3673 i-ci:ver25-Cursor/lCursor,
3674 r-cr:hor20-Cursor/lCursor,
3675 sm:block-Cursor
3676 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003677 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 "n-v-c:block,o:hor50,i-ci:hor15,
3679 r-cr:hor30,sm:block")
3680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003682 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003684 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003685 height of the cursor can be changed. This can be done by specifying a
3686 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003687 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3688 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003690 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 mode-list and an argument-list:
3692 mode-list:argument-list,mode-list:argument-list,..
3693 The mode-list is a dash separated list of these modes:
3694 n Normal mode
3695 v Visual mode
3696 ve Visual mode with 'selection' "exclusive" (same as 'v',
3697 if not specified)
3698 o Operator-pending mode
3699 i Insert mode
3700 r Replace mode
3701 c Command-line Normal (append) mode
3702 ci Command-line Insert mode
3703 cr Command-line Replace mode
3704 sm showmatch in Insert mode
3705 a all modes
3706 The argument-list is a dash separated list of these arguments:
3707 hor{N} horizontal bar, {N} percent of the character height
3708 ver{N} vertical bar, {N} percent of the character width
3709 block block cursor, fills the whole character
3710 [only one of the above three should be present]
3711 blinkwait{N} *cursor-blinking*
3712 blinkon{N}
3713 blinkoff{N}
3714 blink times for cursor: blinkwait is the delay before
3715 the cursor starts blinking, blinkon is the time that
3716 the cursor is shown and blinkoff is the time that the
3717 cursor is not shown. The times are in msec. When one
3718 of the numbers is zero, there is no blinking. The
3719 default is: "blinkwait700-blinkon400-blinkoff250".
3720 These numbers are used for a missing entry. This
3721 means that blinking is enabled by default. To switch
3722 blinking off you can use "blinkon0". The cursor only
3723 blinks when Vim is waiting for input, not while
3724 executing a command.
3725 To make the cursor blink in an xterm, see
3726 |xterm-blink|.
3727 {group-name}
3728 a highlight group name, that sets the color and font
3729 for the cursor
3730 {group-name}/{group-name}
3731 Two highlight group names, the first is used when
3732 no language mappings are used, the other when they
3733 are. |language-mapping|
3734
3735 Examples of parts:
3736 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3737 block cursor with colors from the "nCursor"
3738 highlight group
3739 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3740 In Insert and Command-line Insert mode, use a
3741 30% vertical bar cursor with colors from the
3742 "iCursor" highlight group. Blink a bit
3743 faster.
3744
3745 The 'a' mode is different. It will set the given argument-list for
3746 all modes. It does not reset anything to defaults. This can be used
3747 to do a common setting for all modes. For example, to switch off
3748 blinking: "a:blinkon0"
3749
3750 Examples of cursor highlighting: >
3751 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3752 :highlight Cursor gui=NONE guifg=bg guibg=fg
3753<
3754 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003755 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756'guifont' 'gfn' string (default "")
3757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 {only available when compiled with GUI enabled}
3759 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003760 In its simplest form the value is just one font name.
3761 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762
3763 *'guifontset'* *'gfs'*
3764 *E250* *E252* *E234* *E597* *E598*
3765'guifontset' 'gfs' string (default "")
3766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 {only available when compiled with GUI enabled and
3768 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003769 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 When not empty, specifies two (or more) fonts to be used. The first
3771 one for normal English, the second one for your special language. See
3772 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003773
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3775'guifontwide' 'gfw' string (default "")
3776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 {only available when compiled with GUI enabled}
3778 When not empty, specifies a comma-separated list of fonts to be used
3779 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003780 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003781
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 *'guiheadroom'* *'ghr'*
3783'guiheadroom' 'ghr' number (default 50)
3784 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003785 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 The number of pixels subtracted from the screen height when fitting
3787 the GUI window on the screen. Set this before the GUI is started,
3788 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003789 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 lines will be left for window decorations and other items on the
3791 screen. Set it to a negative value to allow windows taller than the
3792 screen.
3793
Dusan Popovic4eeedc02021-10-16 20:52:05 +01003794 *'guiligatures'* *'gli'* *E1243*
3795'guiligatures' 'gli' string (default "")
3796 global
3797 {only for GTK GUI}
3798 List of ASCII characters that, when combined together, can create more
3799 complex shapes. Each character must be a printable ASCII character
3800 with a value in the 32-127 range.
3801 Example: >
3802 :set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3803< Changing this option updates screen output immediately. Set it to an
3804 empty string to disable ligatures.
3805
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003807'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3808 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003809 "aegimrLtT" (GTK, Motif and Athena),
3810 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003813 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 sequence of letters which describes what components and options of the
3815 GUI should be used.
3816 To avoid problems with flags that are added in the future, use the
3817 "+=" and "-=" feature of ":set" |add-option-flags|.
3818
Bram Moolenaar13568252018-03-16 20:46:58 +01003819 Valid characters are as follows:
3820 *'go-!'*
3821 '!' External commands are executed in a terminal window. Without
3822 this flag the MS-Windows GUI will open a console window to
3823 execute the command. The Unix GUI will simulate a dumb
3824 terminal to list the command output.
3825 The terminal window will be positioned at the bottom, and grow
3826 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003827 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 'a' Autoselect: If present, then whenever VISUAL mode is started,
3829 or the Visual area extended, Vim tries to become the owner of
3830 the windowing system's global selection. This means that the
3831 Visually highlighted text is available for pasting into other
3832 applications as well as into Vim itself. When the Visual mode
3833 ends, possibly due to an operation on the text, or when an
3834 application wants to paste the selection, the highlighted text
3835 is automatically yanked into the "* selection register.
3836 Thus the selection is still available for pasting into other
3837 applications after the VISUAL mode has ended.
3838 If not present, then Vim won't become the owner of the
3839 windowing system's global selection unless explicitly told to
3840 by a yank or delete operation for the "* register.
3841 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003842 *'go-P'*
3843 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003844 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003845 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003846 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 applies to the modeless selection.
3848
3849 'guioptions' autoselect Visual autoselect modeless ~
3850 "" - -
3851 "a" yes yes
3852 "A" - yes
3853 "aA" yes yes
3854
Bram Moolenaar02467872007-05-06 13:22:01 +00003855 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003856 'c' Use console dialogs instead of popup dialogs for simple
3857 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003858 *'go-d'*
3859 'd' Use dark theme variant if available. Currently only works for
3860 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003861 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003862 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003863 'guitablabel' can be used to change the text in the labels.
3864 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003865 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003866 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003867 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 'f' Foreground: Don't use fork() to detach the GUI from the shell
3869 where it was started. Use this for programs that wait for the
3870 editor to finish (e.g., an e-mail program). Alternatively you
3871 can use "gvim -f" or ":gui -f" to start the GUI in the
3872 foreground. |gui-fork|
3873 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003874 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003875 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3877 corner of the window. It's black&white on non-GTK, because of
3878 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003879 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003881 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003882 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003884 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003886 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003887 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 'g' Grey menu items: Make menu items that are not active grey. If
3889 'g' is not included inactive menu items are not shown at all.
3890 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003891 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 't' Include tearoff menu items. Currently only works for Win32,
3893 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003894 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003895 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003896 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003897 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003899 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 'R' Right-hand scrollbar is present when there is a vertically
3901 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003902 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003904 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 'L' Left-hand scrollbar is present when there is a vertically
3906 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003907 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3909 the longest visible line, or on the cursor line if the 'h'
3910 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003911 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 'h' Limit horizontal scrollbar size to the length of the cursor
3913 line. Reduces computations. |gui-horiz-scroll|
3914
3915 And yes, you may even have scrollbars on the left AND the right if
3916 you really want to :-). See |gui-scrollbars| for more information.
3917
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003918 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 'v' Use a vertical button layout for dialogs. When not included,
3920 a horizontal layout is preferred, but when it doesn't fit a
Bram Moolenaardad44732021-03-31 20:07:33 +02003921 vertical layout is used anyway. Not supported in GTK 3.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003922 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 'p' Use Pointer callbacks for X11 GUI. This is required for some
3924 window managers. If the cursor is not blinking or hollow at
3925 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003926 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003928 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003929 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003930 *'go-k'*
3931 'k' Keep the GUI window size when adding/removing a scrollbar, or
3932 toolbar, tabline, etc. Instead, the behavior is similar to
3933 when the window is maximized and will adjust 'lines' and
3934 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003935 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003936 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003937
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 *'guipty'* *'noguipty'*
3939'guipty' boolean (default on)
3940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 {only available when compiled with GUI enabled}
3942 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3943 I/O to/from shell commands. See |gui-pty|.
3944
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003945 *'guitablabel'* *'gtl'*
3946'guitablabel' 'gtl' string (default empty)
3947 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003948 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003949 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003950 pages line. When empty and when the result is empty Vim will use a
3951 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003952
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003953 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003954 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003955 The expression will be evaluated in the |sandbox| when set from a
3956 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003957 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003958
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003959 Only used when the GUI tab pages line is displayed. 'e' must be
3960 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3961 used.
3962
Bram Moolenaar57657d82006-04-21 22:12:41 +00003963 *'guitabtooltip'* *'gtt'*
3964'guitabtooltip' 'gtt' string (default empty)
3965 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003966 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003967 When nonempty describes the text to use in a tooltip for the GUI tab
3968 pages line. When empty Vim will use a default tooltip.
3969 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003970 You can include a line break. Simplest method is to use |:let|: >
3971 :let &guitabtooltip = "line one\nline two"
3972<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003973
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003975'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 (others) "$VIMRUNTIME/doc/help.txt")
3977 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 Name of the main help file. All distributed help files should be
3979 placed together in one directory. Additionally, all "doc" directories
3980 in 'runtimepath' will be used.
3981 Environment variables are expanded |:set_env|. For example:
3982 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003983 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 spaces and backslashes.
3985 This option cannot be set from a |modeline| or in the |sandbox|, for
3986 security reasons.
3987
3988 *'helpheight'* *'hh'*
3989'helpheight' 'hh' number (default 20)
3990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 Minimal initial height of the help window when it is opened with the
3992 ":help" command. The initial height of the help window is half of the
3993 current window, or (when the 'ea' option is on) the same as other
3994 windows. When the height is less than 'helpheight', the height is
3995 set to 'helpheight'. Set to zero to disable.
3996
3997 *'helplang'* *'hlg'*
3998'helplang' 'hlg' string (default: messages language or empty)
3999 global
4000 {only available when compiled with the |+multi_lang|
4001 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 Comma separated list of languages. Vim will use the first language
4003 for which the desired help can be found. The English help will always
4004 be used as a last resort. You can add "en" to prefer English over
4005 another language, but that will only find tags that exist in that
4006 language and not in the English help.
4007 Example: >
4008 :set helplang=de,it
4009< This will first search German, then Italian and finally English help
4010 files.
4011 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4012 try to find the tag in the current language before using this option.
4013 See |help-translated|.
4014
4015 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4016'hidden' 'hid' boolean (default off)
4017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 When off a buffer is unloaded when it is |abandon|ed. When on a
4019 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4020 displayed in another window, it does not become hidden, of course.
4021 The commands that move through the buffer list sometimes make a buffer
4022 hidden although the 'hidden' option is off: When the buffer is
4023 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004024 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004025 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 This option is set for one command with ":hide {command}" |:hide|.
4027 WARNING: It's easy to forget that you have changes in hidden buffers.
4028 Think twice when using ":q!" or ":qa!".
4029
4030 *'highlight'* *'hl'*
4031'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004032 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4033 d:Directory,e:ErrorMsg,i:IncSearch,
4034 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004035 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02004036 N:CursorLineNr,r:Question,s:StatusLine,
4037 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004038 v:Visual,V:VisualNOS,w:WarningMsg,
4039 W:WildMenu,f:Folded,F:FoldColumn,
4040 A:DiffAdd,C:DiffChange,D:DiffDelete,
4041 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004042 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004043 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004044 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4045 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004046 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004047 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 This option can be used to set highlighting mode for various
4050 occasions. It is a comma separated list of character pairs. The
4051 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004052 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004054 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4055 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 characters from 'showbreak'
4057 |hl-Directory| d directories in CTRL-D listing and other special
4058 things in listings
4059 |hl-ErrorMsg| e error messages
4060 h (obsolete, ignored)
4061 |hl-IncSearch| i 'incsearch' highlighting
4062 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4063 |hl-MoreMsg| m |more-prompt|
4064 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004065 |hl-LineNr| n line number for ":number" and ":#" commands, and
4066 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01004067 |hl-LineNrAbove| a line number above the cursor for when the
4068 'relativenumber' option is set.
4069 |hl-LineNrBelow| b line number below the cursor for when the
4070 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004071 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4072 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 |hl-Question| r |hit-enter| prompt and yes/no questions
4074 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004075 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4077 |hl-VertSplit| c column used to separate vertically split windows
4078 |hl-Visual| v Visual mode
4079 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4080 Selection" Only X11 Gui's |gui-x11| and
4081 |xterm-clipboard|.
4082 |hl-WarningMsg| w warning messages
4083 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4084 |hl-Folded| f line used for closed folds
4085 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004086 |hl-DiffAdd| A added line in diff mode
4087 |hl-DiffChange| C changed line in diff mode
4088 |hl-DiffDelete| D deleted line in diff mode
4089 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004091 |hl-Conceal| - the placeholders used for concealed characters
4092 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004093 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004094 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004095 |hl-SpellRare| R rare word |spell|
4096 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004097 |hl-Pmenu| + popup menu normal line
4098 |hl-PmenuSel| = popup menu selected line
4099 |hl-PmenuSbar| x popup menu scrollbar
4100 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101
4102 The display modes are:
4103 r reverse (termcap entry "mr" and "me")
4104 i italic (termcap entry "ZH" and "ZR")
4105 b bold (termcap entry "md" and "me")
4106 s standout (termcap entry "so" and "se")
4107 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004108 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004109 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 n no highlighting
4111 - no highlighting
4112 : use a highlight group
4113 The default is used for occasions that are not included.
4114 If you want to change what the display modes do, see |dos-colors|
4115 for an example.
4116 When using the ':' display mode, this must be followed by the name of
4117 a highlight group. A highlight group can be used to define any type
4118 of highlighting, including using color. See |:highlight| on how to
4119 define one. The default uses a different group for each occasion.
4120 See |highlight-default| for the default highlight groups.
4121
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004123'history' 'hi' number (Vim default: 50, Vi default: 0,
4124 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004127 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004129 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 NOTE: This option is set to the Vi default value when 'compatible' is
4131 set and to the Vim default value when 'compatible' is reset.
4132
4133 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4134'hkmap' 'hk' boolean (default off)
4135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 {only available when compiled with the |+rightleft|
4137 feature}
4138 When on, the keyboard is mapped for the Hebrew character set.
4139 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4140 toggle this option. See |rileft.txt|.
4141 NOTE: This option is reset when 'compatible' is set.
4142
4143 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4144'hkmapp' 'hkp' boolean (default off)
4145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 {only available when compiled with the |+rightleft|
4147 feature}
4148 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4149 This is useful if you have a non-Hebrew keyboard.
4150 See |rileft.txt|.
4151 NOTE: This option is reset when 'compatible' is set.
4152
Bram Moolenaar036986f2017-03-16 17:41:02 +01004153 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4154'hlsearch' 'hls' boolean (default off)
4155 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004156 {not available when compiled without the
4157 |+extra_search| feature}
4158 When there is a previous search pattern, highlight all its matches.
4159 The type of highlighting used can be set with the 'l' occasion in the
4160 'highlight' option. This uses the "Search" highlight group by
4161 default. Note that only the matching text is highlighted, any offsets
4162 are not applied.
4163 See also: 'incsearch' and |:match|.
4164 When you get bored looking at the highlighted matches, you can turn it
4165 off with |:nohlsearch|. This does not change the option value, as
4166 soon as you use a search command, the highlighting comes back.
4167 'redrawtime' specifies the maximum time spent on finding matches.
4168 When the search pattern can match an end-of-line, Vim will try to
4169 highlight all of the matched text. However, this depends on where the
4170 search starts. This will be the first line in the window or the first
4171 line below a closed fold. A match in a previous line which is not
4172 drawn may not continue in a newly drawn line.
4173 You can specify whether the highlight status is restored on startup
4174 with the 'h' flag in 'viminfo' |viminfo-h|.
4175 NOTE: This option is reset when 'compatible' is set.
4176
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 *'icon'* *'noicon'*
4178'icon' boolean (default off, on when title can be restored)
4179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 {not available when compiled without the |+title|
4181 feature}
4182 When on, the icon text of the window will be set to the value of
4183 'iconstring' (if it is not empty), or to the name of the file
4184 currently being edited. Only the last part of the name is used.
4185 Overridden by the 'iconstring' option.
4186 Only works if the terminal supports setting window icons (currently
4187 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4188 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4189 builtin termcap).
4190 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004191 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004193 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194
4195 *'iconstring'*
4196'iconstring' string (default "")
4197 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 {not available when compiled without the |+title|
4199 feature}
4200 When this option is not empty, it will be used for the icon text of
4201 the window. This happens only when the 'icon' option is on.
4202 Only works if the terminal supports setting window icon text
4203 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02004204 Does not work for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 When Vim was compiled with HAVE_X11 defined, the original icon will be
4206 restored if possible |X11|.
4207 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004208 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004210 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 {not available when compiled without the |+statusline| feature}
4212
4213 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4214'ignorecase' 'ic' boolean (default off)
4215 global
4216 Ignore case in search patterns. Also used when searching in the tags
4217 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004218 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 Can be overruled by using "\c" or "\C" in the pattern, see
4220 |/ignorecase|.
4221
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004222 *'imactivatefunc'* *'imaf'*
4223'imactivatefunc' 'imaf' string (default "")
4224 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004225 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004226 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004227 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004228 The expression will be evaluated in the |sandbox| when set from a
4229 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004230
4231 Example: >
4232 function ImActivateFunc(active)
4233 if a:active
4234 ... do something
4235 else
4236 ... do something
4237 endif
4238 " return value is not used
4239 endfunction
4240 set imactivatefunc=ImActivateFunc
4241<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 *'imactivatekey'* *'imak'*
4243'imactivatekey' 'imak' string (default "")
4244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004246 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 Specifies the key that your Input Method in X-Windows uses for
4248 activation. When this is specified correctly, vim can fully control
4249 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4250 You can't use this option to change the activation key, the option
4251 tells Vim what the key is.
4252 Format:
4253 [MODIFIER_FLAG-]KEY_STRING
4254
4255 These characters can be used for MODIFIER_FLAG (case is ignored):
4256 S Shift key
4257 L Lock key
4258 C Control key
4259 1 Mod1 key
4260 2 Mod2 key
4261 3 Mod3 key
4262 4 Mod4 key
4263 5 Mod5 key
4264 Combinations are allowed, for example "S-C-space" or "SC-space" are
4265 both shift+ctrl+space.
4266 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4267
4268 Example: >
4269 :set imactivatekey=S-space
4270< "S-space" means shift+space. This is the activation key for kinput2 +
4271 canna (Japanese), and ami (Korean).
4272
4273 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4274'imcmdline' 'imc' boolean (default off)
4275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 When set the Input Method is always on when starting to edit a command
4277 line, unless entering a search pattern (see 'imsearch' for that).
4278 Setting this option is useful when your input method allows entering
4279 English characters directly, e.g., when it's used to type accented
4280 characters with dead keys.
4281
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004282 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 When set the Input Method is never used. This is useful to disable
4286 the IM when it doesn't work properly.
4287 Currently this option is on by default for SGI/IRIX machines. This
4288 may change in later releases.
4289
4290 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004291'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 Specifies whether :lmap or an Input Method (IM) is to be used in
4294 Insert mode. Valid values:
4295 0 :lmap is off and IM is off
4296 1 :lmap is ON and IM is off
4297 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 To always reset the option to zero when leaving Insert mode with <Esc>
4299 this can be used: >
4300 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4301< This makes :lmap and IM turn off automatically when leaving Insert
4302 mode.
4303 Note that this option changes when using CTRL-^ in Insert mode
4304 |i_CTRL-^|.
4305 The value is set to 1 when setting 'keymap' to a valid keymap name.
4306 It is also used for the argument of commands like "r" and "f".
4307 The value 0 may not work correctly with Athena and Motif with some XIM
4308 methods. Use 'imdisable' to disable XIM then.
4309
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004310 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004311 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004312 |+multi_byte_ime| or |global-ime|.
4313
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004315'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 Specifies whether :lmap or an Input Method (IM) is to be used when
4318 entering a search pattern. Valid values:
4319 -1 the value of 'iminsert' is used, makes it look like
4320 'iminsert' is also used when typing a search pattern
4321 0 :lmap is off and IM is off
4322 1 :lmap is ON and IM is off
4323 2 :lmap is off and IM is ON
4324 Note that this option changes when using CTRL-^ in Command-line mode
4325 |c_CTRL-^|.
4326 The value is set to 1 when it is not -1 and setting the 'keymap'
4327 option to a valid keymap name.
4328 The value 0 may not work correctly with Athena and Motif with some XIM
4329 methods. Use 'imdisable' to disable XIM then.
4330
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004331 *'imstatusfunc'* *'imsf'*
4332'imstatusfunc' 'imsf' string (default "")
4333 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004334 This option specifies a function that is called to obtain the status
4335 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004336 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004337
4338 Example: >
4339 function ImStatusFunc()
4340 let is_active = ...do something
4341 return is_active ? 1 : 0
4342 endfunction
4343 set imstatusfunc=ImStatusFunc
4344<
4345 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004346 The expression will be evaluated in the |sandbox| when set from a
4347 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004348
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004349 *'imstyle'* *'imst'*
4350'imstyle' 'imst' number (default 1)
4351 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004352 {only available when compiled with |+xim| and
4353 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004354 This option specifies the input style of Input Method:
4355 0 use on-the-spot style
4356 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004357 See: |xim-input-style|
4358
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004359 For a long time on-the-spot style had been used in the GTK version of
4360 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004361 |single-repeat|, etc. Therefore over-the-spot style becomes the
4362 default now. This should work fine for most people, however if you
4363 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004364 The expression will be evaluated in the |sandbox| when set from a
4365 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004366
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 *'include'* *'inc'*
4368'include' 'inc' string (default "^\s*#\s*include")
4369 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 {not available when compiled without the
4371 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004372 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 pattern, just like for the "/" command (See |pattern|). The default
4374 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004375 "]I", "[d", etc.
4376 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004377 comes after the matched pattern. But if "\zs" appears in the pattern
4378 then the text matched from "\zs" to the end, or until "\ze" if it
4379 appears, is used as the file name. Use this to include characters
4380 that are not in 'isfname', such as a space. You can then use
4381 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004382 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383
4384 *'includeexpr'* *'inex'*
4385'includeexpr' 'inex' string (default "")
4386 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004388 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004390 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 :set includeexpr=substitute(v:fname,'\\.','/','g')
4392< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004393
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004395 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 Also used for |<cfile>|.
4397
Bram Moolenaar30b65812012-07-12 22:01:11 +02004398 The expression will be evaluated in the |sandbox| when set from a
4399 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004400 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004401
4402 It is not allowed to change text or jump to another window while
4403 evaluating 'includeexpr' |textlock|.
4404
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004406'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4407 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004410 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004411 While typing a search command, show where the pattern, as it was typed
4412 so far, matches. The matched string is highlighted. If the pattern
4413 is invalid or not found, nothing is shown. The screen will be updated
4414 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004415 Also applies to the pattern in commands: >
4416 :global
4417 :lvimgrep
4418 :lvimgrepadd
4419 :smagic
4420 :snomagic
4421 :sort
4422 :substitute
4423 :vglobal
4424 :vimgrep
4425 :vimgrepadd
4426< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004427 original position when no match is found and when pressing <Esc>. You
4428 still need to finish the search command with <Enter> to move the
4429 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004430 You can use the CTRL-G and CTRL-T keys to move to the next and
4431 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004432 When compiled with the |+reltime| feature Vim only searches for about
4433 half a second. With a complicated pattern and/or a lot of text the
4434 match may not be found. This is to avoid that Vim hangs while you
4435 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004436 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004437 When 'hlsearch' is on, all matched strings are highlighted too while
4438 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004439 If you don't want to turn 'hlsearch' on, but want to highlight all
4440 matches while searching, you can turn on and off 'hlsearch' with
4441 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004442 augroup vimrc-incsearch-highlight
4443 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004444 autocmd CmdlineEnter /,\? :set hlsearch
4445 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004446 augroup END
4447<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004448 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004449 to the command line. If 'ignorecase' and 'smartcase' are set and the
4450 command line has no uppercase characters, the added character is
4451 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004452 CTRL-R CTRL-W can be used to add the word at the end of the current
4453 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 NOTE: This option is reset when 'compatible' is set.
4455
4456 *'indentexpr'* *'inde'*
4457'indentexpr' 'inde' string (default "")
4458 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 {not available when compiled without the |+cindent|
4460 or |+eval| features}
4461 Expression which is evaluated to obtain the proper indent for a line.
4462 It is used when a new line is created, for the |=| operator and
4463 in Insert mode as specified with the 'indentkeys' option.
4464 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004465 'smartindent' indenting. When 'lisp' is set, this option is
4466 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 When 'paste' is set this option is not used for indenting.
4468 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004469 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 when the expression is evaluated (but it may be moved around).
4471 The expression must return the number of spaces worth of indent. It
4472 can return "-1" to keep the current indent (this means 'autoindent' is
4473 used for the indent).
4474 Functions useful for computing the indent are |indent()|, |cindent()|
4475 and |lispindent()|.
4476 The evaluation of the expression must not have side effects! It must
4477 not change the text, jump to another window, etc. Afterwards the
4478 cursor position is always restored, thus the cursor may be moved.
4479 Normally this option would be set to call a function: >
4480 :set indentexpr=GetMyIndent()
4481< Error messages will be suppressed, unless the 'debug' option contains
4482 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004483 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004484 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485
Bram Moolenaar30b65812012-07-12 22:01:11 +02004486 The expression will be evaluated in the |sandbox| when set from a
4487 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004488 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004489
4490 It is not allowed to change text or jump to another window while
4491 evaluating 'indentexpr' |textlock|.
4492
4493
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004495'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 {not available when compiled without the |+cindent|
4498 feature}
4499 A list of keys that, when typed in Insert mode, cause reindenting of
4500 the current line. Only happens if 'indentexpr' isn't empty.
4501 The format is identical to 'cinkeys', see |indentkeys-format|.
4502 See |C-indenting| and |indent-expression|.
4503
4504 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4505'infercase' 'inf' boolean (default off)
4506 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004508 'ignorecase' is also on, the case of the match is adjusted depending
4509 on the typed text. If the typed text contains a lowercase letter
4510 where the match has an upper case letter, the completed part is made
4511 lowercase. If the typed text has no lowercase letters and the match
4512 has a lowercase letter where the typed text has an uppercase letter,
4513 and there is a letter before it, the completed part is made uppercase.
4514 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515
4516 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4517'insertmode' 'im' boolean (default off)
4518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 Makes Vim work in a way that Insert mode is the default mode. Useful
4520 if you want to use Vim as a modeless editor. Used for |evim|.
4521 These Insert mode commands will be useful:
4522 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004523 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 this is a mapping, it is executed as if 'insertmode' was off.
4525 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004527 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4528 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529
4530 These items change when 'insertmode' is set:
4531 - when starting to edit of a file, Vim goes to Insert mode.
4532 - <Esc> in Insert mode is a no-op and beeps.
4533 - <Esc> in Normal mode makes Vim go to Insert mode.
4534 - CTRL-L in Insert mode is a command, it is not inserted.
4535 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4536 However, when <Esc> is used inside a mapping, it behaves like
4537 'insertmode' was not set. This was done to be able to use the same
4538 mappings with 'insertmode' set or not set.
4539 When executing commands with |:normal| 'insertmode' is not used.
4540
4541 NOTE: This option is reset when 'compatible' is set.
4542
4543 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004544'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4546 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4547 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4548 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4549 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 The characters specified by this option are included in file names and
4552 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004553 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 Multi-byte characters 256 and above are always included, only the
4555 characters up to 255 are specified with this option.
4556 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004557 Think twice before adding white space to this option. Although a
4558 space may appear inside a file name, the effect will be that Vim
4559 doesn't know where a file name starts or ends when doing completion.
4560 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561
4562 Note that on systems using a backslash as path separator, Vim tries to
4563 do its best to make it work as you would expect. That is a bit
4564 tricky, since Vi originally used the backslash to escape special
4565 characters. Vim will not remove a backslash in front of a normal file
4566 name character on these systems, but it will on Unix and alikes. The
4567 '&' and '^' are not included by default, because these are special for
4568 cmd.exe.
4569
4570 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004571 Each part can be a single character number or a range. A range is two
4572 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 decimal number between 0 and 255 or the ASCII character itself (does
4574 not work for digits). Example:
4575 "_,-,128-140,#-43" (include '_' and '-' and the range
4576 128 to 140 and '#' to 43)
4577 If a part starts with '^', the following character number or range
4578 will be excluded from the option. The option is interpreted from left
4579 to right. Put the excluded character after the range where it is
4580 included. To include '^' itself use it as the last character of the
4581 option or the end of a range. Example:
4582 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4583 If the character is '@', all characters where isalpha() returns TRUE
4584 are included. Normally these are the characters a to z and A to Z,
4585 plus accented characters. To include '@' itself use "@-@". Examples:
4586 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004587 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 "a-z,A-Z,@-@" All letters plus the '@' character.
4589 A comma can be included by using it where a character number is
4590 expected. Example:
4591 "48-57,,,_" Digits, comma and underscore.
4592 A comma can be excluded by prepending a '^'. Example:
4593 " -~,^,,9" All characters from space to '~', excluding
4594 comma, plus <Tab>.
4595 See |option-backslash| about including spaces and backslashes.
4596
4597 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004598'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599 "@,48-57,_,128-167,224-235"
4600 otherwise: "@,48-57,_,192-255")
4601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 The characters given by this option are included in identifiers.
4603 Identifiers are used in recognizing environment variables and after a
4604 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004605 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004606 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004608 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4610
4611 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004612'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 "@,48-57,_,128-167,224-235"
4614 otherwise: "@,48-57,_,192-255"
4615 Vi default: "@,48-57,_")
4616 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004618 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004619 'isfname' for a description of the format of this option. For '@'
Bram Moolenaar4c295022021-05-02 17:19:11 +02004620 characters above 255 check the "word" character class (any character
4621 that is not white space or punctuation).
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004622 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 For a help file it is set to all non-blank printable characters except
4624 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4625 command).
4626 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004627 This option also influences syntax highlighting, unless the syntax
4628 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 NOTE: This option is set to the Vi default value when 'compatible' is
4630 set and to the Vim default value when 'compatible' is reset.
4631
4632 *'isprint'* *'isp'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02004633'isprint' 'isp' string (default for Win32 and macOS:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 "@,~-255"; otherwise: "@,161-255")
4635 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 The characters given by this option are displayed directly on the
4637 screen. It is also used for "\p" in a |pattern|. The characters from
4638 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4639 even when they are not included in 'isprint' or excluded. See
4640 'isfname' for a description of the format of this option.
4641
4642 Non-printable characters are displayed with two characters:
4643 0 - 31 "^@" - "^_"
4644 32 - 126 always single characters
4645 127 "^?"
4646 128 - 159 "~@" - "~_"
4647 160 - 254 "| " - "|~"
4648 255 "~?"
4649 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4650 displayed as <xx>, with the hexadecimal value of the byte.
4651 When 'display' contains "uhex" all unprintable characters are
4652 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004653 The SpecialKey highlighting will be used for unprintable characters.
4654 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655
4656 Multi-byte characters 256 and above are always included, only the
4657 characters up to 255 are specified with this option. When a character
4658 is printable but it is not available in the current font, a
4659 replacement character will be shown.
4660 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4661 There is no option to specify these characters.
4662
4663 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4664'joinspaces' 'js' boolean (default on)
4665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 Insert two spaces after a '.', '?' and '!' with a join command.
4667 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4668 Otherwise only one space is inserted.
4669 NOTE: This option is set when 'compatible' is set.
4670
4671 *'key'*
4672'key' string (default "")
4673 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004674 {only available when compiled with the |+cryptv|
4675 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004677 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 Careful: Do not set the key value by hand, someone might see the typed
4679 key. Use the |:X| command. But you can make 'key' empty: >
4680 :set key=
4681< It is not possible to get the value of this option with ":set key" or
4682 "echo &key". This is to avoid showing it to someone who shouldn't
4683 know. It also means you cannot see it yourself once you have set it,
4684 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004685 You can use "&key" in an expression to detect whether encryption is
4686 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687
4688 *'keymap'* *'kmp'* *E544*
4689'keymap' 'kmp' string (default "")
4690 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 {only available when compiled with the |+keymap|
4692 feature}
4693 Name of a keyboard mapping. See |mbyte-keymap|.
4694 Setting this option to a valid keymap name has the side effect of
4695 setting 'iminsert' to one, so that the keymap becomes effective.
4696 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004697 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698
4699 *'keymodel'* *'km'*
4700'keymodel' 'km' string (default "")
4701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 List of comma separated words, which enable special things that keys
4703 can do. These values can be used:
4704 startsel Using a shifted special key starts selection (either
4705 Select mode or Visual mode, depending on "key" being
4706 present in 'selectmode').
4707 stopsel Using a not-shifted special key stops selection.
4708 Special keys in this context are the cursor keys, <End>, <Home>,
4709 <PageUp> and <PageDown>.
4710 The 'keymodel' option is set by the |:behave| command.
4711
4712 *'keywordprg'* *'kp'*
4713'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004714 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716 Program to use for the |K| command. Environment variables are
4717 expanded |:set_env|. ":help" may be used to access the Vim internal
4718 help. (Note that previously setting the global option to the empty
4719 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004720 When the first character is ":", the command is invoked as a Vim
4721 Ex command prefixed with [count].
4722 When "man", "man -s" or an Ex command is used, Vim will automatically
4723 translate a count for the "K" command and pass it as the first
4724 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 See |option-backslash| about including spaces and backslashes.
4726 Example: >
4727 :set keywordprg=man\ -s
4728< This option cannot be set from a |modeline| or in the |sandbox|, for
4729 security reasons.
4730
4731 *'langmap'* *'lmap'* *E357* *E358*
4732'langmap' 'lmap' string (default "")
4733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 {only available when compiled with the |+langmap|
4735 feature}
4736 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004737 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004738 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739 care of translating these special characters to the original meaning
4740 of the key. This means you don't have to change the keyboard mode to
4741 be able to execute Normal mode commands.
4742 This is the opposite of the 'keymap' option, where characters are
4743 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004744 Also consider setting 'langremap' to off, to prevent 'langmap' from
4745 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004746 This option cannot be set from a |modeline| or in the |sandbox|, for
4747 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004749 Example (for Greek, in UTF-8): *greek* >
4750 :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 +00004751< Example (exchanges meaning of z and y for commands): >
4752 :set langmap=zy,yz,ZY,YZ
4753<
4754 The 'langmap' option is a list of parts, separated with commas. Each
4755 part can be in one of two forms:
4756 1. A list of pairs. Each pair is a "from" character immediately
4757 followed by the "to" character. Examples: "aA", "aAbBcC".
4758 2. A list of "from" characters, a semi-colon and a list of "to"
4759 characters. Example: "abc;ABC"
4760 Example: "aA,fgh;FGH,cCdDeE"
4761 Special characters need to be preceded with a backslash. These are
Bram Moolenaar4f4d51a2020-10-11 13:57:40 +02004762 ";", ',', '"', '|' and backslash itself.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763
4764 This will allow you to activate vim actions without having to switch
4765 back and forth between the languages. Your language characters will
4766 be understood as normal vim English characters (according to the
4767 langmap mappings) in the following cases:
4768 o Normal/Visual mode (commands, buffer/register names, user mappings)
4769 o Insert/Replace Mode: Register names after CTRL-R
4770 o Insert/Replace Mode: Mappings
4771 Characters entered in Command-line mode will NOT be affected by
4772 this option. Note that this option can be changed at any time
4773 allowing to switch between mappings for different languages/encodings.
4774 Use a mapping to avoid having to type it each time!
4775
4776 *'langmenu'* *'lm'*
4777'langmenu' 'lm' string (default "")
4778 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 {only available when compiled with the |+menu| and
4780 |+multi_lang| features}
4781 Language to use for menu translation. Tells which file is loaded
4782 from the "lang" directory in 'runtimepath': >
4783 "lang/menu_" . &langmenu . ".vim"
4784< (without the spaces). For example, to always use the Dutch menus, no
4785 matter what $LANG is set to: >
4786 :set langmenu=nl_NL.ISO_8859-1
4787< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004788 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 If your $LANG is set to a non-English language but you do want to use
4790 the English menus: >
4791 :set langmenu=none
4792< This option must be set before loading menus, switching on filetype
4793 detection or syntax highlighting. Once the menus are defined setting
4794 this option has no effect. But you could do this: >
4795 :source $VIMRUNTIME/delmenu.vim
4796 :set langmenu=de_DE.ISO_8859-1
4797 :source $VIMRUNTIME/menu.vim
4798< Warning: This deletes all menus that you defined yourself!
4799
Bram Moolenaard94464e2015-11-02 15:28:18 +01004800 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004801'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004802 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004803 {only available when compiled with the |+langmap|
4804 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004805 This is just like 'langremap' but with the value inverted. It only
4806 exists for backwards compatibility. When setting 'langremap' then
4807 'langnoremap' is set to the inverted value, and the other way around.
4808
4809 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004810'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004811 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004812 {only available when compiled with the |+langmap|
4813 feature}
4814 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004815 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004816 'langmap' disables some of your mappings, try resetting this option.
4817 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004818 that works for you to avoid mappings to break.
4819
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 *'laststatus'* *'ls'*
4821'laststatus' 'ls' number (default 1)
4822 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 The value of this option influences when the last window will have a
4824 status line:
4825 0: never
4826 1: only if there are at least two windows
4827 2: always
4828 The screen looks nicer with a status line if you have several
4829 windows, but it takes another screen line. |status-line|
4830
4831 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4832'lazyredraw' 'lz' boolean (default off)
4833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 When this option is set, the screen will not be redrawn while
4835 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004836 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 update use |:redraw|.
4838
4839 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4840'linebreak' 'lbr' boolean (default off)
4841 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004842 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004844 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 than at the last character that fits on the screen. Unlike
4846 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004847 it only affects the way the file is displayed, not its contents.
4848 If 'breakindent' is set, line is visually indented. Then, the value
4849 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004850 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 Note that <Tab> characters after an <EOL> are mostly not displayed
4852 with the right amount of white space.
4853
4854 *'lines'* *E593*
4855'lines' number (default 24 or terminal height)
4856 global
4857 Number of lines of the Vim window.
4858 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004859 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 When Vim is running in the GUI or in a resizable window, setting this
4861 option will cause the window size to be changed. When you only want
4862 to use the size for the GUI, put the command in your |gvimrc| file.
4863 Vim limits the number of lines to what fits on the screen. You can
4864 use this command to get the tallest window possible: >
4865 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004866< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004867 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 When you set this option and Vim is unable to change the physical
4869 number of lines of the display, the display may be messed up.
4870
4871 *'linespace'* *'lsp'*
4872'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 {only in the GUI}
4875 Number of pixel lines inserted between characters. Useful if the font
4876 uses the full character cell height, making lines touch each other.
4877 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004878 With some fonts there can be too much room between lines (to have
4879 space for ascents and descents). Then it makes sense to set
4880 'linespace' to a negative value. This may cause display problems
4881 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882
4883 *'lisp'* *'nolisp'*
4884'lisp' boolean (default off)
4885 local to buffer
4886 {not available when compiled without the |+lispindent|
4887 feature}
4888 Lisp mode: When <Enter> is typed in insert mode set the indent for
4889 the next line to Lisp standards (well, sort of). Also happens with
4890 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4891 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4892 better. Also see 'lispwords'.
4893 The '-' character is included in keyword characters. Redefines the
4894 "=" operator to use this same indentation algorithm rather than
4895 calling an external program if 'equalprg' is empty.
4896 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897
4898 *'lispwords'* *'lw'*
4899'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004900 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 {not available when compiled without the |+lispindent|
4902 feature}
4903 Comma separated list of words that influence the Lisp indenting.
4904 |'lisp'|
4905
4906 *'list'* *'nolist'*
4907'list' boolean (default off)
4908 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004909 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4910 line. Useful to see the difference between tabs and spaces and for
4911 trailing blanks. Further changed by the 'listchars' option.
4912
4913 The cursor is displayed at the start of the space a Tab character
4914 occupies, not at the end as usual in Normal mode. To get this cursor
4915 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004916 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004917<
4918 Note that list mode will also affect formatting (set with 'textwidth'
4919 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 changing the way tabs are displayed.
4921
4922 *'listchars'* *'lcs'*
4923'listchars' 'lcs' string (default "eol:$")
Bram Moolenaareed9d462021-02-15 20:38:25 +01004924 global or local to window |global-local|
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004925 Strings to use in 'list' mode and for the |:list| command. It is a
4926 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004927 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 eol:c Character to show at the end of each line. When
4929 omitted, there is no extra character at the end of the
4930 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004931 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004932 tab:xy[z] Two or three characters to be used to show a tab.
4933 The third character is optional.
4934
4935 tab:xy The 'x' is always used, then 'y' as many times as will
4936 fit. Thus "tab:>-" displays:
4937 >
4938 >-
4939 >--
4940 etc.
4941
4942 tab:xyz The 'z' is always used, then 'x' is prepended, and
4943 then 'y' is used as many times as will fit. Thus
4944 "tab:<->" displays:
4945 >
4946 <>
4947 <->
4948 <-->
4949 etc.
4950
4951 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004952 *lcs-space*
4953 space:c Character to show for a space. When omitted, spaces
4954 are left blank.
zeertzjqf14b8ba2021-09-10 16:58:30 +02004955 *lcs-multispace*
4956 multispace:c...
4957 One or more characters to use cyclically to show for
4958 multiple consecutive spaces. Overrides the "space"
4959 setting, except for single spaces. When omitted, the
4960 "space" setting is used. For example,
4961 `:set listchars=multispace:---+` shows ten consecutive
4962 spaces as:
4963 ---+---+--
Bram Moolenaar91478ae2021-02-03 15:58:13 +01004964 *lcs-lead*
4965 lead:c Character to show for leading spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004966 leading spaces are blank. Overrides the "space" and
4967 "multispace" settings for leading spaces. You can
4968 combine it with "tab:", for example: >
Bram Moolenaar942db232021-02-13 18:14:48 +01004969 :set listchars+=tab:>-,lead:.
4970< *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004971 trail:c Character to show for trailing spaces. When omitted,
zeertzjqf14b8ba2021-09-10 16:58:30 +02004972 trailing spaces are blank. Overrides the "space" and
4973 "multispace" settings for trailing spaces.
Bram Moolenaar79278362015-04-21 18:33:48 +02004974 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 extends:c Character to show in the last column, when 'wrap' is
4976 off and the line continues beyond the right of the
4977 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004978 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004979 precedes:c Character to show in the first visible column of the
4980 physical line, when there is text preceding the
4981 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004982 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004983 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004984 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004985 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004986 nbsp:c Character to show for a non-breakable space character
4987 (0xA0 (160 decimal) and U+202F). Left blank when
4988 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004990 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004992 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993
Bram Moolenaar93ff6722021-10-16 17:51:40 +01004994 Each character can be specified as hex: >
4995 set listchars=eol:\\x24
4996 set listchars=eol:\\u21b5
4997 set listchars=eol:\\U000021b5
4998< Note that a double backslash is used. The number of hex characters
4999 must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5000
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 Examples: >
5002 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005003 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 :set lcs=extends:>,precedes:<
5005< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02005006 "precedes". "SpecialKey" will be used for "tab", "nbsp", "space",
5007 "multispace", "lead" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005008 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009
5010 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5011'loadplugins' 'lpl' boolean (default on)
5012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 When on the plugin scripts are loaded when starting up |load-plugins|.
5014 This option can be reset in your |vimrc| file to disable the loading
5015 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005016 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5017 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018
Bram Moolenaard94464e2015-11-02 15:28:18 +01005019 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005020'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005021 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005022 {only available when compiled with the |+lua/dyn|
5023 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005024 Specifies the name of the Lua shared library. The default is
5025 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005026 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005027 This option cannot be set from a |modeline| or in the |sandbox|, for
5028 security reasons.
5029
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005030 *'macatsui'* *'nomacatsui'*
5031'macatsui' boolean (default on)
5032 global
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02005033 {not supported}
5034 No longer supported, as the Mac OS X GUI code was removed.
Bram Moolenaar02467872007-05-06 13:22:01 +00005035
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 *'magic'* *'nomagic'*
5037'magic' boolean (default on)
5038 global
5039 Changes the special characters that can be used in search patterns.
5040 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005041 WARNING: Switching this option off most likely breaks plugins! That
5042 is because many patterns assume it's on and will fail when it's off.
5043 Only switch it off when working with old Vi scripts. In any other
5044 situation write patterns that work when 'magic' is on. Include "\M"
5045 when you want to |/\M|.
Bram Moolenaar4072ba52020-12-23 13:56:35 +01005046 In |Vim9| script the value of 'magic' is ignored, patterns behave like
5047 it is always set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048
5049 *'makeef'* *'mef'*
5050'makeef' 'mef' string (default: "")
5051 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 {not available when compiled without the |+quickfix|
5053 feature}
5054 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5055 and the |:grep| command.
5056 When it is empty, an internally generated temp file will be used.
5057 When "##" is included, it is replaced by a number to make the name
5058 unique. This makes sure that the ":make" command doesn't overwrite an
5059 existing file.
5060 NOT used for the ":cf" command. See 'errorfile' for that.
5061 Environment variables are expanded |:set_env|.
5062 See |option-backslash| about including spaces and backslashes.
5063 This option cannot be set from a |modeline| or in the |sandbox|, for
5064 security reasons.
5065
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005066 *'makeencoding'* *'menc'*
5067'makeencoding' 'menc' string (default "")
5068 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005069 Encoding used for reading the output of external commands. When empty,
5070 encoding is not converted.
5071 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5072 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5073 and `:laddfile`.
5074
5075 This would be mostly useful when you use MS-Windows and set 'encoding'
5076 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5077 'makeencoding' to "char" has the same effect as setting to the system
5078 locale encoding. Example: >
5079 :set encoding=utf-8
5080 :set makeencoding=char " system locale is used
5081<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 *'makeprg'* *'mp'*
5083'makeprg' 'mp' string (default "make", VMS: "MMS")
5084 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00005085 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005086 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5087 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005088 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005089 Environment variables are expanded |:set_env|. See |option-backslash|
5090 about including spaces and backslashes.
5091 Note that a '|' must be escaped twice: once for ":set" and once for
5092 the interpretation of a command. When you use a filter called
5093 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 :set makeprg=gmake\ \\\|\ myfilter
5095< The placeholder "$*" can be given (even multiple times) to specify
5096 where the arguments will be included, for example: >
5097 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5098< This option cannot be set from a |modeline| or in the |sandbox|, for
5099 security reasons.
5100
5101 *'matchpairs'* *'mps'*
5102'matchpairs' 'mps' string (default "(:),{:},[:]")
5103 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005105 other.
5106 Only character pairs are allowed that are different, thus you cannot
5107 jump between two double quotes.
5108 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005109 The pairs must be separated by a comma. Example for including '<' and
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02005110 '>' (for HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 :set mps+=<:>
5112
5113< A more exotic example, to jump between the '=' and ';' in an
5114 assignment, useful for languages like C and Java: >
5115 :au FileType c,cpp,java set mps+==:;
5116
5117< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005118 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119
5120 *'matchtime'* *'mat'*
5121'matchtime' 'mat' number (default 5)
5122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 Tenths of a second to show the matching paren, when 'showmatch' is
5124 set. Note that this is not in milliseconds, like other options that
5125 set a time. This is to be compatible with Nvi.
5126
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005127 *'maxcombine'* *'mco'*
5128'maxcombine' 'mco' number (default 2)
5129 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005130 The maximum number of combining characters supported for displaying.
5131 Only used when 'encoding' is "utf-8".
5132 The default is OK for most languages. Hebrew may require 4.
5133 Maximum value is 6.
5134 Even when this option is set to 2 you can still edit text with more
5135 combining characters, you just can't see them. Use |g8| or |ga|.
5136 See |mbyte-combining|.
5137
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 *'maxfuncdepth'* *'mfd'*
5139'maxfuncdepth' 'mfd' number (default 100)
5140 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005141 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005142 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 Maximum depth of function calls for user functions. This normally
5144 catches endless recursion. When using a recursive function with
5145 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5146 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005147 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005148 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 See also |:function|.
5150
5151 *'maxmapdepth'* *'mmd'* *E223*
5152'maxmapdepth' 'mmd' number (default 1000)
5153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 Maximum number of times a mapping is done without resulting in a
5155 character to be used. This normally catches endless mappings, like
5156 ":map x y" with ":map y x". It still does not catch ":map g wg",
5157 because the 'w' is used before the next mapping is done. See also
5158 |key-mapping|.
5159
5160 *'maxmem'* *'mm'*
5161'maxmem' 'mm' number (default between 256 to 5120 (system
5162 dependent) or half the amount of memory
5163 available)
5164 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5166 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005167 other memory to be freed.
5168 The maximum usable value is about 2000000. Use this to work without a
5169 limit.
5170 The value is ignored when 'swapfile' is off.
5171 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005173 *'maxmempattern'* *'mmp'*
5174'maxmempattern' 'mmp' number (default 1000)
5175 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005176 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005177 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005178 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005179 When Vim runs into the limit it gives an error message and mostly
5180 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005181 Running into the limit often means that the pattern is very
5182 inefficient or too complex. This may already happen with the pattern
5183 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005184 Might also happen on redraw, when syntax rules try to match a complex
5185 text structure.
5186 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5187 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005188
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 *'maxmemtot'* *'mmt'*
5190'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5191 dependent) or half the amount of memory
5192 available)
5193 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005194 Maximum amount of memory in Kbyte to use for all buffers together.
5195 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005196 without a limit.
5197 On 64 bit machines higher values might work. But hey, do you really
5198 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005199 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005200 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005201 Buffers with 'swapfile' off still count to the total amount of memory
5202 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005203 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204
5205 *'menuitems'* *'mis'*
5206'menuitems' 'mis' number (default 25)
5207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 {not available when compiled without the |+menu|
5209 feature}
5210 Maximum number of items to use in a menu. Used for menus that are
5211 generated from a list of items, e.g., the Buffers menu. Changing this
5212 option has no direct effect, the menu must be refreshed first.
5213
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005214 *'mkspellmem'* *'msm'*
5215'mkspellmem' 'msm' string (default "460000,2000,500")
5216 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005217 {not available when compiled without the |+syntax|
5218 feature}
5219 Parameters for |:mkspell|. This tunes when to start compressing the
5220 word tree. Compression can be slow when there are many words, but
5221 it's needed to avoid running out of memory. The amount of memory used
5222 per word depends very much on how similar the words are, that's why
5223 this tuning is complicated.
5224
5225 There are three numbers, separated by commas:
5226 {start},{inc},{added}
5227
5228 For most languages the uncompressed word tree fits in memory. {start}
5229 gives the amount of memory in Kbyte that can be used before any
5230 compression is done. It should be a bit smaller than the amount of
5231 memory that is available to Vim.
5232
5233 When going over the {start} limit the {inc} number specifies the
5234 amount of memory in Kbyte that can be allocated before another
5235 compression is done. A low number means compression is done after
5236 less words are added, which is slow. A high number means more memory
5237 will be allocated.
5238
5239 After doing compression, {added} times 1024 words can be added before
5240 the {inc} limit is ignored and compression is done when any extra
5241 amount of memory is needed. A low number means there is a smaller
5242 chance of hitting the {inc} limit, less memory is used but it's
5243 slower.
5244
5245 The languages for which these numbers are important are Italian and
5246 Hungarian. The default works for when you have about 512 Mbyte. If
5247 you have 1 Gbyte you could use: >
5248 :set mkspellmem=900000,3000,800
5249< If you have less than 512 Mbyte |:mkspell| may fail for some
5250 languages, no matter what you set 'mkspellmem' to.
5251
Bram Moolenaar07607392019-05-26 19:20:43 +02005252 This option cannot be set from a |modeline| or in the |sandbox|.
5253
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005255'modeline' 'ml' boolean (Vim default: on (off for root),
5256 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005258 If 'modeline' is on 'modelines' gives the number of lines that is
5259 checked for set commands. If 'modeline' is off or 'modelines' is zero
5260 no lines are checked. See |modeline|.
5261
5262 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5263'modelineexpr' 'mle' boolean (default: off)
5264 global
5265 When on allow some options that are an expression to be set in the
5266 modeline. Check the option for whether it is affected by
5267 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005268 This option cannot be set from a |modeline| or in the |sandbox|, for
5269 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005270
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 *'modelines'* *'mls'*
5272'modelines' 'mls' number (default 5)
5273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 If 'modeline' is on 'modelines' gives the number of lines that is
5275 checked for set commands. If 'modeline' is off or 'modelines' is zero
5276 no lines are checked. See |modeline|.
5277 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5278 set and to the Vim default value when 'compatible' is reset.
5279
5280 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005281 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282'modifiable' 'ma' boolean (default on)
5283 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 When off the buffer contents cannot be changed. The 'fileformat' and
5285 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005286 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287
5288 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5289'modified' 'mod' boolean (default off)
5290 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 When on, the buffer is considered to be modified. This option is set
5292 when:
5293 1. A change was made to the text since it was last written. Using the
5294 |undo| command to go back to the original text will reset the
5295 option. But undoing changes that were made before writing the
5296 buffer will set the option again, since the text is different from
5297 when it was written.
5298 2. 'fileformat' or 'fileencoding' is different from its original
5299 value. The original value is set when the buffer is read or
5300 written. A ":set nomodified" command also resets the original
5301 values to the current values and the 'modified' option will be
5302 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005303 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005304 This option is not set when a change is made to the buffer as the
5305 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5306 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5307 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5309 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005310 Note that the text may actually be the same, e.g. 'modified' is set
5311 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312
5313 *'more'* *'nomore'*
5314'more' boolean (Vim default: on, Vi default: off)
5315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 When on, listings pause when the whole screen is filled. You will get
5317 the |more-prompt|. When this option is off there are no pauses, the
5318 listing continues until finished.
5319 NOTE: This option is set to the Vi default value when 'compatible' is
5320 set and to the Vim default value when 'compatible' is reset.
5321
Bram Moolenaar98a29d02021-01-18 19:55:44 +01005322 *'mouse'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005323'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005324 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005326 Enable the use of the mouse. Works for most terminals (xterm, Win32
5327 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5328 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5329 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005330 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 v Visual mode
5332 i Insert mode
5333 c Command-line mode
5334 h all previous modes when editing a help file
5335 a all previous modes
5336 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005337 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005339< If your terminal can't overrule the mouse events going to the
5340 application, use: >
5341 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005342< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005343 back to Vim using the mouse events.
5344 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5345 "xterm".
5346
5347 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348 modeless selection. This doesn't move the text cursor.
5349
5350 See |mouse-using|. Also see |'clipboard'|.
5351
5352 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005353 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 the mouse buttons can still be used by keeping the shift key pressed.
5355 Also see the 'clipboard' option.
5356
5357 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5358'mousefocus' 'mousef' boolean (default off)
5359 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 {only works in the GUI}
5361 The window that the mouse pointer is on is automatically activated.
5362 When changing the window layout or window focus in another way, the
5363 mouse pointer is moved to the window with keyboard focus. Off is the
5364 default because it makes using the pull down menus a little goofy, as
5365 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005366 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005367 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368
5369 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5370'mousehide' 'mh' boolean (default on)
5371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 {only works in the GUI}
5373 When on, the mouse pointer is hidden when characters are typed.
5374 The mouse pointer is restored when the mouse is moved.
5375
5376 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005377'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 Sets the model to use for the mouse. The name mostly specifies what
5380 the right mouse button is used for:
5381 extend Right mouse button extends a selection. This works
5382 like in an xterm.
5383 popup Right mouse button pops up a menu. The shifted left
5384 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005385 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386 popup_setpos Like "popup", but the cursor will be moved to the
5387 position where the mouse was clicked, and thus the
5388 selected operation will act upon the clicked object.
5389 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005390 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391 course, that right clicking outside a selection will
5392 end Visual mode.
5393 Overview of what button does what for each model:
5394 mouse extend popup(_setpos) ~
5395 left click place cursor place cursor
5396 left drag start selection start selection
5397 shift-left search word extend selection
5398 right click extend selection popup menu (place cursor)
5399 right drag extend selection -
5400 middle click paste paste
5401
5402 In the "popup" model the right mouse button produces a pop-up menu.
5403 You need to define this first, see |popup-menu|.
5404
5405 Note that you can further refine the meaning of buttons with mappings.
5406 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5407 selection (because that's handled in the GUI code directly).
5408
5409 The 'mousemodel' option is set by the |:behave| command.
5410
5411 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005412'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5413 vs:leftright,vd:lrsizing,m:no,
5414 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 {only available when compiled with the |+mouseshape|
5417 feature}
5418 This option tells Vim what the mouse pointer should look like in
5419 different modes. The option is a comma separated list of parts, much
5420 like used for 'guicursor'. Each part consist of a mode/location-list
5421 and an argument-list:
5422 mode-list:shape,mode-list:shape,..
5423 The mode-list is a dash separated list of these modes/locations:
5424 In a normal window: ~
5425 n Normal mode
5426 v Visual mode
5427 ve Visual mode with 'selection' "exclusive" (same as 'v',
5428 if not specified)
5429 o Operator-pending mode
5430 i Insert mode
5431 r Replace mode
5432
5433 Others: ~
5434 c appending to the command-line
5435 ci inserting in the command-line
5436 cr replacing in the command-line
5437 m at the 'Hit ENTER' or 'More' prompts
5438 ml idem, but cursor in the last line
5439 e any mode, pointer below last window
5440 s any mode, pointer on a status line
5441 sd any mode, while dragging a status line
5442 vs any mode, pointer on a vertical separator line
5443 vd any mode, while dragging a vertical separator line
5444 a everywhere
5445
5446 The shape is one of the following:
5447 avail name looks like ~
5448 w x arrow Normal mouse pointer
5449 w x blank no pointer at all (use with care!)
5450 w x beam I-beam
5451 w x updown up-down sizing arrows
5452 w x leftright left-right sizing arrows
5453 w x busy The system's usual busy pointer
5454 w x no The system's usual 'no input' pointer
5455 x udsizing indicates up-down resizing
5456 x lrsizing indicates left-right resizing
5457 x crosshair like a big thin +
5458 x hand1 black hand
5459 x hand2 white hand
5460 x pencil what you write with
5461 x question big ?
5462 x rightup-arrow arrow pointing right-up
5463 w x up-arrow arrow pointing up
5464 x <number> any X11 pointer number (see X11/cursorfont.h)
5465
5466 The "avail" column contains a 'w' if the shape is available for Win32,
5467 x for X11.
5468 Any modes not specified or shapes not available use the normal mouse
5469 pointer.
5470
5471 Example: >
5472 :set mouseshape=s:udsizing,m:no
5473< will make the mouse turn to a sizing arrow over the status lines and
5474 indicate no input when the hit-enter prompt is displayed (since
5475 clicking the mouse has no effect in this state.)
5476
5477 *'mousetime'* *'mouset'*
5478'mousetime' 'mouset' number (default 500)
5479 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005480 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 time in msec between two mouse clicks for the second click to be
5482 recognized as a multi click.
5483
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005484 *'mzschemedll'*
5485'mzschemedll' string (default depends on the build)
5486 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005487 {only available when compiled with the |+mzscheme/dyn|
5488 feature}
5489 Specifies the name of the MzScheme shared library. The default is
5490 DYNAMIC_MZSCH_DLL which was specified at compile time.
5491 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005492 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005493 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005494 This option cannot be set from a |modeline| or in the |sandbox|, for
5495 security reasons.
5496
5497 *'mzschemegcdll'*
5498'mzschemegcdll' string (default depends on the build)
5499 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005500 {only available when compiled with the |+mzscheme/dyn|
5501 feature}
5502 Specifies the name of the MzScheme GC shared library. The default is
5503 DYNAMIC_MZGC_DLL which was specified at compile time.
5504 The value can be equal to 'mzschemedll' if it includes the GC code.
5505 Environment variables are expanded |:set_env|.
5506 This option cannot be set from a |modeline| or in the |sandbox|, for
5507 security reasons.
5508
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005509 *'mzquantum'* *'mzq'*
5510'mzquantum' 'mzq' number (default 100)
5511 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005512 {not available when compiled without the |+mzscheme|
5513 feature}
5514 The number of milliseconds between polls for MzScheme threads.
5515 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005516 NOTE: This option is set to the Vim default value when 'compatible'
5517 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005518
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005520'nrformats' 'nf' string (default "bin,octal,hex",
5521 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523 This defines what bases Vim will consider for numbers when using the
5524 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5525 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005526 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005528 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005529 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005531 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 considered to be hexadecimal. Example: Using CTRL-X on
5533 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005534 bin If included, numbers starting with "0b" or "0B" will be
5535 considered to be binary. Example: Using CTRL-X on
5536 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005537 unsigned If included, numbers are recognized as unsigned. Thus a
5538 leading dash or negative sign won't be considered as part of
5539 the number. Examples:
5540 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5541 (without "unsigned" it would become "9-2021").
5542 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5543 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005544 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5545 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 Numbers which simply begin with a digit in the range 1-9 are always
5547 considered decimal. This also happens for numbers that are not
5548 recognized as octal or hex.
5549
5550 *'number'* *'nu'* *'nonumber'* *'nonu'*
5551'number' 'nu' boolean (default off)
5552 local to window
5553 Print the line number in front of each line. When the 'n' option is
5554 excluded from 'cpoptions' a wrapped line will not use the column of
5555 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005556 The 'numberwidth' option can be used to set the room used for the line
5557 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558 When a long, wrapped line doesn't start with the first character, '-'
5559 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005560 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5561 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005562 *number_relativenumber*
5563 The 'relativenumber' option changes the displayed number to be
5564 relative to the cursor. Together with 'number' there are these
5565 four combinations (cursor in line 3):
5566
Bram Moolenaar3848e002016-03-19 18:42:29 +01005567 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005568 'nornu' 'nornu' 'rnu' 'rnu'
5569
5570 |apple | 1 apple | 2 apple | 2 apple
5571 |pear | 2 pear | 1 pear | 1 pear
5572 |nobody | 3 nobody | 0 nobody |3 nobody
5573 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005575 *'numberwidth'* *'nuw'*
5576'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5577 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005578 {only available when compiled with the |+linebreak|
5579 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005580 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005581 when the 'number' or 'relativenumber' option is set or printing lines
5582 with a line number. Since one space is always between the number and
5583 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005584 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005585 fit the highest line number in the buffer respectively the number of
5586 rows in the window, depending on whether 'number' or 'relativenumber'
5587 is set. Thus with the Vim default of 4 there is room for a line number
5588 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005589 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005590 NOTE: This option is set to the Vi default value when 'compatible' is
5591 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005592
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005593 *'omnifunc'* *'ofu'*
5594'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005595 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005596 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005597 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005598 This option specifies a function to be used for Insert mode omni
5599 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005600 See |complete-functions| for an explanation of how the function is
5601 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005602 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005603 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005604 This option cannot be set from a |modeline| or in the |sandbox|, for
5605 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005606
5607
Bram Moolenaar02467872007-05-06 13:22:01 +00005608 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005609'opendevice' 'odev' boolean (default off)
5610 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005611 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005612 Enable reading and writing from devices. This may get Vim stuck on a
5613 device that can be opened but doesn't actually do the I/O. Therefore
5614 it is off by default.
5615 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5616 result in editing a device.
5617
5618
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005619 *'operatorfunc'* *'opfunc'*
5620'operatorfunc' 'opfunc' string (default: empty)
5621 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005622 This option specifies a function to be called by the |g@| operator.
5623 See |:map-operator| for more info and an example.
5624
5625 This option cannot be set from a |modeline| or in the |sandbox|, for
5626 security reasons.
5627
5628
Bram Moolenaar251e1912011-06-19 05:09:16 +02005629 *'osfiletype'* *'oft'*
5630'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005632 This option was supported on RISC OS, which has been removed.
5633
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005635 *'packpath'* *'pp'*
5636'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005637 Directories used to find packages. See |packages|.
5638
5639
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005641'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 global
5643 Specifies the nroff macros that separate paragraphs. These are pairs
5644 of two letters (see |object-motions|).
5645
5646 *'paste'* *'nopaste'*
5647'paste' boolean (default off)
5648 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005649 Put Vim in Paste mode. This is useful if you want to cut or copy
5650 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 unexpected effects.
5652 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005653 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 knows about pasting and will mostly do the right thing without 'paste'
5655 being set. The same is true for a terminal where Vim handles the
5656 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005657 This option is reset when starting the GUI. Thus if you set it in
5658 your .vimrc it will work in a terminal, but not in the GUI. Setting
5659 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5660 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 When the 'paste' option is switched on (also when it was already on):
5662 - mapping in Insert mode and Command-line mode is disabled
5663 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005665 - 'expandtab' is reset
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005666 - 'hkmap' is reset
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 - 'revins' is reset
5668 - 'ruler' is reset
5669 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005670 - 'smarttab' is reset
5671 - 'softtabstop' is set to 0
5672 - 'textwidth' is set to 0
5673 - 'wrapmargin' is set to 0
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005674 - 'varsofttabstop' is made empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 - 'cindent'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005677 - 'formatoptions' is used like it is empty
Bram Moolenaarca635012015-09-25 20:34:21 +02005678 - 'indentexpr'
5679 - 'lisp'
Bram Moolenaar4d8f4762021-06-27 15:18:56 +02005680 - 'smartindent'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 NOTE: When you start editing another file while the 'paste' option is
5682 on, settings from the modelines or autocommands may change the
5683 settings again, causing trouble when pasting text. You might want to
5684 set the 'paste' option again.
5685 When the 'paste' option is reset the mentioned options are restored to
5686 the value before the moment 'paste' was switched from off to on.
5687 Resetting 'paste' before ever setting it does not have any effect.
5688 Since mapping doesn't work while 'paste' is active, you need to use
5689 the 'pastetoggle' option to toggle the 'paste' option with some key.
5690
5691 *'pastetoggle'* *'pt'*
5692'pastetoggle' 'pt' string (default "")
5693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 When non-empty, specifies the key sequence that toggles the 'paste'
5695 option. This is like specifying a mapping: >
5696 :map {keys} :set invpaste<CR>
5697< Where {keys} is the value of 'pastetoggle'.
5698 The difference is that it will work even when 'paste' is set.
5699 'pastetoggle' works in Insert mode and Normal mode, but not in
5700 Command-line mode.
5701 Mappings are checked first, thus overrule 'pastetoggle'. However,
5702 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5703 this: >
5704 :map <F10> :set paste<CR>
5705 :map <F11> :set nopaste<CR>
5706 :imap <F10> <C-O>:set paste<CR>
5707 :imap <F11> <nop>
5708 :set pastetoggle=<F11>
5709< This will make <F10> start paste mode and <F11> stop paste mode.
5710 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5711 mode everything is inserted literally, except the 'pastetoggle' key
5712 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005713 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714
5715 *'pex'* *'patchexpr'*
5716'patchexpr' 'pex' string (default "")
5717 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 {not available when compiled without the |+diff|
5719 feature}
5720 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005721 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722
Bram Moolenaardbc28022014-07-26 13:40:44 +02005723 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724'patchmode' 'pm' string (default "")
5725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005726 When non-empty the oldest version of a file is kept. This can be used
5727 to keep the original version of a file if you are changing files in a
5728 source distribution. Only the first time that a file is written a
5729 copy of the original file will be kept. The name of the copy is the
5730 name of the original file with the string in the 'patchmode' option
5731 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005732 ".orig" or ".org". 'backupdir' must not be empty for this to work
5733 (Detail: The backup file is renamed to the patchmode file after the
5734 new file has been successfully written, that's why it must be possible
5735 to write a backup file). If there was no file to be backed up, an
5736 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 When the 'backupskip' pattern matches, a patchmode file is not made.
5738 Using 'patchmode' for compressed files appends the extension at the
5739 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5740 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005741 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005743 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 other systems: ".,,")
5746 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005748 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5749 provided that the file being searched for has a relative path (not
5750 starting with "/", "./" or "../"). The directories in the 'path'
5751 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 - Use commas to separate directory names: >
5753 :set path=.,/usr/local/include,/usr/include
5754< - Spaces can also be used to separate directory names (for backwards
5755 compatibility with version 3.0). To have a space in a directory
5756 name, precede it with an extra backslash, and escape the space: >
5757 :set path=.,/dir/with\\\ space
5758< - To include a comma in a directory name precede it with an extra
5759 backslash: >
5760 :set path=.,/dir/with\\,comma
5761< - To search relative to the directory of the current file, use: >
5762 :set path=.
5763< - To search in the current directory use an empty string between two
5764 commas: >
5765 :set path=,,
5766< - A directory name may end in a ':' or '/'.
5767 - Environment variables are expanded |:set_env|.
5768 - When using |netrw.vim| URLs can be used. For example, adding
5769 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005770 - Search upwards and downwards in a directory tree using "*", "**" and
5771 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 {not available when compiled without the |+path_extra| feature}
5773 - Careful with '\' characters, type two to get one in the option: >
5774 :set path=.,c:\\include
5775< Or just use '/' instead: >
5776 :set path=.,c:/include
5777< Don't forget "." or files won't even be found in the same directory as
5778 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005779 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 it is something like 256 or 1024 characters.
5781 You can check if all the include files are found, using the value of
5782 'path', see |:checkpath|.
5783 The use of |:set+=| and |:set-=| is preferred when adding or removing
5784 directories from the list. This avoids problems when a future version
5785 uses another default. To remove the current directory use: >
5786 :set path-=
5787< To add the current directory use: >
5788 :set path+=
5789< To use an environment variable, you probably need to replace the
5790 separator. Here is an example to append $INCL, in which directory
5791 names are separated with a semi-colon: >
5792 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5793< Replace the ';' with a ':' or whatever separator is used. Note that
5794 this doesn't work when $INCL contains a comma or white space.
5795
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005796 *'perldll'*
5797'perldll' string (default depends on the build)
5798 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005799 {only available when compiled with the |+perl/dyn|
5800 feature}
5801 Specifies the name of the Perl shared library. The default is
5802 DYNAMIC_PERL_DLL, which was specified at compile time.
5803 Environment variables are expanded |:set_env|.
5804 This option cannot be set from a |modeline| or in the |sandbox|, for
5805 security reasons.
5806
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5808'preserveindent' 'pi' boolean (default off)
5809 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810 When changing the indent of the current line, preserve as much of the
5811 indent structure as possible. Normally the indent is replaced by a
5812 series of tabs followed by spaces as required (unless |'expandtab'| is
5813 enabled, in which case only spaces are used). Enabling this option
5814 means the indent will preserve as many existing characters as possible
5815 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005816 'expandtab' does not apply to the preserved white space, a Tab remains
5817 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 NOTE: When using ">>" multiple times the resulting indent is a mix of
5819 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005820 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 Also see 'copyindent'.
5822 Use |:retab| to clean up white space.
5823
5824 *'previewheight'* *'pvh'*
5825'previewheight' 'pvh' number (default 12)
5826 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005827 {not available when compiled without the |+quickfix|
5828 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005830 commands. Used for |CTRL-W_}| when no count is given. Not used when
5831 'previewpopup' is set.
5832
5833 *'previewpopup'* *'pvp'*
5834'previewpopup' 'pvp' string (default empty)
5835 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005836 {not available when compiled without the |+textprop|
5837 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005838 When not empty a popup window is used for commands that would open a
5839 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005840 Not used for the insert completion info, add "popup" to
5841 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842
5843 *'previewwindow'* *'nopreviewwindow'*
5844 *'pvw'* *'nopvw'* *E590*
5845'previewwindow' 'pvw' boolean (default off)
5846 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005847 {not available when compiled without the |+quickfix|
5848 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005849 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 set. It's normally not set directly, but by using one of the commands
5851 |:ptag|, |:pedit|, etc.
5852
5853 *'printdevice'* *'pdev'*
5854'printdevice' 'pdev' string (default empty)
5855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 {only available when compiled with the |+printer|
5857 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005858 The name of the printer to be used for |:hardcopy|.
5859 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005860 This option cannot be set from a |modeline| or in the |sandbox|, for
5861 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862
Bram Moolenaar8299df92004-07-10 09:47:34 +00005863 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005864'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 {only available when compiled with the |+printer|
5867 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005868 Sets the character encoding used when printing.
5869 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870
5871 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005872'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 {only available when compiled with the |+printer|
5875 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005876 Expression used to print the PostScript produced with |:hardcopy|.
5877 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005878 This option cannot be set from a |modeline| or in the |sandbox|, for
5879 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880
Bram Moolenaar8299df92004-07-10 09:47:34 +00005881 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882'printfont' 'pfn' string (default "courier")
5883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 {only available when compiled with the |+printer|
5885 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005886 The name of the font that will be used for |:hardcopy|.
5887 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888
5889 *'printheader'* *'pheader'*
5890'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892 {only available when compiled with the |+printer|
5893 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005894 The format of the header produced in |:hardcopy| output.
5895 See |pheader-option|.
5896
5897 *'printmbcharset'* *'pmbcs'*
5898'printmbcharset' 'pmbcs' string (default "")
5899 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005900 {only available when compiled with the |+printer|
5901 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005902 The CJK character set to be used for CJK output from |:hardcopy|.
5903 See |pmbcs-option|.
5904
5905 *'printmbfont'* *'pmbfn'*
5906'printmbfont' 'pmbfn' string (default "")
5907 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005908 {only available when compiled with the |+printer|
5909 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005910 List of font names to be used for CJK output from |:hardcopy|.
5911 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912
5913 *'printoptions'* *'popt'*
5914'printoptions' 'popt' string (default "")
5915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005917 List of items that control the format of the output of |:hardcopy|.
5918 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005920 *'prompt'* *'noprompt'*
5921'prompt' boolean (default on)
5922 global
5923 When on a ":" prompt is used in Ex mode.
5924
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005925 *'pumheight'* *'ph'*
5926'pumheight' 'ph' number (default 0)
5927 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005928 Determines the maximum number of items to show in the popup menu for
5929 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005930 |ins-completion-menu|.
5931
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005932 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005933'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005934 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005935 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005936 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005937
Bram Moolenaard94464e2015-11-02 15:28:18 +01005938 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005939'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005940 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005941 {only available when compiled with the |+python/dyn|
5942 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005943 Specifies the name of the Python 2.x shared library. The default is
5944 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005945 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005946 This option cannot be set from a |modeline| or in the |sandbox|, for
5947 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005948
Bram Moolenaar94073162018-01-31 21:49:05 +01005949 *'pythonhome'*
5950'pythonhome' string (default "")
5951 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005952 {only available when compiled with the |+python/dyn|
5953 feature}
5954 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5955 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5956 which was specified at compile time, will be used for the Python 2.x
5957 home directory.
5958 Environment variables are expanded |:set_env|.
5959 This option cannot be set from a |modeline| or in the |sandbox|, for
5960 security reasons.
5961
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005962 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005963'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005964 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005965 {only available when compiled with the |+python3/dyn|
5966 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005967 Specifies the name of the Python 3 shared library. The default is
5968 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005969 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005970 This option cannot be set from a |modeline| or in the |sandbox|, for
5971 security reasons.
5972
Bram Moolenaar94073162018-01-31 21:49:05 +01005973 *'pythonthreehome'*
5974'pythonthreehome' string (default "")
5975 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005976 {only available when compiled with the |+python3/dyn|
5977 feature}
5978 Specifies the name of the Python 3 home directory. When
5979 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5980 PYTHON3_HOME, which was specified at compile time, will be used for
5981 the Python 3 home directory.
5982 Environment variables are expanded |:set_env|.
5983 This option cannot be set from a |modeline| or in the |sandbox|, for
5984 security reasons.
5985
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005986 *'pyxversion'* *'pyx'*
5987'pyxversion' 'pyx' number (default depends on the build)
5988 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005989 {only available when compiled with the |+python| or
5990 the |+python3| feature}
5991 Specifies the python version used for pyx* functions and commands
5992 |python_x|. The default value is as follows:
5993
5994 Compiled with Default ~
5995 |+python| and |+python3| 0
5996 only |+python| 2
5997 only |+python3| 3
5998
5999 Available values are 0, 2 and 3.
6000 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6001 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6002 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6003 to 2 if Python 2 is available.
6004 See also: |has-pythonx|
6005
6006 If Vim is compiled with only |+python| or |+python3| setting
6007 'pyxversion' has no effect. The pyx* functions and commands are
6008 always the same as the compiled version.
6009
6010 This option cannot be set from a |modeline| or in the |sandbox|, for
6011 security reasons.
6012
Bram Moolenaar858ba062020-05-31 23:11:59 +02006013 *'quickfixtextfunc'* *'qftf'*
6014'quickfixtextfunc' 'qftf' string (default "")
6015 global
6016 {only available when compiled with the |+quickfix|
6017 feature}
6018 This option specifies a function to be used to get the text to display
6019 in the quickfix and location list windows. This can be used to
6020 customize the information displayed in the quickfix or location window
6021 for each entry in the corresponding quickfix or location list. See
6022 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02006023 function and an example. The value can be the name of a function or a
6024 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006025
6026 This option cannot be set from a |modeline| or in the |sandbox|, for
6027 security reasons.
6028
Bram Moolenaar677ee682005-01-27 14:41:15 +00006029 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006030'quoteescape' 'qe' string (default "\")
6031 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006032 The characters that are used to escape quotes in a string. Used for
6033 objects like a', a" and a` |a'|.
6034 When one of the characters in this option is found inside a string,
6035 the following character will be skipped. The default value makes the
6036 text "foo\"bar\\" considered to be one string.
6037
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6039'readonly' 'ro' boolean (default off)
6040 local to buffer
6041 If on, writes fail unless you use a '!'. Protects you from
6042 accidentally overwriting a file. Default on when Vim is started
6043 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006044 When using ":w!" the 'readonly' option is reset for the current
6045 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006046 When using the ":view" command the 'readonly' option is set for the
6047 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006048 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006050 *'redrawtime'* *'rdt'*
6051'redrawtime' 'rdt' number (default 2000)
6052 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006053 {only available when compiled with the |+reltime|
6054 feature}
6055 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006056 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006057 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006058 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006059 matches will be highlighted.
6060 For syntax highlighting the time applies per window. When over the
6061 limit syntax highlighting is disabled until |CTRL-L| is used.
6062 This is used to avoid that Vim hangs when using a very complicated
6063 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006064
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006065 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006066'regexpengine' 're' number (default 0)
6067 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006068 This selects the default regexp engine. |two-engines|
6069 The possible values are:
6070 0 automatic selection
6071 1 old engine
6072 2 NFA engine
6073 Note that when using the NFA engine and the pattern contains something
6074 that is not supported the pattern will not match. This is only useful
6075 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006076 Using automatic selection enables Vim to switch the engine, if the
6077 default engine becomes too costly. E.g., when the NFA engine uses too
6078 many states. This should prevent Vim from hanging on a combination of
6079 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006080
Bram Moolenaar64486672010-05-16 15:46:46 +02006081 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6082'relativenumber' 'rnu' boolean (default off)
6083 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02006084 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006085 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006086 precede some vertical motion commands (e.g. j k + -) with, without
6087 having to calculate it yourself. Especially useful in combination with
6088 other commands (e.g. y d c < > gq gw =).
6089 When the 'n' option is excluded from 'cpoptions' a wrapped
6090 line will not use the column of line numbers (this is the default when
6091 'compatible' isn't set).
6092 The 'numberwidth' option can be used to set the room used for the line
6093 number.
6094 When a long, wrapped line doesn't start with the first character, '-'
6095 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006096 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6097 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006098
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006099 The number in front of the cursor line also depends on the value of
6100 'number', see |number_relativenumber| for all combinations of the two
6101 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006102
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 *'remap'* *'noremap'*
6104'remap' boolean (default on)
6105 global
6106 Allows for mappings to work recursively. If you do not want this for
6107 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006108 NOTE: To avoid portability problems with Vim scripts, always keep
6109 this option at the default "on". Only switch it off when working with
6110 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006112 *'renderoptions'* *'rop'*
6113'renderoptions' 'rop' string (default: empty)
6114 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006115 {only available when compiled with GUI and DIRECTX on
6116 MS-Windows}
6117 Select a text renderer and set its options. The options depend on the
6118 renderer.
6119
6120 Syntax: >
6121 set rop=type:{renderer}(,{name}:{value})*
6122<
6123 Currently, only one optional renderer is available.
6124
6125 render behavior ~
6126 directx Vim will draw text using DirectX (DirectWrite). It makes
6127 drawn glyphs more beautiful than default GDI.
6128 It requires 'encoding' is "utf-8", and only works on
6129 MS-Windows Vista or newer version.
6130
6131 Options:
6132 name meaning type value ~
6133 gamma gamma float 1.0 - 2.2 (maybe)
6134 contrast enhancedContrast float (unknown)
6135 level clearTypeLevel float (unknown)
6136 geom pixelGeometry int 0 - 2 (see below)
6137 renmode renderingMode int 0 - 6 (see below)
6138 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006139 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006140
Bram Moolenaar92467d32017-12-05 13:22:16 +01006141 See this URL for detail (except for scrlines):
6142 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006143
6144 For geom: structure of a device pixel.
6145 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6146 1 - DWRITE_PIXEL_GEOMETRY_RGB
6147 2 - DWRITE_PIXEL_GEOMETRY_BGR
6148
6149 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006150 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006151
6152 For renmode: method of rendering glyphs.
6153 0 - DWRITE_RENDERING_MODE_DEFAULT
6154 1 - DWRITE_RENDERING_MODE_ALIASED
6155 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6156 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6157 4 - DWRITE_RENDERING_MODE_NATURAL
6158 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6159 6 - DWRITE_RENDERING_MODE_OUTLINE
6160
6161 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006162 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006163
6164 For taamode: antialiasing mode used for drawing text.
6165 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6166 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6167 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6168 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6169
6170 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006171 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6172
Bram Moolenaara338adc2018-01-31 20:51:47 +01006173 For scrlines:
6174 This was used for optimizing scrolling behavior, however this
6175 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006176
6177 Example: >
6178 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006179 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006180 set rop=type:directx
6181<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006182 If select a raster font (Courier, Terminal or FixedSys which
6183 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006184 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006185
6186 NOTE: It is known that some fonts and options combination
6187 causes trouble on drawing glyphs.
6188
Bram Moolenaar92467d32017-12-05 13:22:16 +01006189 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006190 special made fonts (True-Type fonts which includes only
6191 bitmap glyphs).
6192 - 'taamode:3' will not work with some vector fonts.
6193
6194 NOTE: With this option, you can display colored emoji
6195 (emoticon) in Windows 8.1 or later. To display colored emoji,
6196 there are some conditions which you should notice.
6197
6198 - If your font includes non-colored emoji already, it will
6199 be used.
6200 - If your font doesn't have emoji, the system chooses an
6201 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6202 will be used.
6203 - When this alternative font didn't have fixed width glyph,
6204 emoji might be rendered beyond the bounding box of drawing
6205 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006206
6207 Other render types are currently not supported.
6208
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 *'report'*
6210'report' number (default 2)
6211 global
6212 Threshold for reporting number of lines changed. When the number of
6213 changed lines is more than 'report' a message will be given for most
6214 ":" commands. If you want it always, set 'report' to 0.
6215 For the ":substitute" command the number of substitutions is used
6216 instead of the number of lines.
6217
6218 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6219'restorescreen' 'rs' boolean (default on)
6220 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006221 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 When set, the screen contents is restored when exiting Vim. This also
6223 happens when executing external commands.
6224
6225 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6226 options in your .vimrc. To disable restoring:
6227 set t_ti= t_te=
6228 To enable restoring (for an xterm):
6229 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6230 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6231
6232 *'revins'* *'ri'* *'norevins'* *'nori'*
6233'revins' 'ri' boolean (default off)
6234 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 {only available when compiled with the |+rightleft|
6236 feature}
6237 Inserting characters in Insert mode will work backwards. See "typing
6238 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6239 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006240 NOTE: This option is reset when 'compatible' is set.
6241 This option is reset when 'paste' is set and restored when 'paste' is
6242 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243
6244 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6245'rightleft' 'rl' boolean (default off)
6246 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 {only available when compiled with the |+rightleft|
6248 feature}
6249 When on, display orientation becomes right-to-left, i.e., characters
6250 that are stored in the file appear from the right to the left.
6251 Using this option, it is possible to edit files for languages that
6252 are written from the right to the left such as Hebrew and Arabic.
6253 This option is per window, so it is possible to edit mixed files
6254 simultaneously, or to view the same file in both ways (this is
6255 useful whenever you have a mixed text file with both right-to-left
6256 and left-to-right strings so that both sets are displayed properly
6257 in different windows). Also see |rileft.txt|.
6258
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006259 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260'rightleftcmd' 'rlc' string (default "search")
6261 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 {only available when compiled with the |+rightleft|
6263 feature}
6264 Each word in this option enables the command line editing to work in
6265 right-to-left mode for a group of commands:
6266
6267 search "/" and "?" commands
6268
6269 This is useful for languages such as Hebrew, Arabic and Farsi.
6270 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6271
Bram Moolenaard94464e2015-11-02 15:28:18 +01006272 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006273'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006274 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006275 {only available when compiled with the |+ruby/dyn|
6276 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006277 Specifies the name of the Ruby shared library. The default is
6278 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006279 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006280 This option cannot be set from a |modeline| or in the |sandbox|, for
6281 security reasons.
6282
Bram Moolenaar071d4272004-06-13 20:20:40 +00006283 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006284'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 {not available when compiled without the
6287 |+cmdline_info| feature}
6288 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006289 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 text in the file is shown on the far right:
6291 Top first line is visible
6292 Bot last line is visible
6293 All first and last line are visible
6294 45% relative position in the file
6295 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006296 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006298 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299 this option takes precedence over 'ruler' and 'rulerformat'
6300 If the number of characters displayed is different from the number of
Bram Moolenaar207f0092020-08-30 17:20:20 +02006301 bytes in the text (e.g., for a TAB or a multibyte character), both
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 the text column (byte number) and the screen column are shown,
6303 separated with a dash.
6304 For an empty line "0-1" is shown.
6305 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006306 This option is reset when 'paste' is set and restored when 'paste' is
6307 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 If you don't want to see the ruler all the time but want to know where
6309 you are, use "g CTRL-G" |g_CTRL-G|.
6310 NOTE: This option is reset when 'compatible' is set.
6311
6312 *'rulerformat'* *'ruf'*
6313'rulerformat' 'ruf' string (default empty)
6314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 {not available when compiled without the |+statusline|
6316 feature}
6317 When this option is not empty, it determines the content of the ruler
6318 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006319 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006320 This option cannot be set in a modeline when 'modelineexpr' is off.
6321
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 The default ruler width is 17 characters. To make the ruler 15
6323 characters wide, put "%15(" at the start and "%)" at the end.
6324 Example: >
6325 :set rulerformat=%15(%c%V\ %p%%%)
6326<
6327 *'runtimepath'* *'rtp'* *vimfiles*
6328'runtimepath' 'rtp' string (default:
Bram Moolenaar942db232021-02-13 18:14:48 +01006329 Unix: "$HOME/.vim,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 $VIM/vimfiles,
6331 $VIMRUNTIME,
6332 $VIM/vimfiles/after,
6333 $HOME/.vim/after"
6334 Amiga: "home:vimfiles,
6335 $VIM/vimfiles,
6336 $VIMRUNTIME,
6337 $VIM/vimfiles/after,
6338 home:vimfiles/after"
Bram Moolenaar942db232021-02-13 18:14:48 +01006339 MS-Windows: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 $VIM/vimfiles,
6341 $VIMRUNTIME,
6342 $VIM/vimfiles/after,
6343 $HOME/vimfiles/after"
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02006344 macOS: "$VIM:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 $VIMRUNTIME,
6346 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006347 Haiku: "$BE_USER_SETTINGS/vim,
6348 $VIM/vimfiles,
6349 $VIMRUNTIME,
6350 $VIM/vimfiles/after,
Bram Moolenaar942db232021-02-13 18:14:48 +01006351 $BE_USER_SETTINGS/vim/after"
6352 VMS: "sys$login:vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 $VIM/vimfiles,
6354 $VIMRUNTIME,
6355 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006356 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358 This is a list of directories which will be searched for runtime
6359 files:
6360 filetype.vim filetypes by file name |new-filetype|
6361 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006362 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 colors/ color scheme files |:colorscheme|
6364 compiler/ compiler files |:compiler|
6365 doc/ documentation |write-local-help|
6366 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006367 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368 indent/ indent scripts |indent-expression|
6369 keymap/ key mapping files |mbyte-keymap|
6370 lang/ menu translations |:menutrans|
6371 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006372 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 plugin/ plugin scripts |write-plugin|
6374 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006375 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 syntax/ syntax files |mysyntaxfile|
6377 tutor/ files for vimtutor |tutor|
6378
6379 And any other file searched for with the |:runtime| command.
6380
6381 The defaults for most systems are setup to search five locations:
6382 1. In your home directory, for your personal preferences.
6383 2. In a system-wide Vim directory, for preferences from the system
6384 administrator.
6385 3. In $VIMRUNTIME, for files distributed with Vim.
6386 *after-directory*
6387 4. In the "after" directory in the system-wide Vim directory. This is
6388 for the system administrator to overrule or add to the distributed
6389 defaults (rarely needed)
6390 5. In the "after" directory in your home directory. This is for
6391 personal preferences to overrule or add to the distributed defaults
6392 or system-wide settings (rarely needed).
6393
Bram Moolenaard0796902016-09-16 20:02:31 +02006394 More entries are added when using |packages|. If it gets very long
6395 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6396 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006397
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6399 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006400 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 wildcards.
6402 See |:runtime|.
6403 Example: >
6404 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6405< This will use the directory "~/vimruntime" first (containing your
6406 personal Vim runtime files), then "/mygroup/vim" (shared between a
6407 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6408 files).
6409 You probably should always include $VIMRUNTIME somewhere, to use the
6410 distributed runtime files. You can put a directory before $VIMRUNTIME
6411 to find files which replace a distributed runtime files. You can put
6412 a directory after $VIMRUNTIME to find files which add to distributed
6413 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006414 When Vim is started with |--clean| the home directory entries are not
6415 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 This option cannot be set from a |modeline| or in the |sandbox|, for
6417 security reasons.
6418
6419 *'scroll'* *'scr'*
6420'scroll' 'scr' number (default: half the window height)
6421 local to window
6422 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6423 set to half the number of lines in the window when the window size
Bram Moolenaar74667062020-12-28 15:41:41 +01006424 changes. This may happen when enabling the |status-line| or
6425 'tabline' option after setting the 'scroll' option.
6426 If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006427 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006428 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429
6430 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6431'scrollbind' 'scb' boolean (default off)
6432 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 See also |scroll-binding|. When this option is set, the current
6434 window scrolls as other scrollbind windows (windows that also have
6435 this option set) scroll. This option is useful for viewing the
6436 differences between two versions of a file, see 'diff'.
6437 See |'scrollopt'| for options that determine how this option should be
6438 interpreted.
6439 This option is mostly reset when splitting a window to edit another
6440 file. This means that ":split | edit file" results in two windows
6441 with scroll-binding, but ":split file" does not.
6442
Bram Moolenaarae20f342019-11-05 21:09:23 +01006443 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6444'scrollfocus' 'scf' boolean (default off)
6445 global
6446 {only for MS-Windows GUI}
6447 When using the scroll wheel and this option is set, the window under
6448 the mouse pointer is scrolled. With this option off the current
6449 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006450 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006451
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 *'scrolljump'* *'sj'*
6453'scrolljump' 'sj' number (default 1)
6454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 Minimal number of lines to scroll when the cursor gets off the
6456 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6457 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006458 When set to a negative number from -1 to -100 this is used as the
6459 percentage of the window height. Thus -50 scrolls half the window
6460 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 NOTE: This option is set to 1 when 'compatible' is set.
6462
6463 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006464'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006465 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 Minimal number of screen lines to keep above and below the cursor.
6467 This will make some context visible around where you are working. If
6468 you set it to a very large value (999) the cursor line will always be
6469 in the middle of the window (except at the start or end of the file or
6470 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006471 After using the local value, go back the global value with one of
6472 these two: >
6473 setlocal scrolloff<
6474 setlocal scrolloff=-1
6475< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 NOTE: This option is set to 0 when 'compatible' is set.
6477
6478 *'scrollopt'* *'sbo'*
6479'scrollopt' 'sbo' string (default "ver,jump")
6480 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006482 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6483 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 The following words are available:
6485 ver Bind vertical scrolling for 'scrollbind' windows
6486 hor Bind horizontal scrolling for 'scrollbind' windows
6487 jump Applies to the offset between two windows for vertical
6488 scrolling. This offset is the difference in the first
6489 displayed line of the bound windows. When moving
6490 around in a window, another 'scrollbind' window may
6491 reach a position before the start or after the end of
6492 the buffer. The offset is not changed though, when
6493 moving back the 'scrollbind' window will try to scroll
6494 to the desired position when possible.
6495 When now making that window the current one, two
6496 things can be done with the relative offset:
6497 1. When "jump" is not included, the relative offset is
6498 adjusted for the scroll position in the new current
6499 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006500 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 2. When "jump" is included, the other windows are
6502 scrolled to keep the same relative offset. When
6503 going back to the other window, it still uses the
6504 same relative offset.
6505 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006506 When 'diff' mode is active there always is vertical scroll binding,
6507 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508
6509 *'sections'* *'sect'*
6510'sections' 'sect' string (default "SHNHH HUnhsh")
6511 global
6512 Specifies the nroff macros that separate sections. These are pairs of
6513 two letters (See |object-motions|). The default makes a section start
6514 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6515
6516 *'secure'* *'nosecure'* *E523*
6517'secure' boolean (default off)
6518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 When on, ":autocmd", shell and write commands are not allowed in
6520 ".vimrc" and ".exrc" in the current directory and map commands are
6521 displayed. Switch it off only if you know that you will not run into
6522 problems, or when the 'exrc' option is off. On Unix this option is
6523 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006524 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 'secure' at the end of your ~/.vimrc then.
6526 This option cannot be set from a |modeline| or in the |sandbox|, for
6527 security reasons.
6528
6529 *'selection'* *'sel'*
6530'selection' 'sel' string (default "inclusive")
6531 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 This option defines the behavior of the selection. It is only used
6533 in Visual and Select mode.
6534 Possible values:
6535 value past line inclusive ~
6536 old no yes
6537 inclusive yes yes
6538 exclusive yes no
6539 "past line" means that the cursor is allowed to be positioned one
6540 character past the line.
6541 "inclusive" means that the last character of the selection is included
6542 in an operation. For example, when "x" is used to delete the
6543 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006544 When "old" is used and 'virtualedit' allows the cursor to move past
6545 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 Note that when "exclusive" is used and selecting from the end
6547 backwards, you cannot include the last character of a line, when
6548 starting in Normal mode and 'virtualedit' empty.
6549
6550 The 'selection' option is set by the |:behave| command.
6551
6552 *'selectmode'* *'slm'*
6553'selectmode' 'slm' string (default "")
6554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 This is a comma separated list of words, which specifies when to start
6556 Select mode instead of Visual mode, when a selection is started.
6557 Possible values:
6558 mouse when using the mouse
6559 key when using shifted special keys
6560 cmd when using "v", "V" or CTRL-V
6561 See |Select-mode|.
6562 The 'selectmode' option is set by the |:behave| command.
6563
6564 *'sessionoptions'* *'ssop'*
6565'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006566 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006568 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 feature}
6570 Changes the effect of the |:mksession| command. It is a comma
6571 separated list of words. Each word enables saving and restoring
6572 something:
6573 word save and restore ~
6574 blank empty windows
6575 buffers hidden and unloaded buffers, not just those in windows
6576 curdir the current directory
6577 folds manually created folds, opened/closed folds and local
6578 fold options
6579 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006580 and contain at least one lowercase letter. Only
6581 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 help the help window
6583 localoptions options and mappings local to a window or buffer (not
6584 global values for local options)
6585 options all options and mappings (also global values for local
6586 options)
Bram Moolenaard23b7142021-04-17 21:04:34 +02006587 skiprtp exclude 'runtimepath' and 'packpath' from the options
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 resize size of the Vim window: 'lines' and 'columns'
6589 sesdir the directory in which the session file is located
6590 will become the current directory (useful with
6591 projects accessed over a network from different
6592 systems)
6593 slash backslashes in file names replaced with forward
6594 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006595 tabpages all tab pages; without this only the current tab page
6596 is restored, so that you can make a session for each
6597 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006598 terminal include terminal windows where the command can be
6599 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 unix with Unix end-of-line format (single <NL>), even when
6601 on Windows or DOS
6602 winpos position of the whole Vim window
6603 winsize window sizes
6604
6605 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006606 When neither "curdir" nor "sesdir" is included, file names are stored
6607 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 "slash" and "unix" are useful on Windows when sharing session files
6609 with Unix. The Unix version of Vim cannot source dos format scripts,
6610 but the Windows version of Vim can source unix format scripts.
6611
6612 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006613'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 global
6615 Name of the shell to use for ! and :! commands. When changing the
6616 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6617 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006618 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619 See |option-backslash| about including spaces and backslashes.
6620 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006621
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006622 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006623 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6625< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006626 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006628 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006630 Example with escaped space (Vim will do this when initializing the
6631 option from $SHELL): >
6632 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006633< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006634 backslashes are consumed by `:set`.
6635
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 Under MS-Windows, when the executable ends in ".com" it must be
6637 included. Thus setting the shell to "command.com" or "4dos.com"
6638 works, but "command" and "4dos" do not work for all commands (e.g.,
6639 filtering).
6640 For unknown reasons, when using "4dos.com" the current directory is
6641 changed to "C:\". To avoid this set 'shell' like this: >
6642 :set shell=command.com\ /c\ 4dos
6643< This option cannot be set from a |modeline| or in the |sandbox|, for
6644 security reasons.
6645
6646 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006647'shellcmdflag' 'shcf' string (default: "-c";
Mike Williams12795022021-06-28 20:53:58 +02006648 Win32, when 'shell' contains "powershell":
6649 "-Command", or when it does not contain "sh"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006650 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Mike Williams12795022021-06-28 20:53:58 +02006653 "bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6654 For MS-Windows, the default is set according to the value of 'shell',
6655 to reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006656 On Unix it can have more than one flag. Each white space separated
6657 part is passed as an argument to the shell command.
6658 See |option-backslash| about including spaces and backslashes.
Mike Williams12795022021-06-28 20:53:58 +02006659 Also see |dos-shell| and |dos-powershell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 This option cannot be set from a |modeline| or in the |sandbox|, for
6661 security reasons.
6662
6663 *'shellpipe'* *'sp'*
Mike Williams12795022021-06-28 20:53:58 +02006664'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee"
6665 "2>&1| tee", or
6666 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 {not available when compiled without the |+quickfix|
6669 feature}
6670 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006671 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 including spaces and backslashes.
6673 The name of the temporary file can be represented by "%s" if necessary
6674 (the file name is appended automatically if no %s appears in the value
6675 of this option).
Mike Williams12795022021-06-28 20:53:58 +02006676 For the Amiga the default is ">". For MS-Windows using powershell the
6677 default is "2>&1 | Out-File -Encoding default", otherwise the default
6678 is ">%s 2>&1". The output is directly saved in a file and not echoed
6679 to the screen.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02006680 For Unix the default is "| tee". The stdout of the compiler is saved
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 in a file and echoed to the screen. If the 'shell' option is "csh" or
6682 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006683 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Natanael Copa56318362021-05-06 18:46:35 +02006684 "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
6685 means that stderr is also included. Before using the 'shell' option a
6686 path is removed, thus "/bin/sh" uses "sh".
Mike Williamsa3d1b292021-06-30 20:56:00 +02006687 For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6688 becomes ">%s 2>&1" and the output is not echoed to the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 The initialization of this option is done after reading the ".vimrc"
6690 and the other initializations, so that when the 'shell' option is set
6691 there, the 'shellpipe' option changes automatically, unless it was
6692 explicitly set before.
6693 When 'shellpipe' is set to an empty string, no redirection of the
6694 ":make" output will be done. This is useful if you use a 'makeprg'
6695 that writes to 'makeef' by itself. If you want no piping, but do
6696 want to include the 'makeef', set 'shellpipe' to a single space.
6697 Don't forget to precede the space with a backslash: ":set sp=\ ".
6698 In the future pipes may be used for filtering and this option will
6699 become obsolete (at least for Unix).
6700 This option cannot be set from a |modeline| or in the |sandbox|, for
6701 security reasons.
6702
6703 *'shellquote'* *'shq'*
Mike Williamsa3d1b292021-06-30 20:56:00 +02006704'shellquote' 'shq' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 Quoting character(s), put around the command passed to the shell, for
6707 the "!" and ":!" commands. The redirection is kept outside of the
6708 quoting. See 'shellxquote' to include the redirection. It's
6709 probably not useful to set both options.
6710 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006711 third-party shells on MS-Windows-like systems, such as the MKS Korn
Mike Williamsa3d1b292021-06-30 20:56:00 +02006712 Shell or bash, where it should be "\"". See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 This option cannot be set from a |modeline| or in the |sandbox|, for
6714 security reasons.
6715
6716 *'shellredir'* *'srr'*
Mike Williams12795022021-06-28 20:53:58 +02006717'shellredir' 'srr' string (default ">", ">&", ">%s 2>&1", or
6718 "2>&1 | Out-File -Encoding default")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 String to be used to put the output of a filter command in a temporary
6721 file. See also |:!|. See |option-backslash| about including spaces
6722 and backslashes.
6723 The name of the temporary file can be represented by "%s" if necessary
6724 (the file name is appended automatically if no %s appears in the value
6725 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006726 The default is ">". For Unix, if the 'shell' option is "csh" or
6727 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006728 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
Mike Williamsa3d1b292021-06-30 20:56:00 +02006729 "bash", "fish", or "pwsh", the default becomes ">%s 2>&1". This means
6730 that stderr is also included. For Win32, the Unix checks are done and
Mike Williams12795022021-06-28 20:53:58 +02006731 additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6732 and "powershell" is checked for which makes the default
Mike Williamsa3d1b292021-06-30 20:56:00 +02006733 "2>&1 | Out-File -Encoding default" (see |dos-powershell|). Also, the
6734 same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 The initialization of this option is done after reading the ".vimrc"
6736 and the other initializations, so that when the 'shell' option is set
6737 there, the 'shellredir' option changes automatically unless it was
6738 explicitly set before.
6739 In the future pipes may be used for filtering and this option will
6740 become obsolete (at least for Unix).
6741 This option cannot be set from a |modeline| or in the |sandbox|, for
6742 security reasons.
6743
6744 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6745'shellslash' 'ssl' boolean (default off)
6746 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006747 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 When set, a forward slash is used when expanding file names. This is
Mike Williamsa3d1b292021-06-30 20:56:00 +02006749 useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
Mike Williams12795022021-06-28 20:53:58 +02006750 powershell.exe. Backward slashes can still be typed, but they are
6751 changed to forward slashes by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 Note that setting or resetting this option has no effect for some
6753 existing file names, thus this option needs to be set before opening
6754 any file for best results. This might change in the future.
6755 'shellslash' only works when a backslash can be used as a path
6756 separator. To test if this is so use: >
6757 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006758< Also see 'completeslash'.
6759
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006760 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6761'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6762 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006763 When on, use temp files for shell commands. When off use a pipe.
6764 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006765 Currently a pipe is only supported on Unix and MS-Windows 2K and
6766 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006767 :if has("filterpipe")
6768< The advantage of using a pipe is that nobody can read the temp file
6769 and the 'shell' command does not need to support redirection.
6770 The advantage of using a temp file is that the file type and encoding
6771 can be detected.
6772 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6773 |FilterWritePost| autocommands event are not triggered when
6774 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006775 The `system()` function does not respect this option and always uses
6776 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006777 NOTE: This option is set to the Vim default value when 'compatible'
6778 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006779
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780 *'shelltype'* *'st'*
6781'shelltype' 'st' number (default 0)
6782 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006783 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 On the Amiga this option influences the way how the commands work
6785 which use a shell.
6786 0 and 1: always use the shell
6787 2 and 3: use the shell only to filter lines
6788 4 and 5: use shell only for ':sh' command
6789 When not using the shell, the command is executed directly.
6790
6791 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6792 1 and 3: use "shell cmd" to start external commands
6793
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006794 *'shellxescape'* *'sxe'*
6795'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006796 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006797 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006798 When 'shellxquote' is set to "(" then the characters listed in this
6799 option will be escaped with a '^' character. This makes it possible
6800 to execute most external commands with cmd.exe.
6801
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 *'shellxquote'* *'sxq'*
6803'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006804 for Win32, when 'shell' is cmd.exe: "("
Mike Williams12795022021-06-28 20:53:58 +02006805 for Win32, when 'shell' is
6806 powershell.exe: "\""
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006807 for Win32, when 'shell' contains "sh"
6808 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 for Unix, when using system(): "\"")
6810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 Quoting character(s), put around the command passed to the shell, for
6812 the "!" and ":!" commands. Includes the redirection. See
6813 'shellquote' to exclude the redirection. It's probably not useful
6814 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006815 When the value is '(' then ')' is appended. When the value is '"('
6816 then ')"' is appended.
6817 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006818 This is an empty string by default on most systems, but is known to be
Mike Williamsa3d1b292021-06-30 20:56:00 +02006819 useful for on Win32 version, either for cmd.exe, powershell.exe, or
6820 pwsh.exe which automatically strips off the first and last quote on a
6821 command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6822 it should be "\"". The default is adjusted according the value of
Mike Williams12795022021-06-28 20:53:58 +02006823 'shell', to reduce the need to set this option by the user. See
6824 |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 This option cannot be set from a |modeline| or in the |sandbox|, for
6826 security reasons.
6827
6828 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6829'shiftround' 'sr' boolean (default off)
6830 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 Round indent to multiple of 'shiftwidth'. Applies to > and <
6832 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6833 a multiple of 'shiftwidth' (this is Vi compatible).
6834 NOTE: This option is reset when 'compatible' is set.
6835
6836 *'shiftwidth'* *'sw'*
6837'shiftwidth' 'sw' number (default 8)
6838 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006839 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006841 When zero the 'ts' value will be used. Use the |shiftwidth()|
6842 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843
6844 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006845'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6846 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 This option helps to avoid all the |hit-enter| prompts caused by file
6849 messages, for example with CTRL-G, and to avoid some other messages.
6850 It is a list of flags:
6851 flag meaning when present ~
6852 f use "(3 of 5)" instead of "(file 3 of 5)"
6853 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006854 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 m use "[+]" instead of "[Modified]"
6856 n use "[New]" instead of "[New File]"
6857 r use "[RO]" instead of "[readonly]"
6858 w use "[w]" instead of "written" for file write message
6859 and "[a]" instead of "appended" for ':w >> file' command
6860 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6861 "[unix format]" and "[mac]" instead of "[mac format]".
6862 a all of the above abbreviations
6863
6864 o overwrite message for writing a file with subsequent message
6865 for reading a file (useful for ":wn" or when 'autowrite' on)
6866 O message for reading a file overwrites any previous message.
6867 Also for quickfix message (e.g., ":cn").
6868 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006869 hit TOP, continuing at BOTTOM" messages; when using the search
6870 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 t truncate file message at the start if it is too long to fit
6872 on the command-line, "<" will appear in the left most column.
6873 Ignored in Ex mode.
6874 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006875 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 Ignored in Ex mode.
6877 W don't give "written" or "[w]" when writing a file
6878 A don't give the "ATTENTION" message when an existing swap file
6879 is found.
6880 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006881 c don't give |ins-completion-menu| messages. For example,
6882 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6883 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006884 q use "recording" instead of "recording @a"
6885 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006886 was used for the command; note that this also affects messages
6887 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006888 S do not show search count message when searching, e.g.
6889 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890
6891 This gives you the opportunity to avoid that a change between buffers
6892 requires you to hit <Enter>, but still gives as useful a message as
6893 possible for the space available. To get the whole message that you
6894 would have got with 'shm' empty, use ":file!"
6895 Useful values:
6896 shm= No abbreviation of message.
6897 shm=a Abbreviation, but no loss of information.
6898 shm=at Abbreviation, and truncate message when necessary.
6899
6900 NOTE: This option is set to the Vi default value when 'compatible' is
6901 set and to the Vim default value when 'compatible' is reset.
6902
6903 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6904'shortname' 'sn' boolean (default off)
6905 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 Filenames are assumed to be 8 characters plus one extension of 3
6907 characters. Multiple dots in file names are not allowed. When this
6908 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006909 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006911 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912
6913 *'showbreak'* *'sbr'* *E595*
6914'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006915 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006916 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 feature}
6918 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006919 values are "> " or "+++ ": >
6920 :set showbreak=>\
6921< Note the backslash to escape the trailing space. It's easier like
6922 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006923 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006924< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 comma (in a future version the comma might be used to separate the
6926 part that is shown at the end and at the start of a line).
6927 The characters are highlighted according to the '@' flag in
6928 'highlight'.
6929 Note that tabs after the showbreak will be displayed differently.
6930 If you want the 'showbreak' to appear in between line numbers, add the
6931 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006932 A window-local value overrules a global value. If the global value is
6933 set and you want no value in the current window use NONE: >
6934 :setlocal showbreak=NONE
6935<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006937'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6938 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 {not available when compiled without the
6941 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006942 Show (partial) command in the last line of the screen. Set this
6943 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 In Visual mode the size of the selected area is shown:
6945 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006946 If the number of bytes is different it is also displayed: "2-6"
6947 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006949 - When selecting a block, the size in screen characters:
6950 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 NOTE: This option is set to the Vi default value when 'compatible' is
6952 set and to the Vim default value when 'compatible' is reset.
6953
6954 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6955'showfulltag' 'sft' boolean (default off)
6956 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 When completing a word in insert mode (see |ins-completion|) from the
6958 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006959 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 matched a C function, you can see a template for what arguments are
6961 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006962 Note that this doesn't work well together with having "longest" in
6963 'completeopt', because the completion from the search pattern may not
6964 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965
6966 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6967'showmatch' 'sm' boolean (default off)
6968 global
6969 When a bracket is inserted, briefly jump to the matching one. The
6970 jump is only done if the match can be seen on the screen. The time to
6971 show the match can be set with 'matchtime'.
6972 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006973 seen or not).
6974 This option is reset when 'paste' is set and restored when 'paste' is
6975 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 When the 'm' flag is not included in 'cpoptions', typing a character
6977 will immediately move the cursor back to where it belongs.
6978 See the "sm" field in 'guicursor' for setting the cursor shape and
6979 blinking when showing the match.
6980 The 'matchpairs' option can be used to specify the characters to show
6981 matches for. 'rightleft' and 'revins' are used to look for opposite
6982 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006983 Also see the matchparen plugin for highlighting the match when moving
6984 around |pi_paren.txt|.
6985 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986
6987 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6988'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6989 global
6990 If in Insert, Replace or Visual mode put a message on the last line.
6991 Use the 'M' flag in 'highlight' to set the type of highlighting for
6992 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006993 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994 doesn't mean XIM is really active, especially when 'imactivatekey' is
6995 not set.
6996 NOTE: This option is set to the Vi default value when 'compatible' is
6997 set and to the Vim default value when 'compatible' is reset.
6998
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006999 *'showtabline'* *'stal'*
7000'showtabline' 'stal' number (default 1)
7001 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007002 The value of this option specifies when the line with tab page labels
7003 will be displayed:
7004 0: never
7005 1: only if there are at least two tab pages
7006 2: always
7007 This is both for the GUI and non-GUI implementation of the tab pages
7008 line.
7009 See |tab-page| for more information about tab pages.
7010
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 *'sidescroll'* *'ss'*
7012'sidescroll' 'ss' number (default 0)
7013 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 The minimal number of columns to scroll horizontally. Used only when
7015 the 'wrap' option is off and the cursor is moved off of the screen.
7016 When it is zero the cursor will be put in the middle of the screen.
7017 When using a slow terminal set it to a large number or 0. When using
7018 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7019 commands.
7020
7021 *'sidescrolloff'* *'siso'*
7022'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007023 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007025 right of the cursor if 'nowrap' is set. Setting this option to a
7026 value greater than 0 while having |'sidescroll'| also at a non-zero
7027 value makes some context visible in the line you are scrolling in
7028 horizontally (except at beginning of the line). Setting this option
7029 to a large value (like 999) has the effect of keeping the cursor
7030 horizontally centered in the window, as long as one does not come too
7031 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007032 After using the local value, go back the global value with one of
7033 these two: >
7034 setlocal sidescrolloff<
7035 setlocal sidescrolloff=-1
7036< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037
7038 Example: Try this together with 'sidescroll' and 'listchars' as
7039 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007040 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041
7042 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7043 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007044<
7045 *'signcolumn'* *'scl'*
7046'signcolumn' 'scl' string (default "auto")
7047 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007048 {not available when compiled without the |+signs|
7049 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007050 Whether or not to draw the signcolumn. Valid values are:
7051 "auto" only when there is a sign to display
7052 "no" never
7053 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02007054 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02007055 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056
7057
7058 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7059'smartcase' 'scs' boolean (default off)
7060 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 Override the 'ignorecase' option if the search pattern contains upper
7062 case characters. Only used when the search pattern is typed and
7063 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007064 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7066 recalling the search pattern from history and hitting <Enter>.
7067 NOTE: This option is reset when 'compatible' is set.
7068
7069 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7070'smartindent' 'si' boolean (default off)
7071 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 {not available when compiled without the
7073 |+smartindent| feature}
7074 Do smart autoindenting when starting a new line. Works for C-like
7075 programs, but can also be used for other languages. 'cindent' does
7076 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007077 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007078 setting 'si' has no effect. 'indentexpr' is a more advanced
7079 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 Normally 'autoindent' should also be on when using 'smartindent'.
7081 An indent is automatically inserted:
7082 - After a line ending in '{'.
7083 - After a line starting with a keyword from 'cinwords'.
7084 - Before a line starting with '}' (only with the "O" command).
7085 When typing '}' as the first character in a new line, that line is
7086 given the same indent as the matching '{'.
7087 When typing '#' as the first character in a new line, the indent for
7088 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007089 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7091 When using the ">>" command, lines starting with '#' are not shifted
7092 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007093 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007094 This option is reset when 'paste' is set and restored when 'paste' is
7095 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096
7097 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7098'smarttab' 'sta' boolean (default off)
7099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007101 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7102 <BS> will delete a 'shiftwidth' worth of space at the start of the
7103 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007104 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007105 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7106 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007107 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007109 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007110 This option is reset when 'paste' is set and restored when 'paste' is
7111 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 NOTE: This option is reset when 'compatible' is set.
7113
7114 *'softtabstop'* *'sts'*
7115'softtabstop' 'sts' number (default 0)
7116 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 Number of spaces that a <Tab> counts for while performing editing
7118 operations, like inserting a <Tab> or using <BS>. It "feels" like
7119 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7120 used. This is useful to keep the 'ts' setting at its standard value
7121 of 8, while being able to edit like it is set to 'sts'. However,
7122 commands like "x" still work on the actual characters.
7123 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007124 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007125 'softtabstop' is set to 0 when the 'paste' option is set and restored
7126 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7128 spaces is minimized by using <Tab>s.
7129 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7130 set.
7131 NOTE: This option is set to 0 when 'compatible' is set.
7132
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007133 If Vim is compiled with the |+vartabs| feature then the value of
7134 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7135 anything other than an empty string.
7136
Bram Moolenaar217ad922005-03-20 22:37:15 +00007137 *'spell'* *'nospell'*
7138'spell' boolean (default off)
7139 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007140 {not available when compiled without the |+syntax|
7141 feature}
7142 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007143 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007144
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007145 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007146'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007147 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007148 {not available when compiled without the |+syntax|
7149 feature}
7150 Pattern to locate the end of a sentence. The following word will be
7151 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007152 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007153 When this check is not wanted make this option empty.
7154 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007155 Be careful with special characters, see |option-backslash| about
7156 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007157 To set this option automatically depending on the language, see
7158 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007159
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007160 *'spellfile'* *'spf'*
7161'spellfile' 'spf' string (default empty)
7162 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007163 {not available when compiled without the |+syntax|
7164 feature}
7165 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007166 commands. It must end in ".{encoding}.add". You need to include the
7167 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007168 *E765*
7169 It may also be a comma separated list of names. A count before the
7170 |zg| and |zw| commands can be used to access each. This allows using
7171 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007172 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007173 you: Using the first directory in 'runtimepath' that is writable. If
7174 there is no "spell" directory yet it will be created. For the file
7175 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007176 ignoring the region.
7177 The resulting ".spl" file will be used for spell checking, it does not
7178 have to appear in 'spelllang'.
7179 Normally one file is used for all regions, but you can add the region
7180 name if you want to. However, it will then only be used when
7181 'spellfile' is set to it, for entries in 'spelllang' only files
7182 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007183 This option cannot be set from a |modeline| or in the |sandbox|, for
7184 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007185
Bram Moolenaar217ad922005-03-20 22:37:15 +00007186 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007187'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007188 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007189 {not available when compiled without the |+syntax|
7190 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007191 A comma separated list of word list names. When the 'spell' option is
7192 on spellchecking will be done for these languages. Example: >
7193 set spelllang=en_us,nl,medical
7194< This means US English, Dutch and medical words are recognized. Words
7195 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007196 The word list name must consist of alphanumeric characters, a dash or
7197 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007198 recommended to separate the two letter language name from a
7199 specification. Thus "en-rare" is used for rare English words.
7200 A region name must come last and have the form "_xx", where "xx" is
7201 the two-letter, lower case region name. You can use more than one
7202 region by listing them: "en_us,en_ca" supports both US and Canadian
7203 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007204 Britain. (Note: currently en_au and en_nz dictionaries are older than
7205 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007206 If the name "cjk" is included East Asian characters are excluded from
7207 spell checking. This is useful when editing text that also has Asian
7208 words.
Bram Moolenaar6c391a72021-09-09 21:55:11 +02007209 Note that the "medical" dictionary does not exist, it is just an
7210 example of a longer name.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007211 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007212 As a special case the name of a .spl file can be given as-is. The
7213 first "_xx" in the name is removed and used as the region name
7214 (_xx is an underscore, two letters and followed by a non-letter).
7215 This is mainly for testing purposes. You must make sure the correct
7216 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007217 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007218 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7219 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007220 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007221
Bram Moolenaar98692072006-02-04 00:57:42 +00007222 If the |spellfile.vim| plugin is active and you use a language name
7223 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7224 will ask you if you want to download the file.
7225
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007226 After this option has been set successfully, Vim will source the files
7227 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007228 up to the first character that is not an ASCII letter or number and
7229 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007230
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007231 *'spelloptions'* *'spo'*
7232'spelloptions' 'spo' string (default "")
7233 local to buffer
7234 {not available when compiled without the |+syntax|
7235 feature}
7236 A comma separated list of options for spell checking:
7237 camel When a word is CamelCased, assume "Cased" is a
7238 separate word: every upper-case character in a word
7239 that comes after a lower case character indicates the
7240 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007241
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007242 *'spellsuggest'* *'sps'*
7243'spellsuggest' 'sps' string (default "best")
7244 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007245 {not available when compiled without the |+syntax|
7246 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007247 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007248 the |spellsuggest()| function. This is a comma-separated list of
7249 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007250
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007251 best Internal method that works best for English. Finds
7252 changes like "fast" and uses a bit of sound-a-like
7253 scoring to improve the ordering.
7254
7255 double Internal method that uses two methods and mixes the
7256 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007257 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007258 word. That only works when the language specifies
7259 sound folding. Can be slow and doesn't always give
7260 better results.
7261
7262 fast Internal method that only checks for simple changes:
7263 character inserts/deletes/swaps. Works well for
7264 simple typing mistakes.
7265
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007266 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007267 Not used for |spellsuggest()|. The number of
7268 suggestions is never more than the value of 'lines'
7269 minus two.
7270
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007271 file:{filename} Read file {filename}, which must have two columns,
7272 separated by a slash. The first column contains the
7273 bad word, the second column the suggested good word.
7274 Example:
7275 theribal/terrible ~
7276 Use this for common mistakes that do not appear at the
7277 top of the suggestion list with the internal methods.
7278 Lines without a slash are ignored, use this for
7279 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007280 The word in the second column must be correct,
7281 otherwise it will not be used. Add the word to an
7282 ".add" file if it is currently flagged as a spelling
7283 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007284 The file is used for all languages.
7285
7286 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7287 trouble with spaces. |v:val| holds the badly spelled
7288 word. The expression must evaluate to a List of
7289 Lists, each with a suggestion and a score.
7290 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007291 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007292 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007293 internal methods use. A lower score is better.
7294 This may invoke |spellsuggest()| if you temporarily
7295 set 'spellsuggest' to exclude the "expr:" part.
7296 Errors are silently ignored, unless you set the
7297 'verbose' option to a non-zero value.
7298
7299 Only one of "best", "double" or "fast" may be used. The others may
7300 appear several times in any order. Example: >
7301 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7302<
7303 This option cannot be set from a |modeline| or in the |sandbox|, for
7304 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007305
7306
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7308'splitbelow' 'sb' boolean (default off)
7309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 When on, splitting a window will put the new window below the current
7311 one. |:split|
7312
7313 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7314'splitright' 'spr' boolean (default off)
7315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 When on, splitting a window will put the new window right of the
7317 current one. |:vsplit|
7318
7319 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7320'startofline' 'sol' boolean (default on)
7321 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007323 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007324 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007325 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 with a linewise operator, with "%" with a count and to buffer changing
7327 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7328 only has a line number, e.g., ":25" or ":+".
7329 In case of buffer changing commands the cursor is placed at the column
7330 where it was the last time the buffer was edited.
7331 NOTE: This option is set when 'compatible' is set.
7332
Bram Moolenaar00654022011-02-25 14:42:19 +01007333 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007335 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 {not available when compiled without the |+statusline|
7337 feature}
7338 When nonempty, this option determines the content of the status line.
7339 Also see |status-line|.
7340
7341 The option consists of printf style '%' items interspersed with
7342 normal text. Each status line item is of the form:
7343 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007344 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar8133cc62020-10-26 21:05:27 +01007345 be given as "%%".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346
Bram Moolenaar238a5642006-02-21 22:12:05 +00007347 When the option starts with "%!" then it is used as an expression,
7348 evaluated and the result is used as the option value. Example: >
7349 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007350< The *g:statusline_winid* variable will be set to the |window-ID| of the
7351 window that the status line belongs to.
7352 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007353 Note that the "%!" expression is evaluated in the context of the
7354 current window and buffer, while %{} items are evaluated in the
7355 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007356
7357 When there is error while evaluating the option then it will be made
7358 empty to avoid further errors. Otherwise screen updating would loop.
7359
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 Note that the only effect of 'ruler' when this option is set (and
7361 'laststatus' is 2) is controlling the output of |CTRL-G|.
7362
7363 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007364 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007366 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367 minwid Minimum width of the item, padding as set by '-' & '0'.
7368 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007369 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 on the left for text items. Numeric items will be
7371 shifted down to maxwid-2 digits followed by '>'number
7372 where number is the amount of missing digits, much like
7373 an exponential notation.
7374 item A one letter code as described below.
7375
7376 Following is a description of the possible statusline items. The
7377 second character in "item" is the type:
7378 N for number
7379 S for string
7380 F for flags as described below
7381 - not applicable
7382
7383 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007384 f S Path to the file in the buffer, as typed or relative to current
7385 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 F S Full path to the file in the buffer.
7387 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007388 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007390 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007392 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007394 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007396 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007398 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7400 being used: "<keymap>"
7401 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007402 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 B N As above, in hexadecimal.
7404 o N Byte number in file of byte under cursor, first byte is 1.
7405 Mnemonic: Offset from start of file (with one added)
7406 {not available when compiled without |+byte_offset| feature}
7407 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007408 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 l N Line number.
7410 L N Number of lines in buffer.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02007411 c N Column number (byte index).
7412 v N Virtual column number (screen column).
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007413 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 p N Percentage through file in lines as in |CTRL-G|.
7415 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007416 percentage described for 'ruler'. Always 3 in length, unless
7417 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007418 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007420 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007421 Note that there is no '%' before the closing '}'. The
7422 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007423 work around that. See |stl-%{| below.
shadmansaleh30e3de22021-05-15 17:23:28 +02007424 {% - This is almost same as { except the result of the expression is
7425 re-evaluated as a statusline format string. Thus if the
7426 return value of expr contains % items they will get expanded.
7427 The expression can contain the } character, the end of
7428 expression is denoted by %}.
Bram Moolenaar22863042021-10-16 15:23:36 +01007429 For example: >
shadmansaleh30e3de22021-05-15 17:23:28 +02007430 func! Stl_filename() abort
7431 return "%t"
7432 endfunc
7433< `stl=%{Stl_filename()}` results in `"%t"`
7434 `stl=%{%Stl_filename()%}` results in `"Name of current file"`
Bram Moolenaar22863042021-10-16 15:23:36 +01007435 %} - End of `{%` expression
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 ( - Start of item group. Can be used for setting the width and
7437 alignment of a section. Must be followed by %) somewhere.
7438 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007439 T N For 'tabline': start of tab page N label. Use %T after the last
7440 label. This information is used for mouse clicks.
7441 X N For 'tabline': start of close tab N label. Use %X after the
7442 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7443 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 < - Where to truncate line if too long. Default is at the start.
7445 No width fields allowed.
7446 = - Separation point between left and right aligned items.
7447 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007448 # - Set highlight group. The name must follow and then a # again.
7449 Thus use %#HLname# for highlight group HLname. The same
7450 highlighting is used, also for the statusline of non-current
7451 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007453 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 The difference between User{N} and StatusLine will be applied
7455 to StatusLineNC for the statusline of non-current windows.
7456 The number N must be between 1 and 9. See |hl-User1..9|
7457
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007458 When displaying a flag, Vim removes the leading comma, if any, when
7459 that flag comes right after plaintext. This will make a nice display
7460 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461
Bram Moolenaar582fd852005-03-28 20:58:01 +00007462 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463 not set) and a minwid is not set for the group, the whole group will
7464 become empty. This will make a group like the following disappear
7465 completely from the statusline when none of the flags are set. >
7466 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007467< Beware that an expression is evaluated each and every time the status
7468 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007469 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007470 While evaluating %{} the current buffer and current window will be set
7471 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007472 currently being drawn. The expression will evaluate in this context.
7473 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7474 real current buffer and "g:actual_curwin" to the |window-ID| of the
7475 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007476
Bram Moolenaar30b65812012-07-12 22:01:11 +02007477 The 'statusline' option will be evaluated in the |sandbox| if set from
7478 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007479 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007480
7481 It is not allowed to change text or jump to another window while
7482 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483
7484 If the statusline is not updated when you want it (e.g., after setting
7485 a variable that's used in an expression), you can force an update by
7486 setting an option without changing its value. Example: >
7487 :let &ro = &ro
7488
7489< A result of all digits is regarded a number for display purposes.
7490 Otherwise the result is taken as flag text and applied to the rules
7491 described above.
7492
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007493 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007495 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496
7497 Examples:
7498 Emulate standard status line with 'ruler' set >
7499 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7500< Similar, but add ASCII value of char under the cursor (like "ga") >
7501 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7502< Display byte count and byte value, modified flag in red. >
7503 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7504 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7505< Display a ,GZ flag if a compressed file is loaded >
7506 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7507< In the |:autocmd|'s: >
7508 :let b:gzflag = 1
7509< And: >
7510 :unlet b:gzflag
7511< And define this function: >
7512 :function VarExists(var, val)
7513 : if exists(a:var) | return a:val | else | return '' | endif
7514 :endfunction
7515<
7516 *'suffixes'* *'su'*
7517'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7518 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 Files with these suffixes get a lower priority when multiple files
7520 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007521 suffixes. Spaces after the comma are ignored. A dot is also seen as
7522 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 separator, precede it with a backslash (see |option-backslash| about
7524 including spaces and backslashes).
7525 See 'wildignore' for completely ignoring files.
7526 The use of |:set+=| and |:set-=| is preferred when adding or removing
7527 suffixes from the list. This avoids problems when a future version
7528 uses another default.
7529
7530 *'suffixesadd'* *'sua'*
7531'suffixesadd' 'sua' string (default "")
7532 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 {not available when compiled without the
7534 |+file_in_path| feature}
7535 Comma separated list of suffixes, which are used when searching for a
7536 file for the "gf", "[I", etc. commands. Example: >
7537 :set suffixesadd=.java
7538<
7539 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7540'swapfile' 'swf' boolean (default on)
7541 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007542 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 swapfile is not wanted for a specific buffer. For example, with
7544 confidential information that even root must not be able to access.
7545 Careful: All text will be in memory:
7546 - Don't use this for big files.
7547 - Recovery will be impossible!
7548 A swapfile will only be present when |'updatecount'| is non-zero and
7549 'swapfile' is set.
7550 When 'swapfile' is reset, the swap file for the current buffer is
7551 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7552 non-zero, a swap file is immediately created.
7553 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007554 If you want to open a new buffer without creating a swap file for it,
7555 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007556 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557
7558 This option is used together with 'bufhidden' and 'buftype' to
7559 specify special kinds of buffers. See |special-buffers|.
7560
7561 *'swapsync'* *'sws'*
7562'swapsync' 'sws' string (default "fsync")
7563 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007565 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 When this option is empty parts of the swap file may be in memory and
7567 not written to disk. When the system crashes you may lose more work.
7568 On Unix the system does a sync now and then without Vim asking for it,
7569 so the disadvantage of setting this option off is small. On some
7570 systems the swap file will not be written at all. For a unix system
7571 setting it to "sync" will use the sync() call instead of the default
7572 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007573 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574
7575 *'switchbuf'* *'swb'*
7576'switchbuf' 'swb' string (default "")
7577 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 This option controls the behavior when switching between buffers.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02007579 Mostly for |quickfix| commands some values are also used for other
7580 commands, as mentioned below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 Possible values (comma separated list):
7582 useopen If included, jump to the first open window that
7583 contains the specified buffer (if there is one).
7584 Otherwise: Do not examine other windows.
7585 This setting is checked with |quickfix| commands, when
7586 jumping to errors (":cc", ":cn", "cp", etc.). It is
7587 also used in all buffer related split commands, for
7588 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007589 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007590 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007592 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007593 Otherwise: do not split, use current window (when used
7594 in the quickfix window: the previously used window or
7595 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007596 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007597 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007598 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007599 uselast If included, jump to the previously used window when
7600 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007602 *'synmaxcol'* *'smc'*
7603'synmaxcol' 'smc' number (default 3000)
7604 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007605 {not available when compiled without the |+syntax|
7606 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007607 Maximum column in which to search for syntax items. In long lines the
7608 text after this column is not highlighted and following lines may not
7609 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007610 This helps to avoid very slow redrawing for an XML file that is one
7611 long line.
7612 Set to zero to remove the limit.
7613
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 *'syntax'* *'syn'*
7615'syntax' 'syn' string (default empty)
7616 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 {not available when compiled without the |+syntax|
7618 feature}
7619 When this option is set, the syntax with this name is loaded, unless
7620 syntax highlighting has been switched off with ":syntax off".
7621 Otherwise this option does not always reflect the current syntax (the
7622 b:current_syntax variable does).
7623 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007624 not automatically recognized. Example, in an IDL file:
7625 /* vim: set syntax=idl : */ ~
7626 When a dot appears in the value then this separates two filetype
7627 names. Example:
7628 /* vim: set syntax=c.doxygen : */ ~
7629 This will use the "c" syntax first, then the "doxygen" syntax.
7630 Note that the second one must be prepared to be loaded as an addition,
7631 otherwise it will be skipped. More than one dot may appear.
7632 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 :set syntax=OFF
7634< To switch syntax highlighting on according to the current value of the
7635 'filetype' option: >
7636 :set syntax=ON
7637< What actually happens when setting the 'syntax' option is that the
7638 Syntax autocommand event is triggered with the value as argument.
7639 This option is not copied to another buffer, independent of the 's' or
7640 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007641 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007643 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007644'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007645 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007646 When nonempty, this option determines the content of the tab pages
7647 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007648 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007649
7650 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007651 option and only when there is no GUI tab line. When 'e' is in
7652 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007653 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007654
7655 The value is evaluated like with 'statusline'. You can use
7656 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007657 the text to be displayed. Use "%1T" for the first label, "%2T" for
7658 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007659
Bram Moolenaare12bab32019-01-08 22:02:56 +01007660 When changing something that is used in 'tabline' that does not
7661 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007662 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007663
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007664 Keep in mind that only one of the tab pages is the current one, others
7665 are invisible and you can't jump to their windows.
7666
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007667
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007668 *'tabpagemax'* *'tpm'*
7669'tabpagemax' 'tpm' number (default 10)
7670 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007671 Maximum number of tab pages to be opened by the |-p| command line
7672 argument or the ":tab all" command. |tabpage|
7673
7674
7675 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676'tabstop' 'ts' number (default 8)
7677 local to buffer
7678 Number of spaces that a <Tab> in the file counts for. Also see
7679 |:retab| command, and 'softtabstop' option.
7680
7681 Note: Setting 'tabstop' to any other value than 8 can make your file
7682 appear wrong in many places (e.g., when printing it).
7683
7684 There are four main ways to use tabs in Vim:
7685 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7686 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007687 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 behave like a tab appears every 4 (or 3) characters.
7689 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7690 'expandtab'. This way you will always insert spaces. The
7691 formatting will never be messed up when 'tabstop' is changed.
7692 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007693 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 works when using Vim to edit the file.
7695 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7696 'noexpandtab'. This should then work (for initial indents only)
7697 for any tabstop setting that people use. It might be nice to have
7698 tabs after the first non-blank inserted as spaces if you do this
7699 though. Otherwise aligned comments will be wrong when 'tabstop' is
7700 changed.
7701
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007702 If Vim is compiled with the |+vartabs| feature then the value of
7703 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7704 than an empty string.
7705
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7707'tagbsearch' 'tbs' boolean (default on)
7708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007710 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 searching makes searching for a tag a LOT faster, but a linear search
7712 will find more tags if the tags file wasn't properly sorted.
7713 Vim normally assumes that your tags files are sorted, or indicate that
7714 they are not sorted. Only when this is not the case does the
7715 'tagbsearch' option need to be switched off.
7716
7717 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007718 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 certain files, or retry all files with a linear search. When
7720 'tagbsearch' is off, only a linear search is done.
7721
7722 Linear searching is done anyway, for one file, when Vim finds a line
7723 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007724 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725< [The whitespace before and after the '0' must be a single <Tab>]
7726
7727 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007728 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 instead of a normal tag name, a retry is done with a linear search.
7730 Tags in unsorted tags files, and matches with different case will only
7731 be found in the retry.
7732
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007733 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007734 linear search can be avoided when case is ignored. Use a value of '2'
7735 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7736 sorted with the -f switch to "sort" in most unices, as in the command:
7737 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7738 (at least 5.5) the --sort=foldcase switch can be used for this as
7739 well. Note that case must be folded to uppercase for this to work.
7740
7741 By default, tag searches are case-sensitive. Case is ignored when
7742 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7743 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007744 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7745 'tagcase' is "smart", and the pattern contains only lowercase
7746 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747
7748 When 'tagbsearch' is off, tags searching is slower when a full match
7749 exists, but faster when no full match exists. Tags in unsorted tags
7750 files may only be found with 'tagbsearch' off.
7751 When the tags file is not sorted, or sorted in a wrong way (not on
7752 ASCII byte value), 'tagbsearch' should be off, or the line given above
7753 must be included in the tags file.
7754 This option doesn't affect commands that find all matching tags (e.g.,
7755 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007757 *'tagcase'* *'tc'*
7758'tagcase' 'tc' string (default "followic")
7759 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007760 This option specifies how case is handled when searching the tags
7761 file:
7762 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007763 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007764 ignore Ignore case
7765 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007766 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007767 NOTE: This option is set to the Vi default value when 'compatible' is
7768 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007769
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007770 *'tagfunc'* *'tfu'*
7771'tagfunc' 'tfu' string (default: empty)
7772 local to buffer
7773 {not available when compiled without the |+eval|
7774 feature}
7775 This option specifies a function to be used to perform tag searches.
7776 The function gets the tag pattern and should return a List of matching
7777 tags. See |tag-function| for an explanation of how to write the
7778 function and an example.
7779
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 *'taglength'* *'tl'*
7781'taglength' 'tl' number (default 0)
7782 global
7783 If non-zero, tags are significant up to this number of characters.
7784
7785 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7786'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7787 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007788 If on and using a tags file in another directory, file names in that
7789 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 NOTE: This option is set to the Vi default value when 'compatible' is
7791 set and to the Vim default value when 'compatible' is reset.
7792
7793 *'tags'* *'tag'* *E433*
7794'tags' 'tag' string (default "./tags,tags", when compiled with
7795 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7796 global or local to buffer |global-local|
7797 Filenames for the tag command, separated by spaces or commas. To
7798 include a space or comma in a file name, precede it with a backslash
7799 (see |option-backslash| about including spaces and backslashes).
7800 When a file name starts with "./", the '.' is replaced with the path
7801 of the current file. But only when the 'd' flag is not included in
7802 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7803 |tags-option|.
7804 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007805 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7806 find all files named "tags" below "/lib". The filename itself cannot
7807 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7808 files called "tags?". {not available when compiled without the
7809 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007810 The |tagfiles()| function can be used to get a list of the file names
7811 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7813 files are also supported. They are automatically recognized. The
7814 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7815 differences are ignored (MS-Windows). |emacs-tags|
7816 The use of |:set+=| and |:set-=| is preferred when adding or removing
7817 file names from the list. This avoids problems when a future version
7818 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819
7820 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7821'tagstack' 'tgst' boolean (default on)
7822 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 When on, the |tagstack| is used normally. When off, a ":tag" or
7824 ":tselect" command with an argument will not push the tag onto the
7825 tagstack. A following ":tag" without an argument, a ":pop" command or
7826 any other command that uses the tagstack will use the unmodified
7827 tagstack, but does change the pointer to the active entry.
7828 Resetting this option is useful when using a ":tag" command in a
7829 mapping which should not change the tagstack.
7830
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007831 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007832'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007833 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007834 {only available when compiled with the |+tcl/dyn|
7835 feature}
7836 Specifies the name of the Tcl shared library. The default is
7837 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007838 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007839 This option cannot be set from a |modeline| or in the |sandbox|, for
7840 security reasons.
7841
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842 *'term'* *E529* *E530* *E531*
7843'term' string (default is $TERM, if that fails:
7844 in the GUI: "builtin_gui"
7845 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007846 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 on Mac: "mac-ansi"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 on Unix: "ansi"
7849 on VMS: "ansi"
7850 on Win 32: "win32")
7851 global
7852 Name of the terminal. Used for choosing the terminal control
7853 characters. Environment variables are expanded |:set_env|.
7854 For example: >
7855 :set term=$TERM
7856< See |termcap|.
7857
7858 *'termbidi'* *'tbidi'*
7859 *'notermbidi'* *'notbidi'*
7860'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 {only available when compiled with the |+arabic|
7863 feature}
7864 The terminal is in charge of Bi-directionality of text (as specified
7865 by Unicode). The terminal is also expected to do the required shaping
7866 that some languages (such as Arabic) require.
7867 Setting this option implies that 'rightleft' will not be set when
7868 'arabic' is set and the value of 'arabicshape' will be ignored.
7869 Note that setting 'termbidi' has the immediate effect that
7870 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7871 This option is reset when the GUI is started.
7872 For further details see |arabic.txt|.
7873
7874 *'termencoding'* *'tenc'*
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007875'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8")
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 Encoding used for the terminal. This specifies what character
7878 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007879 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02007880 display).
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007881 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007882 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7884 Any attempts to set a different value will be rejected, and an error
7885 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007886 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 because the Win32 system always passes Unicode characters.
7888 When empty, the same encoding is used as for the 'encoding' option.
7889 This is the normal value.
7890 Not all combinations for 'termencoding' and 'encoding' are valid. See
7891 |encoding-table|.
7892 The value for this option must be supported by internal conversions or
7893 iconv(). When this is not possible no conversion will be done and you
7894 will probably experience problems with non-ASCII characters.
7895 Example: You are working with the locale set to euc-jp (Japanese) and
7896 want to edit a UTF-8 file: >
7897 :let &termencoding = &encoding
7898 :set encoding=utf-8
7899< You need to do this when your system has no locale support for UTF-8.
7900
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007901 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007902'termguicolors' 'tgc' boolean (default off)
7903 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007904 {not available when compiled without the
7905 |+termguicolors| feature}
7906 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007907 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007908
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007909 Requires a ISO-8613-3 compatible terminal. If setting this option
7910 does not work (produces a colorless UI) reading |xterm-true-color|
7911 might help.
7912
7913 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7914 is required. Use this check to find out: >
7915 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007916< This requires Vim to be built with the |+vtp| feature.
7917
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007918 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007919 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007920
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007921 *'termwinkey'* *'twk'*
7922'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007923 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007924 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007925 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007926 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007927 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007928< The string must be one key stroke but can be multiple bytes.
7929 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007930 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007931 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007932
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007933 *'termwinscroll'* *'twsl'*
7934'termwinscroll' 'twsl' number (default 10000)
7935 local to buffer
7936 {not available when compiled without the
7937 |+terminal| feature}
7938 Number of scrollback lines to keep. When going over this limit the
7939 first 10% of the scrollback lines are deleted. This is just to reduce
7940 the memory usage. See |Terminal-Normal|.
7941
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007942 *'termwinsize'* *'tws'*
7943'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007944 local to window
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007945 Size used when opening the |terminal| window. Format:
7946 {rows}x{columns} or {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007947 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007948 - When set with a "x" (e.g., "24x80") the terminal size is not
7949 adjusted to the window size. If the window is smaller only the
7950 top-left part is displayed.
7951 - When set with a "*" (e.g., "10*50") the terminal size follows the
7952 window size, but will not be smaller than the specified rows and/or
7953 columns.
7954 - When rows is zero then use the height of the window.
7955 - When columns is zero then use the width of the window.
7956 - Using "0x0" or "0*0" is the same as empty.
Bram Moolenaar1c6737b2020-09-07 22:18:52 +02007957 - Can be overruled in the |term_start()| options with "term_rows" and
7958 "term_cols".
Bram Moolenaar498c2562018-04-15 23:45:15 +02007959
7960 Examples:
7961 "30x0" uses 30 rows and the current window width.
7962 "20*0" uses at least 20 rows and the current window width.
7963 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007964 Note that the command running in the terminal window may still change
7965 the size of the terminal. In that case the Vim window will be
7966 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007967
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007968 *'termwintype'* *'twt'*
7969'termwintype' 'twt' string (default "")
7970 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007971 {only available when compiled with the |terminal|
7972 feature on MS-Windows}
7973 Specify the virtual console (pty) used when opening the terminal
7974 window.
7975
7976 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007977 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007978 "winpty" use winpty, fail if not supported
7979 "conpty" use |ConPTY|, fail if not supported
7980
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007981 |ConPTY| support depends on the platform. Windows 10 October 2018
7982 Update is the first version that supports ConPTY, however it is still
7983 considered unstable. ConPTY might become stable in the next release
7984 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007985 supported then you cannot open a terminal window.
7986
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 *'terse'* *'noterse'*
7988'terse' boolean (default off)
7989 global
7990 When set: Add 's' flag to 'shortmess' option (this makes the message
7991 for a search that hits the start or end of the file not being
7992 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7993 shortens a lot of messages}
7994
7995 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7996'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7997 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 This option is obsolete. Use 'fileformats'.
7999 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8000 set to the default value for the current system. When 'textauto' is
8001 reset, 'fileformats' is made empty.
8002 NOTE: This option is set to the Vi default value when 'compatible' is
8003 set and to the Vim default value when 'compatible' is reset.
8004
8005 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008006'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 others: default off)
8008 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 This option is obsolete. Use 'fileformat'.
8010 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8011 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8012 "unix".
8013
8014 *'textwidth'* *'tw'*
8015'textwidth' 'tw' number (default 0)
8016 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 Maximum width of text that is being inserted. A longer line will be
8018 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008019 this.
8020 'textwidth' is set to 0 when the 'paste' option is set and restored
8021 when 'paste' is reset.
8022 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008024 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 NOTE: This option is set to 0 when 'compatible' is set.
8026
8027 *'thesaurus'* *'tsr'*
8028'thesaurus' 'tsr' string (default "")
8029 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008030 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008031 for thesaurus completion commands |i_CTRL-X_CTRL-T|. See
8032 |compl-thesaurus|.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008033
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008034 This option is not used if 'thesaurusfunc' is set, either for the
8035 buffer or globally.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008036
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008037 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 after a comma are ignored, otherwise spaces are included in the file
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008039 name. See |option-backslash| about using backslashes. The use of
8040 |:set+=| and |:set-=| is preferred when adding or removing directories
8041 from the list. This avoids problems when a future version uses
8042 another default. Backticks cannot be used in this option for security
8043 reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008045 *'thesaurusfunc'* *tsrfu'*
8046'thesaurusfunc' 'tsrfu' string (default: empty)
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008047 global or local to buffer |global-local|
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008048 {not available when compiled without the |+eval|
8049 feature}
8050 This option specifies a function to be used for thesaurus completion
Bram Moolenaarf4d8b762021-10-17 14:13:09 +01008051 with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
8052
Yegappan Lakshmanan160e9942021-10-16 15:41:29 +01008053 This option cannot be set from a |modeline| or in the |sandbox|, for
8054 security reasons.
8055
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8057'tildeop' 'top' boolean (default off)
8058 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059 When on: The tilde command "~" behaves like an operator.
8060 NOTE: This option is reset when 'compatible' is set.
8061
8062 *'timeout'* *'to'* *'notimeout'* *'noto'*
8063'timeout' 'to' boolean (default on)
8064 global
8065 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008066'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 These two options together determine the behavior when part of a
8069 mapped key sequence or keyboard code has been received:
8070
8071 'timeout' 'ttimeout' action ~
8072 off off do not time out
8073 on on or off time out on :mappings and key codes
8074 off on time out on key codes
8075
8076 If both options are off, Vim will wait until either the complete
8077 mapping or key sequence has been received, or it is clear that there
8078 is no mapping or key sequence for the received characters. For
8079 example: if you have mapped "vl" and Vim has received 'v', the next
8080 character is needed to see if the 'v' is followed by an 'l'.
8081 When one of the options is on, Vim will wait for about 1 second for
8082 the next character to arrive. After that the already received
8083 characters are interpreted as single characters. The waiting time can
8084 be changed with the 'timeoutlen' option.
8085 On slow terminals or very busy systems timing out may cause
8086 malfunctioning cursor keys. If both options are off, Vim waits
8087 forever after an entered <Esc> if there are key codes that start
8088 with <Esc>. You will have to type <Esc> twice. If you do not have
8089 problems with key codes, but would like to have :mapped key
8090 sequences not timing out in 1 second, set the 'ttimeout' option and
8091 reset the 'timeout' option.
8092
8093 NOTE: 'ttimeout' is reset when 'compatible' is set.
8094
8095 *'timeoutlen'* *'tm'*
8096'timeoutlen' 'tm' number (default 1000)
8097 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008098
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008100'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102 The time in milliseconds that is waited for a key code or mapped key
8103 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8104 when part of a command has been typed.
8105 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8106 different timeout value for key codes is desired set 'ttimeoutlen' to
8107 a non-negative number.
8108
8109 ttimeoutlen mapping delay key code delay ~
8110 < 0 'timeoutlen' 'timeoutlen'
8111 >= 0 'timeoutlen' 'ttimeoutlen'
8112
8113 The timeout only happens when the 'timeout' and 'ttimeout' options
8114 tell so. A useful setting would be >
8115 :set timeout timeoutlen=3000 ttimeoutlen=100
8116< (time out on mapping after three seconds, time out on key codes after
8117 a tenth of a second).
8118
8119 *'title'* *'notitle'*
8120'title' boolean (default off, on when title can be restored)
8121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008122 {not available when compiled without the |+title|
8123 feature}
8124 When on, the title of the window will be set to the value of
8125 'titlestring' (if it is not empty), or to:
8126 filename [+=-] (path) - VIM
8127 Where:
8128 filename the name of the file being edited
8129 - indicates the file cannot be modified, 'ma' off
8130 + indicates the file was modified
8131 = indicates the file is read-only
8132 =+ indicates the file is read-only and modified
8133 (path) is the path of the file being edited
8134 - VIM the server name |v:servername| or "VIM"
8135 Only works if the terminal supports setting window titles
8136 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02008137 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8139 *X11*
8140 When Vim was compiled with HAVE_X11 defined, the original title will
8141 be restored if possible. The output of ":version" will include "+X11"
8142 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8143 works for the icon name |'icon'|.
8144 But: When Vim was started with the |-X| argument, restoring the title
8145 will not work (except in the GUI).
8146 If the title cannot be restored, it is set to the value of 'titleold'.
8147 You might want to restore the title outside of Vim then.
8148 When using an xterm from a remote machine you can use this command:
8149 rsh machine_name xterm -display $DISPLAY &
8150 then the WINDOWID environment variable should be inherited and the
8151 title of the window should change back to what it should be after
8152 exiting Vim.
8153
8154 *'titlelen'*
8155'titlelen' number (default 85)
8156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 {not available when compiled without the |+title|
8158 feature}
8159 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008160 title. When the title is longer, only the end of the path name is
8161 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 Using a percentage makes this adapt to the width of the window. But
8163 it won't work perfectly, because the actual number of characters
8164 available also depends on the font used and other things in the title
8165 bar. When 'titlelen' is zero the full path is used. Otherwise,
8166 values from 1 to 30000 percent can be used.
8167 'titlelen' is also used for the 'titlestring' option.
8168
8169 *'titleold'*
8170'titleold' string (default "Thanks for flying Vim")
8171 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 {only available when compiled with the |+title|
8173 feature}
8174 This option will be used for the window title when exiting Vim if the
8175 original title cannot be restored. Only happens if 'title' is on or
8176 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008177 This option cannot be set from a |modeline| or in the |sandbox|, for
8178 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 *'titlestring'*
8180'titlestring' string (default "")
8181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 {not available when compiled without the |+title|
8183 feature}
8184 When this option is not empty, it will be used for the title of the
8185 window. This happens only when the 'title' option is on.
8186 Only works if the terminal supports setting window titles (currently
8187 Amiga console, Win32 console, all GUI versions and terminals with a
8188 non-empty 't_ts' option).
8189 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008190 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008191
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192 When this option contains printf-style '%' items, they will be
8193 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008194 This option cannot be set in a modeline when 'modelineexpr' is off.
8195
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 Example: >
8197 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8198 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8199< The value of 'titlelen' is used to align items in the middle or right
8200 of the available space.
8201 Some people prefer to have the file name first: >
8202 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8203< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008204 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205 separating space only when needed.
8206 NOTE: Use of special characters in 'titlestring' may cause the display
8207 to be garbled (e.g., when it contains a CR or NL character).
8208 {not available when compiled without the |+statusline| feature}
8209
8210 *'toolbar'* *'tb'*
8211'toolbar' 'tb' string (default "icons,tooltips")
8212 global
8213 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8214 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008215 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 possible values are:
8217 icons Toolbar buttons are shown with icons.
8218 text Toolbar buttons shown with text.
8219 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008220 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 tooltips Tooltips are active for toolbar buttons.
8222 Tooltips refer to the popup help text which appears after the mouse
8223 cursor is placed over a toolbar button for a brief moment.
8224
8225 If you want the toolbar to be shown with icons as well as text, do the
8226 following: >
8227 :set tb=icons,text
8228< Motif and Athena cannot display icons and text at the same time. They
8229 will show icons if both are requested.
8230
8231 If none of the strings specified in 'toolbar' are valid or if
8232 'toolbar' is empty, this option is ignored. If you want to disable
8233 the toolbar, you need to set the 'guioptions' option. For example: >
8234 :set guioptions-=T
8235< Also see |gui-toolbar|.
8236
8237 *'toolbariconsize'* *'tbis'*
8238'toolbariconsize' 'tbis' string (default "small")
8239 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008240 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008242 tiny Use tiny icons.
8243 small Use small icons (default).
8244 medium Use medium-sized icons.
8245 large Use large icons.
8246 huge Use even larger icons.
8247 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008249 the current theme. Common dimensions are giant=48x48, huge=32x32,
8250 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251
8252 If 'toolbariconsize' is empty, the global default size as determined
8253 by user preferences or the current theme is used.
8254
8255 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8256'ttybuiltin' 'tbi' boolean (default on)
8257 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 When on, the builtin termcaps are searched before the external ones.
8259 When off the builtin termcaps are searched after the external ones.
8260 When this option is changed, you should set the 'term' option next for
8261 the change to take effect, for example: >
8262 :set notbi term=$TERM
8263< See also |termcap|.
8264 Rationale: The default for this option is "on", because the builtin
8265 termcap entries are generally better (many systems contain faulty
8266 xterm entries...).
8267
8268 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8269'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8270 sun-cmd, screen, rxvt, dtterm or
8271 iris-ansi; also on when running Vim in
8272 a DOS console)
8273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 Indicates a fast terminal connection. More characters will be sent to
8275 the screen for redrawing, instead of using insert/delete line
8276 commands. Improves smoothness of redrawing when there are multiple
8277 windows and the terminal does not support a scrolling region.
8278 Also enables the extra writing of characters at the end of each screen
8279 line for lines that wrap. This helps when using copy/paste with the
8280 mouse in an xterm and other terminals.
8281
8282 *'ttymouse'* *'ttym'*
8283'ttymouse' 'ttym' string (default depends on 'term')
8284 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285 {only in Unix and VMS, doesn't work in the GUI; not
8286 available when compiled without |+mouse|}
8287 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008288 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 *xterm-mouse*
8290 xterm xterm-like mouse handling. The mouse generates
8291 "<Esc>[Mscr", where "scr" is three bytes:
8292 "s" = button state
8293 "c" = column plus 33
8294 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008295 This only works up to 223 columns! See "dec",
8296 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 xterm2 Works like "xterm", but with the xterm reporting the
8298 mouse position while the mouse is dragged. This works
8299 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008300 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301 work. See below for how Vim detects this
8302 automatically.
8303 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008304 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008306 for the row and column. No other mouse events are
8307 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 *dec-mouse*
8309 dec DEC terminal mouse handling. The mouse generates a
8310 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008311 This is also available for an Xterm, if it was
8312 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 *jsbterm-mouse*
8314 jsbterm JSB term mouse handling.
8315 *pterm-mouse*
8316 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008317 *urxvt-mouse*
8318 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008319 The mouse works only if the terminal supports this
8320 encoding style, but it does not have 223 columns limit
8321 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008322 *sgr-mouse*
8323 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008324 mouse reporting. The mouse works even in columns
8325 beyond 223. This option is backward compatible with
8326 "xterm2" because it can also decode "xterm2" style
8327 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008328
8329 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008330 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8331 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8333 recognized, if enabled at compile time. DEC terminal mouse codes
8334 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008335 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8336 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008338 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8339 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8340 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008341 Additionally, if vim is compiled with the |+termresponse| feature and
8342 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008343 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008345 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8346 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8347 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008348 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8349 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 :set t_RV=
8351<
8352 *'ttyscroll'* *'tsl'*
8353'ttyscroll' 'tsl' number (default 999)
8354 global
8355 Maximum number of lines to scroll the screen. If there are more lines
8356 to scroll the window is redrawn. For terminals where scrolling is
8357 very slow and redrawing is not slow this can be set to a small number,
8358 e.g., 3, to speed up displaying.
8359
8360 *'ttytype'* *'tty'*
8361'ttytype' 'tty' string (default from $TERM)
8362 global
8363 Alias for 'term', see above.
8364
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008365 *'undodir'* *'udir'*
8366'undodir' 'udir' string (default ".")
8367 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008368 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008369 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008370 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008371 "." means using the directory of the file. The undo file name for
8372 "file.txt" is ".file.txt.un~".
8373 For other directories the file name is the full path of the edited
8374 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008375 When writing: The first directory that exists is used. "." always
8376 works, no directories after "." will be used for writing.
8377 When reading all entries are tried to find an undo file. The first
8378 undo file that exists is used. When it cannot be read an error is
8379 given, no further entry is used.
8380 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008381 This option cannot be set from a |modeline| or in the |sandbox|, for
8382 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008383
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008384 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008385'undofile' 'udf' boolean (default off)
8386 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008387 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008388 When on, Vim automatically saves undo history to an undo file when
8389 writing a buffer to a file, and restores undo history from the same
8390 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008391 The directory where the undo file is stored is specified by 'undodir'.
8392 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008393 The undo file is not read when 'undoreload' causes the buffer from
8394 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008395 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008396 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008397
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008399'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008400 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008402 is kept in memory, higher numbers will cause more memory to be used.
8403 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8405 itself: >
8406 set ul=0
8407< But you can also get Vi compatibility by including the 'u' flag in
8408 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008409 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008410 Set to -1 for no undo at all. You might want to do this only for the
8411 current buffer: >
8412 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008414
8415 The local value is set to -123456 when the global value is to be used.
8416
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008417 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008419 *'undoreload'* *'ur'*
8420'undoreload' 'ur' number (default 10000)
8421 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008422 Save the whole buffer for undo when reloading it. This applies to the
8423 ":e!" command and reloading for when the buffer changed outside of
8424 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008425 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008426 of lines is smaller than the value of this option.
8427 Set this option to zero to disable undo for a reload.
8428
8429 When saving undo for a reload, any undo file is not read.
8430
8431 Note that this causes the whole buffer to be stored in memory. Set
8432 this option to a lower value if you run out of memory.
8433
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 *'updatecount'* *'uc'*
8435'updatecount' 'uc' number (default: 200)
8436 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 After typing this many characters the swap file will be written to
8438 disk. When zero, no swap file will be created at all (see chapter on
8439 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8440 Vim with the "-n" option, see |startup|. When editing in readonly
8441 mode this option will be initialized to 10000.
8442 The swapfile can be disabled per buffer with |'swapfile'|.
8443 When 'updatecount' is set from zero to non-zero, swap files are
8444 created for all buffers that have 'swapfile' set. When 'updatecount'
8445 is set to zero, existing swap files are not deleted.
8446 Also see |'swapsync'|.
8447 This option has no meaning in buffers where |'buftype'| is "nofile"
8448 or "nowrite".
8449
8450 *'updatetime'* *'ut'*
8451'updatetime' 'ut' number (default 4000)
8452 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 If this many milliseconds nothing is typed the swap file will be
8454 written to disk (see |crash-recovery|). Also used for the
8455 |CursorHold| autocommand event.
8456
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008457 *'varsofttabstop'* *'vsts'*
8458'varsofttabstop' 'vsts' string (default "")
8459 local to buffer
8460 {only available when compiled with the |+vartabs|
8461 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008462 A list of the number of spaces that a <Tab> counts for while editing,
8463 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8464 width <Tab>s are being inserted, while in fact a mixture of spaces
8465 and <Tab>s is used. Tab widths are separated with commas, with the
8466 final value applying to all subsequent tabs.
8467
8468 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008469 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008470 to use the following: >
8471 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008472< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8473 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008474
8475 Note that the value of |'softtabstop'| will be ignored while
8476 'varsofttabstop' is set.
8477
8478 *'vartabstop'* *'vts'*
8479'vartabstop' 'vts' string (default "")
8480 local to buffer
8481 {only available when compiled with the |+vartabs|
8482 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008483 A list of the number of spaces that a <Tab> in the file counts for,
8484 separated by commas. Each value corresponds to one tab, with the
8485 final value applying to all subsequent tabs. For example: >
8486 :set vartabstop=4,20,10,8
8487< This will make the first tab 4 spaces wide, the second 20 spaces,
8488 the third 10 spaces, and all following tabs 8 spaces.
8489
8490 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8491 is set.
8492
Bram Moolenaar071d4272004-06-13 20:20:40 +00008493 *'verbose'* *'vbs'*
8494'verbose' 'vbs' number (default 0)
8495 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 When bigger than zero, Vim will give messages about what it is doing.
8497 Currently, these messages are given:
8498 >= 1 When the viminfo file is read or written.
8499 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008500 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008501 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008502 >= 8 Files for which a group of autocommands is executed.
8503 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008504 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 >= 12 Every executed function.
8506 >= 13 When an exception is thrown, caught, finished, or discarded.
8507 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008508 >= 15 Every executed Ex command from a script (truncated at 200
8509 characters).
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02008510 >= 16 Every executed Ex command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511
8512 This option can also be set with the "-V" argument. See |-V|.
8513 This option is also set by the |:verbose| command.
8514
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008515 When the 'verbosefile' option is set then the verbose messages are not
8516 displayed.
8517
8518 *'verbosefile'* *'vfile'*
8519'verbosefile' 'vfile' string (default empty)
8520 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008521 When not empty all messages are written in a file with this name.
8522 When the file exists messages are appended.
8523 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008524 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008525 Setting 'verbosefile' to a new value is like making it empty first.
8526 The difference with |:redir| is that verbose messages are not
8527 displayed when 'verbosefile' is set.
8528
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008530'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008531 "$VIM/vimfiles/view",
8532 for Unix: "~/.vim/view",
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02008533 for macOS: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008534 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008536 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008537 feature}
8538 Name of the directory where to store files for |:mkview|.
8539 This option cannot be set from a |modeline| or in the |sandbox|, for
8540 security reasons.
8541
8542 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008543'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008545 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 feature}
8547 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008548 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008549 word save and restore ~
8550 cursor cursor position in file and in window
8551 folds manually created folds, opened/closed folds and local
8552 fold options
8553 options options and mappings local to a window or buffer (not
8554 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008555 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556 slash backslashes in file names replaced with forward
8557 slashes
8558 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008559 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008560 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008562 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008564 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565
8566 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008567'viminfo' 'vi' string (Vi default: "", Vim default for
8568 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008569 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8570 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008571 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008572 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 feature}
8574 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008575 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8576 "NONE".
8577 The string should be a comma separated list of parameters, each
8578 consisting of a single character identifying the particular parameter,
8579 followed by a number or string which specifies the value of that
8580 parameter. If a particular character is left out, then the default
8581 value is used for that parameter. The following is a list of the
8582 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008584 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 ! When included, save and restore global variables that start
8586 with an uppercase letter, and don't contain a lowercase
8587 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008588 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008589 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008590 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008591 " Maximum number of lines saved for each register. Old name of
8592 the '<' item, with the disadvantage that you need to put a
8593 backslash before the ", otherwise it will be recognized as the
8594 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008595 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 % When included, save and restore the buffer list. If Vim is
8597 started with a file name argument, the buffer list is not
8598 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008599 buffer list is restored from the viminfo file. Quickfix
8600 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8601 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008602 When followed by a number, the number specifies the maximum
8603 number of buffers that are stored. Without a number all
8604 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008605 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 ' Maximum number of previously edited files for which the marks
8607 are remembered. This parameter must always be included when
8608 'viminfo' is non-empty.
8609 Including this item also means that the |jumplist| and the
8610 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008611 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008613 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 patterns are also saved. When not included, the value of
8615 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008616 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008618 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008619 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008620 < Maximum number of lines saved for each register. If zero then
8621 registers are not saved. When not included, all lines are
8622 saved. '"' is the old name for this item.
8623 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008624 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008626 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008627 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 c When included, convert the text in the viminfo file from the
8629 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008630 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008631 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 f Whether file marks need to be stored. If zero, file marks ('0
8633 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008634 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008636 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 h Disable the effect of 'hlsearch' when loading the viminfo
8638 file. When not included, it depends on whether ":nohlsearch"
8639 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008640 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008642 the 'n'. Must be at the end of the option! If the
8643 'viminfofile' option is set, that file name overrides the one
8644 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008645 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008646 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 r Removable media. The argument is a string (up to the next
8648 ','). This parameter can be given several times. Each
8649 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008650 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008651 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8652 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8653 ignored. Maximum length of each 'r' argument is 50
8654 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008655 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 s Maximum size of an item in Kbyte. If zero then registers are
8657 not saved. Currently only applies to registers. The default
8658 "s10" will exclude registers with more than 10 Kbyte of text.
8659 Also see the '<' item above: line count limit.
8660
8661 Example: >
8662 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8663<
8664 '50 Marks will be remembered for the last 50 files you
8665 edited.
8666 <1000 Contents of registers (up to 1000 lines each) will be
8667 remembered.
8668 s100 Registers with more than 100 Kbyte text are skipped.
8669 :0 Command-line history will not be saved.
8670 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8671 no / Since '/' is not specified, the default will be used,
8672 that is, save all of the search history, and also the
8673 previous search and substitute patterns.
8674 no % The buffer list will not be saved nor read back.
8675 no h 'hlsearch' highlighting will be restored.
8676
8677 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8678 load the contents of the file, this is not done automatically.
8679
8680 This option cannot be set from a |modeline| or in the |sandbox|, for
8681 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008682 NOTE: This option is set to the Vim default value when 'compatible'
8683 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008685 *'viminfofile'* *'vif'*
8686'viminfofile' 'vif' string (default: "")
8687 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008688 {not available when compiled without the |+viminfo|
8689 feature}
8690 When non-empty, overrides the file name used for viminfo.
8691 When equal to "NONE" no viminfo file will be read or written.
8692 This option can be set with the |-i| command line flag. The |--clean|
8693 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008694 This option cannot be set from a |modeline| or in the |sandbox|, for
8695 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008696
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 *'virtualedit'* *'ve'*
8698'virtualedit' 've' string (default "")
Gary Johnson51ad8502021-08-03 18:33:08 +02008699 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 A comma separated list of these words:
8701 block Allow virtual editing in Visual block mode.
8702 insert Allow virtual editing in Insert mode.
8703 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008704 onemore Allow the cursor to move just past the end of the line
Gary Johnson53ba05b2021-07-26 22:19:10 +02008705 none When used as the local value, do not allow virtual
8706 editing even when the global value is set. When used
8707 as the global value, "none" is the same as "".
8708 NONE Alternative spelling of "none".
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008709
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008711 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712 of the line. Useful for selecting a rectangle in Visual mode and
8713 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008714 "onemore" is not the same, it will only allow moving the cursor just
8715 after the last character of the line. This makes some commands more
8716 consistent. Previously the cursor was always past the end of the line
8717 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008718 break some plugins or Vim scripts. For example because |l| can move
8719 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008720 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008721 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008722 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008723 It doesn't make sense to combine "all" with "onemore", but you will
8724 not get a warning for it.
Bram Moolenaar53f7fcc2021-07-28 20:10:16 +02008725 When combined with other words, "none" is ignored.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008726 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727
8728 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8729'visualbell' 'vb' boolean (default off)
8730 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008731 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008733 use: >
8734 :set vb t_vb=
8735< If you want a short flash, you can use this on many terminals: >
8736 :set vb t_vb=[?5h$<100>[?5l
8737< Here $<100> specifies the time, you can use a smaller or bigger value
8738 to get a shorter or longer flash.
8739
8740 Note: Vim will limit the bell to once per half a second. This avoids
8741 having to wait for the flashing to finish when there are lots of
8742 bells, e.g. on key repeat. This also happens without 'visualbell'
8743 set.
8744
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8746 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8747 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008748
8749 Note: When the GUI starts, 't_vb' is reset to its default value. You
8750 might want to set it again in your |gvimrc|.
8751
Bram Moolenaar071d4272004-06-13 20:20:40 +00008752 Does not work on the Amiga, you always get a screen flash.
8753 Also see 'errorbells'.
8754
8755 *'warn'* *'nowarn'*
8756'warn' boolean (default on)
8757 global
8758 Give a warning message when a shell command is used while the buffer
8759 has been changed.
8760
8761 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8762'weirdinvert' 'wiv' boolean (default off)
8763 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008764 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 It is provided for backwards compatibility with version 4.x.
8766 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8767 vice versa. Has no effect when the GUI is running.
8768
8769 *'whichwrap'* *'ww'*
8770'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8771 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 Allow specified keys that move the cursor left/right to move to the
8773 previous/next line when the cursor is on the first/last character in
8774 the line. Concatenate characters to allow this for these keys:
8775 char key mode ~
8776 b <BS> Normal and Visual
8777 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008778 h "h" Normal and Visual (not recommended)
8779 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780 < <Left> Normal and Visual
8781 > <Right> Normal and Visual
8782 ~ "~" Normal
8783 [ <Left> Insert and Replace
8784 ] <Right> Insert and Replace
8785 For example: >
8786 :set ww=<,>,[,]
8787< allows wrap only when cursor keys are used.
8788 When the movement keys are used in combination with a delete or change
8789 operator, the <EOL> also counts for a character. This makes "3h"
8790 different from "3dh" when the cursor crosses the end of a line. This
8791 is also true for "x" and "X", because they do the same as "dl" and
8792 "dh". If you use this, you may also want to use the mapping
8793 ":map <BS> X" to make backspace delete the character in front of the
8794 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008795 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008796 line (not an empty line) then it will not move to the next line. This
8797 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 NOTE: This option is set to the Vi default value when 'compatible' is
8799 set and to the Vim default value when 'compatible' is reset.
8800
8801 *'wildchar'* *'wc'*
8802'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008804 Character you have to type to start wildcard expansion in the
8805 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008806 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 The character is not recognized when used inside a macro. See
8808 'wildcharm' for that.
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008809 Some keys will not work, such as CTRL-C, <CR> and Enter.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 Although 'wc' is a number option, you can set it to a special key: >
Bram Moolenaar34cc7d82021-09-21 20:09:51 +02008811 :set wc=<Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812< NOTE: This option is set to the Vi default value when 'compatible' is
8813 set and to the Vim default value when 'compatible' is reset.
8814
8815 *'wildcharm'* *'wcm'*
8816'wildcharm' 'wcm' number (default: none (0))
8817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008819 recognized when used inside a macro. You can find "spare" command-line
8820 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 you'll never actually type 'wildcharm', just use it in mappings that
8822 automatically invoke completion mode, e.g.: >
8823 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008824 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825< Then after typing :ss you can use CTRL-P & CTRL-N.
8826
8827 *'wildignore'* *'wig'*
8828'wildignore' 'wig' string (default "")
8829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830 {not available when compiled without the |+wildignore|
8831 feature}
8832 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008833 patterns is ignored when expanding |wildcards|, completing file or
8834 directory names, and influences the result of |expand()|, |glob()| and
8835 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8837 Also see 'suffixes'.
8838 Example: >
8839 :set wildignore=*.o,*.obj
8840< The use of |:set+=| and |:set-=| is preferred when adding or removing
8841 a pattern from the list. This avoids problems when a future version
8842 uses another default.
8843
Bram Moolenaar94950a92010-12-02 16:01:29 +01008844
Bram Moolenaar81af9252010-12-10 20:35:50 +01008845 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008846'wildignorecase' 'wic' boolean (default off)
8847 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008848 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008849 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008850 Does not apply when the shell is used to expand wildcards, which
8851 happens when there are special characters.
8852
8853
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008855'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008856 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 {not available if compiled without the |+wildmenu|
8858 feature}
8859 When 'wildmenu' is on, command-line completion operates in an enhanced
8860 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8861 the possible matches are shown just above the command line, with the
8862 first match highlighted (overwriting the status line, if there is
8863 one). Keys that show the previous/next match, such as <Tab> or
8864 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8865 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8866 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008867 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008868 If there are more matches than can fit in the line, a ">" is shown on
8869 the right and/or a "<" is shown on the left. The status line scrolls
8870 as needed.
8871 The "wildmenu" mode is abandoned when a key is hit that is not used
8872 for selecting a completion.
8873 While the "wildmenu" is active the following keys have special
8874 meanings:
8875
8876 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8877 <Down> - in filename/menu name completion: move into a
8878 subdirectory or submenu.
8879 <CR> - in menu completion, when the cursor is just after a
8880 dot: move into a submenu.
8881 <Up> - in filename/menu name completion: move up into
8882 parent directory or parent menu.
8883
8884 This makes the menus accessible from the console |console-menus|.
8885
8886 If you prefer the <Left> and <Right> keys to move the cursor instead
8887 of selecting a different match, use this: >
8888 :cnoremap <Left> <Space><BS><Left>
8889 :cnoremap <Right> <Space><BS><Right>
8890<
8891 The "WildMenu" highlighting is used for displaying the current match
8892 |hl-WildMenu|.
8893
8894 *'wildmode'* *'wim'*
8895'wildmode' 'wim' string (Vim default: "full")
8896 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008897 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008898 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008899 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 first part specifies the behavior for the first use of 'wildchar',
8901 The second part for the second use, etc.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008902
8903 Each part consists of a colon separated list consisting of the
8904 following possible values:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008905 "" Complete only the first match.
8906 "full" Complete the next full match. After the last match,
8907 the original string is used and then the first match
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008908 again. Will also start 'wildmenu' if it is enabled.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909 "longest" Complete till longest common string. If this doesn't
8910 result in a longer string, use the next part.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008911 "list" When more than one match, list all matches.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008912 "lastused" When completing buffer names and more than one buffer
8913 matches, sort buffers by time last used (other than
8914 the current buffer).
8915 When there is only a single match, it is fully completed in all cases.
8916
8917 Examples of useful colon-separated values:
8918 "longest:full" Like "longest", but also start 'wildmenu' if it is
8919 enabled. Will not complete to the next full match.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008920 "list:full" When more than one match, list all matches and
8921 complete first match.
8922 "list:longest" When more than one match, list all matches and
8923 complete till longest common string.
Bram Moolenaar130cbfc2021-04-07 21:07:20 +02008924 "list:lastused" When more than one buffer matches, list all matches
8925 and sort buffers by time last used (other than the
8926 current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008927
8928 Examples: >
8929 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008930< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 :set wildmode=longest,full
8932< Complete longest common string, then each full match >
8933 :set wildmode=list:full
8934< List all matches and complete each full match >
8935 :set wildmode=list,full
8936< List all matches without completing, then each full match >
8937 :set wildmode=longest,list
8938< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008939 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008941 *'wildoptions'* *'wop'*
8942'wildoptions' 'wop' string (default "")
8943 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008944 {not available when compiled without the |+wildignore|
8945 feature}
8946 A list of words that change how command line completion is done.
8947 Currently only one word is allowed:
8948 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008949 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008950 is displayed per line. Often used tag kinds are:
8951 d #define
8952 f function
8953 Also see |cmdline-completion|.
8954
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955 *'winaltkeys'* *'wak'*
8956'winaltkeys' 'wak' string (default "menu")
8957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 {only used in Win32, Motif, GTK and Photon GUI}
8959 Some GUI versions allow the access to menu entries by using the ALT
8960 key in combination with a character that appears underlined in the
8961 menu. This conflicts with the use of the ALT key for mappings and
8962 entering special characters. This option tells what to do:
8963 no Don't use ALT keys for menus. ALT key combinations can be
8964 mapped, but there is no automatic handling. This can then be
8965 done with the |:simalt| command.
8966 yes ALT key handling is done by the windowing system. ALT key
8967 combinations cannot be mapped.
8968 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008969 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008970 keys can be mapped.
8971 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8972 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008973 This option is not used for <F10>; on Win32 and with GTK <F10> will
8974 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008976 *'wincolor'* *'wcr'*
8977'wincolor' 'wcr' string (default empty)
8978 local to window
8979 Highlight group name to use for this window instead of the Normal
8980 color |hl-Normal|.
8981
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008982 *'window'* *'wi'*
8983'window' 'wi' number (default screen height - 1)
8984 global
Bram Moolenaardad44732021-03-31 20:07:33 +02008985 Window height used for |CTRL-F| and |CTRL-B| when there is only one
8986 window and the value is smaller than 'lines' minus one. The screen
8987 will scroll 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008988 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8989 in a much smarter way, taking care of wrapping lines.
8990 When resizing the Vim window, the value is smaller than 1 or more than
8991 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaardad44732021-03-31 20:07:33 +02008992 Note: Do not confuse this with the height of the Vim window, use
8993 'lines' for that.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008994
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 *'winheight'* *'wh'* *E591*
8996'winheight' 'wh' number (default 1)
8997 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008998 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008999 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009000 focus goes to a window that is smaller, its size is increased, at the
9001 cost of the height of other windows.
9002 Set 'winheight' to a small number for normal editing.
9003 Set it to 999 to make the current window fill most of the screen.
9004 Other windows will be only 'winminheight' high. This has the drawback
9005 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9006 to create only two windows, set the option after startup is done,
9007 using the |VimEnter| event: >
9008 au VimEnter * set winheight=999
9009< Minimum value is 1.
9010 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 height of the current window.
9012 'winheight' applies to the current window. Use 'winminheight' to set
9013 the minimal height for other windows.
9014
9015 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9016'winfixheight' 'wfh' boolean (default off)
9017 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009018 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009019 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9020 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 The height may be changed anyway when running out of room.
9022
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009023 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9024'winfixwidth' 'wfw' boolean (default off)
9025 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009026 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009027 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009028 The width may be changed anyway when running out of room.
9029
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 *'winminheight'* *'wmh'*
9031'winminheight' 'wmh' number (default 1)
9032 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009033 The minimal height of a window, when it's not the current window.
9034 This is a hard minimum, windows will never become smaller.
9035 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9036 status bar) if necessary. They will return to at least one line when
9037 they become active (since the cursor has to have somewhere to go.)
9038 Use 'winheight' to set the minimal height of the current window.
9039 This option is only checked when making a window smaller. Don't use a
9040 large number, it will cause errors when opening more than a few
9041 windows. A value of 0 to 3 is reasonable.
9042
9043 *'winminwidth'* *'wmw'*
9044'winminwidth' 'wmw' number (default 1)
9045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009046 The minimal width of a window, when it's not the current window.
9047 This is a hard minimum, windows will never become smaller.
9048 When set to zero, windows may be "squashed" to zero columns (i.e. just
9049 a vertical separator) if necessary. They will return to at least one
9050 line when they become active (since the cursor has to have somewhere
9051 to go.)
9052 Use 'winwidth' to set the minimal width of the current window.
9053 This option is only checked when making a window smaller. Don't use a
9054 large number, it will cause errors when opening more than a few
9055 windows. A value of 0 to 12 is reasonable.
9056
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009057 *'winptydll'*
9058'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9059 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009060 {only available when compiled with the |terminal|
9061 feature on MS-Windows}
9062 Specifies the name of the winpty shared library, used for the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02009063 |:terminal| command. The default depends on whether Vim was built as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009064 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009065 a fallback.
9066 Environment variables are expanded |:set_env|.
9067 This option cannot be set from a |modeline| or in the |sandbox|, for
9068 security reasons.
9069
Bram Moolenaar071d4272004-06-13 20:20:40 +00009070 *'winwidth'* *'wiw'* *E592*
9071'winwidth' 'wiw' number (default 20)
9072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009073 Minimal number of columns for the current window. This is not a hard
9074 minimum, Vim will use fewer columns if there is not enough room. If
9075 the current window is smaller, its size is increased, at the cost of
9076 the width of other windows. Set it to 999 to make the current window
9077 always fill the screen. Set it to a small number for normal editing.
9078 The width is not adjusted after one of the commands to change the
9079 width of the current window.
9080 'winwidth' applies to the current window. Use 'winminwidth' to set
9081 the minimal width for other windows.
9082
9083 *'wrap'* *'nowrap'*
9084'wrap' boolean (default on)
9085 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00009086 This option changes how text is displayed. It doesn't change the text
9087 in the buffer, see 'textwidth' for that.
9088 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009089 displaying continues on the next line. When off lines will not wrap
9090 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009091 moved to a part that is not shown, the screen will scroll
9092 horizontally.
9093 The line will be broken in the middle of a word if necessary. See
9094 'linebreak' to get the break at a word boundary.
9095 To make scrolling horizontally a bit more useful, try this: >
9096 :set sidescroll=5
9097 :set listchars+=precedes:<,extends:>
9098< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009099 This option can't be set from a |modeline| when the 'diff' option is
9100 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009101
9102 *'wrapmargin'* *'wm'*
9103'wrapmargin' 'wm' number (default 0)
9104 local to buffer
9105 Number of characters from the right window border where wrapping
9106 starts. When typing text beyond this limit, an <EOL> will be inserted
9107 and inserting continues on the next line.
9108 Options that add a margin, such as 'number' and 'foldcolumn', cause
9109 the text width to be further reduced. This is Vi compatible.
9110 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009111 This option is set to 0 when 'paste' is set and restored when 'paste'
9112 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02009113 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114
9115 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9116'wrapscan' 'ws' boolean (default on) *E384* *E385*
9117 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009118 Searches wrap around the end of the file. Also applies to |]s| and
9119 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009120
9121 *'write'* *'nowrite'*
9122'write' boolean (default on)
9123 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 Allows writing files. When not set, writing a file is not allowed.
9125 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009126 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009127 argument. Filtering text is still possible, even though this requires
9128 writing a temporary file.
9129
9130 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9131'writeany' 'wa' boolean (default off)
9132 global
9133 Allows writing to any file with no need for "!" override.
9134
9135 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9136'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9137 otherwise)
9138 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139 Make a backup before overwriting a file. The backup is removed after
9140 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009141 also on.
9142 WARNING: Switching this option off means that when Vim fails to write
9143 your buffer correctly and then, for whatever reason, Vim exits, you
9144 lose both the original file and what you were writing. Only reset
9145 this option if your file system is almost full and it makes the write
9146 fail (and make sure not to exit Vim until the write was successful).
9147 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009148 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01009149 Depending on 'backupcopy' the backup is a new file or the original
9150 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00009151 NOTE: This option is set to the default value when 'compatible' is
9152 set.
9153
9154 *'writedelay'* *'wd'*
9155'writedelay' 'wd' number (default 0)
9156 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009157 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009158 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009159 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009160
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009161 vim:tw=78:ts=8:noet:ft=help:norl: