blob: 847290e29fbfe2f75055f948dec083c8436ba4bb [file] [log] [blame]
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01001*options.txt* For Vim version 8.2. Last change: 2020 Jan 24
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100203For Win32 backslashes in file names are mostly not removed. More precise: For
204options that expect a file name (those where environment variables are
205expanded) a backslash before a normal file name character is not removed. But
206a backslash before a special character (space, backslash, comma, etc.) is used
207like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100294:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000309:setl[ocal] {option}< Set the local value of {option} to its global value by
310 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000311
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100312:se[t] {option}< For |global-local| options: Remove the local value of
313 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314
315 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100316:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 option without changing the local value.
318 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200319 With the "all" argument: display global values for all
320 local options.
321 Without argument: display global values for all local
322 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324For buffer-local and window-local options:
325 Command global value local value ~
326 :set option=value set set
327 :setlocal option=value - set
328:setglobal option=value set -
329 :set option? - display
330 :setlocal option? - display
331:setglobal option? display -
332
333
334Global options with a local value *global-local*
335
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000336Options are global when you mostly use one value for all buffers and windows.
337For some global options it's useful to sometimes have a different local value.
338You can set the local value with ":setlocal". That buffer or window will then
339use the local value, while other buffers and windows continue using the global
340value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341
342For example, you have two windows, both on C source code. They use the global
343'makeprg' option. If you do this in one of the two windows: >
344 :set makeprg=gmake
345then the other window will switch to the same value. There is no need to set
346the 'makeprg' option in the other C source window too.
347However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000348another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000349files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 :setlocal makeprg=perlmake
351You can switch back to using the global value by making the local value empty: >
352 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100353This only works for a string option. For a number or boolean option you need
354to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100356Note that for non-boolean and non-number options using "<" copies the global
357value to the local value, it doesn't switch back to using the global value
358(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000359 :set path<
360This will make the local value of 'path' empty, so that the global value is
361used. Thus it does the same as: >
362 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363Note: In the future more global options can be made global-local. Using
364":setlocal" on a global option might work differently then.
365
366
367Setting the filetype
368
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200369:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 Set the 'filetype' option to {filetype}, but only if
371 not done yet in a sequence of (nested) autocommands.
372 This is short for: >
373 :if !did_filetype()
374 : setlocal filetype={filetype}
375 :endif
376< This command is used in a filetype.vim file to avoid
377 setting the 'filetype' option twice, causing different
378 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200379
380 When the optional FALLBACK argument is present, a
381 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100382 'filetype'. This is to be used for filetype
383 detections that are just a guess. |did_filetype()|
384 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200385
Bram Moolenaard58e9292011-02-09 17:07:58 +0100386 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
388:opt[ions] Open a window for viewing and setting all options.
389 Options are grouped by function.
390 Offers short help for each option. Hit <CR> on the
391 short help to open a help window with more help for
392 the option.
393 Modify the value of the option and hit <CR> on the
394 "set" line to set the new value. For window and
395 buffer specific options, the last accessed window is
396 used to set the option value in, unless this is a help
397 window, in which case the window below help window is
398 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100399 {not available when compiled without the |+eval|
400 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401
402 *$HOME*
403Using "~" is like using "$HOME", but it is only recognized at the start of an
404option and after a space or comma.
405
406On Unix systems "~user" can be used too. It is replaced by the home directory
407of user "user". Example: >
408 :set path=~mool/include,/usr/include,.
409
410On Unix systems the form "${HOME}" can be used too. The name between {} can
411contain non-id characters then. Note that if you want to use this for the
412"gf" command, you need to add the '{' and '}' characters to 'isfname'.
413
414NOTE: expanding environment variables and "~/" is only done with the ":set"
415command, not when assigning a value to an option with ":let".
416
Bram Moolenaarc572da52017-08-27 16:52:01 +0200417 *$HOME-windows*
418On MS-Windows, if $HOME is not defined as an environment variable, then
419at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200420If $HOMEDRIVE is not set then $USERPROFILE is used.
421
422This expanded value is not exported to the environment, this matters when
423running an external command: >
424 :echo system('set | findstr ^HOME=')
425and >
426 :echo luaeval('os.getenv("HOME")')
427should echo nothing (an empty string) despite exists('$HOME') being true.
428When setting $HOME to a non-empty string it will be exported to the
429subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200430
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431
432Note the maximum length of an expanded option is limited. How much depends on
433the system, mostly it is something like 256 or 1024 characters.
434
435 *:fix* *:fixdel*
436:fix[del] Set the value of 't_kD':
437 't_kb' is 't_kD' becomes ~
438 CTRL-? CTRL-H
439 not CTRL-? CTRL-?
440
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200441 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442
443 If your delete key terminal code is wrong, but the
444 code for backspace is alright, you can put this in
445 your .vimrc: >
446 :fixdel
447< This works no matter what the actual code for
448 backspace is.
449
450 If the backspace key terminal code is wrong you can
451 use this: >
452 :if &term == "termname"
453 : set t_kb=^V<BS>
454 : fixdel
455 :endif
456< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000457 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458 with your terminal name.
459
460 If your <Delete> key sends a strange key sequence (not
461 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
462 :if &term == "termname"
463 : set t_kD=^V<Delete>
464 :endif
465< Where "^V" is CTRL-V and "<Delete>" is the delete key
466 (don't type eight characters!). Replace "termname"
467 with your terminal name.
468
469 *Linux-backspace*
470 Note about Linux: By default the backspace key
471 produces CTRL-?, which is wrong. You can fix it by
472 putting this line in your rc.local: >
473 echo "keycode 14 = BackSpace" | loadkeys
474<
475 *NetBSD-backspace*
476 Note about NetBSD: If your backspace doesn't produce
477 the right code, try this: >
478 xmodmap -e "keycode 22 = BackSpace"
479< If this works, add this in your .Xmodmap file: >
480 keysym 22 = BackSpace
481< You need to restart for this to take effect.
482
483==============================================================================
4842. Automatically setting options *auto-setting*
485
486Besides changing options with the ":set" command, there are three alternatives
487to set options automatically for one or more files:
488
4891. When starting Vim initializations are read from various places. See
490 |initialization|. Most of them are performed for all editing sessions,
491 and some of them depend on the directory where Vim is started.
492 You can create an initialization file with |:mkvimrc|, |:mkview| and
493 |:mksession|.
4942. If you start editing a new file, the automatic commands are executed.
495 This can be used to set options for files matching a particular pattern and
496 many other things. See |autocommand|.
4973. If you start editing a new file, and the 'modeline' option is on, a
498 number of lines at the beginning and end of the file are checked for
499 modelines. This is explained here.
500
501 *modeline* *vim:* *vi:* *ex:* *E520*
502There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100503 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100505[text{white}] empty or any text followed by at least one blank
506 character (<Space> or <Tab>); "ex:" always requires at
507 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200508{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[white] optional white space
510{options} a list of option settings, separated with white space
511 or ':', where each part between ':' is the argument
512 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar14b69452013-06-29 23:05:20 +0200514Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000515 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200516 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
518The second form (this is compatible with some versions of Vi):
519
Bram Moolenaarade0d392020-01-21 22:33:58 +0100520 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
Bram Moolenaarade0d392020-01-21 22:33:58 +0100522[text{white}] empty or any text followed by at least one blank
523 character (<Space> or <Tab>); "ex:" always requires at
524 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
526[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200527se[t] the string "set " or "se " (note the space); When
528 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200529{options} a list of options, separated with white space, which
530 is the argument for a ":set" command
531: a colon
532[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000535 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200536 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200538The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
539chance that a normal word like "lex:" is caught. There is one exception:
540"vi:" and "vim:" can also be at the start of the line (for compatibility with
541version 3.0). Using "ex:" at the start of the line will be ignored (this
542could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
544 *modeline-local*
545The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000546buffer and window that contain the file. Although it's possible to set global
547options from a modeline, this is unusual. If you have two windows open and
548the files in it set the same global option to a different value, the result
549depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000551When editing a file that was already loaded, only the window-local options
552from the modeline are used. Thus if you manually changed a buffer-local
553option after opening the file, it won't be changed if you edit the same buffer
554in another window. But window-local options will be set.
555
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556 *modeline-version*
557If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200558number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559 vim{vers}: version {vers} or later
560 vim<{vers}: version before {vers}
561 vim={vers}: version {vers}
562 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100563{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
564For example, to use a modeline only for Vim 7.0:
565 /* vim700: set foldmethod=marker */ ~
566To use a modeline for Vim after version 7.2:
567 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568There can be no blanks between "vim" and the ":".
569
570
571The number of lines that are checked can be set with the 'modelines' option.
572If 'modeline' is off or 'modelines' is 0 no lines are checked.
573
574Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000575like:
576 /* vi:ts=4: */ ~
577will give an error message for the trailing "*/". This line is OK:
578 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579
580If an error is detected the rest of the line is skipped.
581
582If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000583backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100584 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
585This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
586before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200587 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000589might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200590can be set. For some options a flag is set, so that when the value is used
591the |sandbox| is effective. Some options can only be set from the modeline
592when 'modelineexpr' is set (the default is off).
593
594Still, there is always a small risk that a modeline causes trouble. E.g.,
595when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
596So disable modelines before editing untrusted text. The mail ftplugin does
597this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599Hint: If you would like to do something else than setting an option, you could
600define an autocommand that checks the file for a specific string. For
601example: >
602 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
603And define a function SetVar() that does something with the line containing
604"VAR".
605
606==============================================================================
6073. Options summary *option-summary*
608
609In the list below all the options are mentioned with their full name and with
610an abbreviation if there is one. Both forms may be used.
611
612In this document when a boolean option is "set" that means that ":set option"
613is entered. When an option is "reset", ":set nooption" is used.
614
615For some options there are two default values: The "Vim default", which is
616used when 'compatible' is not set, and the "Vi default", which is used when
617'compatible' is set.
618
619Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621different value in each window. For example the 'list' option can be set in
622one window and reset in another for the same text, giving both types of view
623at the same time. There are a few options that are specific to a certain
624file. These can have a different value for each file or buffer. For example
625the 'textwidth' option can be 78 for a normal text file and 0 for a C
626program.
627
628 global one option for all buffers and windows
629 local to window each window has its own copy of this option
630 local to buffer each buffer has its own copy of this option
631
632When creating a new window the option values from the currently active window
633are used as a default value for the window-specific options. For the
634buffer-specific options this depends on the 's' and 'S' flags in the
635'cpoptions' option. If 's' is included (which is the default) the values for
636buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000637first entered. If 'S' is present the options are copied each time the buffer
638is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639present, the options are copied from the currently active buffer when the
640buffer is created.
641
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000642Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000644Not all options are supported in all versions. This depends on the supported
645features and sometimes on the system. A remark about this is in curly braces
646below. When an option is not supported it may still be set without getting an
647error, this is called a hidden option. You can't get the value of a hidden
648option though, it is not stored.
649
650To test if option "foo" can be used with ":set" use something like this: >
651 if exists('&foo')
652This also returns true for a hidden option. To test if option "foo" is really
653supported use something like this: >
654 if exists('+foo')
655<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 *E355*
657A jump table for the options with a short description can be found at |Q_op|.
658
659 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100660'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 {only available when compiled with the |+rightleft|
663 feature}
664 The ASCII code for the first letter of the Hebrew alphabet. The
665 routine that maps the keyboard in Hebrew mode, both in Insert mode
666 (when hkmap is set) and on the command-line (when hitting CTRL-_)
667 outputs the Hebrew characters in the range [aleph..aleph+26].
668 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
669 See |rileft.txt|.
670
671 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
672'allowrevins' 'ari' boolean (default off)
673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 {only available when compiled with the |+rightleft|
675 feature}
676 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
677 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
678 into reverse Insert mode, and don't know how to get out. See
679 'revins'.
680 NOTE: This option is reset when 'compatible' is set.
681
682 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
683'altkeymap' 'akm' boolean (default off)
684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 {only available when compiled with the |+farsi|
686 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100687 This option was for using Farsi, which has been removed. See
688 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 *'ambiwidth'* *'ambw'*
691'ambiwidth' 'ambw' string (default: "single")
692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
694 Tells Vim what to do with characters with East Asian Width Class
695 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
696 letters, Cyrillic letters).
697
698 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000699 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 expected by most users.
701 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200702 *E834* *E835*
703 The value "double" cannot be used if 'listchars' or 'fillchars'
704 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705
706 There are a number of CJK fonts for which the width of glyphs for
707 those characters are solely based on how many octets they take in
708 legacy/traditional CJK encodings. In those encodings, Euro,
709 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000710 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000712 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 Vim is running inside a terminal (emulators) that uses a CJK font
714 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
715 this option should be set to "double" to match the width perceived
716 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100717 to be set to "double" under CJK MS-Windows when the system locale is
718 set to one of CJK locales. See Unicode Standard Annex #11
719 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100721 Vim may set this option automatically at startup time when Vim is
722 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200723 escape sequence to request cursor position report. The response can
724 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100725
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
727'antialias' 'anti' boolean (default: off)
728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729 {only available when compiled with GUI enabled
730 on Mac OS X}
731 This option only has an effect in the GUI version of Vim on Mac OS X
732 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
733 which can be easier to read at certain sizes on certain displays.
734 Setting this option can sometimes cause problems if 'guifont' is set
735 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100736 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737
738 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
739'autochdir' 'acd' boolean (default off)
740 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200741 {only available when compiled with it, use
742 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000743 When on, Vim will change the current working directory whenever you
744 open a file, switch buffers, delete a buffer or open/close a window.
745 It will change to the directory containing the file which was opened
746 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000747 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748
749 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
750'arabic' 'arab' boolean (default off)
751 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 {only available when compiled with the |+arabic|
753 feature}
754 This option can be set to start editing Arabic text.
755 Setting this option will:
756 - Set the 'rightleft' option, unless 'termbidi' is set.
757 - Set the 'arabicshape' option, unless 'termbidi' is set.
758 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
759 between typing English and Arabic key mapping.
760 - Set the 'delcombine' option
761 Note that 'encoding' must be "utf-8" for working with Arabic text.
762
763 Resetting this option will:
764 - Reset the 'rightleft' option.
765 - Disable the use of 'keymap' (without changing its value).
766 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200767 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100768 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Also see |arabic.txt|.
770
771 *'arabicshape'* *'arshape'*
772 *'noarabicshape'* *'noarshape'*
773'arabicshape' 'arshape' boolean (default on)
774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 {only available when compiled with the |+arabic|
776 feature}
777 When on and 'termbidi' is off, the required visual character
778 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200779 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 one which encompasses:
781 a) the changing/morphing of characters based on their location
782 within a word (initial, medial, final and stand-alone).
783 b) the enabling of the ability to compose characters
784 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100785 When disabled the display shows each character's true stand-alone
786 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 Arabic is a complex language which requires other settings, for
788 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100789 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
791 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
792'autoindent' 'ai' boolean (default off)
793 local to buffer
794 Copy indent from current line when starting a new line (typing <CR>
795 in Insert mode or when using the "o" or "O" command). If you do not
796 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000797 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
798 to another line has the same effect, unless the 'I' flag is included
799 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000800 When autoindent is on, formatting (with the "gq" command or when you
801 reach 'textwidth' in Insert mode) uses the indentation of the first
802 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 When 'smartindent' or 'cindent' is on the indent is changed in
804 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200805 The 'autoindent' option is reset when the 'paste' option is set and
806 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *'autoread'* *'ar'* *'noautoread'* *'noar'*
809'autoread' 'ar' boolean (default off)
810 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 When a file has been detected to have been changed outside of Vim and
812 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200813 When the file has been deleted this is not done, so you have the text
814 from before it was deleted. When it appears again then it is read.
815 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 If this option has a local value, use this command to switch back to
817 using the global value: >
818 :set autoread<
819<
820 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
821'autowrite' 'aw' boolean (default off)
822 global
823 Write the contents of the file, if it has been modified, on each
824 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000825 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
827 Note that for some commands the 'autowrite' option is not used, see
828 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200829 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200830 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831
832 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
833'autowriteall' 'awa' boolean (default off)
834 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
836 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
837 Setting this option also implies that Vim behaves like 'autowrite' has
838 been set.
839
840 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200841'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 When set to "dark", Vim will try to use colors that look good on a
844 dark background. When set to "light", Vim will try to use colors that
845 look good on a light background. Any other value is illegal.
846 Vim tries to set the default value according to the terminal used.
847 This will not always be correct.
848 Setting this option does not change the background color, it tells Vim
849 what the background color looks like. For changing the background
850 color, see |:hi-normal|.
851
852 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000853 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000854 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100855 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 setting 'background' will cause the color scheme to be reloaded. If
857 the color scheme adjusts to the value of 'background' this will work.
858 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100859 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860
861 When setting 'background' to the default value with: >
862 :set background&
863< Vim will guess the value. In the GUI this should work correctly,
864 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200865 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200866 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200868 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200869 color from the terminal. If the returned RGB value is dark/light and
870 'background' is not dark/light, 'background' will be set and the
871 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200872 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100873 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200874
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 When starting the GUI, the default value for 'background' will be
876 "light". When the value is not set in the .gvimrc, and Vim detects
877 that the background is actually quite dark, 'background' is set to
878 "dark". But this happens only AFTER the .gvimrc file has been read
879 (because the window needs to be opened to find the actual background
880 color). To get around this, force the GUI window to be opened by
881 putting a ":gui" command in the .gvimrc file, before where the value
882 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200883
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100884 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200885 For other systems "dark" is used when 'term' is "linux",
886 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
887 background. Otherwise the default is "light".
888
Bram Moolenaarc572da52017-08-27 16:52:01 +0200889 The |:terminal| command and the |term_start()| function use the
890 'background' value to decide whether the terminal window will start
891 with a white or black background.
892
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 Normally this option would be set in the .vimrc file. Possibly
894 depending on the terminal name. Example: >
895 :if &term == "pcterm"
896 : set background=dark
897 :endif
898< When this option is set, the default settings for the highlight groups
899 will change. To use other settings, place ":highlight" commands AFTER
900 the setting of the 'background' option.
901 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
902 to select the colors for syntax highlighting. After changing this
903 option, you must load syntax.vim again to see the result. This can be
904 done with ":syntax on".
905
906 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200907'backspace' 'bs' string (default "", set to "indent,eol,start"
908 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
911 mode. This is a list of items, separated by commas. Each item allows
912 a way to backspace over something:
913 value effect ~
914 indent allow backspacing over autoindent
915 eol allow backspacing over line breaks (join lines)
916 start allow backspacing over the start of insert; CTRL-W and CTRL-U
917 stop once at the start of insert.
918
919 When the value is empty, Vi compatible backspacing is used.
920
921 For backwards compatibility with version 5.4 and earlier:
922 value effect ~
923 0 same as ":set backspace=" (Vi compatible)
924 1 same as ":set backspace=indent,eol"
925 2 same as ":set backspace=indent,eol,start"
926
927 See |:fixdel| if your <BS> or <Del> key does not do what you want.
928 NOTE: This option is set to "" when 'compatible' is set.
929
930 *'backup'* *'bk'* *'nobackup'* *'nobk'*
931'backup' 'bk' boolean (default off)
932 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 Make a backup before overwriting a file. Leave it around after the
934 file has been successfully written. If you do not want to keep the
935 backup file, but you do want a backup while the file is being
936 written, reset this option and set the 'writebackup' option (this is
937 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000938 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 |backup-table| for more explanations.
940 When the 'backupskip' pattern matches, a backup is not made anyway.
941 When 'patchmode' is set, the backup may be renamed to become the
942 oldest version of a file.
943 NOTE: This option is reset when 'compatible' is set.
944
945 *'backupcopy'* *'bkc'*
946'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200947 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 When writing a file and a backup is made, this option tells how it's
949 done. This is a comma separated list of words.
950
951 The main values are:
952 "yes" make a copy of the file and overwrite the original one
953 "no" rename the file and write a new one
954 "auto" one of the previous, what works best
955
956 Extra values that can be combined with the ones above are:
957 "breaksymlink" always break symlinks when writing
958 "breakhardlink" always break hardlinks when writing
959
960 Making a copy and overwriting the original file:
961 - Takes extra time to copy the file.
962 + When the file has special attributes, is a (hard/symbolic) link or
963 has a resource fork, all this is preserved.
964 - When the file is a link the backup will have the name of the link,
965 not of the real file.
966
967 Renaming the file and writing a new one:
968 + It's fast.
969 - Sometimes not all attributes of the file can be copied to the new
970 file.
971 - When the file is a link the new file will not be a link.
972
973 The "auto" value is the middle way: When Vim sees that renaming file
974 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000975 the file is not a link) that is used. When problems are expected, a
976 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977
978 The "breaksymlink" and "breakhardlink" values can be used in
979 combination with any of "yes", "no" and "auto". When included, they
980 force Vim to always break either symbolic or hard links by doing
981 exactly what the "no" option does, renaming the original file to
982 become the backup and writing a new file in its place. This can be
983 useful for example in source trees where all the files are symbolic or
984 hard links and any changes should stay in the local source tree, not
985 be propagated back to the original source.
986 *crontab*
987 One situation where "no" and "auto" will cause problems: A program
988 that opens a file, invokes Vim to edit that file, and then tests if
989 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000990 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 example.
992
993 When a copy is made, the original file is truncated and then filled
994 with the new text. This means that protection bits, owner and
995 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000996 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 group of the backup is set to the group of the original file. If this
998 fails, the protection bits for the group are made the same as for
999 others.
1000
1001 When the file is renamed this is the other way around: The backup has
1002 the same attributes of the original file, and the newly written file
1003 is owned by the current user. When the file was a (hard/symbolic)
1004 link, the new file will not! That's why the "auto" value doesn't
1005 rename when the file is a link. The owner and group of the newly
1006 written file will be set to the same ones as the original file, but
1007 the system may refuse to do this. In that case the "auto" value will
1008 again not rename the file.
1009
Bram Moolenaar036986f2017-03-16 17:41:02 +01001010 NOTE: This option is set to the Vi default value when 'compatible' is
1011 set and to the Vim default value when 'compatible' is reset.
1012
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 *'backupdir'* *'bdir'*
1014'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001015 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 for Unix: ".,~/tmp,~/")
1017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 List of directories for the backup file, separated with commas.
1019 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001020 where this is possible. The directory must exist, Vim will not
1021 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001022 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 impossible!). Writing may fail because of this.
1024 - A directory "." means to put the backup file in the same directory
1025 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001026 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1027 the backup file relative to where the edited file is. The leading
1028 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 ("." inside a directory name has no special meaning).
1030 - Spaces after the comma are ignored, other spaces are considered part
1031 of the directory name. To have a space at the start of a directory
1032 name, precede it with a backslash.
1033 - To include a comma in a directory name precede it with a backslash.
1034 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001035 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001036 the backup file name will be built from the complete path to the
1037 file with all path separators changed to percent '%' signs. This
1038 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001039 On Win32, it is also possible to end with "\\". However, When a
1040 separating comma is following, you must use "//", since "\\" will
1041 include the comma in the file name. Therefore it is recommended to
1042 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 - Environment variables are expanded |:set_env|.
1044 - Careful with '\' characters, type one before a space, type two to
1045 get one in the option (see |option-backslash|), for example: >
1046 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1047< - For backwards compatibility with Vim version 3.0 a '>' at the start
1048 of the option is removed.
1049 See also 'backup' and 'writebackup' options.
1050 If you want to hide your backup files on Unix, consider this value: >
1051 :set backupdir=./.backup,~/.backup,.,/tmp
1052< You must create a ".backup" directory in each directory and in your
1053 home directory for this to work properly.
1054 The use of |:set+=| and |:set-=| is preferred when adding or removing
1055 directories from the list. This avoids problems when a future version
1056 uses another default.
1057 This option cannot be set from a |modeline| or in the |sandbox|, for
1058 security reasons.
1059
1060 *'backupext'* *'bex'* *E589*
1061'backupext' 'bex' string (default "~", for VMS: "_")
1062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063 String which is appended to a file name to make the name of the
1064 backup file. The default is quite unusual, because this avoids
1065 accidentally overwriting existing files with a backup file. You might
1066 prefer using ".bak", but make sure that you don't have files with
1067 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001068 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001070 If you like to keep a lot of backups, you could use a BufWritePre
1071 autocommand to change 'backupext' just before writing the file to
1072 include a timestamp. >
1073 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1074< Use 'backupdir' to put the backup in a different directory.
1075
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001077'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1078 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1079 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081 {not available when compiled without the |+wildignore|
1082 feature}
1083 A list of file patterns. When one of the patterns matches with the
1084 name of the file which is written, no backup file is created. Both
1085 the specified file name and the full path name of the file are used.
1086 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1087 Watch out for special characters, see |option-backslash|.
1088 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001089 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001090
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001091 WARNING: Not having a backup file means that when Vim fails to write
1092 your buffer correctly and then, for whatever reason, Vim exits, you
1093 lose both the original file and what you were writing. Only disable
1094 backups if you don't care about losing the file.
1095
Bram Moolenaar02467872007-05-06 13:22:01 +00001096 Note that environment variables are not expanded. If you want to use
1097 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001098 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001099
1100< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001101 backup would be made by renaming the original file crontab won't see
1102 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103
1104 *'balloondelay'* *'bdlay'*
1105'balloondelay' 'bdlay' number (default: 600)
1106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 {only available when compiled with the |+balloon_eval|
1108 feature}
1109 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1110
1111 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1112'ballooneval' 'beval' boolean (default off)
1113 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001115 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001116 Switch on the |balloon-eval| functionality for the GUI.
1117
1118 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1119 *'nobevalterm'*
1120'balloonevalterm' 'bevalterm' boolean (default off)
1121 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001122 {only available when compiled with the
1123 |+balloon_eval_term| feature}
1124 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001126 *'balloonexpr'* *'bexpr'*
1127'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001128 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001129 {only available when compiled with the |+balloon_eval|
1130 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001131 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001132 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1133 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001134
1135 v:beval_bufnr number of the buffer in which balloon is going to show
1136 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001137 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 v:beval_lnum line number
1139 v:beval_col column number (byte index)
1140 v:beval_text word under or after the mouse pointer
1141
Bram Moolenaar54775062019-07-31 21:07:14 +02001142 Instead of showing a balloon, which is limited to plain text, consider
1143 using a popup window, see |popup_beval_example|. A popup window can
1144 use highlighting and show a border.
1145
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001146 The evaluation of the expression must not have side effects!
1147 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001148 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001149 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001150 \', column ' . v:beval_col .
1151 \ ' of file ' . bufname(v:beval_bufnr) .
1152 \ ' on word "' . v:beval_text . '"'
1153 endfunction
1154 set bexpr=MyBalloonExpr()
1155 set ballooneval
1156<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001157 Also see |balloon_show()|, it can be used if the content of the balloon
1158 is to be fetched asynchronously. In that case evaluating
1159 'balloonexpr' should result in an empty string. If you get a balloon
1160 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001161
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001162 NOTE: The balloon is displayed only if the cursor is on a text
1163 character. If the result of evaluating 'balloonexpr' is not empty,
1164 Vim does not try to send a message to an external debugger (Netbeans
1165 or Sun Workshop).
1166
Bram Moolenaar30b65812012-07-12 22:01:11 +02001167 The expression will be evaluated in the |sandbox| when set from a
1168 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001169 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001170
1171 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001172 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001173
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001174 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001175 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001176< When they are supported "\n" characters will start a new line. If the
1177 expression evaluates to a |List| this is equal to using each List item
1178 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001179 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001180
Bram Moolenaar165bc692015-07-21 17:53:25 +02001181 *'belloff'* *'bo'*
1182'belloff' 'bo' string (default "")
1183 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001184 Specifies for which events the bell will not be rung. It is a comma
1185 separated list of items. For each item that is present, the bell
1186 will be silenced. This is most useful to specify specific events in
1187 insert mode to be silenced.
1188
1189 item meaning when present ~
1190 all All events.
1191 backspace When hitting <BS> or <Del> and deleting results in an
1192 error.
1193 cursor Fail to move around using the cursor keys or
1194 <PageUp>/<PageDown> in |Insert-mode|.
1195 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1196 |i_CTRL-X_CTRL-T|.
1197 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1198 |i_CTRL-E|.
1199 ctrlg Unknown Char after <C-G> in Insert mode.
1200 error Other Error occurred (e.g. try to join last line)
1201 (mostly used in |Normal-mode| or |Cmdline-mode|).
1202 esc hitting <Esc> in |Normal-mode|.
1203 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001204 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001205 insertmode Pressing <Esc> in 'insertmode'.
1206 lang Calling the beep module for Lua/Mzscheme/TCL.
1207 mess No output available for |g<|.
1208 showmatch Error occurred for 'showmatch' function.
1209 operator Empty region error |cpo-E|.
1210 register Unknown register after <C-R> in |Insert-mode|.
1211 shell Bell from shell output |:!|.
1212 spell Error happened on spell suggest.
1213 wildmode More matches in |cmdline-completion| available
1214 (depends on the 'wildmode' setting).
1215
Bram Moolenaar036986f2017-03-16 17:41:02 +01001216 This is most useful to fine tune when in Insert mode the bell should
1217 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001218 indicate that an error occurred. It can be silenced by adding the
1219 "error" keyword.
1220
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1222'binary' 'bin' boolean (default off)
1223 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 This option should be set before editing a binary file. You can also
1225 use the |-b| Vim argument. When this option is switched on a few
1226 options will be changed (also when it already was on):
1227 'textwidth' will be set to 0
1228 'wrapmargin' will be set to 0
1229 'modeline' will be off
1230 'expandtab' will be off
1231 Also, 'fileformat' and 'fileformats' options will not be used, the
1232 file is read and written like 'fileformat' was "unix" (a single <NL>
1233 separates lines).
1234 The 'fileencoding' and 'fileencodings' options will not be used, the
1235 file is read without conversion.
1236 NOTE: When you start editing a(nother) file while the 'bin' option is
1237 on, settings from autocommands may change the settings again (e.g.,
1238 'textwidth'), causing trouble when editing. You might want to set
1239 'bin' again when the file has been loaded.
1240 The previous values of these options are remembered and restored when
1241 'bin' is switched from on to off. Each buffer has its own set of
1242 saved option values.
1243 To edit a file with 'binary' set you can use the |++bin| argument.
1244 This avoids you have to do ":set bin", which would have effect for all
1245 files you edit.
1246 When writing a file the <EOL> for the last line is only written if
1247 there was one in the original file (normally Vim appends an <EOL> to
1248 the last line if there is none; this would make the file longer). See
1249 the 'endofline' option.
1250
1251 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1252'bioskey' 'biosk' boolean (default on)
1253 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001254 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001255 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256
1257 *'bomb'* *'nobomb'*
1258'bomb' boolean (default off)
1259 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260 When writing a file and the following conditions are met, a BOM (Byte
1261 Order Mark) is prepended to the file:
1262 - this option is on
1263 - the 'binary' option is off
1264 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1265 endian variants.
1266 Some applications use the BOM to recognize the encoding of the file.
1267 Often used for UCS-2 files on MS-Windows. For other applications it
1268 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001269 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1271 check for the presence of the BOM is done and 'bomb' set accordingly.
1272 Unless 'binary' is set, it is removed from the first line, so that you
1273 don't see it when editing. When you don't change the options, the BOM
1274 will be restored when writing the file.
1275
1276 *'breakat'* *'brk'*
1277'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1278 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001279 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 feature}
1281 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001282 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1283 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001285 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001286'breakindent' 'bri' boolean (default off)
1287 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001288 {not available when compiled without the |+linebreak|
1289 feature}
1290 Every wrapped line will continue visually indented (same amount of
1291 space as the beginning of that line), thus preserving horizontal blocks
1292 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001293 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001294
1295 *'breakindentopt'* *'briopt'*
1296'breakindentopt' 'briopt' string (default empty)
1297 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001298 {not available when compiled without the |+linebreak|
1299 feature}
1300 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001301 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001302 min:{n} Minimum text width that will be kept after
1303 applying 'breakindent', even if the resulting
1304 text should normally be narrower. This prevents
1305 text indented almost to the right window border
1306 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001307 shift:{n} After applying 'breakindent', the wrapped line's
1308 beginning will be shifted by the given number of
1309 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001310 indentation (negative) or emphasizing the line
1311 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001312 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001313 additional indent.
1314 The default value for min is 20 and shift is 0.
1315
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001317'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001319 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001321 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001322 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 buffer Use the directory of the related buffer.
1324 current Use the current directory.
1325 {path} Use the specified directory
1326
1327 *'bufhidden'* *'bh'*
1328'bufhidden' 'bh' string (default: "")
1329 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330 This option specifies what happens when a buffer is no longer
1331 displayed in a window:
1332 <empty> follow the global 'hidden' option
1333 hide hide the buffer (don't unload it), also when 'hidden'
1334 is not set
1335 unload unload the buffer, also when 'hidden' is set or using
1336 |:hide|
1337 delete delete the buffer from the buffer list, also when
1338 'hidden' is set or using |:hide|, like using
1339 |:bdelete|
1340 wipe wipe out the buffer from the buffer list, also when
1341 'hidden' is set or using |:hide|, like using
1342 |:bwipeout|
1343
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001344 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001345 are lost without a warning. Also, these values may break autocommands
1346 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 This option is used together with 'buftype' and 'swapfile' to specify
1348 special kinds of buffers. See |special-buffers|.
1349
1350 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1351'buflisted' 'bl' boolean (default: on)
1352 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 When this option is set, the buffer shows up in the buffer list. If
1354 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1355 This option is reset by Vim for buffers that are only used to remember
1356 a file name or marks. Vim sets it when starting to edit a buffer.
1357 But not when moving to a buffer with ":buffer".
1358
1359 *'buftype'* *'bt'* *E382*
1360'buftype' 'bt' string (default: "")
1361 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 The value of this option specifies the type of a buffer:
1363 <empty> normal buffer
1364 nofile buffer which is not related to a file and will not be
1365 written
1366 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001367 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001368 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001370 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 help help buffer (you are not supposed to set this
1372 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001373 terminal buffer for a |terminal| (you are not supposed to set
1374 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001375 prompt buffer where only the last line can be edited, meant
1376 to be used by a plugin, see |prompt-buffer|
1377 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001378 popup buffer used in a popup window, see |popup|.
1379 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380
1381 This option is used together with 'bufhidden' and 'swapfile' to
1382 specify special kinds of buffers. See |special-buffers|.
1383
1384 Be careful with changing this option, it can have many side effects!
1385
Bram Moolenaar280f1262006-01-30 00:14:18 +00001386 A "quickfix" buffer is only used for the error list and the location
1387 list. This value is set by the |:cwindow| and |:lwindow| commands and
1388 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389
1390 "nofile" and "nowrite" buffers are similar:
1391 both: The buffer is not to be written to disk, ":w" doesn't
1392 work (":w filename" does work though).
1393 both: The buffer is never considered to be |'modified'|.
1394 There is no warning when the changes will be lost, for
1395 example when you quit Vim.
1396 both: A swap file is only created when using too much memory
1397 (when 'swapfile' has been reset there is never a swap
1398 file).
1399 nofile only: The buffer name is fixed, it is not handled like a
1400 file name. It is not modified in response to a |:cd|
1401 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001402 both: When using ":e bufname" and already editing "bufname"
1403 the buffer is made empty and autocommands are
1404 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001405 *E676*
1406 "acwrite" implies that the buffer name is not related to a file, like
1407 "nofile", but it will be written. Thus, in contrast to "nofile" and
1408 "nowrite", ":w" does work and a modified buffer can't be abandoned
1409 without saving. For writing there must be matching |BufWriteCmd|,
1410 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411
1412 *'casemap'* *'cmp'*
1413'casemap' 'cmp' string (default: "internal,keepascii")
1414 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415 Specifies details about changing the case of letters. It may contain
1416 these words, separated by a comma:
1417 internal Use internal case mapping functions, the current
1418 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001419 matters when 'encoding' is a Unicode encoding,
1420 "latin1" or "iso-8859-15". When "internal" is
1421 omitted, the towupper() and towlower() system library
1422 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1424 case mapping, the current locale is not effective.
1425 This probably only matters for Turkish.
1426
1427 *'cdpath'* *'cd'* *E344* *E346*
1428'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 {not available when compiled without the
1431 |+file_in_path| feature}
1432 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001433 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1434 searched for has a relative path, not an absolute part starting with
1435 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 The 'cdpath' option's value has the same form and semantics as
1437 |'path'|. Also see |file-searching|.
1438 The default value is taken from $CDPATH, with a "," prepended to look
1439 in the current directory first.
1440 If the default value taken from $CDPATH is not what you want, include
1441 a modified version of the following command in your vimrc file to
1442 override it: >
1443 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1444< This option cannot be set from a |modeline| or in the |sandbox|, for
1445 security reasons.
1446 (parts of 'cdpath' can be passed to the shell to expand file names).
1447
1448 *'cedit'*
1449'cedit' string (Vi default: "", Vim default: CTRL-F)
1450 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451 The key used in Command-line Mode to open the command-line window.
1452 The default is CTRL-F when 'compatible' is off.
1453 Only non-printable keys are allowed.
1454 The key can be specified as a single character, but it is difficult to
1455 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001456 :exe "set cedit=\<C-Y>"
1457 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458< |Nvi| also has this option, but it only uses the first character.
1459 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001460 NOTE: This option is set to the Vim default value when 'compatible'
1461 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462
1463 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1464'charconvert' 'ccv' string (default "")
1465 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001466 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 An expression that is used for character encoding conversion. It is
1468 evaluated when a file that is to be read or has been written has a
1469 different encoding from what is desired.
1470 'charconvert' is not used when the internal iconv() function is
1471 supported and is able to do the conversion. Using iconv() is
1472 preferred, because it is much faster.
1473 'charconvert' is not used when reading stdin |--|, because there is no
1474 file to convert from. You will have to save the text in a file first.
1475 The expression must return zero or an empty string for success,
1476 non-zero for failure.
1477 The possible encoding names encountered are in 'encoding'.
1478 Additionally, names given in 'fileencodings' and 'fileencoding' are
1479 used.
1480 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1481 is done internally by Vim, 'charconvert' is not used for this.
1482 'charconvert' is also used to convert the viminfo file, if the 'c'
1483 flag is present in 'viminfo'. Also used for Unicode conversion.
1484 Example: >
1485 set charconvert=CharConvert()
1486 fun CharConvert()
1487 system("recode "
1488 \ . v:charconvert_from . ".." . v:charconvert_to
1489 \ . " <" . v:fname_in . " >" v:fname_out)
1490 return v:shell_error
1491 endfun
1492< The related Vim variables are:
1493 v:charconvert_from name of the current encoding
1494 v:charconvert_to name of the desired encoding
1495 v:fname_in name of the input file
1496 v:fname_out name of the output file
1497 Note that v:fname_in and v:fname_out will never be the same.
1498 Note that v:charconvert_from and v:charconvert_to may be different
1499 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1500 Encryption is not done by Vim when using 'charconvert'. If you want
1501 to encrypt the file after conversion, 'charconvert' should take care
1502 of this.
1503 This option cannot be set from a |modeline| or in the |sandbox|, for
1504 security reasons.
1505
1506 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1507'cindent' 'cin' boolean (default off)
1508 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 {not available when compiled without the |+cindent|
1510 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001511 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 that trigger reindenting in insert mode and 'cinoptions' to set your
1513 preferred indent style.
1514 If 'indentexpr' is not empty, it overrules 'cindent'.
1515 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1516 the "=" operator indents using this algorithm rather than calling an
1517 external program.
1518 See |C-indenting|.
1519 When you don't like the way 'cindent' works, try the 'smartindent'
1520 option or 'indentexpr'.
1521 This option is not used when 'paste' is set.
1522 NOTE: This option is reset when 'compatible' is set.
1523
1524 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001525'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527 {not available when compiled without the |+cindent|
1528 feature}
1529 A list of keys that, when typed in Insert mode, cause reindenting of
1530 the current line. Only used if 'cindent' is on and 'indentexpr' is
1531 empty.
1532 For the format of this option see |cinkeys-format|.
1533 See |C-indenting|.
1534
1535 *'cinoptions'* *'cino'*
1536'cinoptions' 'cino' string (default "")
1537 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 {not available when compiled without the |+cindent|
1539 feature}
1540 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1541 program. See |cinoptions-values| for the values of this option, and
1542 |C-indenting| for info on C indenting in general.
1543
1544
1545 *'cinwords'* *'cinw'*
1546'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1547 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 {not available when compiled without both the
1549 |+cindent| and the |+smartindent| features}
1550 These keywords start an extra indent in the next line when
1551 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1552 an appropriate place (inside {}).
1553 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1554 matter, include the keyword both the uppercase and lowercase:
1555 "if,If,IF".
1556
1557 *'clipboard'* *'cb'*
1558'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1559 for X-windows, "" otherwise)
1560 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 {only in GUI versions or when the |+xterm_clipboard|
1562 feature is included}
1563 This option is a list of comma separated names.
1564 These names are recognized:
1565
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001566 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 unnamed When included, Vim will use the clipboard register '*'
1568 for all yank, delete, change and put operations which
1569 would normally go to the unnamed register. When a
1570 register is explicitly specified, it will always be
1571 used regardless of whether "unnamed" is in 'clipboard'
1572 or not. The clipboard register can always be
1573 explicitly accessed using the "* notation. Also see
1574 |gui-clipboard|.
1575
Bram Moolenaar30b65812012-07-12 22:01:11 +02001576 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001577 unnamedplus A variant of the "unnamed" flag which uses the
1578 clipboard register '+' (|quoteplus|) instead of
1579 register '*' for all yank, delete, change and put
1580 operations which would normally go to the unnamed
1581 register. When "unnamed" is also included to the
1582 option, yank operations (but not delete, change or
1583 put) will additionally copy the text into register
1584 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001585 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001586 Availability can be checked with: >
1587 if has('unnamedplus')
1588<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001589 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 autoselect Works like the 'a' flag in 'guioptions': If present,
1591 then whenever Visual mode is started, or the Visual
1592 area extended, Vim tries to become the owner of the
1593 windowing system's global selection or put the
1594 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001595 register "*. See |'go-a'| and |quotestar| for details.
1596 When the GUI is active, the 'a' flag in 'guioptions'
1597 is used, when the GUI is not active, this "autoselect"
1598 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 Also applies to the modeless selection.
1600
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001601 *clipboard-autoselectplus*
1602 autoselectplus Like "autoselect" but using the + register instead of
1603 the * register. Compare to the 'P' flag in
1604 'guioptions'.
1605
1606 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 autoselectml Like "autoselect", but for the modeless selection
1608 only. Compare to the 'A' flag in 'guioptions'.
1609
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001610 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001611 html When the clipboard contains HTML, use this when
1612 pasting. When putting text on the clipboard, mark it
1613 as HTML. This works to copy rendered HTML from
1614 Firefox, paste it as raw HTML in Vim, select the HTML
1615 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001616 You probably want to add this only temporarily,
1617 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001618 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001619
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001620 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 exclude:{pattern}
1622 Defines a pattern that is matched against the name of
1623 the terminal 'term'. If there is a match, no
1624 connection will be made to the X server. This is
1625 useful in this situation:
1626 - Running Vim in a console.
1627 - $DISPLAY is set to start applications on another
1628 display.
1629 - You do not want to connect to the X server in the
1630 console, but do want this in a terminal emulator.
1631 To never connect to the X server use: >
1632 exclude:.*
1633< This has the same effect as using the |-X| argument.
1634 Note that when there is no connection to the X server
1635 the window title won't be restored and the clipboard
1636 cannot be accessed.
1637 The value of 'magic' is ignored, {pattern} is
1638 interpreted as if 'magic' was on.
1639 The rest of the option value will be used for
1640 {pattern}, this must be the last entry.
1641
1642 *'cmdheight'* *'ch'*
1643'cmdheight' 'ch' number (default 1)
1644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 Number of screen lines to use for the command-line. Helps avoiding
1646 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001647 The value of this option is stored with the tab page, so that each tab
1648 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649
1650 *'cmdwinheight'* *'cwh'*
1651'cmdwinheight' 'cwh' number (default 7)
1652 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 Number of screen lines to use for the command-line window. |cmdwin|
1654
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001655 *'colorcolumn'* *'cc'*
1656'colorcolumn' 'cc' string (default "")
1657 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001658 {not available when compiled without the |+syntax|
1659 feature}
1660 'colorcolumn' is a comma separated list of screen columns that are
1661 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1662 text. Will make screen redrawing slower.
1663 The screen column can be an absolute number, or a number preceded with
1664 '+' or '-', which is added to or subtracted from 'textwidth'. >
1665
1666 :set cc=+1 " highlight column after 'textwidth'
1667 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1668 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1669<
1670 When 'textwidth' is zero then the items with '-' and '+' are not used.
1671 A maximum of 256 columns are highlighted.
1672
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 *'columns'* *'co'* *E594*
1674'columns' 'co' number (default 80 or terminal width)
1675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001677 initialization and does not have to be set by hand. Also see
1678 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 When Vim is running in the GUI or in a resizable window, setting this
1680 option will cause the window size to be changed. When you only want
1681 to use the size for the GUI, put the command in your |gvimrc| file.
1682 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001683 number of columns of the display, the display may be messed up. For
1684 the GUI it is always possible and Vim limits the number of columns to
1685 what fits on the screen. You can use this command to get the widest
1686 window possible: >
1687 :set columns=9999
1688< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689
1690 *'comments'* *'com'* *E524* *E525*
1691'comments' 'com' string (default
1692 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1693 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 A comma separated list of strings that can start a comment line. See
1695 |format-comments|. See |option-backslash| about using backslashes to
1696 insert a space.
1697
1698 *'commentstring'* *'cms'* *E537*
1699'commentstring' 'cms' string (default "/*%s*/")
1700 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 {not available when compiled without the |+folding|
1702 feature}
1703 A template for a comment. The "%s" in the value is replaced with the
1704 comment text. Currently only used to add markers for folding, see
1705 |fold-marker|.
1706
1707 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001708'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001709 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 This option has the effect of making Vim either more Vi-compatible, or
1712 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001713
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001715 other options are also changed as a side effect.
1716 NOTE: Setting or resetting this option can have a lot of unexpected
1717 effects: Mappings are interpreted in another way, undo behaves
1718 differently, etc. If you set this option in your vimrc file, you
1719 should probably put it at the very start.
1720
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 By default this option is on and the Vi defaults are used for the
1722 options. This default was chosen for those people who want to use Vim
1723 just like Vi, and don't even (want to) know about the 'compatible'
1724 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001725 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001726 this option is switched off, and all options that have not been
1727 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001728 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001729 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001730 happen for the system-wide vimrc or gvimrc file, nor for a file given
1731 with the |-u| argument). Also see |compatible-default| and
1732 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 You can also set this option with the "-C" argument, and reset it with
1734 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001735 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736
Bram Moolenaar214641f2017-03-05 17:04:09 +01001737 When this option is set, numerous other options are set to make Vim as
1738 Vi-compatible as possible. When this option is unset, various options
1739 are set to make Vim more useful. The table below lists all the
1740 options affected.
1741 The {?} column indicates when the options are affected:
1742 + Means that the option is set to the value given in {set value} when
1743 'compatible' is set.
1744 & Means that the option is set to the value given in {set value} when
1745 'compatible' is set AND is set to its Vim default value when
1746 'compatible' is unset.
1747 - Means the option is NOT changed when setting 'compatible' but IS
1748 set to its Vim default when 'compatible' is unset.
1749 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750
Bram Moolenaar036986f2017-03-16 17:41:02 +01001751 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001752
1753 'allowrevins' + off no CTRL-_ command
1754 'antialias' + off don't use antialiased fonts
1755 'arabic' + off reset arabic-related options
1756 'arabicshape' + on correct character shapes
1757 'backspace' + "" normal backspace
1758 'backup' + off no backup file
1759 'backupcopy' & Unix: "yes" backup file is a copy
1760 else: "auto" copy or rename backup file
1761 'balloonexpr' + "" text to show in evaluation balloon
1762 'breakindent' + off don't indent when wrapping lines
1763 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1764 'cindent' + off no C code indentation
1765 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1766 'copyindent' + off don't copy indent structure
1767 'cpoptions' & (all flags) Vi-compatible flags
1768 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001769 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001770 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001771 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001772 'cscopeverbose' + off see |cscopeverbose|
1773 'delcombine' + off unicode: delete whole char combination
1774 'digraph' + off no digraphs
1775 'esckeys' & off no <Esc>-keys in Insert mode
1776 'expandtab' + off tabs not expanded to spaces
1777 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001778 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001779 'formatexpr' + "" use 'formatprg' for auto-formatting
1780 'formatoptions' & "vt" Vi compatible formatting
1781 'gdefault' + off no default 'g' flag for ":s"
1782 'history' & 0 no commandline history
1783 'hkmap' + off no Hebrew keyboard mapping
1784 'hkmapp' + off no phonetic Hebrew keyboard mapping
1785 'hlsearch' + off no highlighting of search matches
1786 'incsearch' + off no incremental searching
1787 'indentexpr' + "" no indenting by expression
1788 'insertmode' + off do not start in Insert mode
1789 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001791 'joinspaces' + on insert 2 spaces after period
1792 'modeline' & off no modelines
1793 'more' & off no pauses in listings
1794 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1795 'numberwidth' & 8 min number of columns for line number
1796 'preserveindent'+ off don't preserve current indent structure
1797 when changing it
1798 'revins' + off no reverse insert
1799 'ruler' + off no ruler
1800 'scrolljump' + 1 no jump scroll
1801 'scrolloff' + 0 no scroll offset
1802 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1803 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001804 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001805 'showcmd' & off command characters not shown
1806 'showmode' & off current mode not shown
1807 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1808 'smartcase' + off no automatic ignore case switch
1809 'smartindent' + off no smart indentation
1810 'smarttab' + off no smart tab size
1811 'softtabstop' + 0 tabs are always 'tabstop' positions
1812 'startofline' + on goto startofline with some commands
1813 'tagcase' & "followic" 'ignorecase' when searching tags file
1814 'tagrelative' & off tag file names are not relative
1815 'termguicolors' + off don't use highlight-(guifg|guibg)
1816 'textauto' & off no automatic textmode detection
1817 'textwidth' + 0 no automatic line wrap
1818 'tildeop' + off tilde is not an operator
1819 'ttimeout' + off no terminal timeout
1820 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001821 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001822 'virtualedit' + "" cursor can only be placed on characters
1823 'whichwrap' & "" left-right movements don't wrap
1824 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001826 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827
1828 *'complete'* *'cpt'* *E535*
1829'complete' 'cpt' string (default: ".,w,b,u,t,i")
1830 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 This option specifies how keyword completion |ins-completion| works
1832 when CTRL-P or CTRL-N are used. It is also used for whole-line
1833 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1834 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001835 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 w scan buffers from other windows
1837 b scan other loaded buffers that are in the buffer list
1838 u scan the unloaded buffers that are in the buffer list
1839 U scan the buffers that are not in the buffer list
1840 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001841 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 k{dict} scan the file {dict}. Several "k" flags can be given,
1843 patterns are valid too. For example: >
1844 :set cpt=k/usr/dict/*,k~/spanish
1845< s scan the files given with the 'thesaurus' option
1846 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1847 are valid too.
1848 i scan current and included files
1849 d scan current and included files for defined name or macro
1850 |i_CTRL-X_CTRL-D|
1851 ] tag completion
1852 t same as "]"
1853
1854 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1855 not executed, this may lead to unexpected completions from some files
1856 (gzipped files for example). Unloaded buffers are not scanned for
1857 whole-line completion.
1858
1859 The default is ".,w,b,u,t,i", which means to scan:
1860 1. the current buffer
1861 2. buffers in other windows
1862 3. other loaded buffers
1863 4. unloaded buffers
1864 5. tags
1865 6. included files
1866
1867 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001868 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1869 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001871 *'completefunc'* *'cfu'*
1872'completefunc' 'cfu' string (default: empty)
1873 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001874 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001875 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001876 This option specifies a function to be used for Insert mode completion
1877 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001878 See |complete-functions| for an explanation of how the function is
1879 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001880 This option cannot be set from a |modeline| or in the |sandbox|, for
1881 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001882
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001883 *'completeslash'* *'csl'*
1884'completeslash' 'csl' string (default: "")
1885 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001886 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001887 When this option is set it overrules 'shellslash' for completion:
1888 - When this option is set to "slash", a forward slash is used for path
1889 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001890 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001891 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001892 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001893 - When this option is empty, same character is used as for
1894 'shellslash'.
1895 For Insert mode completion the buffer-local value is used. For
1896 command line completion the global value is used.
1897
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001898 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001899'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001900 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001901 A comma separated list of options for Insert mode completion
1902 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001903
1904 menu Use a popup menu to show the possible completions. The
1905 menu is only shown when there is more than one match and
1906 sufficient colors are available. |ins-completion-menu|
1907
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001908 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001909 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001910 match, e.g., what file it comes from.
1911
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001912 longest Only insert the longest common text of the matches. If
1913 the menu is displayed you can use CTRL-L to add more
1914 characters. Whether case is ignored depends on the kind
1915 of completion. For buffer text the 'ignorecase' option is
1916 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001917
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001918 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001919 completion in the preview window. Only works in
1920 combination with "menu" or "menuone".
1921
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001922 popup Show extra information about the currently selected
1923 completion in a popup window. Only works in combination
1924 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001925 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001926 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001927
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001928 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001929 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001930 |CompleteChanged| autocommand to fetch the info and call
1931 |popup_show()| once the popup has been filled.
1932 See the example at |complete-popuphidden|.
1933 {only works when compiled with the |+textprop| feature}
1934
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001935 noinsert Do not insert any text for a match until the user selects
1936 a match from the menu. Only works in combination with
1937 "menu" or "menuone". No effect if "longest" is present.
1938
1939 noselect Do not select a match in the menu, force the user to
1940 select one from the menu. Only works in combination with
1941 "menu" or "menuone".
1942
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001943
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001944 *'completepopup'* *'cpp'*
1945'completepopup' 'cpp' string (default empty)
1946 global
1947 {not available when compiled without the |+textprop|
1948 or |+quickfix| feature}
1949 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001950 properties of the info popup when it is created. You can also use
1951 |popup_findinfo()| and then set properties for an existing info popup
1952 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001953
1954
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001955 *'concealcursor'* *'cocu'*
1956'concealcursor' 'cocu' string (default: "")
1957 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001958 {not available when compiled without the |+conceal|
1959 feature}
1960 Sets the modes in which text in the cursor line can also be concealed.
1961 When the current mode is listed then concealing happens just like in
1962 other lines.
1963 n Normal mode
1964 v Visual mode
1965 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001966 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001967
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001968 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001969 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001970 are moving around text is concealed, but when starting to insert text
1971 or selecting a Visual area the concealed text is displayed, so that
1972 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001973 Keep in mind that the cursor position is not always where it's
1974 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001975
1976
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001977 *'conceallevel'* *'cole'*
1978'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001979 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001980 {not available when compiled without the |+conceal|
1981 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001982 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1983 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001984
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001985 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001986 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001987 1 Each block of concealed text is replaced with one
1988 character. If the syntax item does not have a custom
1989 replacement character defined (see |:syn-cchar|) the
1990 character defined in 'listchars' is used (default is a
1991 space).
1992 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001993 2 Concealed text is completely hidden unless it has a
1994 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001995 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001996 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001997
Bram Moolenaara7781e02010-07-19 20:13:22 +02001998 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001999 edit and copy the text. This can be changed with the 'concealcursor'
2000 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002001
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2003'confirm' 'cf' boolean (default off)
2004 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 When 'confirm' is on, certain operations that would normally
2006 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2007 instead raise a |dialog| asking if you wish to save the current
2008 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2009 If 'confirm' is off you can still activate confirmation for one
2010 command only (this is most useful in mappings) with the |:confirm|
2011 command.
2012 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2013
2014 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2015'conskey' 'consk' boolean (default off)
2016 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002017 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018
2019 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2020'copyindent' 'ci' boolean (default off)
2021 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 Copy the structure of the existing lines indent when autoindenting a
2023 new line. Normally the new indent is reconstructed by a series of
2024 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2025 in which case only spaces are used). Enabling this option makes the
2026 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002027 existing line. 'expandtab' has no effect on these characters, a Tab
2028 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002030 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 Also see 'preserveindent'.
2032
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002033 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034'cpoptions' 'cpo' string (Vim default: "aABceFs",
2035 Vi default: all flags)
2036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002038 this indicates Vi-compatible behavior. This is used for things where
2039 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 'cpoptions' stands for "compatible-options".
2041 Commas can be added for readability.
2042 To avoid problems with flags that are added in the future, use the
2043 "+=" and "-=" feature of ":set" |add-option-flags|.
2044 NOTE: This option is set to the Vi default value when 'compatible' is
2045 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002046 NOTE: This option is set to the POSIX default value at startup when
2047 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002048 variable exists |posix|. This means Vim tries to behave like the
2049 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050
2051 contains behavior ~
2052 *cpo-a*
2053 a When included, a ":read" command with a file name
2054 argument will set the alternate file name for the
2055 current window.
2056 *cpo-A*
2057 A When included, a ":write" command with a file name
2058 argument will set the alternate file name for the
2059 current window.
2060 *cpo-b*
2061 b "\|" in a ":map" command is recognized as the end of
2062 the map command. The '\' is included in the mapping,
2063 the text after the '|' is interpreted as the next
2064 command. Use a CTRL-V instead of a backslash to
2065 include the '|' in the mapping. Applies to all
2066 mapping, abbreviation, menu and autocmd commands.
2067 See also |map_bar|.
2068 *cpo-B*
2069 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002070 abbreviations, user commands and the "to" part of the
2071 menu commands. Remove this flag to be able to use a
2072 backslash like a CTRL-V. For example, the command
2073 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 'B' included: "\^[" (^[ is a real <Esc>)
2075 'B' excluded: "<Esc>" (5 characters)
2076 ('<' excluded in both cases)
2077 *cpo-c*
2078 c Searching continues at the end of any match at the
2079 cursor position, but not further than the start of the
2080 next line. When not present searching continues
2081 one character from the cursor position. With 'c'
2082 "abababababab" only gets three matches when repeating
2083 "/abab", without 'c' there are five matches.
2084 *cpo-C*
2085 C Do not concatenate sourced lines that start with a
2086 backslash. See |line-continuation|.
2087 *cpo-d*
2088 d Using "./" in the 'tags' option doesn't mean to use
2089 the tags file relative to the current file, but the
2090 tags file in the current directory.
2091 *cpo-D*
2092 D Can't use CTRL-K to enter a digraph after Normal mode
2093 commands with a character argument, like |r|, |f| and
2094 |t|.
2095 *cpo-e*
2096 e When executing a register with ":@r", always add a
2097 <CR> to the last line, also when the register is not
2098 linewise. If this flag is not present, the register
2099 is not linewise and the last line does not end in a
2100 <CR>, then the last line is put on the command-line
2101 and can be edited before hitting <CR>.
2102 *cpo-E*
2103 E It is an error when using "y", "d", "c", "g~", "gu" or
2104 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002105 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 This makes "y0" fail in the first column.
2107 *cpo-f*
2108 f When included, a ":read" command with a file name
2109 argument will set the file name for the current buffer,
2110 if the current buffer doesn't have a file name yet.
2111 *cpo-F*
2112 F When included, a ":write" command with a file name
2113 argument will set the file name for the current
2114 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002115 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 *cpo-g*
2117 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002118 *cpo-H*
2119 H When using "I" on a line with only blanks, insert
2120 before the last blank. Without this flag insert after
2121 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 *cpo-i*
2123 i When included, interrupting the reading of a file will
2124 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002125 *cpo-I*
2126 I When moving the cursor up or down just after inserting
2127 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 *cpo-j*
2129 j When joining lines, only add two spaces after a '.',
2130 not after '!' or '?'. Also see 'joinspaces'.
2131 *cpo-J*
2132 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002133 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134 white space.
2135 *cpo-k*
2136 k Disable the recognition of raw key codes in
2137 mappings, abbreviations, and the "to" part of menu
2138 commands. For example, if <Key> sends ^[OA (where ^[
2139 is <Esc>), the command ":map X ^[OA" results in X
2140 being mapped to:
2141 'k' included: "^[OA" (3 characters)
2142 'k' excluded: "<Key>" (one key code)
2143 Also see the '<' flag below.
2144 *cpo-K*
2145 K Don't wait for a key code to complete when it is
2146 halfway a mapping. This breaks mapping <F1><F1> when
2147 only part of the second <F1> has been read. It
2148 enables cancelling the mapping by typing <F1><Esc>.
2149 *cpo-l*
2150 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002151 literally, only "\]", "\^", "\-" and "\\" are special.
2152 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2154 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002155 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 *cpo-L*
2157 L When the 'list' option is set, 'wrapmargin',
2158 'textwidth', 'softtabstop' and Virtual Replace mode
2159 (see |gR|) count a <Tab> as two characters, instead of
2160 the normal behavior of a <Tab>.
2161 *cpo-m*
2162 m When included, a showmatch will always wait half a
2163 second. When not included, a showmatch will wait half
2164 a second or until a character is typed. |'showmatch'|
2165 *cpo-M*
2166 M When excluded, "%" matching will take backslashes into
2167 account. Thus in "( \( )" and "\( ( \)" the outer
2168 parenthesis match. When included "%" ignores
2169 backslashes, which is Vi compatible.
2170 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002171 n When included, the column used for 'number' and
2172 'relativenumber' will also be used for text of wrapped
2173 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 *cpo-o*
2175 o Line offset to search command is not remembered for
2176 next search.
2177 *cpo-O*
2178 O Don't complain if a file is being overwritten, even
2179 when it didn't exist when editing it. This is a
2180 protection against a file unexpectedly created by
2181 someone else. Vi didn't complain about this.
2182 *cpo-p*
2183 p Vi compatible Lisp indenting. When not present, a
2184 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002185 *cpo-P*
2186 P When included, a ":write" command that appends to a
2187 file will set the file name for the current buffer, if
2188 the current buffer doesn't have a file name yet and
2189 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002190 *cpo-q*
2191 q When joining multiple lines leave the cursor at the
2192 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 *cpo-r*
2194 r Redo ("." command) uses "/" to repeat a search
2195 command, instead of the actually used search string.
2196 *cpo-R*
2197 R Remove marks from filtered lines. Without this flag
2198 marks are kept like |:keepmarks| was used.
2199 *cpo-s*
2200 s Set buffer options when entering the buffer for the
2201 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002202 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002203 set when the buffer is created.
2204 *cpo-S*
2205 S Set buffer options always when entering a buffer
2206 (except 'readonly', 'fileformat', 'filetype' and
2207 'syntax'). This is the (most) Vi compatible setting.
2208 The options are set to the values in the current
2209 buffer. When you change an option and go to another
2210 buffer, the value is copied. Effectively makes the
2211 buffer options global to all buffers.
2212
2213 's' 'S' copy buffer options
2214 no no when buffer created
2215 yes no when buffer first entered (default)
2216 X yes each time when buffer entered (vi comp.)
2217 *cpo-t*
2218 t Search pattern for the tag command is remembered for
2219 "n" command. Otherwise Vim only puts the pattern in
2220 the history for search pattern, but doesn't change the
2221 last used search pattern.
2222 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002223 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 *cpo-v*
2225 v Backspaced characters remain visible on the screen in
2226 Insert mode. Without this flag the characters are
2227 erased from the screen right away. With this flag the
2228 screen newly typed text overwrites backspaced
2229 characters.
2230 *cpo-w*
2231 w When using "cw" on a blank character, only change one
2232 character and not all blanks until the start of the
2233 next word.
2234 *cpo-W*
2235 W Don't overwrite a readonly file. When omitted, ":w!"
2236 overwrites a readonly file, if possible.
2237 *cpo-x*
2238 x <Esc> on the command-line executes the command-line.
2239 The default in Vim is to abandon the command-line,
2240 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002241 *cpo-X*
2242 X When using a count with "R" the replaced text is
2243 deleted only once. Also when repeating "R" with "."
2244 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002246 y A yank command can be redone with ".". Think twice if
2247 you really want to use this, it may break some
2248 plugins, since most people expect "." to only repeat a
2249 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002250 *cpo-Z*
2251 Z When using "w!" while the 'readonly' option is set,
2252 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 *cpo-!*
2254 ! When redoing a filter command, use the last used
2255 external command, whatever it was. Otherwise the last
2256 used -filter- command is used.
2257 *cpo-$*
2258 $ When making a change to one line, don't redisplay the
2259 line, but put a '$' at the end of the changed text.
2260 The changed text will be overwritten when you type the
2261 new text. The line is redisplayed if you type any
2262 command that moves the cursor from the insertion
2263 point.
2264 *cpo-%*
2265 % Vi-compatible matching is done for the "%" command.
2266 Does not recognize "#if", "#endif", etc.
2267 Does not recognize "/*" and "*/".
2268 Parens inside single and double quotes are also
2269 counted, causing a string that contains a paren to
2270 disturb the matching. For example, in a line like
2271 "if (strcmp("foo(", s))" the first paren does not
2272 match the last one. When this flag is not included,
2273 parens inside single and double quotes are treated
2274 specially. When matching a paren outside of quotes,
2275 everything inside quotes is ignored. When matching a
2276 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002277 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002278 This flag is also used for other features, such as
2279 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002280 *cpo--*
2281 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002282 it would go above the first line or below the last
2283 line. Without it the cursor moves to the first or
2284 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002285 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002286 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002287 *cpo-+*
2288 + When included, a ":write file" command will reset the
2289 'modified' flag of the buffer, even though the buffer
2290 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002291 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 * Use ":*" in the same way as ":@". When not included,
2293 ":*" is an alias for ":'<,'>", select the Visual area.
2294 *cpo-<*
2295 < Disable the recognition of special key codes in |<>|
2296 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002297 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 ":map X <Tab>" results in X being mapped to:
2299 '<' included: "<Tab>" (5 characters)
2300 '<' excluded: "^I" (^I is a real <Tab>)
2301 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002302 *cpo->*
2303 > When appending to a register, put a line break before
2304 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002305 *cpo-;*
2306 ; When using |,| or |;| to repeat the last |t| search
2307 and the cursor is right in front of the searched
2308 character, the cursor won't move. When not included,
2309 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002310 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002311
2312 POSIX flags. These are not included in the Vi default value, except
2313 when $VIM_POSIX was set on startup. |posix|
2314
2315 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002316 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002317 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002318 *cpo-&*
2319 & When ":preserve" was used keep the swap file when
2320 exiting normally while this buffer is still loaded.
2321 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002322 *cpo-\*
2323 \ Backslash in a [] range in a search pattern is taken
2324 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002325 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2326 '\' excluded: "/[ \-]" finds <Space> and '-'
2327 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002328 *cpo-/*
2329 / When "%" is used as the replacement string in a |:s|
2330 command, use the previous replacement string. |:s%|
2331 *cpo-{*
2332 { The |{| and |}| commands also stop at a "{" character
2333 at the start of a line.
2334 *cpo-.*
2335 . The ":chdir" and ":cd" commands fail if the current
2336 buffer is modified, unless ! is used. Vim doesn't
2337 need this, since it remembers the full path of an
2338 opened file.
2339 *cpo-bar*
2340 | The value of the $LINES and $COLUMNS environment
2341 variables overrule the terminal size values obtained
2342 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002343
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002345 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002346'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002347 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002348 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002349 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002350 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002351 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002352 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002353 blowfish Blowfish method. Medium strong encryption but it has
2354 an implementation flaw. Requires Vim 7.3 or later,
2355 files can NOT be read by Vim 7.2 and older. This adds
2356 a "seed" to the file, every time you write the file
2357 the encrypted bytes will be different.
2358 *blowfish2*
2359 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002360 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002361 and older. This adds a "seed" to the file, every time
2362 you write the file the encrypted bytes will be
2363 different. The whole undo file is encrypted, not just
2364 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002365
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002366 You should use "blowfish2", also to re-encrypt older files.
2367
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002368 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002369 to the detected method of the file being read. Thus if you write it
2370 without changing 'cryptmethod' the same method will be used.
2371 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002372 explicitly write it, you don't get a warning unless there are other
2373 modifications. Also see |:X|.
2374
2375 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002376 the value "blowfish2". When setting the local value to an empty
2377 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002378
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002379 When a new encryption method is added in a later version of Vim, and
2380 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002381 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002382
2383
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 *'cscopepathcomp'* *'cspc'*
2385'cscopepathcomp' 'cspc' number (default 0)
2386 global
2387 {not available when compiled without the |+cscope|
2388 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 Determines how many components of the path to show in a list of tags.
2390 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002391 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392
2393 *'cscopeprg'* *'csprg'*
2394'cscopeprg' 'csprg' string (default "cscope")
2395 global
2396 {not available when compiled without the |+cscope|
2397 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 Specifies the command to execute cscope. See |cscopeprg|.
2399 This option cannot be set from a |modeline| or in the |sandbox|, for
2400 security reasons.
2401
2402 *'cscopequickfix'* *'csqf'*
2403'cscopequickfix' 'csqf' string (default "")
2404 global
2405 {not available when compiled without the |+cscope|
2406 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 Specifies whether to use quickfix window to show cscope results.
2408 See |cscopequickfix|.
2409
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002410 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002411'cscoperelative' 'csre' boolean (default off)
2412 global
2413 {not available when compiled without the |+cscope|
2414 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002415 In the absence of a prefix (-P) for cscope. setting this option enables
2416 to use the basename of cscope.out path as the prefix.
2417 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002418 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002419
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2421'cscopetag' 'cst' boolean (default off)
2422 global
2423 {not available when compiled without the |+cscope|
2424 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425 Use cscope for tag commands. See |cscope-options|.
2426 NOTE: This option is reset when 'compatible' is set.
2427
2428 *'cscopetagorder'* *'csto'*
2429'cscopetagorder' 'csto' number (default 0)
2430 global
2431 {not available when compiled without the |+cscope|
2432 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 Determines the order in which ":cstag" performs a search. See
2434 |cscopetagorder|.
2435 NOTE: This option is set to 0 when 'compatible' is set.
2436
2437 *'cscopeverbose'* *'csverb'*
2438 *'nocscopeverbose'* *'nocsverb'*
2439'cscopeverbose' 'csverb' boolean (default off)
2440 global
2441 {not available when compiled without the |+cscope|
2442 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443 Give messages when adding a cscope database. See |cscopeverbose|.
2444 NOTE: This option is reset when 'compatible' is set.
2445
Bram Moolenaar860cae12010-06-05 23:22:07 +02002446 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2447'cursorbind' 'crb' boolean (default off)
2448 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002449 When this option is set, as the cursor in the current
2450 window moves other cursorbound windows (windows that also have
2451 this option set) move their cursors to the corresponding line and
2452 column. This option is useful for viewing the
2453 differences between two versions of a file (see 'diff'); in diff mode,
2454 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002455 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002456
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002457
2458 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2459'cursorcolumn' 'cuc' boolean (default off)
2460 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002461 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002462 feature}
2463 Highlight the screen column of the cursor with CursorColumn
2464 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2465 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002466 If you only want the highlighting in the current window you can use
2467 these autocommands: >
2468 au WinLeave * set nocursorline nocursorcolumn
2469 au WinEnter * set cursorline cursorcolumn
2470<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002471
2472 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2473'cursorline' 'cul' boolean (default off)
2474 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002475 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002476 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002477 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2478 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002479 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002480 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002481
2482
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002483 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002484'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002485 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002486 {not available when compiled without the |+syntax|
2487 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002488 Comma separated list of settings for how 'cursorline' is displayed.
2489 Valid values:
2490 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002491 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002492 "screenline" Highlight only the screen line of the cursor with
2493 CursorLine |hl-CursorLine|.
2494 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002495 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002496
2497 Special value:
2498 "both" Alias for the values "line,number".
2499
2500 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002501
2502
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 *'debug'*
2504'debug' string (default "")
2505 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002506 These values can be used:
2507 msg Error messages that would otherwise be omitted will be given
2508 anyway.
2509 throw Error messages that would otherwise be omitted will be given
2510 anyway and also throw an exception and set |v:errmsg|.
2511 beep A message will be given when otherwise only a beep would be
2512 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002513 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002514 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2515 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516
2517 *'define'* *'def'*
2518'define' 'def' string (default "^\s*#\s*define")
2519 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002520 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 pattern, just like for the "/" command. This option is used for the
2522 commands like "[i" and "[d" |include-search|. The 'isident' option is
2523 used to recognize the defined name after the match:
2524 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2525 See |option-backslash| about inserting backslashes to include a space
2526 or backslash.
2527 The default value is for C programs. For C++ this value would be
2528 useful, to include const type declarations: >
2529 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002530< You can also use "\ze" just before the name and continue the pattern
2531 to check what is following. E.g. for Javascript, if a function is
2532 defined with "func_name = function(args)": >
2533 ^\s*\ze\i\+\s*=\s*function(
2534< If the function is defined with "func_name : function() {...": >
2535 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002537 To avoid that use `:let` with a single quote string: >
2538 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002539<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540
2541 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2542'delcombine' 'deco' boolean (default off)
2543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 If editing Unicode and this option is set, backspace and Normal mode
2545 "x" delete each combining character on its own. When it is off (the
2546 default) the character along with its combining characters are
2547 deleted.
2548 Note: When 'delcombine' is set "xx" may work different from "2x"!
2549
2550 This is useful for Arabic, Hebrew and many other languages where one
2551 may have combining characters overtop of base characters, and want
2552 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002553 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554
2555 *'dictionary'* *'dict'*
2556'dictionary' 'dict' string (default "")
2557 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 List of file names, separated by commas, that are used to lookup words
2559 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2560 contain a list of words. This can be one word per line, or several
2561 words per line, separated by non-keyword characters (white space is
2562 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002563
2564 When this option is empty or an entry "spell" is present, and spell
2565 checking is enabled, words in the word lists for the currently active
2566 'spelllang' are used. See |spell|.
2567
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002568 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 after a comma are ignored, otherwise spaces are included in the file
2570 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002571 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 Where to find a list of words?
2573 - On FreeBSD, there is the file "/usr/share/dict/words".
2574 - In the Simtel archive, look in the "msdos/linguist" directory.
2575 - In "miscfiles" of the GNU collection.
2576 The use of |:set+=| and |:set-=| is preferred when adding or removing
2577 directories from the list. This avoids problems when a future version
2578 uses another default.
2579 Backticks cannot be used in this option for security reasons.
2580
2581 *'diff'* *'nodiff'*
2582'diff' boolean (default off)
2583 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 {not available when compiled without the |+diff|
2585 feature}
2586 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002587 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588
2589 *'dex'* *'diffexpr'*
2590'diffexpr' 'dex' string (default "")
2591 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 {not available when compiled without the |+diff|
2593 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002594 Expression which is evaluated to obtain a diff file (either ed-style
2595 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 This option cannot be set from a |modeline| or in the |sandbox|, for
2597 security reasons.
2598
2599 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002600'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 {not available when compiled without the |+diff|
2603 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002604 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 All are optional. Items must be separated by a comma.
2606
2607 filler Show filler lines, to keep the text
2608 synchronized with a window that has inserted
2609 lines at the same position. Mostly useful
2610 when windows are side-by-side and 'scrollbind'
2611 is set.
2612
2613 context:{n} Use a context of {n} lines between a change
2614 and a fold that contains unchanged lines.
2615 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002616 When using zero the context is actually one,
2617 since folds require a line in between, also
2618 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 See |fold-diff|.
2620
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002621 iblank Ignore changes where lines are all blank. Adds
2622 the "-B" flag to the "diff" command if
2623 'diffexpr' is empty. Check the documentation
2624 of the "diff" command for what this does
2625 exactly.
2626 NOTE: the diff windows will get out of sync,
2627 because no differences between blank lines are
2628 taken into account.
2629
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630 icase Ignore changes in case of text. "a" and "A"
2631 are considered the same. Adds the "-i" flag
2632 to the "diff" command if 'diffexpr' is empty.
2633
2634 iwhite Ignore changes in amount of white space. Adds
2635 the "-b" flag to the "diff" command if
2636 'diffexpr' is empty. Check the documentation
2637 of the "diff" command for what this does
2638 exactly. It should ignore adding trailing
2639 white space, but not leading white space.
2640
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002641 iwhiteall Ignore all white space changes. Adds
2642 the "-w" flag to the "diff" command if
2643 'diffexpr' is empty. Check the documentation
2644 of the "diff" command for what this does
2645 exactly.
2646
2647 iwhiteeol Ignore white space changes at end of line.
2648 Adds the "-Z" flag to the "diff" command if
2649 'diffexpr' is empty. Check the documentation
2650 of the "diff" command for what this does
2651 exactly.
2652
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002653 horizontal Start diff mode with horizontal splits (unless
2654 explicitly specified otherwise).
2655
2656 vertical Start diff mode with vertical splits (unless
2657 explicitly specified otherwise).
2658
Bram Moolenaarc8234772019-11-10 21:00:27 +01002659 closeoff When a window is closed where 'diff' is set
2660 and there is only one window remaining in the
2661 same tab page with 'diff' set, execute
2662 `:diffoff` in that window. This undoes a
2663 `:diffsplit` command.
2664
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002665 hiddenoff Do not use diff mode for a buffer when it
2666 becomes hidden.
2667
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002668 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2669 starting diff mode. Without this 2 is used.
2670
Bram Moolenaare828b762018-09-10 17:51:58 +02002671 internal Use the internal diff library. This is
2672 ignored when 'diffexpr' is set. *E960*
2673 When running out of memory when writing a
2674 buffer this item will be ignored for diffs
2675 involving that buffer. Set the 'verbose'
2676 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677
Bram Moolenaare828b762018-09-10 17:51:58 +02002678 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002679 Use the indent heuristic for the internal
2680 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002681
2682 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002683 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002684 algorithms are:
2685 myers the default algorithm
2686 minimal spend extra time to generate the
2687 smallest possible diff
2688 patience patience diff algorithm
2689 histogram histogram diff algorithm
2690
2691 Examples: >
2692 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002694 :set diffopt=internal,filler,foldcolumn:3
2695 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696<
2697 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2698'digraph' 'dg' boolean (default off)
2699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 {not available when compiled without the |+digraphs|
2701 feature}
2702 Enable the entering of digraphs in Insert mode with {char1} <BS>
2703 {char2}. See |digraphs|.
2704 NOTE: This option is reset when 'compatible' is set.
2705
2706 *'directory'* *'dir'*
2707'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002708 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 for Unix: ".,~/tmp,/var/tmp,/tmp")
2710 global
2711 List of directory names for the swap file, separated with commas.
2712 - The swap file will be created in the first directory where this is
2713 possible.
2714 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002715 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 - A directory "." means to put the swap file in the same directory as
2717 the edited file. On Unix, a dot is prepended to the file name, so
2718 it doesn't show in a directory listing. On MS-Windows the "hidden"
2719 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002720 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2721 the swap file relative to where the edited file is. The leading "."
2722 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002723 - For Unix and Win32, if a directory ends in two path separators "//",
2724 the swap file name will be built from the complete path to the file
2725 with all path separators substituted to percent '%' signs. This will
2726 ensure file name uniqueness in the preserve directory.
2727 On Win32, it is also possible to end with "\\". However, When a
2728 separating comma is following, you must use "//", since "\\" will
2729 include the comma in the file name. Therefore it is recommended to
2730 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 - Spaces after the comma are ignored, other spaces are considered part
2732 of the directory name. To have a space at the start of a directory
2733 name, precede it with a backslash.
2734 - To include a comma in a directory name precede it with a backslash.
2735 - A directory name may end in an ':' or '/'.
2736 - Environment variables are expanded |:set_env|.
2737 - Careful with '\' characters, type one before a space, type two to
2738 get one in the option (see |option-backslash|), for example: >
2739 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2740< - For backwards compatibility with Vim version 3.0 a '>' at the start
2741 of the option is removed.
2742 Using "." first in the list is recommended. This means that editing
2743 the same file twice will result in a warning. Using "/tmp" on Unix is
2744 discouraged: When the system crashes you lose the swap file.
2745 "/var/tmp" is often not cleared when rebooting, thus is a better
2746 choice than "/tmp". But it can contain a lot of files, your swap
2747 files get lost in the crowd. That is why a "tmp" directory in your
2748 home directory is tried first.
2749 The use of |:set+=| and |:set-=| is preferred when adding or removing
2750 directories from the list. This avoids problems when a future version
2751 uses another default.
2752 This option cannot be set from a |modeline| or in the |sandbox|, for
2753 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754
2755 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002756'display' 'dy' string (default "", set to "truncate" in
2757 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 Change the way text is displayed. This is comma separated list of
2760 flags:
2761 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002762 in a window will be displayed. "@@@" is put in the
2763 last columns of the last screen line to indicate the
2764 rest of the line is not displayed.
2765 truncate Like "lastline", but "@@@" is displayed in the first
2766 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 uhex Show unprintable characters hexadecimal as <xx>
2768 instead of using ^C and ~C.
2769
Bram Moolenaard0796902016-09-16 20:02:31 +02002770 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002771 doesn't fit is replaced with "@" lines.
2772
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 *'eadirection'* *'ead'*
2774'eadirection' 'ead' string (default "both")
2775 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 Tells when the 'equalalways' option applies:
2777 ver vertically, width of windows is not affected
2778 hor horizontally, height of windows is not affected
2779 both width and height of windows is affected
2780
2781 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2782'edcompatible' 'ed' boolean (default off)
2783 global
2784 Makes the 'g' and 'c' flags of the ":substitute" command to be
2785 toggled each time the flag is given. See |complex-change|. See
2786 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002787 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788
Bram Moolenaar03413f42016-04-12 21:07:15 +02002789 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002790'emoji' 'emo' boolean (default: on)
2791 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002792 When on all Unicode emoji characters are considered to be full width.
2793
2794
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 *'encoding'* *'enc'* *E543*
2796'encoding' 'enc' string (default: "latin1" or value from $LANG)
2797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 Sets the character encoding used inside Vim. It applies to text in
2799 the buffers, registers, Strings in expressions, text stored in the
2800 viminfo file, etc. It sets the kind of characters which Vim can work
2801 with. See |encoding-names| for the possible values.
2802
2803 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002804 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002806 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807
Bram Moolenaar865242e2010-07-14 21:12:05 +02002808 This option cannot be set from a |modeline|. It would most likely
2809 corrupt the text.
2810
Bram Moolenaar3df01732017-02-17 22:47:16 +01002811 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2812 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 'encoding', "utf-8" is the natural choice for the environment and
2814 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002815 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 versions, and to avoid changing the encoding of newly created files
2817 without your knowledge (in case 'fileencodings' is empty).
2818
2819 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002820 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 iconv() or as specified with 'charconvert'.
2822
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002823 If you need to know whether 'encoding' is a multi-byte encoding, you
2824 can use: >
2825 if has("multi_byte_encoding")
2826<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 Normally 'encoding' will be equal to your current locale. This will
2828 be the default if Vim recognizes your environment settings. If
2829 'encoding' is not set to the current locale, 'termencoding' must be
2830 set to convert typed and displayed text. See |encoding-table|.
2831
2832 When you set this option, it fires the |EncodingChanged| autocommand
2833 event so that you can set up fonts if necessary.
2834
2835 When the option is set, the value is converted to lowercase. Thus
2836 you can set it with uppercase values too. Underscores are translated
2837 to '-' signs.
2838 When the encoding is recognized, it is changed to the standard name.
2839 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2840 "iso-8859-2" and "utf8" becomes "utf-8".
2841
2842 Note: "latin1" is also used when the encoding could not be detected.
2843 This only works when editing files in the same encoding! When the
2844 actual character set is not latin1, make sure 'fileencoding' and
2845 'fileencodings' are empty. When conversion is needed, switch to using
2846 utf-8.
2847
2848 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2849 You don't notice this while editing, but it does matter for the
2850 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2851 setting 'encoding' to one of these values instead of utf-8 only has
2852 effect for encoding used for files when 'fileencoding' is empty.
2853
Bram Moolenaar661b1822005-07-28 22:36:45 +00002854 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2855 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856
2857 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2858'endofline' 'eol' boolean (default on)
2859 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002861 is on, or 'fixeol' option is off, no <EOL> will be written for the
2862 last line in the file. This option is automatically set or reset when
2863 starting to edit a new file, depending on whether file has an <EOL>
2864 for the last line in the file. Normally you don't have to set or
2865 reset this option.
2866 When 'binary' is off and 'fixeol' is on the value is not used when
2867 writing the file. When 'binary' is on or 'fixeol' is off it is used
2868 to remember the presence of a <EOL> for the last line in the file, so
2869 that when you write the file the situation from the original file can
2870 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871
2872 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2873'equalalways' 'ea' boolean (default on)
2874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002876 splitting or closing a window. This also happens the moment the
2877 option is switched on. When off, splitting a window will reduce the
2878 size of the current window and leave the other windows the same. When
2879 closing a window the extra lines are given to the window next to it
2880 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 When mixing vertically and horizontally split windows, a minimal size
2882 is computed and some windows may be larger if there is room. The
2883 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002884 Changing the height and width of a window can be avoided by setting
2885 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002886 If a window size is specified when creating a new window sizes are
2887 currently not equalized (it's complicated, but may be implemented in
2888 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889
2890 *'equalprg'* *'ep'*
2891'equalprg' 'ep' string (default "")
2892 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002894 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002895 or 'indentexpr'. When Vim was compiled without internal formatting,
2896 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002897 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 about including spaces and backslashes.
2899 This option cannot be set from a |modeline| or in the |sandbox|, for
2900 security reasons.
2901
2902 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2903'errorbells' 'eb' boolean (default off)
2904 global
2905 Ring the bell (beep or screen flash) for error messages. This only
2906 makes a difference for error messages, the bell will be used always
2907 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002908 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002909 screen flash or do nothing. See 'belloff' to finetune when to ring the
2910 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911
2912 *'errorfile'* *'ef'*
2913'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2914 others: "errors.err")
2915 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 {not available when compiled without the |+quickfix|
2917 feature}
2918 Name of the errorfile for the QuickFix mode (see |:cf|).
2919 When the "-q" command-line argument is used, 'errorfile' is set to the
2920 following argument. See |-q|.
2921 NOT used for the ":make" command. See 'makeef' for that.
2922 Environment variables are expanded |:set_env|.
2923 See |option-backslash| about including spaces and backslashes.
2924 This option cannot be set from a |modeline| or in the |sandbox|, for
2925 security reasons.
2926
2927 *'errorformat'* *'efm'*
2928'errorformat' 'efm' string (default is very long)
2929 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 {not available when compiled without the |+quickfix|
2931 feature}
2932 Scanf-like description of the format for the lines in the error file
2933 (see |errorformat|).
2934
2935 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2936'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 Function keys that start with an <Esc> are recognized in Insert
2939 mode. When this option is off, the cursor and function keys cannot be
2940 used in Insert mode if they start with an <Esc>. The advantage of
2941 this is that the single <Esc> is recognized immediately, instead of
2942 after one second. Instead of resetting this option, you might want to
2943 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2944 when 'esckeys' is off, you can still map anything, but the cursor keys
2945 won't work by default.
2946 NOTE: This option is set to the Vi default value when 'compatible' is
2947 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002948 NOTE: when this option is off then the |modifyOtherKeys| functionality
2949 is disabled while in Insert mode to avoid ending Insert mode with any
2950 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951
2952 *'eventignore'* *'ei'*
2953'eventignore' 'ei' string (default "")
2954 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002956 When set to "all" or when "all" is one of the items, all autocommand
2957 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 Otherwise this is a comma separated list of event names. Example: >
2959 :set ei=WinEnter,WinLeave
2960<
2961 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2962'expandtab' 'et' boolean (default off)
2963 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002965 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2967 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002968 This option is reset when the 'paste' option is set and restored when
2969 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 NOTE: This option is reset when 'compatible' is set.
2971
2972 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2973'exrc' 'ex' boolean (default off)
2974 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002976 directory.
2977
2978 Setting this option is a potential security leak. E.g., consider
2979 unpacking a package or fetching files from github, a .vimrc in there
2980 might be a trojan horse. BETTER NOT SET THIS OPTION!
2981 Instead, define an autocommand in your .vimrc to set options for a
2982 matching directory.
2983
2984 If you do switch this option on you should also consider setting the
2985 'secure' option (see |initialization|).
2986 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 This option cannot be set from a |modeline| or in the |sandbox|, for
2988 security reasons.
2989
2990 *'fileencoding'* *'fenc'* *E213*
2991'fileencoding' 'fenc' string (default: "")
2992 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002994
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002996 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 When 'fileencoding' is empty, the same value as 'encoding' will be
2998 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002999 No error will be given when the value is set, only when it is used,
3000 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003001 Conversion will also be done when 'encoding' and 'fileencoding' are
3002 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3003 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003005 'encoding' is "utf-8" or another Unicode encoding, conversion
3006 is most likely done in a way that the reverse conversion
3007 results in the same text. When 'encoding' is not "utf-8" some
3008 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003009
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 See 'encoding' for the possible values. Additionally, values may be
3011 specified that can be handled by the converter, see
3012 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003013
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 When reading a file 'fileencoding' will be set from 'fileencodings'.
3015 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003016 'fileencoding', use the |++enc| argument. One exception: when
3017 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003018 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003019
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3021 When the option is set, the value is converted to lowercase. Thus
3022 you can set it with uppercase values too. '_' characters are
3023 replaced with '-'. If a name is recognized from the list for
3024 'encoding', it is replaced by the standard name. For example
3025 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003026
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 When this option is set, after starting to edit a file, the 'modified'
3028 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003029
3030 Keep in mind that changing 'fenc' from a modeline happens
3031 AFTER the text has been read, thus it applies to when the file will be
3032 written. If you do set 'fenc' in a modeline, you might want to set
3033 'nomodified' to avoid not being able to ":q".
3034
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 This option can not be changed when 'modifiable' is off.
3036
3037 *'fe'*
3038 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003039 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 old short name was 'fe', which is no longer used.
3041
3042 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003043'fileencodings' 'fencs' string (default: "ucs-bom",
3044 "ucs-bom,utf-8,default,latin1" when
3045 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 This is a list of character encodings considered when starting to edit
3048 an existing file. When a file is read, Vim tries to use the first
3049 mentioned character encoding. If an error is detected, the next one
3050 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003051 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 an empty string, which means the value of 'encoding' is used.
3053 WARNING: Conversion can cause loss of information! When
3054 'encoding' is "utf-8" (or one of the other Unicode variants)
3055 conversion is most likely done in a way that the reverse
3056 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003057 "utf-8" some non-ASCII characters may be lost! You can use
3058 the |++bad| argument to specify what is done with characters
3059 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 For an empty file or a file with only ASCII characters most encodings
3061 will work and the first entry of 'fileencodings' will be used (except
3062 "ucs-bom", which requires the BOM to be present). If you prefer
3063 another encoding use an BufReadPost autocommand event to test if your
3064 preferred encoding is to be used. Example: >
3065 au BufReadPost * if search('\S', 'w') == 0 |
3066 \ set fenc=iso-2022-jp | endif
3067< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3068 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003069 When the |++enc| argument is used then the value of 'fileencodings' is
3070 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003071 Note that 'fileencodings' is not used for a new file, the global value
3072 of 'fileencoding' is used instead. You can set it with: >
3073 :setglobal fenc=iso-8859-2
3074< This means that a non-existing file may get a different encoding than
3075 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 The special value "ucs-bom" can be used to check for a Unicode BOM
3077 (Byte Order Mark) at the start of the file. It must not be preceded
3078 by "utf-8" or another Unicode encoding for this to work properly.
3079 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3080 because Vim cannot detect an error, thus the encoding is always
3081 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003082 The special value "default" can be used for the encoding from the
3083 environment. This is the default value for 'encoding'. It is useful
3084 when 'encoding' is set to "utf-8" and your environment uses a
3085 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003086 When 'encoding' is "utf-8" and a file contains an illegal byte
3087 sequence it won't be recognized as UTF-8. You can use the |8g8|
3088 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 WRONG VALUES: WHAT'S WRONG:
3090 latin1,utf-8 "latin1" will always be used
3091 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3092 file
3093 cp1250,latin1 "cp1250" will always be used
3094 If 'fileencodings' is empty, 'fileencoding' is not modified.
3095 See 'fileencoding' for the possible values.
3096 Setting this option does not have an effect until the next time a file
3097 is read.
3098
3099 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003100'fileformat' 'ff' string (MS-Windows default: "dos",
3101 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 This gives the <EOL> of the current buffer, which is used for
3104 reading/writing the buffer from/to a file:
3105 dos <CR> <NL>
3106 unix <NL>
3107 mac <CR>
3108 When "dos" is used, CTRL-Z at the end of a file is ignored.
3109 See |file-formats| and |file-read|.
3110 For the character encoding of the file see 'fileencoding'.
3111 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003112 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 This option is set automatically when starting to edit a file and
3114 'fileformats' is not empty and 'binary' is off.
3115 When this option is set, after starting to edit a file, the 'modified'
3116 option is set, because the file would be different when written.
3117 This option can not be changed when 'modifiable' is off.
3118 For backwards compatibility: When this option is set to "dos",
3119 'textmode' is set, otherwise 'textmode' is reset.
3120
3121 *'fileformats'* *'ffs'*
3122'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003123 Vim+Vi MS-Windows: "dos,unix",
3124 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 Vi Cygwin: "unix,dos",
3126 Vi others: "")
3127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 This gives the end-of-line (<EOL>) formats that will be tried when
3129 starting to edit a new buffer and when reading a file into an existing
3130 buffer:
3131 - When empty, the format defined with 'fileformat' will be used
3132 always. It is not set automatically.
3133 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003134 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 'fileformats' name will be used when a file is read into an existing
3136 buffer, no matter what 'fileformat' for that buffer is set to.
3137 - When more than one name is present, separated by commas, automatic
3138 <EOL> detection will be done when reading a file. When starting to
3139 edit a file, a check is done for the <EOL>:
3140 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3141 'fileformat' is set to "dos".
3142 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003143 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003145 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3146 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003147 This means that "mac" is only chosen when:
3148 "unix" is not present or no <NL> is found in the file, and
3149 "dos" is not present or no <CR><NL> is found in the file.
3150 Except: if "unix" was chosen, but there is a <CR> before
3151 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003152 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 4. If 'fileformat' is still not set, the first name from
3154 'fileformats' is used.
3155 When reading a file into an existing buffer, the same is done, but
3156 this happens like 'fileformat' has been set appropriately for that
3157 file only, the option is not changed.
3158 When 'binary' is set, the value of 'fileformats' is not used.
3159
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003160 When Vim starts up with an empty buffer the first item is used. You
3161 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003162
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3164 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3165 done:
3166 - When 'fileformats' is empty, there is no automatic detection. Dos
3167 format will be used.
3168 - When 'fileformats' is set to one or more names, automatic detection
3169 is done. This is based on the first <NL> in the file: If there is a
3170 <CR> in front of it, Dos format is used, otherwise Unix format is
3171 used.
3172 Also see |file-formats|.
3173 For backwards compatibility: When this option is set to an empty
3174 string or one format (no comma is included), 'textauto' is reset,
3175 otherwise 'textauto' is set.
3176 NOTE: This option is set to the Vi default value when 'compatible' is
3177 set and to the Vim default value when 'compatible' is reset.
3178
Bram Moolenaarbf884932013-04-05 22:26:15 +02003179 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3180'fileignorecase' 'fic' boolean (default on for systems where case in file
3181 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003182 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003183 When set case is ignored when using file names and directories.
3184 See 'wildignorecase' for only ignoring case when doing completion.
3185
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 *'filetype'* *'ft'*
3187'filetype' 'ft' string (default: "")
3188 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 When this option is set, the FileType autocommand event is triggered.
3190 All autocommands that match with the value of this option will be
3191 executed. Thus the value of 'filetype' is used in place of the file
3192 name.
3193 Otherwise this option does not always reflect the current file type.
3194 This option is normally set when the file type is detected. To enable
3195 this use the ":filetype on" command. |:filetype|
3196 Setting this option to a different value is most useful in a modeline,
3197 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003198 Example, for in an IDL file:
3199 /* vim: set filetype=idl : */ ~
3200 |FileType| |filetypes|
3201 When a dot appears in the value then this separates two filetype
3202 names. Example:
3203 /* vim: set filetype=c.doxygen : */ ~
3204 This will use the "c" filetype first, then the "doxygen" filetype.
3205 This works both for filetype plugins and for syntax files. More than
3206 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 This option is not copied to another buffer, independent of the 's' or
3208 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003209 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210
3211 *'fillchars'* *'fcs'*
3212'fillchars' 'fcs' string (default "vert:|,fold:-")
3213 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003214 {not available when compiled without the |+folding|
3215 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 Characters to fill the statuslines and vertical separators.
3217 It is a comma separated list of items:
3218
3219 item default Used for ~
3220 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003221 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 vert:c '|' vertical separators |:vsplit|
3223 fold:c '-' filling 'foldtext'
3224 diff:c '-' deleted lines of the 'diff' option
3225
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003226 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003227 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 otherwise.
3229
3230 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003231 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232< This is similar to the default, except that these characters will also
3233 be used when there is highlighting.
3234
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003235 for "stl" and "stlnc" only single-byte values are supported.
3236
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 The highlighting used for these items:
3238 item highlight group ~
3239 stl:c StatusLine |hl-StatusLine|
3240 stlnc:c StatusLineNC |hl-StatusLineNC|
3241 vert:c VertSplit |hl-VertSplit|
3242 fold:c Folded |hl-Folded|
3243 diff:c DiffDelete |hl-DiffDelete|
3244
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003245 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3246'fixendofline' 'fixeol' boolean (default on)
3247 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003248 When writing a file and this option is on, <EOL> at the end of file
3249 will be restored if missing. Turn this option off if you want to
3250 preserve the situation from the original file.
3251 When the 'binary' option is set the value of this option doesn't
3252 matter.
3253 See the 'endofline' option.
3254
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3256'fkmap' 'fk' boolean (default off) *E198*
3257 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 {only available when compiled with the |+rightleft|
3259 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003260 This option was for using Farsi, which has been removed. See
3261 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262
3263 *'foldclose'* *'fcl'*
3264'foldclose' 'fcl' string (default "")
3265 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 {not available when compiled without the |+folding|
3267 feature}
3268 When set to "all", a fold is closed when the cursor isn't in it and
3269 its level is higher than 'foldlevel'. Useful if you want folds to
3270 automatically close when moving out of them.
3271
3272 *'foldcolumn'* *'fdc'*
3273'foldcolumn' 'fdc' number (default 0)
3274 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 {not available when compiled without the |+folding|
3276 feature}
3277 When non-zero, a column with the specified width is shown at the side
3278 of the window which indicates open and closed folds. The maximum
3279 value is 12.
3280 See |folding|.
3281
3282 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3283'foldenable' 'fen' boolean (default on)
3284 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 {not available when compiled without the |+folding|
3286 feature}
3287 When off, all folds are open. This option can be used to quickly
3288 switch between showing all text unfolded and viewing the text with
3289 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003290 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 'foldenable' is off.
3292 This option is set by commands that create a new fold or close a fold.
3293 See |folding|.
3294
3295 *'foldexpr'* *'fde'*
3296'foldexpr' 'fde' string (default: "0")
3297 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003299 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003301 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003302
Bram Moolenaar30b65812012-07-12 22:01:11 +02003303 The expression will be evaluated in the |sandbox| if set from a
3304 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003305 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003306 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003307
3308 It is not allowed to change text or jump to another window while
3309 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310
3311 *'foldignore'* *'fdi'*
3312'foldignore' 'fdi' string (default: "#")
3313 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 {not available when compiled without the |+folding|
3315 feature}
3316 Used only when 'foldmethod' is "indent". Lines starting with
3317 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003318 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 The default "#" works well for C programs. See |fold-indent|.
3320
3321 *'foldlevel'* *'fdl'*
3322'foldlevel' 'fdl' number (default: 0)
3323 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 {not available when compiled without the |+folding|
3325 feature}
3326 Sets the fold level: Folds with a higher level will be closed.
3327 Setting this option to zero will close all folds. Higher numbers will
3328 close fewer folds.
3329 This option is set by commands like |zm|, |zM| and |zR|.
3330 See |fold-foldlevel|.
3331
3332 *'foldlevelstart'* *'fdls'*
3333'foldlevelstart' 'fdls' number (default: -1)
3334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 {not available when compiled without the |+folding|
3336 feature}
3337 Sets 'foldlevel' when starting to edit another buffer in a window.
3338 Useful to always start editing with all folds closed (value zero),
3339 some folds closed (one) or no folds closed (99).
3340 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003341 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 ignores this option and closes all folds.
3343 It is also done before BufReadPre autocommands, to allow an autocmd to
3344 overrule the 'foldlevel' value for specific files.
3345 When the value is negative, it is not used.
3346
3347 *'foldmarker'* *'fmr'* *E536*
3348'foldmarker' 'fmr' string (default: "{{{,}}}")
3349 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 {not available when compiled without the |+folding|
3351 feature}
3352 The start and end marker used when 'foldmethod' is "marker". There
3353 must be one comma, which separates the start and end marker. The
3354 marker is a literal string (a regular expression would be too slow).
3355 See |fold-marker|.
3356
3357 *'foldmethod'* *'fdm'*
3358'foldmethod' 'fdm' string (default: "manual")
3359 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 {not available when compiled without the |+folding|
3361 feature}
3362 The kind of folding used for the current window. Possible values:
3363 |fold-manual| manual Folds are created manually.
3364 |fold-indent| indent Lines with equal indent form a fold.
3365 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3366 |fold-marker| marker Markers are used to specify folds.
3367 |fold-syntax| syntax Syntax highlighting items specify folds.
3368 |fold-diff| diff Fold text that is not changed.
3369
3370 *'foldminlines'* *'fml'*
3371'foldminlines' 'fml' number (default: 1)
3372 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 {not available when compiled without the |+folding|
3374 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003375 Sets the number of screen lines above which a fold can be displayed
3376 closed. Also for manually closed folds. With the default value of
3377 one a fold can only be closed if it takes up two or more screen lines.
3378 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003379 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 "zc" to close a fold, which is displayed open because it's smaller
3381 than 'foldminlines', a following "zc" may close a containing fold.
3382
3383 *'foldnestmax'* *'fdn'*
3384'foldnestmax' 'fdn' number (default: 20)
3385 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 {not available when compiled without the |+folding|
3387 feature}
3388 Sets the maximum nesting of folds for the "indent" and "syntax"
3389 methods. This avoids that too many folds will be created. Using more
3390 than 20 doesn't work, because the internal limit is 20.
3391
3392 *'foldopen'* *'fdo'*
3393'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3394 search,tag,undo")
3395 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 {not available when compiled without the |+folding|
3397 feature}
3398 Specifies for which type of commands folds will be opened, if the
3399 command moves the cursor into a closed fold. It is a comma separated
3400 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003401 NOTE: When the command is part of a mapping this option is not used.
3402 Add the |zv| command to the mapping to get the same effect.
3403 (rationale: the mapping may want to control opening folds itself)
3404
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 item commands ~
3406 all any
3407 block "(", "{", "[[", "[{", etc.
3408 hor horizontal movements: "l", "w", "fx", etc.
3409 insert any command in Insert mode
3410 jump far jumps: "G", "gg", etc.
3411 mark jumping to a mark: "'m", CTRL-O, etc.
3412 percent "%"
3413 quickfix ":cn", ":crew", ":make", etc.
3414 search search for a pattern: "/", "n", "*", "gd", etc.
3415 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003416 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 tag jumping to a tag: ":ta", CTRL-T, etc.
3418 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 When a movement command is used for an operator (e.g., "dl" or "y%")
3420 this option is not used. This means the operator will include the
3421 whole closed fold.
3422 Note that vertical movements are not here, because it would make it
3423 very difficult to move onto a closed fold.
3424 In insert mode the folds containing the cursor will always be open
3425 when text is inserted.
3426 To close folds you can re-apply 'foldlevel' with the |zx| command or
3427 set the 'foldclose' option to "all".
3428
3429 *'foldtext'* *'fdt'*
3430'foldtext' 'fdt' string (default: "foldtext()")
3431 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 {not available when compiled without the |+folding|
3433 feature}
3434 An expression which is used to specify the text displayed for a closed
3435 fold. See |fold-foldtext|.
3436
Bram Moolenaar30b65812012-07-12 22:01:11 +02003437 The expression will be evaluated in the |sandbox| if set from a
3438 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003439 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003440
3441 It is not allowed to change text or jump to another window while
3442 evaluating 'foldtext' |textlock|.
3443
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003444 *'formatexpr'* *'fex'*
3445'formatexpr' 'fex' string (default "")
3446 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003447 {not available when compiled without the |+eval|
3448 feature}
3449 Expression which is evaluated to format a range of lines for the |gq|
3450 operator or automatic formatting (see 'formatoptions'). When this
3451 option is empty 'formatprg' is used.
3452
3453 The |v:lnum| variable holds the first line to be formatted.
3454 The |v:count| variable holds the number of lines to be formatted.
3455 The |v:char| variable holds the character that is going to be
3456 inserted if the expression is being evaluated due to
3457 automatic formatting. This can be empty. Don't insert
3458 it yet!
3459
3460 Example: >
3461 :set formatexpr=mylang#Format()
3462< This will invoke the mylang#Format() function in the
3463 autoload/mylang.vim file in 'runtimepath'. |autoload|
3464
3465 The expression is also evaluated when 'textwidth' is set and adding
3466 text beyond that limit. This happens under the same conditions as
3467 when internal formatting is used. Make sure the cursor is kept in the
3468 same spot relative to the text then! The |mode()| function will
3469 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003470
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003471 When the expression evaluates to non-zero Vim will fall back to using
3472 the internal format mechanism.
3473
3474 The expression will be evaluated in the |sandbox| when set from a
3475 modeline, see |sandbox-option|. That stops the option from working,
3476 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003477 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003478 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003479
Bram Moolenaar86b68352004-12-27 21:59:20 +00003480 *'formatlistpat'* *'flp'*
3481'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3482 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003483 A pattern that is used to recognize a list header. This is used for
3484 the "n" flag in 'formatoptions'.
3485 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003486 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003487 while still checking more characters. There must be a character
3488 following the pattern, when it matches the whole line it is handled
3489 like there is no match.
3490 The default recognizes a number, followed by an optional punctuation
3491 character and white space.
3492
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003493 *'formatoptions'* *'fo'*
3494'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3495 local to buffer
3496 This is a sequence of letters which describes how automatic
3497 formatting is to be done. See |fo-table|. When the 'paste' option is
3498 on, no formatting is done (like 'formatoptions' is empty). Commas can
3499 be inserted for readability.
3500 To avoid problems with flags that are added in the future, use the
3501 "+=" and "-=" feature of ":set" |add-option-flags|.
3502 NOTE: This option is set to the Vi default value when 'compatible' is
3503 set and to the Vim default value when 'compatible' is reset.
3504
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 *'formatprg'* *'fp'*
3506'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003507 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003509 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003511 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003512 If the 'formatexpr' option is not empty it will be used instead.
3513 Otherwise, if 'formatprg' option is an empty string, the internal
3514 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003515 Environment variables are expanded |:set_env|. See |option-backslash|
3516 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003517 This option cannot be set from a |modeline| or in the |sandbox|, for
3518 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519
Bram Moolenaard94464e2015-11-02 15:28:18 +01003520 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003521'fsync' 'fs' boolean (default on)
3522 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003523 When on, the library function fsync() will be called after writing a
3524 file. This will flush a file to disk, ensuring that it is safely
3525 written even on filesystems which do metadata-only journaling. This
3526 will force the harddrive to spin up on Linux systems running in laptop
3527 mode, so it may be undesirable in some situations. Be warned that
3528 turning this off increases the chances of data loss after a crash. On
3529 systems without an fsync() implementation, this variable is always
3530 off.
3531 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003532 'fsync' also applies to |writefile()|, unless a flag is used to
3533 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003534 This option cannot be set from a |modeline| or in the |sandbox|, for
3535 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003536
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3538'gdefault' 'gd' boolean (default off)
3539 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 When on, the ":substitute" flag 'g' is default on. This means that
3541 all matches in a line are substituted instead of one. When a 'g' flag
3542 is given to a ":substitute" command, this will toggle the substitution
3543 of all or one match. See |complex-change|.
3544
3545 command 'gdefault' on 'gdefault' off ~
3546 :s/// subst. all subst. one
3547 :s///g subst. one subst. all
3548 :s///gg subst. all subst. one
3549
3550 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003551 DEPRECATED: Setting this option may break plugins that are not aware
3552 of this option. Also, many users get confused that adding the /g flag
3553 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
3555 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003556'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 Format to recognize for the ":grep" command output.
3559 This is a scanf-like string that uses the same format as the
3560 'errorformat' option: see |errorformat|.
3561
3562 *'grepprg'* *'gp'*
3563'grepprg' 'gp' string (default "grep -n ",
3564 Unix: "grep -n $* /dev/null",
3565 Win32: "findstr /n" or "grep -n",
3566 VMS: "SEARCH/NUMBERS ")
3567 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003568 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 and '#' characters, which are expanded like when used in a command-
3570 line. The placeholder "$*" is allowed to specify where the arguments
3571 will be included. Environment variables are expanded |:set_env|. See
3572 |option-backslash| about including spaces and backslashes.
3573 When your "grep" accepts the "-H" argument, use this to make ":grep"
3574 also work well with a single file: >
3575 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003576< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003577 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3578 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003579 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 apply equally to 'grepprg'.
3581 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3582 otherwise it's "grep -n".
3583 This option cannot be set from a |modeline| or in the |sandbox|, for
3584 security reasons.
3585
3586 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3587'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3588 ve:ver35-Cursor,
3589 o:hor50-Cursor,
3590 i-ci:ver25-Cursor/lCursor,
3591 r-cr:hor20-Cursor/lCursor,
3592 sm:block-Cursor
3593 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003594 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 "n-v-c:block,o:hor50,i-ci:hor15,
3596 r-cr:hor30,sm:block")
3597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003599 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003601 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003602 height of the cursor can be changed. This can be done by specifying a
3603 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003604 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3605 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003607 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 mode-list and an argument-list:
3609 mode-list:argument-list,mode-list:argument-list,..
3610 The mode-list is a dash separated list of these modes:
3611 n Normal mode
3612 v Visual mode
3613 ve Visual mode with 'selection' "exclusive" (same as 'v',
3614 if not specified)
3615 o Operator-pending mode
3616 i Insert mode
3617 r Replace mode
3618 c Command-line Normal (append) mode
3619 ci Command-line Insert mode
3620 cr Command-line Replace mode
3621 sm showmatch in Insert mode
3622 a all modes
3623 The argument-list is a dash separated list of these arguments:
3624 hor{N} horizontal bar, {N} percent of the character height
3625 ver{N} vertical bar, {N} percent of the character width
3626 block block cursor, fills the whole character
3627 [only one of the above three should be present]
3628 blinkwait{N} *cursor-blinking*
3629 blinkon{N}
3630 blinkoff{N}
3631 blink times for cursor: blinkwait is the delay before
3632 the cursor starts blinking, blinkon is the time that
3633 the cursor is shown and blinkoff is the time that the
3634 cursor is not shown. The times are in msec. When one
3635 of the numbers is zero, there is no blinking. The
3636 default is: "blinkwait700-blinkon400-blinkoff250".
3637 These numbers are used for a missing entry. This
3638 means that blinking is enabled by default. To switch
3639 blinking off you can use "blinkon0". The cursor only
3640 blinks when Vim is waiting for input, not while
3641 executing a command.
3642 To make the cursor blink in an xterm, see
3643 |xterm-blink|.
3644 {group-name}
3645 a highlight group name, that sets the color and font
3646 for the cursor
3647 {group-name}/{group-name}
3648 Two highlight group names, the first is used when
3649 no language mappings are used, the other when they
3650 are. |language-mapping|
3651
3652 Examples of parts:
3653 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3654 block cursor with colors from the "nCursor"
3655 highlight group
3656 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3657 In Insert and Command-line Insert mode, use a
3658 30% vertical bar cursor with colors from the
3659 "iCursor" highlight group. Blink a bit
3660 faster.
3661
3662 The 'a' mode is different. It will set the given argument-list for
3663 all modes. It does not reset anything to defaults. This can be used
3664 to do a common setting for all modes. For example, to switch off
3665 blinking: "a:blinkon0"
3666
3667 Examples of cursor highlighting: >
3668 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3669 :highlight Cursor gui=NONE guifg=bg guibg=fg
3670<
3671 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003672 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673'guifont' 'gfn' string (default "")
3674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 {only available when compiled with GUI enabled}
3676 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003677 In its simplest form the value is just one font name.
3678 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679
3680 *'guifontset'* *'gfs'*
3681 *E250* *E252* *E234* *E597* *E598*
3682'guifontset' 'gfs' string (default "")
3683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 {only available when compiled with GUI enabled and
3685 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003686 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 When not empty, specifies two (or more) fonts to be used. The first
3688 one for normal English, the second one for your special language. See
3689 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003690
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3692'guifontwide' 'gfw' string (default "")
3693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 {only available when compiled with GUI enabled}
3695 When not empty, specifies a comma-separated list of fonts to be used
3696 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003697 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003698
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 *'guiheadroom'* *'ghr'*
3700'guiheadroom' 'ghr' number (default 50)
3701 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003702 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 The number of pixels subtracted from the screen height when fitting
3704 the GUI window on the screen. Set this before the GUI is started,
3705 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003706 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 lines will be left for window decorations and other items on the
3708 screen. Set it to a negative value to allow windows taller than the
3709 screen.
3710
3711 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003712'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3713 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003714 "aegimrLtT" (GTK, Motif and Athena),
3715 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003718 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 sequence of letters which describes what components and options of the
3720 GUI should be used.
3721 To avoid problems with flags that are added in the future, use the
3722 "+=" and "-=" feature of ":set" |add-option-flags|.
3723
Bram Moolenaar13568252018-03-16 20:46:58 +01003724 Valid characters are as follows:
3725 *'go-!'*
3726 '!' External commands are executed in a terminal window. Without
3727 this flag the MS-Windows GUI will open a console window to
3728 execute the command. The Unix GUI will simulate a dumb
3729 terminal to list the command output.
3730 The terminal window will be positioned at the bottom, and grow
3731 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003732 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 'a' Autoselect: If present, then whenever VISUAL mode is started,
3734 or the Visual area extended, Vim tries to become the owner of
3735 the windowing system's global selection. This means that the
3736 Visually highlighted text is available for pasting into other
3737 applications as well as into Vim itself. When the Visual mode
3738 ends, possibly due to an operation on the text, or when an
3739 application wants to paste the selection, the highlighted text
3740 is automatically yanked into the "* selection register.
3741 Thus the selection is still available for pasting into other
3742 applications after the VISUAL mode has ended.
3743 If not present, then Vim won't become the owner of the
3744 windowing system's global selection unless explicitly told to
3745 by a yank or delete operation for the "* register.
3746 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003747 *'go-P'*
3748 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003749 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003750 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003751 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 applies to the modeless selection.
3753
3754 'guioptions' autoselect Visual autoselect modeless ~
3755 "" - -
3756 "a" yes yes
3757 "A" - yes
3758 "aA" yes yes
3759
Bram Moolenaar02467872007-05-06 13:22:01 +00003760 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 'c' Use console dialogs instead of popup dialogs for simple
3762 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003763 *'go-d'*
3764 'd' Use dark theme variant if available. Currently only works for
3765 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003766 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003767 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003768 'guitablabel' can be used to change the text in the labels.
3769 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003770 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003771 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003772 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 'f' Foreground: Don't use fork() to detach the GUI from the shell
3774 where it was started. Use this for programs that wait for the
3775 editor to finish (e.g., an e-mail program). Alternatively you
3776 can use "gvim -f" or ":gui -f" to start the GUI in the
3777 foreground. |gui-fork|
3778 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003779 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003780 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3782 corner of the window. It's black&white on non-GTK, because of
3783 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003784 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003786 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003787 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003789 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003791 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003792 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 'g' Grey menu items: Make menu items that are not active grey. If
3794 'g' is not included inactive menu items are not shown at all.
3795 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003796 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 't' Include tearoff menu items. Currently only works for Win32,
3798 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003799 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003800 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003801 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003802 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003804 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 'R' Right-hand scrollbar is present when there is a vertically
3806 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003807 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003809 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 'L' Left-hand scrollbar is present when there is a vertically
3811 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003812 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3814 the longest visible line, or on the cursor line if the 'h'
3815 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003816 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 'h' Limit horizontal scrollbar size to the length of the cursor
3818 line. Reduces computations. |gui-horiz-scroll|
3819
3820 And yes, you may even have scrollbars on the left AND the right if
3821 you really want to :-). See |gui-scrollbars| for more information.
3822
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003823 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 'v' Use a vertical button layout for dialogs. When not included,
3825 a horizontal layout is preferred, but when it doesn't fit a
3826 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003827 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 'p' Use Pointer callbacks for X11 GUI. This is required for some
3829 window managers. If the cursor is not blinking or hollow at
3830 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003831 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003833 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003834 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003835 *'go-k'*
3836 'k' Keep the GUI window size when adding/removing a scrollbar, or
3837 toolbar, tabline, etc. Instead, the behavior is similar to
3838 when the window is maximized and will adjust 'lines' and
3839 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003840 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003841 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003842
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 *'guipty'* *'noguipty'*
3844'guipty' boolean (default on)
3845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 {only available when compiled with GUI enabled}
3847 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3848 I/O to/from shell commands. See |gui-pty|.
3849
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003850 *'guitablabel'* *'gtl'*
3851'guitablabel' 'gtl' string (default empty)
3852 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003853 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003854 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003855 pages line. When empty and when the result is empty Vim will use a
3856 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003857
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003858 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003859 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003860 The expression will be evaluated in the |sandbox| when set from a
3861 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003862 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003863
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003864 Only used when the GUI tab pages line is displayed. 'e' must be
3865 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3866 used.
3867
Bram Moolenaar57657d82006-04-21 22:12:41 +00003868 *'guitabtooltip'* *'gtt'*
3869'guitabtooltip' 'gtt' string (default empty)
3870 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003871 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003872 When nonempty describes the text to use in a tooltip for the GUI tab
3873 pages line. When empty Vim will use a default tooltip.
3874 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003875 You can include a line break. Simplest method is to use |:let|: >
3876 :let &guitabtooltip = "line one\nline two"
3877<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003878
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003880'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 (others) "$VIMRUNTIME/doc/help.txt")
3882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 Name of the main help file. All distributed help files should be
3884 placed together in one directory. Additionally, all "doc" directories
3885 in 'runtimepath' will be used.
3886 Environment variables are expanded |:set_env|. For example:
3887 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003888 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 spaces and backslashes.
3890 This option cannot be set from a |modeline| or in the |sandbox|, for
3891 security reasons.
3892
3893 *'helpheight'* *'hh'*
3894'helpheight' 'hh' number (default 20)
3895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 Minimal initial height of the help window when it is opened with the
3897 ":help" command. The initial height of the help window is half of the
3898 current window, or (when the 'ea' option is on) the same as other
3899 windows. When the height is less than 'helpheight', the height is
3900 set to 'helpheight'. Set to zero to disable.
3901
3902 *'helplang'* *'hlg'*
3903'helplang' 'hlg' string (default: messages language or empty)
3904 global
3905 {only available when compiled with the |+multi_lang|
3906 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 Comma separated list of languages. Vim will use the first language
3908 for which the desired help can be found. The English help will always
3909 be used as a last resort. You can add "en" to prefer English over
3910 another language, but that will only find tags that exist in that
3911 language and not in the English help.
3912 Example: >
3913 :set helplang=de,it
3914< This will first search German, then Italian and finally English help
3915 files.
3916 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3917 try to find the tag in the current language before using this option.
3918 See |help-translated|.
3919
3920 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3921'hidden' 'hid' boolean (default off)
3922 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 When off a buffer is unloaded when it is |abandon|ed. When on a
3924 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3925 displayed in another window, it does not become hidden, of course.
3926 The commands that move through the buffer list sometimes make a buffer
3927 hidden although the 'hidden' option is off: When the buffer is
3928 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003929 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003930 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 This option is set for one command with ":hide {command}" |:hide|.
3932 WARNING: It's easy to forget that you have changes in hidden buffers.
3933 Think twice when using ":q!" or ":qa!".
3934
3935 *'highlight'* *'hl'*
3936'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003937 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3938 d:Directory,e:ErrorMsg,i:IncSearch,
3939 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003940 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003941 N:CursorLineNr,r:Question,s:StatusLine,
3942 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003943 v:Visual,V:VisualNOS,w:WarningMsg,
3944 W:WildMenu,f:Folded,F:FoldColumn,
3945 A:DiffAdd,C:DiffChange,D:DiffDelete,
3946 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003947 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003948 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003949 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3950 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003951 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003952 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 This option can be used to set highlighting mode for various
3955 occasions. It is a comma separated list of character pairs. The
3956 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003957 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003959 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3960 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 characters from 'showbreak'
3962 |hl-Directory| d directories in CTRL-D listing and other special
3963 things in listings
3964 |hl-ErrorMsg| e error messages
3965 h (obsolete, ignored)
3966 |hl-IncSearch| i 'incsearch' highlighting
3967 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3968 |hl-MoreMsg| m |more-prompt|
3969 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003970 |hl-LineNr| n line number for ":number" and ":#" commands, and
3971 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003972 |hl-LineNrAbove| a line number above the cursor for when the
3973 'relativenumber' option is set.
3974 |hl-LineNrBelow| b line number below the cursor for when the
3975 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003976 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3977 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 |hl-Question| r |hit-enter| prompt and yes/no questions
3979 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003980 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3982 |hl-VertSplit| c column used to separate vertically split windows
3983 |hl-Visual| v Visual mode
3984 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3985 Selection" Only X11 Gui's |gui-x11| and
3986 |xterm-clipboard|.
3987 |hl-WarningMsg| w warning messages
3988 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3989 |hl-Folded| f line used for closed folds
3990 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003991 |hl-DiffAdd| A added line in diff mode
3992 |hl-DiffChange| C changed line in diff mode
3993 |hl-DiffDelete| D deleted line in diff mode
3994 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003996 |hl-Conceal| - the placeholders used for concealed characters
3997 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003998 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003999 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004000 |hl-SpellRare| R rare word |spell|
4001 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004002 |hl-Pmenu| + popup menu normal line
4003 |hl-PmenuSel| = popup menu selected line
4004 |hl-PmenuSbar| x popup menu scrollbar
4005 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006
4007 The display modes are:
4008 r reverse (termcap entry "mr" and "me")
4009 i italic (termcap entry "ZH" and "ZR")
4010 b bold (termcap entry "md" and "me")
4011 s standout (termcap entry "so" and "se")
4012 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004013 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004014 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 n no highlighting
4016 - no highlighting
4017 : use a highlight group
4018 The default is used for occasions that are not included.
4019 If you want to change what the display modes do, see |dos-colors|
4020 for an example.
4021 When using the ':' display mode, this must be followed by the name of
4022 a highlight group. A highlight group can be used to define any type
4023 of highlighting, including using color. See |:highlight| on how to
4024 define one. The default uses a different group for each occasion.
4025 See |highlight-default| for the default highlight groups.
4026
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004028'history' 'hi' number (Vim default: 50, Vi default: 0,
4029 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004032 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004034 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 NOTE: This option is set to the Vi default value when 'compatible' is
4036 set and to the Vim default value when 'compatible' is reset.
4037
4038 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4039'hkmap' 'hk' boolean (default off)
4040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 {only available when compiled with the |+rightleft|
4042 feature}
4043 When on, the keyboard is mapped for the Hebrew character set.
4044 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4045 toggle this option. See |rileft.txt|.
4046 NOTE: This option is reset when 'compatible' is set.
4047
4048 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4049'hkmapp' 'hkp' boolean (default off)
4050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 {only available when compiled with the |+rightleft|
4052 feature}
4053 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4054 This is useful if you have a non-Hebrew keyboard.
4055 See |rileft.txt|.
4056 NOTE: This option is reset when 'compatible' is set.
4057
Bram Moolenaar036986f2017-03-16 17:41:02 +01004058 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4059'hlsearch' 'hls' boolean (default off)
4060 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004061 {not available when compiled without the
4062 |+extra_search| feature}
4063 When there is a previous search pattern, highlight all its matches.
4064 The type of highlighting used can be set with the 'l' occasion in the
4065 'highlight' option. This uses the "Search" highlight group by
4066 default. Note that only the matching text is highlighted, any offsets
4067 are not applied.
4068 See also: 'incsearch' and |:match|.
4069 When you get bored looking at the highlighted matches, you can turn it
4070 off with |:nohlsearch|. This does not change the option value, as
4071 soon as you use a search command, the highlighting comes back.
4072 'redrawtime' specifies the maximum time spent on finding matches.
4073 When the search pattern can match an end-of-line, Vim will try to
4074 highlight all of the matched text. However, this depends on where the
4075 search starts. This will be the first line in the window or the first
4076 line below a closed fold. A match in a previous line which is not
4077 drawn may not continue in a newly drawn line.
4078 You can specify whether the highlight status is restored on startup
4079 with the 'h' flag in 'viminfo' |viminfo-h|.
4080 NOTE: This option is reset when 'compatible' is set.
4081
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 *'icon'* *'noicon'*
4083'icon' boolean (default off, on when title can be restored)
4084 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 {not available when compiled without the |+title|
4086 feature}
4087 When on, the icon text of the window will be set to the value of
4088 'iconstring' (if it is not empty), or to the name of the file
4089 currently being edited. Only the last part of the name is used.
4090 Overridden by the 'iconstring' option.
4091 Only works if the terminal supports setting window icons (currently
4092 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4093 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4094 builtin termcap).
4095 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004096 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004098 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099
4100 *'iconstring'*
4101'iconstring' string (default "")
4102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 {not available when compiled without the |+title|
4104 feature}
4105 When this option is not empty, it will be used for the icon text of
4106 the window. This happens only when the 'icon' option is on.
4107 Only works if the terminal supports setting window icon text
4108 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4109 Does not work for MS Windows.
4110 When Vim was compiled with HAVE_X11 defined, the original icon will be
4111 restored if possible |X11|.
4112 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004113 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004115 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 {not available when compiled without the |+statusline| feature}
4117
4118 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4119'ignorecase' 'ic' boolean (default off)
4120 global
4121 Ignore case in search patterns. Also used when searching in the tags
4122 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004123 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 Can be overruled by using "\c" or "\C" in the pattern, see
4125 |/ignorecase|.
4126
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004127 *'imactivatefunc'* *'imaf'*
4128'imactivatefunc' 'imaf' string (default "")
4129 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004130 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004131 activate or deactivate the Input Method.
4132 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004133 The expression will be evaluated in the |sandbox| when set from a
4134 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004135
4136 Example: >
4137 function ImActivateFunc(active)
4138 if a:active
4139 ... do something
4140 else
4141 ... do something
4142 endif
4143 " return value is not used
4144 endfunction
4145 set imactivatefunc=ImActivateFunc
4146<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 *'imactivatekey'* *'imak'*
4148'imactivatekey' 'imak' string (default "")
4149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004151 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 Specifies the key that your Input Method in X-Windows uses for
4153 activation. When this is specified correctly, vim can fully control
4154 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4155 You can't use this option to change the activation key, the option
4156 tells Vim what the key is.
4157 Format:
4158 [MODIFIER_FLAG-]KEY_STRING
4159
4160 These characters can be used for MODIFIER_FLAG (case is ignored):
4161 S Shift key
4162 L Lock key
4163 C Control key
4164 1 Mod1 key
4165 2 Mod2 key
4166 3 Mod3 key
4167 4 Mod4 key
4168 5 Mod5 key
4169 Combinations are allowed, for example "S-C-space" or "SC-space" are
4170 both shift+ctrl+space.
4171 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4172
4173 Example: >
4174 :set imactivatekey=S-space
4175< "S-space" means shift+space. This is the activation key for kinput2 +
4176 canna (Japanese), and ami (Korean).
4177
4178 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4179'imcmdline' 'imc' boolean (default off)
4180 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 When set the Input Method is always on when starting to edit a command
4182 line, unless entering a search pattern (see 'imsearch' for that).
4183 Setting this option is useful when your input method allows entering
4184 English characters directly, e.g., when it's used to type accented
4185 characters with dead keys.
4186
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004187 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 When set the Input Method is never used. This is useful to disable
4191 the IM when it doesn't work properly.
4192 Currently this option is on by default for SGI/IRIX machines. This
4193 may change in later releases.
4194
4195 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004196'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 Specifies whether :lmap or an Input Method (IM) is to be used in
4199 Insert mode. Valid values:
4200 0 :lmap is off and IM is off
4201 1 :lmap is ON and IM is off
4202 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 To always reset the option to zero when leaving Insert mode with <Esc>
4204 this can be used: >
4205 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4206< This makes :lmap and IM turn off automatically when leaving Insert
4207 mode.
4208 Note that this option changes when using CTRL-^ in Insert mode
4209 |i_CTRL-^|.
4210 The value is set to 1 when setting 'keymap' to a valid keymap name.
4211 It is also used for the argument of commands like "r" and "f".
4212 The value 0 may not work correctly with Athena and Motif with some XIM
4213 methods. Use 'imdisable' to disable XIM then.
4214
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004215 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004216 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004217 |+multi_byte_ime| or |global-ime|.
4218
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004220'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 Specifies whether :lmap or an Input Method (IM) is to be used when
4223 entering a search pattern. Valid values:
4224 -1 the value of 'iminsert' is used, makes it look like
4225 'iminsert' is also used when typing a search pattern
4226 0 :lmap is off and IM is off
4227 1 :lmap is ON and IM is off
4228 2 :lmap is off and IM is ON
4229 Note that this option changes when using CTRL-^ in Command-line mode
4230 |c_CTRL-^|.
4231 The value is set to 1 when it is not -1 and setting the 'keymap'
4232 option to a valid keymap name.
4233 The value 0 may not work correctly with Athena and Motif with some XIM
4234 methods. Use 'imdisable' to disable XIM then.
4235
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004236 *'imstatusfunc'* *'imsf'*
4237'imstatusfunc' 'imsf' string (default "")
4238 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004239 This option specifies a function that is called to obtain the status
4240 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004241 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004242
4243 Example: >
4244 function ImStatusFunc()
4245 let is_active = ...do something
4246 return is_active ? 1 : 0
4247 endfunction
4248 set imstatusfunc=ImStatusFunc
4249<
4250 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004251 The expression will be evaluated in the |sandbox| when set from a
4252 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004253
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004254 *'imstyle'* *'imst'*
4255'imstyle' 'imst' number (default 1)
4256 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004257 {only available when compiled with |+xim| and
4258 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004259 This option specifies the input style of Input Method:
4260 0 use on-the-spot style
4261 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004262 See: |xim-input-style|
4263
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004264 For a long time on-the-spot style had been used in the GTK version of
4265 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004266 |single-repeat|, etc. Therefore over-the-spot style becomes the
4267 default now. This should work fine for most people, however if you
4268 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004269 The expression will be evaluated in the |sandbox| when set from a
4270 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004271
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 *'include'* *'inc'*
4273'include' 'inc' string (default "^\s*#\s*include")
4274 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 {not available when compiled without the
4276 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004277 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 pattern, just like for the "/" command (See |pattern|). The default
4279 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004280 "]I", "[d", etc.
4281 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004282 comes after the matched pattern. But if "\zs" appears in the pattern
4283 then the text matched from "\zs" to the end, or until "\ze" if it
4284 appears, is used as the file name. Use this to include characters
4285 that are not in 'isfname', such as a space. You can then use
4286 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004287 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288
4289 *'includeexpr'* *'inex'*
4290'includeexpr' 'inex' string (default "")
4291 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004293 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004295 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 :set includeexpr=substitute(v:fname,'\\.','/','g')
4297< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004298
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004300 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 Also used for |<cfile>|.
4302
Bram Moolenaar30b65812012-07-12 22:01:11 +02004303 The expression will be evaluated in the |sandbox| when set from a
4304 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004305 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004306
4307 It is not allowed to change text or jump to another window while
4308 evaluating 'includeexpr' |textlock|.
4309
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004311'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4312 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004315 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004316 While typing a search command, show where the pattern, as it was typed
4317 so far, matches. The matched string is highlighted. If the pattern
4318 is invalid or not found, nothing is shown. The screen will be updated
4319 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004320 Also applies to the pattern in commands: >
4321 :global
4322 :lvimgrep
4323 :lvimgrepadd
4324 :smagic
4325 :snomagic
4326 :sort
4327 :substitute
4328 :vglobal
4329 :vimgrep
4330 :vimgrepadd
4331< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004332 original position when no match is found and when pressing <Esc>. You
4333 still need to finish the search command with <Enter> to move the
4334 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004335 You can use the CTRL-G and CTRL-T keys to move to the next and
4336 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004337 When compiled with the |+reltime| feature Vim only searches for about
4338 half a second. With a complicated pattern and/or a lot of text the
4339 match may not be found. This is to avoid that Vim hangs while you
4340 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004341 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004342 When 'hlsearch' is on, all matched strings are highlighted too while
4343 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004344 If you don't want to turn 'hlsearch' on, but want to highlight all
4345 matches while searching, you can turn on and off 'hlsearch' with
4346 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004347 augroup vimrc-incsearch-highlight
4348 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004349 autocmd CmdlineEnter /,\? :set hlsearch
4350 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004351 augroup END
4352<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004353 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004354 to the command line. If 'ignorecase' and 'smartcase' are set and the
4355 command line has no uppercase characters, the added character is
4356 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004357 CTRL-R CTRL-W can be used to add the word at the end of the current
4358 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 NOTE: This option is reset when 'compatible' is set.
4360
4361 *'indentexpr'* *'inde'*
4362'indentexpr' 'inde' string (default "")
4363 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 {not available when compiled without the |+cindent|
4365 or |+eval| features}
4366 Expression which is evaluated to obtain the proper indent for a line.
4367 It is used when a new line is created, for the |=| operator and
4368 in Insert mode as specified with the 'indentkeys' option.
4369 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004370 'smartindent' indenting. When 'lisp' is set, this option is
4371 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 When 'paste' is set this option is not used for indenting.
4373 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004374 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 when the expression is evaluated (but it may be moved around).
4376 The expression must return the number of spaces worth of indent. It
4377 can return "-1" to keep the current indent (this means 'autoindent' is
4378 used for the indent).
4379 Functions useful for computing the indent are |indent()|, |cindent()|
4380 and |lispindent()|.
4381 The evaluation of the expression must not have side effects! It must
4382 not change the text, jump to another window, etc. Afterwards the
4383 cursor position is always restored, thus the cursor may be moved.
4384 Normally this option would be set to call a function: >
4385 :set indentexpr=GetMyIndent()
4386< Error messages will be suppressed, unless the 'debug' option contains
4387 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004388 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004389 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390
Bram Moolenaar30b65812012-07-12 22:01:11 +02004391 The expression will be evaluated in the |sandbox| when set from a
4392 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004393 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004394
4395 It is not allowed to change text or jump to another window while
4396 evaluating 'indentexpr' |textlock|.
4397
4398
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004400'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 {not available when compiled without the |+cindent|
4403 feature}
4404 A list of keys that, when typed in Insert mode, cause reindenting of
4405 the current line. Only happens if 'indentexpr' isn't empty.
4406 The format is identical to 'cinkeys', see |indentkeys-format|.
4407 See |C-indenting| and |indent-expression|.
4408
4409 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4410'infercase' 'inf' boolean (default off)
4411 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004413 'ignorecase' is also on, the case of the match is adjusted depending
4414 on the typed text. If the typed text contains a lowercase letter
4415 where the match has an upper case letter, the completed part is made
4416 lowercase. If the typed text has no lowercase letters and the match
4417 has a lowercase letter where the typed text has an uppercase letter,
4418 and there is a letter before it, the completed part is made uppercase.
4419 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420
4421 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4422'insertmode' 'im' boolean (default off)
4423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 Makes Vim work in a way that Insert mode is the default mode. Useful
4425 if you want to use Vim as a modeless editor. Used for |evim|.
4426 These Insert mode commands will be useful:
4427 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004428 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 this is a mapping, it is executed as if 'insertmode' was off.
4430 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004432 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4433 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434
4435 These items change when 'insertmode' is set:
4436 - when starting to edit of a file, Vim goes to Insert mode.
4437 - <Esc> in Insert mode is a no-op and beeps.
4438 - <Esc> in Normal mode makes Vim go to Insert mode.
4439 - CTRL-L in Insert mode is a command, it is not inserted.
4440 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4441 However, when <Esc> is used inside a mapping, it behaves like
4442 'insertmode' was not set. This was done to be able to use the same
4443 mappings with 'insertmode' set or not set.
4444 When executing commands with |:normal| 'insertmode' is not used.
4445
4446 NOTE: This option is reset when 'compatible' is set.
4447
4448 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004449'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4451 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4452 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4453 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4454 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4455 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 The characters specified by this option are included in file names and
4457 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004458 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 Multi-byte characters 256 and above are always included, only the
4460 characters up to 255 are specified with this option.
4461 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004462 Think twice before adding white space to this option. Although a
4463 space may appear inside a file name, the effect will be that Vim
4464 doesn't know where a file name starts or ends when doing completion.
4465 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466
4467 Note that on systems using a backslash as path separator, Vim tries to
4468 do its best to make it work as you would expect. That is a bit
4469 tricky, since Vi originally used the backslash to escape special
4470 characters. Vim will not remove a backslash in front of a normal file
4471 name character on these systems, but it will on Unix and alikes. The
4472 '&' and '^' are not included by default, because these are special for
4473 cmd.exe.
4474
4475 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004476 Each part can be a single character number or a range. A range is two
4477 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 decimal number between 0 and 255 or the ASCII character itself (does
4479 not work for digits). Example:
4480 "_,-,128-140,#-43" (include '_' and '-' and the range
4481 128 to 140 and '#' to 43)
4482 If a part starts with '^', the following character number or range
4483 will be excluded from the option. The option is interpreted from left
4484 to right. Put the excluded character after the range where it is
4485 included. To include '^' itself use it as the last character of the
4486 option or the end of a range. Example:
4487 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4488 If the character is '@', all characters where isalpha() returns TRUE
4489 are included. Normally these are the characters a to z and A to Z,
4490 plus accented characters. To include '@' itself use "@-@". Examples:
4491 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004492 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 "a-z,A-Z,@-@" All letters plus the '@' character.
4494 A comma can be included by using it where a character number is
4495 expected. Example:
4496 "48-57,,,_" Digits, comma and underscore.
4497 A comma can be excluded by prepending a '^'. Example:
4498 " -~,^,,9" All characters from space to '~', excluding
4499 comma, plus <Tab>.
4500 See |option-backslash| about including spaces and backslashes.
4501
4502 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004503'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 "@,48-57,_,128-167,224-235"
4505 otherwise: "@,48-57,_,192-255")
4506 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 The characters given by this option are included in identifiers.
4508 Identifiers are used in recognizing environment variables and after a
4509 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004510 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004511 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004513 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4515
4516 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004517'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 "@,48-57,_,128-167,224-235"
4519 otherwise: "@,48-57,_,192-255"
4520 Vi default: "@,48-57,_")
4521 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004523 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004524 'isfname' for a description of the format of this option. For '@'
4525 characters above 255 check the "word" character class.
4526 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 For a help file it is set to all non-blank printable characters except
4528 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4529 command).
4530 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004531 This option also influences syntax highlighting, unless the syntax
4532 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 NOTE: This option is set to the Vi default value when 'compatible' is
4534 set and to the Vim default value when 'compatible' is reset.
4535
4536 *'isprint'* *'isp'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004537'isprint' 'isp' string (default for Win32 and Macintosh:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 "@,~-255"; otherwise: "@,161-255")
4539 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540 The characters given by this option are displayed directly on the
4541 screen. It is also used for "\p" in a |pattern|. The characters from
4542 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4543 even when they are not included in 'isprint' or excluded. See
4544 'isfname' for a description of the format of this option.
4545
4546 Non-printable characters are displayed with two characters:
4547 0 - 31 "^@" - "^_"
4548 32 - 126 always single characters
4549 127 "^?"
4550 128 - 159 "~@" - "~_"
4551 160 - 254 "| " - "|~"
4552 255 "~?"
4553 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4554 displayed as <xx>, with the hexadecimal value of the byte.
4555 When 'display' contains "uhex" all unprintable characters are
4556 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004557 The SpecialKey highlighting will be used for unprintable characters.
4558 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559
4560 Multi-byte characters 256 and above are always included, only the
4561 characters up to 255 are specified with this option. When a character
4562 is printable but it is not available in the current font, a
4563 replacement character will be shown.
4564 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4565 There is no option to specify these characters.
4566
4567 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4568'joinspaces' 'js' boolean (default on)
4569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 Insert two spaces after a '.', '?' and '!' with a join command.
4571 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4572 Otherwise only one space is inserted.
4573 NOTE: This option is set when 'compatible' is set.
4574
4575 *'key'*
4576'key' string (default "")
4577 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004578 {only available when compiled with the |+cryptv|
4579 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004581 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 Careful: Do not set the key value by hand, someone might see the typed
4583 key. Use the |:X| command. But you can make 'key' empty: >
4584 :set key=
4585< It is not possible to get the value of this option with ":set key" or
4586 "echo &key". This is to avoid showing it to someone who shouldn't
4587 know. It also means you cannot see it yourself once you have set it,
4588 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004589 You can use "&key" in an expression to detect whether encryption is
4590 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591
4592 *'keymap'* *'kmp'* *E544*
4593'keymap' 'kmp' string (default "")
4594 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 {only available when compiled with the |+keymap|
4596 feature}
4597 Name of a keyboard mapping. See |mbyte-keymap|.
4598 Setting this option to a valid keymap name has the side effect of
4599 setting 'iminsert' to one, so that the keymap becomes effective.
4600 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004601 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602
4603 *'keymodel'* *'km'*
4604'keymodel' 'km' string (default "")
4605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 List of comma separated words, which enable special things that keys
4607 can do. These values can be used:
4608 startsel Using a shifted special key starts selection (either
4609 Select mode or Visual mode, depending on "key" being
4610 present in 'selectmode').
4611 stopsel Using a not-shifted special key stops selection.
4612 Special keys in this context are the cursor keys, <End>, <Home>,
4613 <PageUp> and <PageDown>.
4614 The 'keymodel' option is set by the |:behave| command.
4615
4616 *'keywordprg'* *'kp'*
4617'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004618 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 Program to use for the |K| command. Environment variables are
4621 expanded |:set_env|. ":help" may be used to access the Vim internal
4622 help. (Note that previously setting the global option to the empty
4623 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004624 When the first character is ":", the command is invoked as a Vim
4625 Ex command prefixed with [count].
4626 When "man", "man -s" or an Ex command is used, Vim will automatically
4627 translate a count for the "K" command and pass it as the first
4628 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 See |option-backslash| about including spaces and backslashes.
4630 Example: >
4631 :set keywordprg=man\ -s
4632< This option cannot be set from a |modeline| or in the |sandbox|, for
4633 security reasons.
4634
4635 *'langmap'* *'lmap'* *E357* *E358*
4636'langmap' 'lmap' string (default "")
4637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 {only available when compiled with the |+langmap|
4639 feature}
4640 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004641 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004642 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 care of translating these special characters to the original meaning
4644 of the key. This means you don't have to change the keyboard mode to
4645 be able to execute Normal mode commands.
4646 This is the opposite of the 'keymap' option, where characters are
4647 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004648 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004649 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004650 This option cannot be set from a |modeline| or in the |sandbox|, for
4651 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004653 Example (for Greek, in UTF-8): *greek* >
4654 :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 +00004655< Example (exchanges meaning of z and y for commands): >
4656 :set langmap=zy,yz,ZY,YZ
4657<
4658 The 'langmap' option is a list of parts, separated with commas. Each
4659 part can be in one of two forms:
4660 1. A list of pairs. Each pair is a "from" character immediately
4661 followed by the "to" character. Examples: "aA", "aAbBcC".
4662 2. A list of "from" characters, a semi-colon and a list of "to"
4663 characters. Example: "abc;ABC"
4664 Example: "aA,fgh;FGH,cCdDeE"
4665 Special characters need to be preceded with a backslash. These are
4666 ";", ',' and backslash itself.
4667
4668 This will allow you to activate vim actions without having to switch
4669 back and forth between the languages. Your language characters will
4670 be understood as normal vim English characters (according to the
4671 langmap mappings) in the following cases:
4672 o Normal/Visual mode (commands, buffer/register names, user mappings)
4673 o Insert/Replace Mode: Register names after CTRL-R
4674 o Insert/Replace Mode: Mappings
4675 Characters entered in Command-line mode will NOT be affected by
4676 this option. Note that this option can be changed at any time
4677 allowing to switch between mappings for different languages/encodings.
4678 Use a mapping to avoid having to type it each time!
4679
4680 *'langmenu'* *'lm'*
4681'langmenu' 'lm' string (default "")
4682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 {only available when compiled with the |+menu| and
4684 |+multi_lang| features}
4685 Language to use for menu translation. Tells which file is loaded
4686 from the "lang" directory in 'runtimepath': >
4687 "lang/menu_" . &langmenu . ".vim"
4688< (without the spaces). For example, to always use the Dutch menus, no
4689 matter what $LANG is set to: >
4690 :set langmenu=nl_NL.ISO_8859-1
4691< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004692 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 If your $LANG is set to a non-English language but you do want to use
4694 the English menus: >
4695 :set langmenu=none
4696< This option must be set before loading menus, switching on filetype
4697 detection or syntax highlighting. Once the menus are defined setting
4698 this option has no effect. But you could do this: >
4699 :source $VIMRUNTIME/delmenu.vim
4700 :set langmenu=de_DE.ISO_8859-1
4701 :source $VIMRUNTIME/menu.vim
4702< Warning: This deletes all menus that you defined yourself!
4703
Bram Moolenaard94464e2015-11-02 15:28:18 +01004704 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004705'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004706 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004707 {only available when compiled with the |+langmap|
4708 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004709 This is just like 'langremap' but with the value inverted. It only
4710 exists for backwards compatibility. When setting 'langremap' then
4711 'langnoremap' is set to the inverted value, and the other way around.
4712
4713 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4714'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4715 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004716 {only available when compiled with the |+langmap|
4717 feature}
4718 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004719 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004720 'langmap' disables some of your mappings, try resetting this option.
4721 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004722 that works for you to avoid mappings to break.
4723
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 *'laststatus'* *'ls'*
4725'laststatus' 'ls' number (default 1)
4726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 The value of this option influences when the last window will have a
4728 status line:
4729 0: never
4730 1: only if there are at least two windows
4731 2: always
4732 The screen looks nicer with a status line if you have several
4733 windows, but it takes another screen line. |status-line|
4734
4735 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4736'lazyredraw' 'lz' boolean (default off)
4737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 When this option is set, the screen will not be redrawn while
4739 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004740 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 update use |:redraw|.
4742
4743 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4744'linebreak' 'lbr' boolean (default off)
4745 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004746 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004748 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 than at the last character that fits on the screen. Unlike
4750 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004751 it only affects the way the file is displayed, not its contents.
4752 If 'breakindent' is set, line is visually indented. Then, the value
4753 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004754 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 Note that <Tab> characters after an <EOL> are mostly not displayed
4756 with the right amount of white space.
4757
4758 *'lines'* *E593*
4759'lines' number (default 24 or terminal height)
4760 global
4761 Number of lines of the Vim window.
4762 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004763 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 When Vim is running in the GUI or in a resizable window, setting this
4765 option will cause the window size to be changed. When you only want
4766 to use the size for the GUI, put the command in your |gvimrc| file.
4767 Vim limits the number of lines to what fits on the screen. You can
4768 use this command to get the tallest window possible: >
4769 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004770< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004771 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 When you set this option and Vim is unable to change the physical
4773 number of lines of the display, the display may be messed up.
4774
4775 *'linespace'* *'lsp'*
4776'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4777 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 {only in the GUI}
4779 Number of pixel lines inserted between characters. Useful if the font
4780 uses the full character cell height, making lines touch each other.
4781 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004782 With some fonts there can be too much room between lines (to have
4783 space for ascents and descents). Then it makes sense to set
4784 'linespace' to a negative value. This may cause display problems
4785 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786
4787 *'lisp'* *'nolisp'*
4788'lisp' boolean (default off)
4789 local to buffer
4790 {not available when compiled without the |+lispindent|
4791 feature}
4792 Lisp mode: When <Enter> is typed in insert mode set the indent for
4793 the next line to Lisp standards (well, sort of). Also happens with
4794 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4795 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4796 better. Also see 'lispwords'.
4797 The '-' character is included in keyword characters. Redefines the
4798 "=" operator to use this same indentation algorithm rather than
4799 calling an external program if 'equalprg' is empty.
4800 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801
4802 *'lispwords'* *'lw'*
4803'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 {not available when compiled without the |+lispindent|
4806 feature}
4807 Comma separated list of words that influence the Lisp indenting.
4808 |'lisp'|
4809
4810 *'list'* *'nolist'*
4811'list' boolean (default off)
4812 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004813 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4814 line. Useful to see the difference between tabs and spaces and for
4815 trailing blanks. Further changed by the 'listchars' option.
4816
4817 The cursor is displayed at the start of the space a Tab character
4818 occupies, not at the end as usual in Normal mode. To get this cursor
4819 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004820 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004821<
4822 Note that list mode will also affect formatting (set with 'textwidth'
4823 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 changing the way tabs are displayed.
4825
4826 *'listchars'* *'lcs'*
4827'listchars' 'lcs' string (default "eol:$")
4828 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004829 Strings to use in 'list' mode and for the |:list| command. It is a
4830 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004831 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 eol:c Character to show at the end of each line. When
4833 omitted, there is no extra character at the end of the
4834 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004835 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004836 tab:xy[z] Two or three characters to be used to show a tab.
4837 The third character is optional.
4838
4839 tab:xy The 'x' is always used, then 'y' as many times as will
4840 fit. Thus "tab:>-" displays:
4841 >
4842 >-
4843 >--
4844 etc.
4845
4846 tab:xyz The 'z' is always used, then 'x' is prepended, and
4847 then 'y' is used as many times as will fit. Thus
4848 "tab:<->" displays:
4849 >
4850 <>
4851 <->
4852 <-->
4853 etc.
4854
4855 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004856 *lcs-space*
4857 space:c Character to show for a space. When omitted, spaces
4858 are left blank.
4859 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004860 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004861 trailing spaces are blank. Overrides the "space"
4862 setting for trailing spaces.
4863 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 extends:c Character to show in the last column, when 'wrap' is
4865 off and the line continues beyond the right of the
4866 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004867 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004868 precedes:c Character to show in the first visible column of the
4869 physical line, when there is text preceding the
4870 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004871 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004872 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004873 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004874 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004875 nbsp:c Character to show for a non-breakable space character
4876 (0xA0 (160 decimal) and U+202F). Left blank when
4877 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004879 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004881 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882
4883 Examples: >
4884 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004885 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 :set lcs=extends:>,precedes:<
4887< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004888 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004889 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890
4891 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4892'loadplugins' 'lpl' boolean (default on)
4893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 When on the plugin scripts are loaded when starting up |load-plugins|.
4895 This option can be reset in your |vimrc| file to disable the loading
4896 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004897 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4898 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899
Bram Moolenaard94464e2015-11-02 15:28:18 +01004900 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004901'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004902 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004903 {only available when compiled with the |+lua/dyn|
4904 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004905 Specifies the name of the Lua shared library. The default is
4906 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004907 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004908 This option cannot be set from a |modeline| or in the |sandbox|, for
4909 security reasons.
4910
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004911 *'macatsui'* *'nomacatsui'*
4912'macatsui' boolean (default on)
4913 global
4914 {only available in Mac GUI version}
4915 This is a workaround for when drawing doesn't work properly. When set
4916 and compiled with multi-byte support ATSUI text drawing is used. When
4917 not set ATSUI text drawing is not used. Switch this option off when
4918 you experience drawing problems. In a future version the problems may
4919 be solved and this option becomes obsolete. Therefore use this method
4920 to unset it: >
4921 if exists('&macatsui')
4922 set nomacatsui
4923 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004924< Another option to check if you have drawing problems is
4925 'termencoding'.
4926
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 *'magic'* *'nomagic'*
4928'magic' boolean (default on)
4929 global
4930 Changes the special characters that can be used in search patterns.
4931 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004932 WARNING: Switching this option off most likely breaks plugins! That
4933 is because many patterns assume it's on and will fail when it's off.
4934 Only switch it off when working with old Vi scripts. In any other
4935 situation write patterns that work when 'magic' is on. Include "\M"
4936 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937
4938 *'makeef'* *'mef'*
4939'makeef' 'mef' string (default: "")
4940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941 {not available when compiled without the |+quickfix|
4942 feature}
4943 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4944 and the |:grep| command.
4945 When it is empty, an internally generated temp file will be used.
4946 When "##" is included, it is replaced by a number to make the name
4947 unique. This makes sure that the ":make" command doesn't overwrite an
4948 existing file.
4949 NOT used for the ":cf" command. See 'errorfile' for that.
4950 Environment variables are expanded |:set_env|.
4951 See |option-backslash| about including spaces and backslashes.
4952 This option cannot be set from a |modeline| or in the |sandbox|, for
4953 security reasons.
4954
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004955 *'makeencoding'* *'menc'*
4956'makeencoding' 'menc' string (default "")
4957 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004958 Encoding used for reading the output of external commands. When empty,
4959 encoding is not converted.
4960 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4961 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4962 and `:laddfile`.
4963
4964 This would be mostly useful when you use MS-Windows and set 'encoding'
4965 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4966 'makeencoding' to "char" has the same effect as setting to the system
4967 locale encoding. Example: >
4968 :set encoding=utf-8
4969 :set makeencoding=char " system locale is used
4970<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 *'makeprg'* *'mp'*
4972'makeprg' 'mp' string (default "make", VMS: "MMS")
4973 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004974 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004975 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4976 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004977 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004978 Environment variables are expanded |:set_env|. See |option-backslash|
4979 about including spaces and backslashes.
4980 Note that a '|' must be escaped twice: once for ":set" and once for
4981 the interpretation of a command. When you use a filter called
4982 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 :set makeprg=gmake\ \\\|\ myfilter
4984< The placeholder "$*" can be given (even multiple times) to specify
4985 where the arguments will be included, for example: >
4986 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4987< This option cannot be set from a |modeline| or in the |sandbox|, for
4988 security reasons.
4989
4990 *'matchpairs'* *'mps'*
4991'matchpairs' 'mps' string (default "(:),{:},[:]")
4992 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004994 other.
4995 Only character pairs are allowed that are different, thus you cannot
4996 jump between two double quotes.
4997 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004998 The pairs must be separated by a comma. Example for including '<' and
4999 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 :set mps+=<:>
5001
5002< A more exotic example, to jump between the '=' and ';' in an
5003 assignment, useful for languages like C and Java: >
5004 :au FileType c,cpp,java set mps+==:;
5005
5006< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005007 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008
5009 *'matchtime'* *'mat'*
5010'matchtime' 'mat' number (default 5)
5011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 Tenths of a second to show the matching paren, when 'showmatch' is
5013 set. Note that this is not in milliseconds, like other options that
5014 set a time. This is to be compatible with Nvi.
5015
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005016 *'maxcombine'* *'mco'*
5017'maxcombine' 'mco' number (default 2)
5018 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005019 The maximum number of combining characters supported for displaying.
5020 Only used when 'encoding' is "utf-8".
5021 The default is OK for most languages. Hebrew may require 4.
5022 Maximum value is 6.
5023 Even when this option is set to 2 you can still edit text with more
5024 combining characters, you just can't see them. Use |g8| or |ga|.
5025 See |mbyte-combining|.
5026
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 *'maxfuncdepth'* *'mfd'*
5028'maxfuncdepth' 'mfd' number (default 100)
5029 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005030 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005031 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 Maximum depth of function calls for user functions. This normally
5033 catches endless recursion. When using a recursive function with
5034 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5035 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005036 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005037 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 See also |:function|.
5039
5040 *'maxmapdepth'* *'mmd'* *E223*
5041'maxmapdepth' 'mmd' number (default 1000)
5042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 Maximum number of times a mapping is done without resulting in a
5044 character to be used. This normally catches endless mappings, like
5045 ":map x y" with ":map y x". It still does not catch ":map g wg",
5046 because the 'w' is used before the next mapping is done. See also
5047 |key-mapping|.
5048
5049 *'maxmem'* *'mm'*
5050'maxmem' 'mm' number (default between 256 to 5120 (system
5051 dependent) or half the amount of memory
5052 available)
5053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5055 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005056 other memory to be freed.
5057 The maximum usable value is about 2000000. Use this to work without a
5058 limit.
5059 The value is ignored when 'swapfile' is off.
5060 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005062 *'maxmempattern'* *'mmp'*
5063'maxmempattern' 'mmp' number (default 1000)
5064 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005065 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005066 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005067 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005068 When Vim runs into the limit it gives an error message and mostly
5069 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005070 Running into the limit often means that the pattern is very
5071 inefficient or too complex. This may already happen with the pattern
5072 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005073 Might also happen on redraw, when syntax rules try to match a complex
5074 text structure.
5075 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5076 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005077
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 *'maxmemtot'* *'mmt'*
5079'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5080 dependent) or half the amount of memory
5081 available)
5082 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005083 Maximum amount of memory in Kbyte to use for all buffers together.
5084 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005085 without a limit.
5086 On 64 bit machines higher values might work. But hey, do you really
5087 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005088 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005089 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005090 Buffers with 'swapfile' off still count to the total amount of memory
5091 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005092 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093
5094 *'menuitems'* *'mis'*
5095'menuitems' 'mis' number (default 25)
5096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 {not available when compiled without the |+menu|
5098 feature}
5099 Maximum number of items to use in a menu. Used for menus that are
5100 generated from a list of items, e.g., the Buffers menu. Changing this
5101 option has no direct effect, the menu must be refreshed first.
5102
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005103 *'mkspellmem'* *'msm'*
5104'mkspellmem' 'msm' string (default "460000,2000,500")
5105 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005106 {not available when compiled without the |+syntax|
5107 feature}
5108 Parameters for |:mkspell|. This tunes when to start compressing the
5109 word tree. Compression can be slow when there are many words, but
5110 it's needed to avoid running out of memory. The amount of memory used
5111 per word depends very much on how similar the words are, that's why
5112 this tuning is complicated.
5113
5114 There are three numbers, separated by commas:
5115 {start},{inc},{added}
5116
5117 For most languages the uncompressed word tree fits in memory. {start}
5118 gives the amount of memory in Kbyte that can be used before any
5119 compression is done. It should be a bit smaller than the amount of
5120 memory that is available to Vim.
5121
5122 When going over the {start} limit the {inc} number specifies the
5123 amount of memory in Kbyte that can be allocated before another
5124 compression is done. A low number means compression is done after
5125 less words are added, which is slow. A high number means more memory
5126 will be allocated.
5127
5128 After doing compression, {added} times 1024 words can be added before
5129 the {inc} limit is ignored and compression is done when any extra
5130 amount of memory is needed. A low number means there is a smaller
5131 chance of hitting the {inc} limit, less memory is used but it's
5132 slower.
5133
5134 The languages for which these numbers are important are Italian and
5135 Hungarian. The default works for when you have about 512 Mbyte. If
5136 you have 1 Gbyte you could use: >
5137 :set mkspellmem=900000,3000,800
5138< If you have less than 512 Mbyte |:mkspell| may fail for some
5139 languages, no matter what you set 'mkspellmem' to.
5140
Bram Moolenaar07607392019-05-26 19:20:43 +02005141 This option cannot be set from a |modeline| or in the |sandbox|.
5142
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005144'modeline' 'ml' boolean (Vim default: on (off for root),
5145 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005147 If 'modeline' is on 'modelines' gives the number of lines that is
5148 checked for set commands. If 'modeline' is off or 'modelines' is zero
5149 no lines are checked. See |modeline|.
5150
5151 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5152'modelineexpr' 'mle' boolean (default: off)
5153 global
5154 When on allow some options that are an expression to be set in the
5155 modeline. Check the option for whether it is affected by
5156 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005157 This option cannot be set from a |modeline| or in the |sandbox|, for
5158 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005159
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 *'modelines'* *'mls'*
5161'modelines' 'mls' number (default 5)
5162 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 If 'modeline' is on 'modelines' gives the number of lines that is
5164 checked for set commands. If 'modeline' is off or 'modelines' is zero
5165 no lines are checked. See |modeline|.
5166 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5167 set and to the Vim default value when 'compatible' is reset.
5168
5169 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005170 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171'modifiable' 'ma' boolean (default on)
5172 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173 When off the buffer contents cannot be changed. The 'fileformat' and
5174 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005175 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176
5177 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5178'modified' 'mod' boolean (default off)
5179 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 When on, the buffer is considered to be modified. This option is set
5181 when:
5182 1. A change was made to the text since it was last written. Using the
5183 |undo| command to go back to the original text will reset the
5184 option. But undoing changes that were made before writing the
5185 buffer will set the option again, since the text is different from
5186 when it was written.
5187 2. 'fileformat' or 'fileencoding' is different from its original
5188 value. The original value is set when the buffer is read or
5189 written. A ":set nomodified" command also resets the original
5190 values to the current values and the 'modified' option will be
5191 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005192 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005193 This option is not set when a change is made to the buffer as the
5194 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5195 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5196 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5198 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005199 Note that the text may actually be the same, e.g. 'modified' is set
5200 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201
5202 *'more'* *'nomore'*
5203'more' boolean (Vim default: on, Vi default: off)
5204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 When on, listings pause when the whole screen is filled. You will get
5206 the |more-prompt|. When this option is off there are no pauses, the
5207 listing continues until finished.
5208 NOTE: This option is set to the Vi default value when 'compatible' is
5209 set and to the Vim default value when 'compatible' is reset.
5210
5211 *'mouse'* *E538*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005212'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005213 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005215 Enable the use of the mouse. Works for most terminals (xterm, Win32
5216 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5217 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5218 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005219 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 v Visual mode
5221 i Insert mode
5222 c Command-line mode
5223 h all previous modes when editing a help file
5224 a all previous modes
5225 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005226 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005228< If your terminal can't overrule the mouse events going to the
5229 application, use: >
5230 :set mouse=nvi
5231< The you can press ":", select text for the system, and press Esc to go
5232 back to Vim using the mouse events.
5233 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5234 "xterm".
5235
5236 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 modeless selection. This doesn't move the text cursor.
5238
5239 See |mouse-using|. Also see |'clipboard'|.
5240
5241 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005242 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 the mouse buttons can still be used by keeping the shift key pressed.
5244 Also see the 'clipboard' option.
5245
5246 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5247'mousefocus' 'mousef' boolean (default off)
5248 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 {only works in the GUI}
5250 The window that the mouse pointer is on is automatically activated.
5251 When changing the window layout or window focus in another way, the
5252 mouse pointer is moved to the window with keyboard focus. Off is the
5253 default because it makes using the pull down menus a little goofy, as
5254 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005255 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005256 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257
5258 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5259'mousehide' 'mh' boolean (default on)
5260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 {only works in the GUI}
5262 When on, the mouse pointer is hidden when characters are typed.
5263 The mouse pointer is restored when the mouse is moved.
5264
5265 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005266'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 Sets the model to use for the mouse. The name mostly specifies what
5269 the right mouse button is used for:
5270 extend Right mouse button extends a selection. This works
5271 like in an xterm.
5272 popup Right mouse button pops up a menu. The shifted left
5273 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005274 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 popup_setpos Like "popup", but the cursor will be moved to the
5276 position where the mouse was clicked, and thus the
5277 selected operation will act upon the clicked object.
5278 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005279 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 course, that right clicking outside a selection will
5281 end Visual mode.
5282 Overview of what button does what for each model:
5283 mouse extend popup(_setpos) ~
5284 left click place cursor place cursor
5285 left drag start selection start selection
5286 shift-left search word extend selection
5287 right click extend selection popup menu (place cursor)
5288 right drag extend selection -
5289 middle click paste paste
5290
5291 In the "popup" model the right mouse button produces a pop-up menu.
5292 You need to define this first, see |popup-menu|.
5293
5294 Note that you can further refine the meaning of buttons with mappings.
5295 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5296 selection (because that's handled in the GUI code directly).
5297
5298 The 'mousemodel' option is set by the |:behave| command.
5299
5300 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005301'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5302 vs:leftright,vd:lrsizing,m:no,
5303 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 {only available when compiled with the |+mouseshape|
5306 feature}
5307 This option tells Vim what the mouse pointer should look like in
5308 different modes. The option is a comma separated list of parts, much
5309 like used for 'guicursor'. Each part consist of a mode/location-list
5310 and an argument-list:
5311 mode-list:shape,mode-list:shape,..
5312 The mode-list is a dash separated list of these modes/locations:
5313 In a normal window: ~
5314 n Normal mode
5315 v Visual mode
5316 ve Visual mode with 'selection' "exclusive" (same as 'v',
5317 if not specified)
5318 o Operator-pending mode
5319 i Insert mode
5320 r Replace mode
5321
5322 Others: ~
5323 c appending to the command-line
5324 ci inserting in the command-line
5325 cr replacing in the command-line
5326 m at the 'Hit ENTER' or 'More' prompts
5327 ml idem, but cursor in the last line
5328 e any mode, pointer below last window
5329 s any mode, pointer on a status line
5330 sd any mode, while dragging a status line
5331 vs any mode, pointer on a vertical separator line
5332 vd any mode, while dragging a vertical separator line
5333 a everywhere
5334
5335 The shape is one of the following:
5336 avail name looks like ~
5337 w x arrow Normal mouse pointer
5338 w x blank no pointer at all (use with care!)
5339 w x beam I-beam
5340 w x updown up-down sizing arrows
5341 w x leftright left-right sizing arrows
5342 w x busy The system's usual busy pointer
5343 w x no The system's usual 'no input' pointer
5344 x udsizing indicates up-down resizing
5345 x lrsizing indicates left-right resizing
5346 x crosshair like a big thin +
5347 x hand1 black hand
5348 x hand2 white hand
5349 x pencil what you write with
5350 x question big ?
5351 x rightup-arrow arrow pointing right-up
5352 w x up-arrow arrow pointing up
5353 x <number> any X11 pointer number (see X11/cursorfont.h)
5354
5355 The "avail" column contains a 'w' if the shape is available for Win32,
5356 x for X11.
5357 Any modes not specified or shapes not available use the normal mouse
5358 pointer.
5359
5360 Example: >
5361 :set mouseshape=s:udsizing,m:no
5362< will make the mouse turn to a sizing arrow over the status lines and
5363 indicate no input when the hit-enter prompt is displayed (since
5364 clicking the mouse has no effect in this state.)
5365
5366 *'mousetime'* *'mouset'*
5367'mousetime' 'mouset' number (default 500)
5368 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005369 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 time in msec between two mouse clicks for the second click to be
5371 recognized as a multi click.
5372
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005373 *'mzschemedll'*
5374'mzschemedll' string (default depends on the build)
5375 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005376 {only available when compiled with the |+mzscheme/dyn|
5377 feature}
5378 Specifies the name of the MzScheme shared library. The default is
5379 DYNAMIC_MZSCH_DLL which was specified at compile time.
5380 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005381 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005382 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005383 This option cannot be set from a |modeline| or in the |sandbox|, for
5384 security reasons.
5385
5386 *'mzschemegcdll'*
5387'mzschemegcdll' string (default depends on the build)
5388 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005389 {only available when compiled with the |+mzscheme/dyn|
5390 feature}
5391 Specifies the name of the MzScheme GC shared library. The default is
5392 DYNAMIC_MZGC_DLL which was specified at compile time.
5393 The value can be equal to 'mzschemedll' if it includes the GC code.
5394 Environment variables are expanded |:set_env|.
5395 This option cannot be set from a |modeline| or in the |sandbox|, for
5396 security reasons.
5397
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005398 *'mzquantum'* *'mzq'*
5399'mzquantum' 'mzq' number (default 100)
5400 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005401 {not available when compiled without the |+mzscheme|
5402 feature}
5403 The number of milliseconds between polls for MzScheme threads.
5404 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005405 NOTE: This option is set to the Vim default value when 'compatible'
5406 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005407
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005409'nrformats' 'nf' string (default "bin,octal,hex",
5410 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 This defines what bases Vim will consider for numbers when using the
5413 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5414 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005415 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005417 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005418 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005420 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 considered to be hexadecimal. Example: Using CTRL-X on
5422 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005423 bin If included, numbers starting with "0b" or "0B" will be
5424 considered to be binary. Example: Using CTRL-X on
5425 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 Numbers which simply begin with a digit in the range 1-9 are always
5427 considered decimal. This also happens for numbers that are not
5428 recognized as octal or hex.
5429
5430 *'number'* *'nu'* *'nonumber'* *'nonu'*
5431'number' 'nu' boolean (default off)
5432 local to window
5433 Print the line number in front of each line. When the 'n' option is
5434 excluded from 'cpoptions' a wrapped line will not use the column of
5435 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005436 The 'numberwidth' option can be used to set the room used for the line
5437 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438 When a long, wrapped line doesn't start with the first character, '-'
5439 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005440 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5441 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005442 *number_relativenumber*
5443 The 'relativenumber' option changes the displayed number to be
5444 relative to the cursor. Together with 'number' there are these
5445 four combinations (cursor in line 3):
5446
Bram Moolenaar3848e002016-03-19 18:42:29 +01005447 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005448 'nornu' 'nornu' 'rnu' 'rnu'
5449
5450 |apple | 1 apple | 2 apple | 2 apple
5451 |pear | 2 pear | 1 pear | 1 pear
5452 |nobody | 3 nobody | 0 nobody |3 nobody
5453 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005455 *'numberwidth'* *'nuw'*
5456'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5457 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005458 {only available when compiled with the |+linebreak|
5459 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005460 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005461 when the 'number' or 'relativenumber' option is set or printing lines
5462 with a line number. Since one space is always between the number and
5463 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005464 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005465 fit the highest line number in the buffer respectively the number of
5466 rows in the window, depending on whether 'number' or 'relativenumber'
5467 is set. Thus with the Vim default of 4 there is room for a line number
5468 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005469 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005470 NOTE: This option is set to the Vi default value when 'compatible' is
5471 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005472
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005473 *'omnifunc'* *'ofu'*
5474'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005475 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005476 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005477 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005478 This option specifies a function to be used for Insert mode omni
5479 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005480 See |complete-functions| for an explanation of how the function is
5481 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005482 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005483 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005484 This option cannot be set from a |modeline| or in the |sandbox|, for
5485 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005486
5487
Bram Moolenaar02467872007-05-06 13:22:01 +00005488 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005489'opendevice' 'odev' boolean (default off)
5490 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005491 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005492 Enable reading and writing from devices. This may get Vim stuck on a
5493 device that can be opened but doesn't actually do the I/O. Therefore
5494 it is off by default.
5495 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5496 result in editing a device.
5497
5498
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005499 *'operatorfunc'* *'opfunc'*
5500'operatorfunc' 'opfunc' string (default: empty)
5501 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005502 This option specifies a function to be called by the |g@| operator.
5503 See |:map-operator| for more info and an example.
5504
5505 This option cannot be set from a |modeline| or in the |sandbox|, for
5506 security reasons.
5507
5508
Bram Moolenaar251e1912011-06-19 05:09:16 +02005509 *'osfiletype'* *'oft'*
5510'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005512 This option was supported on RISC OS, which has been removed.
5513
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005515 *'packpath'* *'pp'*
5516'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005517 Directories used to find packages. See |packages|.
5518
5519
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005521'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 global
5523 Specifies the nroff macros that separate paragraphs. These are pairs
5524 of two letters (see |object-motions|).
5525
5526 *'paste'* *'nopaste'*
5527'paste' boolean (default off)
5528 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005529 Put Vim in Paste mode. This is useful if you want to cut or copy
5530 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 unexpected effects.
5532 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005533 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 knows about pasting and will mostly do the right thing without 'paste'
5535 being set. The same is true for a terminal where Vim handles the
5536 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005537 This option is reset when starting the GUI. Thus if you set it in
5538 your .vimrc it will work in a terminal, but not in the GUI. Setting
5539 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5540 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 When the 'paste' option is switched on (also when it was already on):
5542 - mapping in Insert mode and Command-line mode is disabled
5543 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005545 - 'expandtab' is reset
5546 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 - 'revins' is reset
5548 - 'ruler' is reset
5549 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005550 - 'smartindent' is reset
5551 - 'smarttab' is reset
5552 - 'softtabstop' is set to 0
5553 - 'textwidth' is set to 0
5554 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005557 - 'indentexpr'
5558 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 NOTE: When you start editing another file while the 'paste' option is
5560 on, settings from the modelines or autocommands may change the
5561 settings again, causing trouble when pasting text. You might want to
5562 set the 'paste' option again.
5563 When the 'paste' option is reset the mentioned options are restored to
5564 the value before the moment 'paste' was switched from off to on.
5565 Resetting 'paste' before ever setting it does not have any effect.
5566 Since mapping doesn't work while 'paste' is active, you need to use
5567 the 'pastetoggle' option to toggle the 'paste' option with some key.
5568
5569 *'pastetoggle'* *'pt'*
5570'pastetoggle' 'pt' string (default "")
5571 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 When non-empty, specifies the key sequence that toggles the 'paste'
5573 option. This is like specifying a mapping: >
5574 :map {keys} :set invpaste<CR>
5575< Where {keys} is the value of 'pastetoggle'.
5576 The difference is that it will work even when 'paste' is set.
5577 'pastetoggle' works in Insert mode and Normal mode, but not in
5578 Command-line mode.
5579 Mappings are checked first, thus overrule 'pastetoggle'. However,
5580 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5581 this: >
5582 :map <F10> :set paste<CR>
5583 :map <F11> :set nopaste<CR>
5584 :imap <F10> <C-O>:set paste<CR>
5585 :imap <F11> <nop>
5586 :set pastetoggle=<F11>
5587< This will make <F10> start paste mode and <F11> stop paste mode.
5588 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5589 mode everything is inserted literally, except the 'pastetoggle' key
5590 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005591 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592
5593 *'pex'* *'patchexpr'*
5594'patchexpr' 'pex' string (default "")
5595 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 {not available when compiled without the |+diff|
5597 feature}
5598 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005599 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600
Bram Moolenaardbc28022014-07-26 13:40:44 +02005601 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602'patchmode' 'pm' string (default "")
5603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 When non-empty the oldest version of a file is kept. This can be used
5605 to keep the original version of a file if you are changing files in a
5606 source distribution. Only the first time that a file is written a
5607 copy of the original file will be kept. The name of the copy is the
5608 name of the original file with the string in the 'patchmode' option
5609 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005610 ".orig" or ".org". 'backupdir' must not be empty for this to work
5611 (Detail: The backup file is renamed to the patchmode file after the
5612 new file has been successfully written, that's why it must be possible
5613 to write a backup file). If there was no file to be backed up, an
5614 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 When the 'backupskip' pattern matches, a patchmode file is not made.
5616 Using 'patchmode' for compressed files appends the extension at the
5617 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5618 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005619 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005621 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 other systems: ".,,")
5624 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005626 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5627 provided that the file being searched for has a relative path (not
5628 starting with "/", "./" or "../"). The directories in the 'path'
5629 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 - Use commas to separate directory names: >
5631 :set path=.,/usr/local/include,/usr/include
5632< - Spaces can also be used to separate directory names (for backwards
5633 compatibility with version 3.0). To have a space in a directory
5634 name, precede it with an extra backslash, and escape the space: >
5635 :set path=.,/dir/with\\\ space
5636< - To include a comma in a directory name precede it with an extra
5637 backslash: >
5638 :set path=.,/dir/with\\,comma
5639< - To search relative to the directory of the current file, use: >
5640 :set path=.
5641< - To search in the current directory use an empty string between two
5642 commas: >
5643 :set path=,,
5644< - A directory name may end in a ':' or '/'.
5645 - Environment variables are expanded |:set_env|.
5646 - When using |netrw.vim| URLs can be used. For example, adding
5647 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005648 - Search upwards and downwards in a directory tree using "*", "**" and
5649 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 {not available when compiled without the |+path_extra| feature}
5651 - Careful with '\' characters, type two to get one in the option: >
5652 :set path=.,c:\\include
5653< Or just use '/' instead: >
5654 :set path=.,c:/include
5655< Don't forget "." or files won't even be found in the same directory as
5656 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005657 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 it is something like 256 or 1024 characters.
5659 You can check if all the include files are found, using the value of
5660 'path', see |:checkpath|.
5661 The use of |:set+=| and |:set-=| is preferred when adding or removing
5662 directories from the list. This avoids problems when a future version
5663 uses another default. To remove the current directory use: >
5664 :set path-=
5665< To add the current directory use: >
5666 :set path+=
5667< To use an environment variable, you probably need to replace the
5668 separator. Here is an example to append $INCL, in which directory
5669 names are separated with a semi-colon: >
5670 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5671< Replace the ';' with a ':' or whatever separator is used. Note that
5672 this doesn't work when $INCL contains a comma or white space.
5673
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005674 *'perldll'*
5675'perldll' string (default depends on the build)
5676 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005677 {only available when compiled with the |+perl/dyn|
5678 feature}
5679 Specifies the name of the Perl shared library. The default is
5680 DYNAMIC_PERL_DLL, which was specified at compile time.
5681 Environment variables are expanded |:set_env|.
5682 This option cannot be set from a |modeline| or in the |sandbox|, for
5683 security reasons.
5684
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5686'preserveindent' 'pi' boolean (default off)
5687 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 When changing the indent of the current line, preserve as much of the
5689 indent structure as possible. Normally the indent is replaced by a
5690 series of tabs followed by spaces as required (unless |'expandtab'| is
5691 enabled, in which case only spaces are used). Enabling this option
5692 means the indent will preserve as many existing characters as possible
5693 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005694 'expandtab' does not apply to the preserved white space, a Tab remains
5695 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 NOTE: When using ">>" multiple times the resulting indent is a mix of
5697 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005698 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 Also see 'copyindent'.
5700 Use |:retab| to clean up white space.
5701
5702 *'previewheight'* *'pvh'*
5703'previewheight' 'pvh' number (default 12)
5704 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005705 {not available when compiled without the |+quickfix|
5706 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005708 commands. Used for |CTRL-W_}| when no count is given. Not used when
5709 'previewpopup' is set.
5710
5711 *'previewpopup'* *'pvp'*
5712'previewpopup' 'pvp' string (default empty)
5713 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005714 {not available when compiled without the |+textprop|
5715 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005716 When not empty a popup window is used for commands that would open a
5717 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005718 Not used for the insert completion info, add "popup" to
5719 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720
5721 *'previewwindow'* *'nopreviewwindow'*
5722 *'pvw'* *'nopvw'* *E590*
5723'previewwindow' 'pvw' boolean (default off)
5724 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005725 {not available when compiled without the |+quickfix|
5726 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005727 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 set. It's normally not set directly, but by using one of the commands
5729 |:ptag|, |:pedit|, etc.
5730
5731 *'printdevice'* *'pdev'*
5732'printdevice' 'pdev' string (default empty)
5733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 {only available when compiled with the |+printer|
5735 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005736 The name of the printer to be used for |:hardcopy|.
5737 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005738 This option cannot be set from a |modeline| or in the |sandbox|, for
5739 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740
Bram Moolenaar8299df92004-07-10 09:47:34 +00005741 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005742'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 {only available when compiled with the |+printer|
5745 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005746 Sets the character encoding used when printing.
5747 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748
5749 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005750'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 {only available when compiled with the |+printer|
5753 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005754 Expression used to print the PostScript produced with |:hardcopy|.
5755 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005756 This option cannot be set from a |modeline| or in the |sandbox|, for
5757 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758
Bram Moolenaar8299df92004-07-10 09:47:34 +00005759 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760'printfont' 'pfn' string (default "courier")
5761 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 {only available when compiled with the |+printer|
5763 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005764 The name of the font that will be used for |:hardcopy|.
5765 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766
5767 *'printheader'* *'pheader'*
5768'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 {only available when compiled with the |+printer|
5771 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005772 The format of the header produced in |:hardcopy| output.
5773 See |pheader-option|.
5774
5775 *'printmbcharset'* *'pmbcs'*
5776'printmbcharset' 'pmbcs' string (default "")
5777 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005778 {only available when compiled with the |+printer|
5779 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005780 The CJK character set to be used for CJK output from |:hardcopy|.
5781 See |pmbcs-option|.
5782
5783 *'printmbfont'* *'pmbfn'*
5784'printmbfont' 'pmbfn' string (default "")
5785 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005786 {only available when compiled with the |+printer|
5787 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005788 List of font names to be used for CJK output from |:hardcopy|.
5789 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790
5791 *'printoptions'* *'popt'*
5792'printoptions' 'popt' string (default "")
5793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005795 List of items that control the format of the output of |:hardcopy|.
5796 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005798 *'prompt'* *'noprompt'*
5799'prompt' boolean (default on)
5800 global
5801 When on a ":" prompt is used in Ex mode.
5802
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005803 *'pumheight'* *'ph'*
5804'pumheight' 'ph' number (default 0)
5805 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005806 Determines the maximum number of items to show in the popup menu for
5807 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005808 |ins-completion-menu|.
5809
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005810 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005811'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005812 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005813 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005814 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005815
Bram Moolenaard94464e2015-11-02 15:28:18 +01005816 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005817'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005818 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005819 {only available when compiled with the |+python/dyn|
5820 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005821 Specifies the name of the Python 2.x shared library. The default is
5822 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005823 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005824 This option cannot be set from a |modeline| or in the |sandbox|, for
5825 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005826
Bram Moolenaar94073162018-01-31 21:49:05 +01005827 *'pythonhome'*
5828'pythonhome' string (default "")
5829 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005830 {only available when compiled with the |+python/dyn|
5831 feature}
5832 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5833 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5834 which was specified at compile time, will be used for the Python 2.x
5835 home directory.
5836 Environment variables are expanded |:set_env|.
5837 This option cannot be set from a |modeline| or in the |sandbox|, for
5838 security reasons.
5839
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005840 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005841'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005842 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005843 {only available when compiled with the |+python3/dyn|
5844 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005845 Specifies the name of the Python 3 shared library. The default is
5846 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005847 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005848 This option cannot be set from a |modeline| or in the |sandbox|, for
5849 security reasons.
5850
Bram Moolenaar94073162018-01-31 21:49:05 +01005851 *'pythonthreehome'*
5852'pythonthreehome' string (default "")
5853 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005854 {only available when compiled with the |+python3/dyn|
5855 feature}
5856 Specifies the name of the Python 3 home directory. When
5857 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5858 PYTHON3_HOME, which was specified at compile time, will be used for
5859 the Python 3 home directory.
5860 Environment variables are expanded |:set_env|.
5861 This option cannot be set from a |modeline| or in the |sandbox|, for
5862 security reasons.
5863
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005864 *'pyxversion'* *'pyx'*
5865'pyxversion' 'pyx' number (default depends on the build)
5866 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005867 {only available when compiled with the |+python| or
5868 the |+python3| feature}
5869 Specifies the python version used for pyx* functions and commands
5870 |python_x|. The default value is as follows:
5871
5872 Compiled with Default ~
5873 |+python| and |+python3| 0
5874 only |+python| 2
5875 only |+python3| 3
5876
5877 Available values are 0, 2 and 3.
5878 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5879 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5880 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5881 to 2 if Python 2 is available.
5882 See also: |has-pythonx|
5883
5884 If Vim is compiled with only |+python| or |+python3| setting
5885 'pyxversion' has no effect. The pyx* functions and commands are
5886 always the same as the compiled version.
5887
5888 This option cannot be set from a |modeline| or in the |sandbox|, for
5889 security reasons.
5890
Bram Moolenaar677ee682005-01-27 14:41:15 +00005891 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005892'quoteescape' 'qe' string (default "\")
5893 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005894 The characters that are used to escape quotes in a string. Used for
5895 objects like a', a" and a` |a'|.
5896 When one of the characters in this option is found inside a string,
5897 the following character will be skipped. The default value makes the
5898 text "foo\"bar\\" considered to be one string.
5899
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5901'readonly' 'ro' boolean (default off)
5902 local to buffer
5903 If on, writes fail unless you use a '!'. Protects you from
5904 accidentally overwriting a file. Default on when Vim is started
5905 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005906 When using ":w!" the 'readonly' option is reset for the current
5907 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005908 When using the ":view" command the 'readonly' option is set for the
5909 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005910 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005912 *'redrawtime'* *'rdt'*
5913'redrawtime' 'rdt' number (default 2000)
5914 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005915 {only available when compiled with the |+reltime|
5916 feature}
5917 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005918 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005919 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005920 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005921 matches will be highlighted.
5922 For syntax highlighting the time applies per window. When over the
5923 limit syntax highlighting is disabled until |CTRL-L| is used.
5924 This is used to avoid that Vim hangs when using a very complicated
5925 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005926
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005927 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005928'regexpengine' 're' number (default 0)
5929 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005930 This selects the default regexp engine. |two-engines|
5931 The possible values are:
5932 0 automatic selection
5933 1 old engine
5934 2 NFA engine
5935 Note that when using the NFA engine and the pattern contains something
5936 that is not supported the pattern will not match. This is only useful
5937 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005938 Using automatic selection enables Vim to switch the engine, if the
5939 default engine becomes too costly. E.g., when the NFA engine uses too
5940 many states. This should prevent Vim from hanging on a combination of
5941 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005942
Bram Moolenaar64486672010-05-16 15:46:46 +02005943 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5944'relativenumber' 'rnu' boolean (default off)
5945 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005946 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005947 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005948 precede some vertical motion commands (e.g. j k + -) with, without
5949 having to calculate it yourself. Especially useful in combination with
5950 other commands (e.g. y d c < > gq gw =).
5951 When the 'n' option is excluded from 'cpoptions' a wrapped
5952 line will not use the column of line numbers (this is the default when
5953 'compatible' isn't set).
5954 The 'numberwidth' option can be used to set the room used for the line
5955 number.
5956 When a long, wrapped line doesn't start with the first character, '-'
5957 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005958 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5959 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005960
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005961 The number in front of the cursor line also depends on the value of
5962 'number', see |number_relativenumber| for all combinations of the two
5963 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005964
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 *'remap'* *'noremap'*
5966'remap' boolean (default on)
5967 global
5968 Allows for mappings to work recursively. If you do not want this for
5969 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005970 NOTE: To avoid portability problems with Vim scripts, always keep
5971 this option at the default "on". Only switch it off when working with
5972 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005973
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005974 *'renderoptions'* *'rop'*
5975'renderoptions' 'rop' string (default: empty)
5976 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005977 {only available when compiled with GUI and DIRECTX on
5978 MS-Windows}
5979 Select a text renderer and set its options. The options depend on the
5980 renderer.
5981
5982 Syntax: >
5983 set rop=type:{renderer}(,{name}:{value})*
5984<
5985 Currently, only one optional renderer is available.
5986
5987 render behavior ~
5988 directx Vim will draw text using DirectX (DirectWrite). It makes
5989 drawn glyphs more beautiful than default GDI.
5990 It requires 'encoding' is "utf-8", and only works on
5991 MS-Windows Vista or newer version.
5992
5993 Options:
5994 name meaning type value ~
5995 gamma gamma float 1.0 - 2.2 (maybe)
5996 contrast enhancedContrast float (unknown)
5997 level clearTypeLevel float (unknown)
5998 geom pixelGeometry int 0 - 2 (see below)
5999 renmode renderingMode int 0 - 6 (see below)
6000 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006001 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006002
Bram Moolenaar92467d32017-12-05 13:22:16 +01006003 See this URL for detail (except for scrlines):
6004 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006005
6006 For geom: structure of a device pixel.
6007 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6008 1 - DWRITE_PIXEL_GEOMETRY_RGB
6009 2 - DWRITE_PIXEL_GEOMETRY_BGR
6010
6011 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006012 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006013
6014 For renmode: method of rendering glyphs.
6015 0 - DWRITE_RENDERING_MODE_DEFAULT
6016 1 - DWRITE_RENDERING_MODE_ALIASED
6017 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6018 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6019 4 - DWRITE_RENDERING_MODE_NATURAL
6020 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6021 6 - DWRITE_RENDERING_MODE_OUTLINE
6022
6023 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006024 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006025
6026 For taamode: antialiasing mode used for drawing text.
6027 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6028 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6029 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6030 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6031
6032 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006033 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6034
Bram Moolenaara338adc2018-01-31 20:51:47 +01006035 For scrlines:
6036 This was used for optimizing scrolling behavior, however this
6037 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006038
6039 Example: >
6040 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006041 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006042 set rop=type:directx
6043<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006044 If select a raster font (Courier, Terminal or FixedSys which
6045 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006046 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006047
6048 NOTE: It is known that some fonts and options combination
6049 causes trouble on drawing glyphs.
6050
Bram Moolenaar92467d32017-12-05 13:22:16 +01006051 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006052 special made fonts (True-Type fonts which includes only
6053 bitmap glyphs).
6054 - 'taamode:3' will not work with some vector fonts.
6055
6056 NOTE: With this option, you can display colored emoji
6057 (emoticon) in Windows 8.1 or later. To display colored emoji,
6058 there are some conditions which you should notice.
6059
6060 - If your font includes non-colored emoji already, it will
6061 be used.
6062 - If your font doesn't have emoji, the system chooses an
6063 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6064 will be used.
6065 - When this alternative font didn't have fixed width glyph,
6066 emoji might be rendered beyond the bounding box of drawing
6067 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006068
6069 Other render types are currently not supported.
6070
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 *'report'*
6072'report' number (default 2)
6073 global
6074 Threshold for reporting number of lines changed. When the number of
6075 changed lines is more than 'report' a message will be given for most
6076 ":" commands. If you want it always, set 'report' to 0.
6077 For the ":substitute" command the number of substitutions is used
6078 instead of the number of lines.
6079
6080 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6081'restorescreen' 'rs' boolean (default on)
6082 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006083 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 When set, the screen contents is restored when exiting Vim. This also
6085 happens when executing external commands.
6086
6087 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6088 options in your .vimrc. To disable restoring:
6089 set t_ti= t_te=
6090 To enable restoring (for an xterm):
6091 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6092 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6093
6094 *'revins'* *'ri'* *'norevins'* *'nori'*
6095'revins' 'ri' boolean (default off)
6096 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006097 {only available when compiled with the |+rightleft|
6098 feature}
6099 Inserting characters in Insert mode will work backwards. See "typing
6100 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6101 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006102 NOTE: This option is reset when 'compatible' is set.
6103 This option is reset when 'paste' is set and restored when 'paste' is
6104 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105
6106 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6107'rightleft' 'rl' boolean (default off)
6108 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 {only available when compiled with the |+rightleft|
6110 feature}
6111 When on, display orientation becomes right-to-left, i.e., characters
6112 that are stored in the file appear from the right to the left.
6113 Using this option, it is possible to edit files for languages that
6114 are written from the right to the left such as Hebrew and Arabic.
6115 This option is per window, so it is possible to edit mixed files
6116 simultaneously, or to view the same file in both ways (this is
6117 useful whenever you have a mixed text file with both right-to-left
6118 and left-to-right strings so that both sets are displayed properly
6119 in different windows). Also see |rileft.txt|.
6120
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006121 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122'rightleftcmd' 'rlc' string (default "search")
6123 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124 {only available when compiled with the |+rightleft|
6125 feature}
6126 Each word in this option enables the command line editing to work in
6127 right-to-left mode for a group of commands:
6128
6129 search "/" and "?" commands
6130
6131 This is useful for languages such as Hebrew, Arabic and Farsi.
6132 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6133
Bram Moolenaard94464e2015-11-02 15:28:18 +01006134 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006135'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006136 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006137 {only available when compiled with the |+ruby/dyn|
6138 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006139 Specifies the name of the Ruby shared library. The default is
6140 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006141 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006142 This option cannot be set from a |modeline| or in the |sandbox|, for
6143 security reasons.
6144
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006146'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 {not available when compiled without the
6149 |+cmdline_info| feature}
6150 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006151 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 text in the file is shown on the far right:
6153 Top first line is visible
6154 Bot last line is visible
6155 All first and last line are visible
6156 45% relative position in the file
6157 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006158 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006160 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 this option takes precedence over 'ruler' and 'rulerformat'
6162 If the number of characters displayed is different from the number of
6163 bytes in the text (e.g., for a TAB or a multi-byte character), both
6164 the text column (byte number) and the screen column are shown,
6165 separated with a dash.
6166 For an empty line "0-1" is shown.
6167 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006168 This option is reset when 'paste' is set and restored when 'paste' is
6169 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 If you don't want to see the ruler all the time but want to know where
6171 you are, use "g CTRL-G" |g_CTRL-G|.
6172 NOTE: This option is reset when 'compatible' is set.
6173
6174 *'rulerformat'* *'ruf'*
6175'rulerformat' 'ruf' string (default empty)
6176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177 {not available when compiled without the |+statusline|
6178 feature}
6179 When this option is not empty, it determines the content of the ruler
6180 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006181 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006182 This option cannot be set in a modeline when 'modelineexpr' is off.
6183
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 The default ruler width is 17 characters. To make the ruler 15
6185 characters wide, put "%15(" at the start and "%)" at the end.
6186 Example: >
6187 :set rulerformat=%15(%c%V\ %p%%%)
6188<
6189 *'runtimepath'* *'rtp'* *vimfiles*
6190'runtimepath' 'rtp' string (default:
6191 Unix: "$HOME/.vim,
6192 $VIM/vimfiles,
6193 $VIMRUNTIME,
6194 $VIM/vimfiles/after,
6195 $HOME/.vim/after"
6196 Amiga: "home:vimfiles,
6197 $VIM/vimfiles,
6198 $VIMRUNTIME,
6199 $VIM/vimfiles/after,
6200 home:vimfiles/after"
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006201 PC: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 $VIM/vimfiles,
6203 $VIMRUNTIME,
6204 $VIM/vimfiles/after,
6205 $HOME/vimfiles/after"
6206 Macintosh: "$VIM:vimfiles,
6207 $VIMRUNTIME,
6208 $VIM:vimfiles:after"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 VMS: "sys$login:vimfiles,
6210 $VIM/vimfiles,
6211 $VIMRUNTIME,
6212 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006213 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 This is a list of directories which will be searched for runtime
6216 files:
6217 filetype.vim filetypes by file name |new-filetype|
6218 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006219 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 colors/ color scheme files |:colorscheme|
6221 compiler/ compiler files |:compiler|
6222 doc/ documentation |write-local-help|
6223 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006224 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 indent/ indent scripts |indent-expression|
6226 keymap/ key mapping files |mbyte-keymap|
6227 lang/ menu translations |:menutrans|
6228 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006229 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 plugin/ plugin scripts |write-plugin|
6231 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006232 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 syntax/ syntax files |mysyntaxfile|
6234 tutor/ files for vimtutor |tutor|
6235
6236 And any other file searched for with the |:runtime| command.
6237
6238 The defaults for most systems are setup to search five locations:
6239 1. In your home directory, for your personal preferences.
6240 2. In a system-wide Vim directory, for preferences from the system
6241 administrator.
6242 3. In $VIMRUNTIME, for files distributed with Vim.
6243 *after-directory*
6244 4. In the "after" directory in the system-wide Vim directory. This is
6245 for the system administrator to overrule or add to the distributed
6246 defaults (rarely needed)
6247 5. In the "after" directory in your home directory. This is for
6248 personal preferences to overrule or add to the distributed defaults
6249 or system-wide settings (rarely needed).
6250
Bram Moolenaard0796902016-09-16 20:02:31 +02006251 More entries are added when using |packages|. If it gets very long
6252 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6253 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006254
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6256 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006257 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 wildcards.
6259 See |:runtime|.
6260 Example: >
6261 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6262< This will use the directory "~/vimruntime" first (containing your
6263 personal Vim runtime files), then "/mygroup/vim" (shared between a
6264 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6265 files).
6266 You probably should always include $VIMRUNTIME somewhere, to use the
6267 distributed runtime files. You can put a directory before $VIMRUNTIME
6268 to find files which replace a distributed runtime files. You can put
6269 a directory after $VIMRUNTIME to find files which add to distributed
6270 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006271 When Vim is started with |--clean| the home directory entries are not
6272 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273 This option cannot be set from a |modeline| or in the |sandbox|, for
6274 security reasons.
6275
6276 *'scroll'* *'scr'*
6277'scroll' 'scr' number (default: half the window height)
6278 local to window
6279 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6280 set to half the number of lines in the window when the window size
6281 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006282 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006283 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284
6285 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6286'scrollbind' 'scb' boolean (default off)
6287 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 See also |scroll-binding|. When this option is set, the current
6289 window scrolls as other scrollbind windows (windows that also have
6290 this option set) scroll. This option is useful for viewing the
6291 differences between two versions of a file, see 'diff'.
6292 See |'scrollopt'| for options that determine how this option should be
6293 interpreted.
6294 This option is mostly reset when splitting a window to edit another
6295 file. This means that ":split | edit file" results in two windows
6296 with scroll-binding, but ":split file" does not.
6297
Bram Moolenaarae20f342019-11-05 21:09:23 +01006298 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6299'scrollfocus' 'scf' boolean (default off)
6300 global
6301 {only for MS-Windows GUI}
6302 When using the scroll wheel and this option is set, the window under
6303 the mouse pointer is scrolled. With this option off the current
6304 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006305 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006306
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 *'scrolljump'* *'sj'*
6308'scrolljump' 'sj' number (default 1)
6309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 Minimal number of lines to scroll when the cursor gets off the
6311 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6312 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006313 When set to a negative number from -1 to -100 this is used as the
6314 percentage of the window height. Thus -50 scrolls half the window
6315 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 NOTE: This option is set to 1 when 'compatible' is set.
6317
6318 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006319'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006320 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 Minimal number of screen lines to keep above and below the cursor.
6322 This will make some context visible around where you are working. If
6323 you set it to a very large value (999) the cursor line will always be
6324 in the middle of the window (except at the start or end of the file or
6325 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006326 After using the local value, go back the global value with one of
6327 these two: >
6328 setlocal scrolloff<
6329 setlocal scrolloff=-1
6330< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 NOTE: This option is set to 0 when 'compatible' is set.
6332
6333 *'scrollopt'* *'sbo'*
6334'scrollopt' 'sbo' string (default "ver,jump")
6335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006337 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6338 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 The following words are available:
6340 ver Bind vertical scrolling for 'scrollbind' windows
6341 hor Bind horizontal scrolling for 'scrollbind' windows
6342 jump Applies to the offset between two windows for vertical
6343 scrolling. This offset is the difference in the first
6344 displayed line of the bound windows. When moving
6345 around in a window, another 'scrollbind' window may
6346 reach a position before the start or after the end of
6347 the buffer. The offset is not changed though, when
6348 moving back the 'scrollbind' window will try to scroll
6349 to the desired position when possible.
6350 When now making that window the current one, two
6351 things can be done with the relative offset:
6352 1. When "jump" is not included, the relative offset is
6353 adjusted for the scroll position in the new current
6354 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006355 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 2. When "jump" is included, the other windows are
6357 scrolled to keep the same relative offset. When
6358 going back to the other window, it still uses the
6359 same relative offset.
6360 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006361 When 'diff' mode is active there always is vertical scroll binding,
6362 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363
6364 *'sections'* *'sect'*
6365'sections' 'sect' string (default "SHNHH HUnhsh")
6366 global
6367 Specifies the nroff macros that separate sections. These are pairs of
6368 two letters (See |object-motions|). The default makes a section start
6369 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6370
6371 *'secure'* *'nosecure'* *E523*
6372'secure' boolean (default off)
6373 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 When on, ":autocmd", shell and write commands are not allowed in
6375 ".vimrc" and ".exrc" in the current directory and map commands are
6376 displayed. Switch it off only if you know that you will not run into
6377 problems, or when the 'exrc' option is off. On Unix this option is
6378 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006379 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 'secure' at the end of your ~/.vimrc then.
6381 This option cannot be set from a |modeline| or in the |sandbox|, for
6382 security reasons.
6383
6384 *'selection'* *'sel'*
6385'selection' 'sel' string (default "inclusive")
6386 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 This option defines the behavior of the selection. It is only used
6388 in Visual and Select mode.
6389 Possible values:
6390 value past line inclusive ~
6391 old no yes
6392 inclusive yes yes
6393 exclusive yes no
6394 "past line" means that the cursor is allowed to be positioned one
6395 character past the line.
6396 "inclusive" means that the last character of the selection is included
6397 in an operation. For example, when "x" is used to delete the
6398 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006399 When "old" is used and 'virtualedit' allows the cursor to move past
6400 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 Note that when "exclusive" is used and selecting from the end
6402 backwards, you cannot include the last character of a line, when
6403 starting in Normal mode and 'virtualedit' empty.
6404
6405 The 'selection' option is set by the |:behave| command.
6406
6407 *'selectmode'* *'slm'*
6408'selectmode' 'slm' string (default "")
6409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 This is a comma separated list of words, which specifies when to start
6411 Select mode instead of Visual mode, when a selection is started.
6412 Possible values:
6413 mouse when using the mouse
6414 key when using shifted special keys
6415 cmd when using "v", "V" or CTRL-V
6416 See |Select-mode|.
6417 The 'selectmode' option is set by the |:behave| command.
6418
6419 *'sessionoptions'* *'ssop'*
6420'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006421 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006423 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 feature}
6425 Changes the effect of the |:mksession| command. It is a comma
6426 separated list of words. Each word enables saving and restoring
6427 something:
6428 word save and restore ~
6429 blank empty windows
6430 buffers hidden and unloaded buffers, not just those in windows
6431 curdir the current directory
6432 folds manually created folds, opened/closed folds and local
6433 fold options
6434 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006435 and contain at least one lowercase letter. Only
6436 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 help the help window
6438 localoptions options and mappings local to a window or buffer (not
6439 global values for local options)
6440 options all options and mappings (also global values for local
6441 options)
6442 resize size of the Vim window: 'lines' and 'columns'
6443 sesdir the directory in which the session file is located
6444 will become the current directory (useful with
6445 projects accessed over a network from different
6446 systems)
6447 slash backslashes in file names replaced with forward
6448 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006449 tabpages all tab pages; without this only the current tab page
6450 is restored, so that you can make a session for each
6451 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006452 terminal include terminal windows where the command can be
6453 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 unix with Unix end-of-line format (single <NL>), even when
6455 on Windows or DOS
6456 winpos position of the whole Vim window
6457 winsize window sizes
6458
6459 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006460 When neither "curdir" nor "sesdir" is included, file names are stored
6461 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 "slash" and "unix" are useful on Windows when sharing session files
6463 with Unix. The Unix version of Vim cannot source dos format scripts,
6464 but the Windows version of Vim can source unix format scripts.
6465
6466 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006467'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 global
6469 Name of the shell to use for ! and :! commands. When changing the
6470 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6471 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006472 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 See |option-backslash| about including spaces and backslashes.
6474 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006475
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006476 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006477 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6479< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006480 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006482 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006484 Example with escaped space (Vim will do this when initializing the
6485 option from $SHELL): >
6486 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006487< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006488 backslashes are consumed by `:set`.
6489
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 Under MS-Windows, when the executable ends in ".com" it must be
6491 included. Thus setting the shell to "command.com" or "4dos.com"
6492 works, but "command" and "4dos" do not work for all commands (e.g.,
6493 filtering).
6494 For unknown reasons, when using "4dos.com" the current directory is
6495 changed to "C:\". To avoid this set 'shell' like this: >
6496 :set shell=command.com\ /c\ 4dos
6497< This option cannot be set from a |modeline| or in the |sandbox|, for
6498 security reasons.
6499
6500 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006501'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006502 Win32, when 'shell' does not contain "sh"
6503 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006506 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6507 set according to the value of 'shell', to reduce the need to set this
6508 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006509 On Unix it can have more than one flag. Each white space separated
6510 part is passed as an argument to the shell command.
6511 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006512 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 This option cannot be set from a |modeline| or in the |sandbox|, for
6514 security reasons.
6515
6516 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006517'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6518 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 {not available when compiled without the |+quickfix|
6521 feature}
6522 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006523 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 including spaces and backslashes.
6525 The name of the temporary file can be represented by "%s" if necessary
6526 (the file name is appended automatically if no %s appears in the value
6527 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006528 For the Amiga the default is ">". For MS-Windows the default is
6529 ">%s 2>&1". The output is directly saved in a file and not echoed to
6530 the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 For Unix the default it "| tee". The stdout of the compiler is saved
6532 in a file and echoed to the screen. If the 'shell' option is "csh" or
6533 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006534 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6535 "bash" or "fish" the default becomes "2>&1| tee". This means that
6536 stderr is also included. Before using the 'shell' option a path is
6537 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 The initialization of this option is done after reading the ".vimrc"
6539 and the other initializations, so that when the 'shell' option is set
6540 there, the 'shellpipe' option changes automatically, unless it was
6541 explicitly set before.
6542 When 'shellpipe' is set to an empty string, no redirection of the
6543 ":make" output will be done. This is useful if you use a 'makeprg'
6544 that writes to 'makeef' by itself. If you want no piping, but do
6545 want to include the 'makeef', set 'shellpipe' to a single space.
6546 Don't forget to precede the space with a backslash: ":set sp=\ ".
6547 In the future pipes may be used for filtering and this option will
6548 become obsolete (at least for Unix).
6549 This option cannot be set from a |modeline| or in the |sandbox|, for
6550 security reasons.
6551
6552 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006553'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 contains "sh" somewhere: "\"")
6555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 Quoting character(s), put around the command passed to the shell, for
6557 the "!" and ":!" commands. The redirection is kept outside of the
6558 quoting. See 'shellxquote' to include the redirection. It's
6559 probably not useful to set both options.
6560 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006561 third-party shells on MS-Windows-like systems, such as the MKS Korn
6562 Shell or bash, where it should be "\"". The default is adjusted
6563 according the value of 'shell', to reduce the need to set this option
6564 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 This option cannot be set from a |modeline| or in the |sandbox|, for
6566 security reasons.
6567
6568 *'shellredir'* *'srr'*
6569'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 String to be used to put the output of a filter command in a temporary
6572 file. See also |:!|. See |option-backslash| about including spaces
6573 and backslashes.
6574 The name of the temporary file can be represented by "%s" if necessary
6575 (the file name is appended automatically if no %s appears in the value
6576 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006577 The default is ">". For Unix, if the 'shell' option is "csh" or
6578 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006579 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6580 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6581 stderr is also included. For Win32, the Unix checks are done and
6582 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6583 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 The initialization of this option is done after reading the ".vimrc"
6585 and the other initializations, so that when the 'shell' option is set
6586 there, the 'shellredir' option changes automatically unless it was
6587 explicitly set before.
6588 In the future pipes may be used for filtering and this option will
6589 become obsolete (at least for Unix).
6590 This option cannot be set from a |modeline| or in the |sandbox|, for
6591 security reasons.
6592
6593 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6594'shellslash' 'ssl' boolean (default off)
6595 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006596 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006598 useful when a Unix-like shell is used instead of cmd.exe. Backward
6599 slashes can still be typed, but they are changed to forward slashes by
6600 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 Note that setting or resetting this option has no effect for some
6602 existing file names, thus this option needs to be set before opening
6603 any file for best results. This might change in the future.
6604 'shellslash' only works when a backslash can be used as a path
6605 separator. To test if this is so use: >
6606 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006607< Also see 'completeslash'.
6608
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006609 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6610'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6611 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006612 When on, use temp files for shell commands. When off use a pipe.
6613 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006614 Currently a pipe is only supported on Unix and MS-Windows 2K and
6615 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006616 :if has("filterpipe")
6617< The advantage of using a pipe is that nobody can read the temp file
6618 and the 'shell' command does not need to support redirection.
6619 The advantage of using a temp file is that the file type and encoding
6620 can be detected.
6621 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6622 |FilterWritePost| autocommands event are not triggered when
6623 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006624 The `system()` function does not respect this option and always uses
6625 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006626 NOTE: This option is set to the Vim default value when 'compatible'
6627 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006628
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 *'shelltype'* *'st'*
6630'shelltype' 'st' number (default 0)
6631 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006632 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 On the Amiga this option influences the way how the commands work
6634 which use a shell.
6635 0 and 1: always use the shell
6636 2 and 3: use the shell only to filter lines
6637 4 and 5: use shell only for ':sh' command
6638 When not using the shell, the command is executed directly.
6639
6640 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6641 1 and 3: use "shell cmd" to start external commands
6642
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006643 *'shellxescape'* *'sxe'*
6644'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006645 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006646 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006647 When 'shellxquote' is set to "(" then the characters listed in this
6648 option will be escaped with a '^' character. This makes it possible
6649 to execute most external commands with cmd.exe.
6650
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 *'shellxquote'* *'sxq'*
6652'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006653 for Win32, when 'shell' is cmd.exe: "("
6654 for Win32, when 'shell' contains "sh"
6655 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 for Unix, when using system(): "\"")
6657 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 Quoting character(s), put around the command passed to the shell, for
6659 the "!" and ":!" commands. Includes the redirection. See
6660 'shellquote' to exclude the redirection. It's probably not useful
6661 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006662 When the value is '(' then ')' is appended. When the value is '"('
6663 then ')"' is appended.
6664 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006665 This is an empty string by default on most systems, but is known to be
6666 useful for on Win32 version, either for cmd.exe which automatically
6667 strips off the first and last quote on a command, or 3rd-party shells
6668 such as the MKS Korn Shell or bash, where it should be "\"". The
6669 default is adjusted according the value of 'shell', to reduce the need
6670 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 This option cannot be set from a |modeline| or in the |sandbox|, for
6672 security reasons.
6673
6674 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6675'shiftround' 'sr' boolean (default off)
6676 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 Round indent to multiple of 'shiftwidth'. Applies to > and <
6678 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6679 a multiple of 'shiftwidth' (this is Vi compatible).
6680 NOTE: This option is reset when 'compatible' is set.
6681
6682 *'shiftwidth'* *'sw'*
6683'shiftwidth' 'sw' number (default 8)
6684 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006685 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006687 When zero the 'ts' value will be used. Use the |shiftwidth()|
6688 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689
6690 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006691'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6692 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 This option helps to avoid all the |hit-enter| prompts caused by file
6695 messages, for example with CTRL-G, and to avoid some other messages.
6696 It is a list of flags:
6697 flag meaning when present ~
6698 f use "(3 of 5)" instead of "(file 3 of 5)"
6699 i use "[noeol]" instead of "[Incomplete last line]"
6700 l use "999L, 888C" instead of "999 lines, 888 characters"
6701 m use "[+]" instead of "[Modified]"
6702 n use "[New]" instead of "[New File]"
6703 r use "[RO]" instead of "[readonly]"
6704 w use "[w]" instead of "written" for file write message
6705 and "[a]" instead of "appended" for ':w >> file' command
6706 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6707 "[unix format]" and "[mac]" instead of "[mac format]".
6708 a all of the above abbreviations
6709
6710 o overwrite message for writing a file with subsequent message
6711 for reading a file (useful for ":wn" or when 'autowrite' on)
6712 O message for reading a file overwrites any previous message.
6713 Also for quickfix message (e.g., ":cn").
6714 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006715 hit TOP, continuing at BOTTOM" messages; when using the search
6716 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 t truncate file message at the start if it is too long to fit
6718 on the command-line, "<" will appear in the left most column.
6719 Ignored in Ex mode.
6720 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006721 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 Ignored in Ex mode.
6723 W don't give "written" or "[w]" when writing a file
6724 A don't give the "ATTENTION" message when an existing swap file
6725 is found.
6726 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006727 c don't give |ins-completion-menu| messages. For example,
6728 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6729 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006730 q use "recording" instead of "recording @a"
6731 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006732 was used for the command; note that this also affects messages
6733 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006734 S do not show search count message when searching, e.g.
6735 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736
6737 This gives you the opportunity to avoid that a change between buffers
6738 requires you to hit <Enter>, but still gives as useful a message as
6739 possible for the space available. To get the whole message that you
6740 would have got with 'shm' empty, use ":file!"
6741 Useful values:
6742 shm= No abbreviation of message.
6743 shm=a Abbreviation, but no loss of information.
6744 shm=at Abbreviation, and truncate message when necessary.
6745
6746 NOTE: This option is set to the Vi default value when 'compatible' is
6747 set and to the Vim default value when 'compatible' is reset.
6748
6749 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6750'shortname' 'sn' boolean (default off)
6751 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 Filenames are assumed to be 8 characters plus one extension of 3
6753 characters. Multiple dots in file names are not allowed. When this
6754 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006755 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006757 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758
6759 *'showbreak'* *'sbr'* *E595*
6760'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006761 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006762 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 feature}
6764 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006765 values are "> " or "+++ ": >
6766 :set showbreak=>\
6767< Note the backslash to escape the trailing space. It's easier like
6768 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006769 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006770< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 comma (in a future version the comma might be used to separate the
6772 part that is shown at the end and at the start of a line).
6773 The characters are highlighted according to the '@' flag in
6774 'highlight'.
6775 Note that tabs after the showbreak will be displayed differently.
6776 If you want the 'showbreak' to appear in between line numbers, add the
6777 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006778 A window-local value overrules a global value. If the global value is
6779 set and you want no value in the current window use NONE: >
6780 :setlocal showbreak=NONE
6781<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006783'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6784 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 {not available when compiled without the
6787 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006788 Show (partial) command in the last line of the screen. Set this
6789 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 In Visual mode the size of the selected area is shown:
6791 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006792 If the number of bytes is different it is also displayed: "2-6"
6793 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006795 - When selecting a block, the size in screen characters:
6796 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 NOTE: This option is set to the Vi default value when 'compatible' is
6798 set and to the Vim default value when 'compatible' is reset.
6799
6800 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6801'showfulltag' 'sft' boolean (default off)
6802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 When completing a word in insert mode (see |ins-completion|) from the
6804 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006805 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 matched a C function, you can see a template for what arguments are
6807 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006808 Note that this doesn't work well together with having "longest" in
6809 'completeopt', because the completion from the search pattern may not
6810 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811
6812 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6813'showmatch' 'sm' boolean (default off)
6814 global
6815 When a bracket is inserted, briefly jump to the matching one. The
6816 jump is only done if the match can be seen on the screen. The time to
6817 show the match can be set with 'matchtime'.
6818 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006819 seen or not).
6820 This option is reset when 'paste' is set and restored when 'paste' is
6821 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 When the 'm' flag is not included in 'cpoptions', typing a character
6823 will immediately move the cursor back to where it belongs.
6824 See the "sm" field in 'guicursor' for setting the cursor shape and
6825 blinking when showing the match.
6826 The 'matchpairs' option can be used to specify the characters to show
6827 matches for. 'rightleft' and 'revins' are used to look for opposite
6828 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006829 Also see the matchparen plugin for highlighting the match when moving
6830 around |pi_paren.txt|.
6831 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832
6833 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6834'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6835 global
6836 If in Insert, Replace or Visual mode put a message on the last line.
6837 Use the 'M' flag in 'highlight' to set the type of highlighting for
6838 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006839 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 doesn't mean XIM is really active, especially when 'imactivatekey' is
6841 not set.
6842 NOTE: This option is set to the Vi default value when 'compatible' is
6843 set and to the Vim default value when 'compatible' is reset.
6844
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006845 *'showtabline'* *'stal'*
6846'showtabline' 'stal' number (default 1)
6847 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006848 The value of this option specifies when the line with tab page labels
6849 will be displayed:
6850 0: never
6851 1: only if there are at least two tab pages
6852 2: always
6853 This is both for the GUI and non-GUI implementation of the tab pages
6854 line.
6855 See |tab-page| for more information about tab pages.
6856
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 *'sidescroll'* *'ss'*
6858'sidescroll' 'ss' number (default 0)
6859 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 The minimal number of columns to scroll horizontally. Used only when
6861 the 'wrap' option is off and the cursor is moved off of the screen.
6862 When it is zero the cursor will be put in the middle of the screen.
6863 When using a slow terminal set it to a large number or 0. When using
6864 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6865 commands.
6866
6867 *'sidescrolloff'* *'siso'*
6868'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006869 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006871 right of the cursor if 'nowrap' is set. Setting this option to a
6872 value greater than 0 while having |'sidescroll'| also at a non-zero
6873 value makes some context visible in the line you are scrolling in
6874 horizontally (except at beginning of the line). Setting this option
6875 to a large value (like 999) has the effect of keeping the cursor
6876 horizontally centered in the window, as long as one does not come too
6877 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006878 After using the local value, go back the global value with one of
6879 these two: >
6880 setlocal sidescrolloff<
6881 setlocal sidescrolloff=-1
6882< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883
6884 Example: Try this together with 'sidescroll' and 'listchars' as
6885 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006886 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887
6888 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6889 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006890<
6891 *'signcolumn'* *'scl'*
6892'signcolumn' 'scl' string (default "auto")
6893 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006894 {not available when compiled without the |+signs|
6895 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006896 Whether or not to draw the signcolumn. Valid values are:
6897 "auto" only when there is a sign to display
6898 "no" never
6899 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006900 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006901 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902
6903
6904 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6905'smartcase' 'scs' boolean (default off)
6906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 Override the 'ignorecase' option if the search pattern contains upper
6908 case characters. Only used when the search pattern is typed and
6909 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006910 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6912 recalling the search pattern from history and hitting <Enter>.
6913 NOTE: This option is reset when 'compatible' is set.
6914
6915 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6916'smartindent' 'si' boolean (default off)
6917 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 {not available when compiled without the
6919 |+smartindent| feature}
6920 Do smart autoindenting when starting a new line. Works for C-like
6921 programs, but can also be used for other languages. 'cindent' does
6922 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006923 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006924 setting 'si' has no effect. 'indentexpr' is a more advanced
6925 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 Normally 'autoindent' should also be on when using 'smartindent'.
6927 An indent is automatically inserted:
6928 - After a line ending in '{'.
6929 - After a line starting with a keyword from 'cinwords'.
6930 - Before a line starting with '}' (only with the "O" command).
6931 When typing '}' as the first character in a new line, that line is
6932 given the same indent as the matching '{'.
6933 When typing '#' as the first character in a new line, the indent for
6934 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006935 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6937 When using the ">>" command, lines starting with '#' are not shifted
6938 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006939 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006940 This option is reset when 'paste' is set and restored when 'paste' is
6941 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942
6943 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6944'smarttab' 'sta' boolean (default off)
6945 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006947 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6948 <BS> will delete a 'shiftwidth' worth of space at the start of the
6949 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006950 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006951 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6952 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006953 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006955 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006956 This option is reset when 'paste' is set and restored when 'paste' is
6957 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 NOTE: This option is reset when 'compatible' is set.
6959
6960 *'softtabstop'* *'sts'*
6961'softtabstop' 'sts' number (default 0)
6962 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 Number of spaces that a <Tab> counts for while performing editing
6964 operations, like inserting a <Tab> or using <BS>. It "feels" like
6965 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6966 used. This is useful to keep the 'ts' setting at its standard value
6967 of 8, while being able to edit like it is set to 'sts'. However,
6968 commands like "x" still work on the actual characters.
6969 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006970 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006971 'softtabstop' is set to 0 when the 'paste' option is set and restored
6972 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6974 spaces is minimized by using <Tab>s.
6975 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6976 set.
6977 NOTE: This option is set to 0 when 'compatible' is set.
6978
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006979 If Vim is compiled with the |+vartabs| feature then the value of
6980 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6981 anything other than an empty string.
6982
Bram Moolenaar217ad922005-03-20 22:37:15 +00006983 *'spell'* *'nospell'*
6984'spell' boolean (default off)
6985 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006986 {not available when compiled without the |+syntax|
6987 feature}
6988 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006989 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006990
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006991 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006992'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006993 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006994 {not available when compiled without the |+syntax|
6995 feature}
6996 Pattern to locate the end of a sentence. The following word will be
6997 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006998 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006999 When this check is not wanted make this option empty.
7000 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007001 Be careful with special characters, see |option-backslash| about
7002 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007003 To set this option automatically depending on the language, see
7004 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007005
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007006 *'spellfile'* *'spf'*
7007'spellfile' 'spf' string (default empty)
7008 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007009 {not available when compiled without the |+syntax|
7010 feature}
7011 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007012 commands. It must end in ".{encoding}.add". You need to include the
7013 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007014 *E765*
7015 It may also be a comma separated list of names. A count before the
7016 |zg| and |zw| commands can be used to access each. This allows using
7017 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007018 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007019 you: Using the first directory in 'runtimepath' that is writable. If
7020 there is no "spell" directory yet it will be created. For the file
7021 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007022 ignoring the region.
7023 The resulting ".spl" file will be used for spell checking, it does not
7024 have to appear in 'spelllang'.
7025 Normally one file is used for all regions, but you can add the region
7026 name if you want to. However, it will then only be used when
7027 'spellfile' is set to it, for entries in 'spelllang' only files
7028 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007029 This option cannot be set from a |modeline| or in the |sandbox|, for
7030 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007031
Bram Moolenaar217ad922005-03-20 22:37:15 +00007032 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007033'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007034 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007035 {not available when compiled without the |+syntax|
7036 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007037 A comma separated list of word list names. When the 'spell' option is
7038 on spellchecking will be done for these languages. Example: >
7039 set spelllang=en_us,nl,medical
7040< This means US English, Dutch and medical words are recognized. Words
7041 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007042 The word list name must consist of alphanumeric characters, a dash or
7043 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007044 recommended to separate the two letter language name from a
7045 specification. Thus "en-rare" is used for rare English words.
7046 A region name must come last and have the form "_xx", where "xx" is
7047 the two-letter, lower case region name. You can use more than one
7048 region by listing them: "en_us,en_ca" supports both US and Canadian
7049 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007050 Britain. (Note: currently en_au and en_nz dictionaries are older than
7051 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007052 If the name "cjk" is included East Asian characters are excluded from
7053 spell checking. This is useful when editing text that also has Asian
7054 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007055 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007056 As a special case the name of a .spl file can be given as-is. The
7057 first "_xx" in the name is removed and used as the region name
7058 (_xx is an underscore, two letters and followed by a non-letter).
7059 This is mainly for testing purposes. You must make sure the correct
7060 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007061 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007062 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7063 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007064 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007065
Bram Moolenaar98692072006-02-04 00:57:42 +00007066 If the |spellfile.vim| plugin is active and you use a language name
7067 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7068 will ask you if you want to download the file.
7069
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007070 After this option has been set successfully, Vim will source the files
7071 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007072 up to the first character that is not an ASCII letter or number and
7073 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007074
7075
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007076 *'spellsuggest'* *'sps'*
7077'spellsuggest' 'sps' string (default "best")
7078 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007079 {not available when compiled without the |+syntax|
7080 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007081 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007082 the |spellsuggest()| function. This is a comma-separated list of
7083 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007084
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007085 best Internal method that works best for English. Finds
7086 changes like "fast" and uses a bit of sound-a-like
7087 scoring to improve the ordering.
7088
7089 double Internal method that uses two methods and mixes the
7090 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007091 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007092 word. That only works when the language specifies
7093 sound folding. Can be slow and doesn't always give
7094 better results.
7095
7096 fast Internal method that only checks for simple changes:
7097 character inserts/deletes/swaps. Works well for
7098 simple typing mistakes.
7099
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007100 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007101 Not used for |spellsuggest()|. The number of
7102 suggestions is never more than the value of 'lines'
7103 minus two.
7104
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007105 file:{filename} Read file {filename}, which must have two columns,
7106 separated by a slash. The first column contains the
7107 bad word, the second column the suggested good word.
7108 Example:
7109 theribal/terrible ~
7110 Use this for common mistakes that do not appear at the
7111 top of the suggestion list with the internal methods.
7112 Lines without a slash are ignored, use this for
7113 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007114 The word in the second column must be correct,
7115 otherwise it will not be used. Add the word to an
7116 ".add" file if it is currently flagged as a spelling
7117 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007118 The file is used for all languages.
7119
7120 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7121 trouble with spaces. |v:val| holds the badly spelled
7122 word. The expression must evaluate to a List of
7123 Lists, each with a suggestion and a score.
7124 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007125 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007126 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007127 internal methods use. A lower score is better.
7128 This may invoke |spellsuggest()| if you temporarily
7129 set 'spellsuggest' to exclude the "expr:" part.
7130 Errors are silently ignored, unless you set the
7131 'verbose' option to a non-zero value.
7132
7133 Only one of "best", "double" or "fast" may be used. The others may
7134 appear several times in any order. Example: >
7135 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7136<
7137 This option cannot be set from a |modeline| or in the |sandbox|, for
7138 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007139
7140
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7142'splitbelow' 'sb' boolean (default off)
7143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 When on, splitting a window will put the new window below the current
7145 one. |:split|
7146
7147 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7148'splitright' 'spr' boolean (default off)
7149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 When on, splitting a window will put the new window right of the
7151 current one. |:vsplit|
7152
7153 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7154'startofline' 'sol' boolean (default on)
7155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007157 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007158 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007159 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 with a linewise operator, with "%" with a count and to buffer changing
7161 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7162 only has a line number, e.g., ":25" or ":+".
7163 In case of buffer changing commands the cursor is placed at the column
7164 where it was the last time the buffer was edited.
7165 NOTE: This option is set when 'compatible' is set.
7166
Bram Moolenaar00654022011-02-25 14:42:19 +01007167 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007169 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 {not available when compiled without the |+statusline|
7171 feature}
7172 When nonempty, this option determines the content of the status line.
7173 Also see |status-line|.
7174
7175 The option consists of printf style '%' items interspersed with
7176 normal text. Each status line item is of the form:
7177 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007178 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007179 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180
Bram Moolenaar238a5642006-02-21 22:12:05 +00007181 When the option starts with "%!" then it is used as an expression,
7182 evaluated and the result is used as the option value. Example: >
7183 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007184< The *g:statusline_winid* variable will be set to the |window-ID| of the
7185 window that the status line belongs to.
7186 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007187 Note that the "%!" expression is evaluated in the context of the
7188 current window and buffer, while %{} items are evaluated in the
7189 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007190
7191 When there is error while evaluating the option then it will be made
7192 empty to avoid further errors. Otherwise screen updating would loop.
7193
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 Note that the only effect of 'ruler' when this option is set (and
7195 'laststatus' is 2) is controlling the output of |CTRL-G|.
7196
7197 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007198 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007200 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 minwid Minimum width of the item, padding as set by '-' & '0'.
7202 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007203 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 on the left for text items. Numeric items will be
7205 shifted down to maxwid-2 digits followed by '>'number
7206 where number is the amount of missing digits, much like
7207 an exponential notation.
7208 item A one letter code as described below.
7209
7210 Following is a description of the possible statusline items. The
7211 second character in "item" is the type:
7212 N for number
7213 S for string
7214 F for flags as described below
7215 - not applicable
7216
7217 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007218 f S Path to the file in the buffer, as typed or relative to current
7219 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 F S Full path to the file in the buffer.
7221 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007222 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007224 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007226 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007228 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007230 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007232 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7234 being used: "<keymap>"
7235 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007236 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 B N As above, in hexadecimal.
7238 o N Byte number in file of byte under cursor, first byte is 1.
7239 Mnemonic: Offset from start of file (with one added)
7240 {not available when compiled without |+byte_offset| feature}
7241 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007242 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 l N Line number.
7244 L N Number of lines in buffer.
7245 c N Column number.
7246 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007247 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 p N Percentage through file in lines as in |CTRL-G|.
7249 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007250 percentage described for 'ruler'. Always 3 in length, unless
7251 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007252 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007254 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007255 Note that there is no '%' before the closing '}'. The
7256 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007257 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258 ( - Start of item group. Can be used for setting the width and
7259 alignment of a section. Must be followed by %) somewhere.
7260 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007261 T N For 'tabline': start of tab page N label. Use %T after the last
7262 label. This information is used for mouse clicks.
7263 X N For 'tabline': start of close tab N label. Use %X after the
7264 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7265 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 < - Where to truncate line if too long. Default is at the start.
7267 No width fields allowed.
7268 = - Separation point between left and right aligned items.
7269 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007270 # - Set highlight group. The name must follow and then a # again.
7271 Thus use %#HLname# for highlight group HLname. The same
7272 highlighting is used, also for the statusline of non-current
7273 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007275 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 The difference between User{N} and StatusLine will be applied
7277 to StatusLineNC for the statusline of non-current windows.
7278 The number N must be between 1 and 9. See |hl-User1..9|
7279
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007280 When displaying a flag, Vim removes the leading comma, if any, when
7281 that flag comes right after plaintext. This will make a nice display
7282 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283
Bram Moolenaar582fd852005-03-28 20:58:01 +00007284 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 not set) and a minwid is not set for the group, the whole group will
7286 become empty. This will make a group like the following disappear
7287 completely from the statusline when none of the flags are set. >
7288 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007289< Beware that an expression is evaluated each and every time the status
7290 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007291 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007292 While evaluating %{} the current buffer and current window will be set
7293 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007294 currently being drawn. The expression will evaluate in this context.
7295 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7296 real current buffer and "g:actual_curwin" to the |window-ID| of the
7297 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007298
Bram Moolenaar30b65812012-07-12 22:01:11 +02007299 The 'statusline' option will be evaluated in the |sandbox| if set from
7300 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007301 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007302
7303 It is not allowed to change text or jump to another window while
7304 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305
7306 If the statusline is not updated when you want it (e.g., after setting
7307 a variable that's used in an expression), you can force an update by
7308 setting an option without changing its value. Example: >
7309 :let &ro = &ro
7310
7311< A result of all digits is regarded a number for display purposes.
7312 Otherwise the result is taken as flag text and applied to the rules
7313 described above.
7314
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007315 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007317 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318
7319 Examples:
7320 Emulate standard status line with 'ruler' set >
7321 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7322< Similar, but add ASCII value of char under the cursor (like "ga") >
7323 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7324< Display byte count and byte value, modified flag in red. >
7325 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7326 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7327< Display a ,GZ flag if a compressed file is loaded >
7328 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7329< In the |:autocmd|'s: >
7330 :let b:gzflag = 1
7331< And: >
7332 :unlet b:gzflag
7333< And define this function: >
7334 :function VarExists(var, val)
7335 : if exists(a:var) | return a:val | else | return '' | endif
7336 :endfunction
7337<
7338 *'suffixes'* *'su'*
7339'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 Files with these suffixes get a lower priority when multiple files
7342 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007343 suffixes. Spaces after the comma are ignored. A dot is also seen as
7344 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 separator, precede it with a backslash (see |option-backslash| about
7346 including spaces and backslashes).
7347 See 'wildignore' for completely ignoring files.
7348 The use of |:set+=| and |:set-=| is preferred when adding or removing
7349 suffixes from the list. This avoids problems when a future version
7350 uses another default.
7351
7352 *'suffixesadd'* *'sua'*
7353'suffixesadd' 'sua' string (default "")
7354 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 {not available when compiled without the
7356 |+file_in_path| feature}
7357 Comma separated list of suffixes, which are used when searching for a
7358 file for the "gf", "[I", etc. commands. Example: >
7359 :set suffixesadd=.java
7360<
7361 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7362'swapfile' 'swf' boolean (default on)
7363 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007364 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 swapfile is not wanted for a specific buffer. For example, with
7366 confidential information that even root must not be able to access.
7367 Careful: All text will be in memory:
7368 - Don't use this for big files.
7369 - Recovery will be impossible!
7370 A swapfile will only be present when |'updatecount'| is non-zero and
7371 'swapfile' is set.
7372 When 'swapfile' is reset, the swap file for the current buffer is
7373 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7374 non-zero, a swap file is immediately created.
7375 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007376 If you want to open a new buffer without creating a swap file for it,
7377 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007378 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379
7380 This option is used together with 'bufhidden' and 'buftype' to
7381 specify special kinds of buffers. See |special-buffers|.
7382
7383 *'swapsync'* *'sws'*
7384'swapsync' 'sws' string (default "fsync")
7385 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007387 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 When this option is empty parts of the swap file may be in memory and
7389 not written to disk. When the system crashes you may lose more work.
7390 On Unix the system does a sync now and then without Vim asking for it,
7391 so the disadvantage of setting this option off is small. On some
7392 systems the swap file will not be written at all. For a unix system
7393 setting it to "sync" will use the sync() call instead of the default
7394 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007395 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396
7397 *'switchbuf'* *'swb'*
7398'switchbuf' 'swb' string (default "")
7399 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 This option controls the behavior when switching between buffers.
7401 Possible values (comma separated list):
7402 useopen If included, jump to the first open window that
7403 contains the specified buffer (if there is one).
7404 Otherwise: Do not examine other windows.
7405 This setting is checked with |quickfix| commands, when
7406 jumping to errors (":cc", ":cn", "cp", etc.). It is
7407 also used in all buffer related split commands, for
7408 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007409 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007410 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007412 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007413 Otherwise: do not split, use current window (when used
7414 in the quickfix window: the previously used window or
7415 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007416 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007417 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007418 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007419 uselast If included, jump to the previously used window when
7420 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007422 *'synmaxcol'* *'smc'*
7423'synmaxcol' 'smc' number (default 3000)
7424 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007425 {not available when compiled without the |+syntax|
7426 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007427 Maximum column in which to search for syntax items. In long lines the
7428 text after this column is not highlighted and following lines may not
7429 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007430 This helps to avoid very slow redrawing for an XML file that is one
7431 long line.
7432 Set to zero to remove the limit.
7433
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 *'syntax'* *'syn'*
7435'syntax' 'syn' string (default empty)
7436 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007437 {not available when compiled without the |+syntax|
7438 feature}
7439 When this option is set, the syntax with this name is loaded, unless
7440 syntax highlighting has been switched off with ":syntax off".
7441 Otherwise this option does not always reflect the current syntax (the
7442 b:current_syntax variable does).
7443 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007444 not automatically recognized. Example, in an IDL file:
7445 /* vim: set syntax=idl : */ ~
7446 When a dot appears in the value then this separates two filetype
7447 names. Example:
7448 /* vim: set syntax=c.doxygen : */ ~
7449 This will use the "c" syntax first, then the "doxygen" syntax.
7450 Note that the second one must be prepared to be loaded as an addition,
7451 otherwise it will be skipped. More than one dot may appear.
7452 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 :set syntax=OFF
7454< To switch syntax highlighting on according to the current value of the
7455 'filetype' option: >
7456 :set syntax=ON
7457< What actually happens when setting the 'syntax' option is that the
7458 Syntax autocommand event is triggered with the value as argument.
7459 This option is not copied to another buffer, independent of the 's' or
7460 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007461 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007463 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007464'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007465 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007466 When nonempty, this option determines the content of the tab pages
7467 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007468 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007469
7470 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007471 option and only when there is no GUI tab line. When 'e' is in
7472 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007473 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007474
7475 The value is evaluated like with 'statusline'. You can use
7476 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007477 the text to be displayed. Use "%1T" for the first label, "%2T" for
7478 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007479
Bram Moolenaare12bab32019-01-08 22:02:56 +01007480 When changing something that is used in 'tabline' that does not
7481 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007482 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007483
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007484 Keep in mind that only one of the tab pages is the current one, others
7485 are invisible and you can't jump to their windows.
7486
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007487
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007488 *'tabpagemax'* *'tpm'*
7489'tabpagemax' 'tpm' number (default 10)
7490 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007491 Maximum number of tab pages to be opened by the |-p| command line
7492 argument or the ":tab all" command. |tabpage|
7493
7494
7495 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496'tabstop' 'ts' number (default 8)
7497 local to buffer
7498 Number of spaces that a <Tab> in the file counts for. Also see
7499 |:retab| command, and 'softtabstop' option.
7500
7501 Note: Setting 'tabstop' to any other value than 8 can make your file
7502 appear wrong in many places (e.g., when printing it).
7503
7504 There are four main ways to use tabs in Vim:
7505 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7506 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007507 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 behave like a tab appears every 4 (or 3) characters.
7509 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7510 'expandtab'. This way you will always insert spaces. The
7511 formatting will never be messed up when 'tabstop' is changed.
7512 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007513 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 works when using Vim to edit the file.
7515 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7516 'noexpandtab'. This should then work (for initial indents only)
7517 for any tabstop setting that people use. It might be nice to have
7518 tabs after the first non-blank inserted as spaces if you do this
7519 though. Otherwise aligned comments will be wrong when 'tabstop' is
7520 changed.
7521
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007522 If Vim is compiled with the |+vartabs| feature then the value of
7523 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7524 than an empty string.
7525
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7527'tagbsearch' 'tbs' boolean (default on)
7528 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007530 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 searching makes searching for a tag a LOT faster, but a linear search
7532 will find more tags if the tags file wasn't properly sorted.
7533 Vim normally assumes that your tags files are sorted, or indicate that
7534 they are not sorted. Only when this is not the case does the
7535 'tagbsearch' option need to be switched off.
7536
7537 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007538 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 certain files, or retry all files with a linear search. When
7540 'tagbsearch' is off, only a linear search is done.
7541
7542 Linear searching is done anyway, for one file, when Vim finds a line
7543 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007544 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545< [The whitespace before and after the '0' must be a single <Tab>]
7546
7547 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007548 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 instead of a normal tag name, a retry is done with a linear search.
7550 Tags in unsorted tags files, and matches with different case will only
7551 be found in the retry.
7552
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007553 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007554 linear search can be avoided when case is ignored. Use a value of '2'
7555 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7556 sorted with the -f switch to "sort" in most unices, as in the command:
7557 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7558 (at least 5.5) the --sort=foldcase switch can be used for this as
7559 well. Note that case must be folded to uppercase for this to work.
7560
7561 By default, tag searches are case-sensitive. Case is ignored when
7562 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7563 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007564 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7565 'tagcase' is "smart", and the pattern contains only lowercase
7566 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567
7568 When 'tagbsearch' is off, tags searching is slower when a full match
7569 exists, but faster when no full match exists. Tags in unsorted tags
7570 files may only be found with 'tagbsearch' off.
7571 When the tags file is not sorted, or sorted in a wrong way (not on
7572 ASCII byte value), 'tagbsearch' should be off, or the line given above
7573 must be included in the tags file.
7574 This option doesn't affect commands that find all matching tags (e.g.,
7575 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007577 *'tagcase'* *'tc'*
7578'tagcase' 'tc' string (default "followic")
7579 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007580 This option specifies how case is handled when searching the tags
7581 file:
7582 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007583 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007584 ignore Ignore case
7585 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007586 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007587 NOTE: This option is set to the Vi default value when 'compatible' is
7588 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007589
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007590 *'tagfunc'* *'tfu'*
7591'tagfunc' 'tfu' string (default: empty)
7592 local to buffer
7593 {not available when compiled without the |+eval|
7594 feature}
7595 This option specifies a function to be used to perform tag searches.
7596 The function gets the tag pattern and should return a List of matching
7597 tags. See |tag-function| for an explanation of how to write the
7598 function and an example.
7599
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 *'taglength'* *'tl'*
7601'taglength' 'tl' number (default 0)
7602 global
7603 If non-zero, tags are significant up to this number of characters.
7604
7605 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7606'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7607 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007608 If on and using a tags file in another directory, file names in that
7609 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 NOTE: This option is set to the Vi default value when 'compatible' is
7611 set and to the Vim default value when 'compatible' is reset.
7612
7613 *'tags'* *'tag'* *E433*
7614'tags' 'tag' string (default "./tags,tags", when compiled with
7615 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7616 global or local to buffer |global-local|
7617 Filenames for the tag command, separated by spaces or commas. To
7618 include a space or comma in a file name, precede it with a backslash
7619 (see |option-backslash| about including spaces and backslashes).
7620 When a file name starts with "./", the '.' is replaced with the path
7621 of the current file. But only when the 'd' flag is not included in
7622 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7623 |tags-option|.
7624 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007625 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7626 find all files named "tags" below "/lib". The filename itself cannot
7627 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7628 files called "tags?". {not available when compiled without the
7629 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007630 The |tagfiles()| function can be used to get a list of the file names
7631 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7633 files are also supported. They are automatically recognized. The
7634 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7635 differences are ignored (MS-Windows). |emacs-tags|
7636 The use of |:set+=| and |:set-=| is preferred when adding or removing
7637 file names from the list. This avoids problems when a future version
7638 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639
7640 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7641'tagstack' 'tgst' boolean (default on)
7642 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 When on, the |tagstack| is used normally. When off, a ":tag" or
7644 ":tselect" command with an argument will not push the tag onto the
7645 tagstack. A following ":tag" without an argument, a ":pop" command or
7646 any other command that uses the tagstack will use the unmodified
7647 tagstack, but does change the pointer to the active entry.
7648 Resetting this option is useful when using a ":tag" command in a
7649 mapping which should not change the tagstack.
7650
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007651 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007652'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007653 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007654 {only available when compiled with the |+tcl/dyn|
7655 feature}
7656 Specifies the name of the Tcl shared library. The default is
7657 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007658 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007659 This option cannot be set from a |modeline| or in the |sandbox|, for
7660 security reasons.
7661
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 *'term'* *E529* *E530* *E531*
7663'term' string (default is $TERM, if that fails:
7664 in the GUI: "builtin_gui"
7665 on Amiga: "amiga"
7666 on BeOS: "beos-ansi"
7667 on Mac: "mac-ansi"
7668 on MiNT: "vt52"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 on Unix: "ansi"
7670 on VMS: "ansi"
7671 on Win 32: "win32")
7672 global
7673 Name of the terminal. Used for choosing the terminal control
7674 characters. Environment variables are expanded |:set_env|.
7675 For example: >
7676 :set term=$TERM
7677< See |termcap|.
7678
7679 *'termbidi'* *'tbidi'*
7680 *'notermbidi'* *'notbidi'*
7681'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 {only available when compiled with the |+arabic|
7684 feature}
7685 The terminal is in charge of Bi-directionality of text (as specified
7686 by Unicode). The terminal is also expected to do the required shaping
7687 that some languages (such as Arabic) require.
7688 Setting this option implies that 'rightleft' will not be set when
7689 'arabic' is set and the value of 'arabicshape' will be ignored.
7690 Note that setting 'termbidi' has the immediate effect that
7691 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7692 This option is reset when the GUI is started.
7693 For further details see |arabic.txt|.
7694
7695 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007696'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697 Macintosh GUI: "macroman")
7698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699 Encoding used for the terminal. This specifies what character
7700 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007701 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007702 display). Except for the Mac when 'macatsui' is off, then
7703 'termencoding' should be "macroman".
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007704 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007705 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7707 Any attempts to set a different value will be rejected, and an error
7708 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007709 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 because the Win32 system always passes Unicode characters.
7711 When empty, the same encoding is used as for the 'encoding' option.
7712 This is the normal value.
7713 Not all combinations for 'termencoding' and 'encoding' are valid. See
7714 |encoding-table|.
7715 The value for this option must be supported by internal conversions or
7716 iconv(). When this is not possible no conversion will be done and you
7717 will probably experience problems with non-ASCII characters.
7718 Example: You are working with the locale set to euc-jp (Japanese) and
7719 want to edit a UTF-8 file: >
7720 :let &termencoding = &encoding
7721 :set encoding=utf-8
7722< You need to do this when your system has no locale support for UTF-8.
7723
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007724 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007725'termguicolors' 'tgc' boolean (default off)
7726 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007727 {not available when compiled without the
7728 |+termguicolors| feature}
7729 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007730 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007731
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007732 Requires a ISO-8613-3 compatible terminal. If setting this option
7733 does not work (produces a colorless UI) reading |xterm-true-color|
7734 might help.
7735
7736 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7737 is required. Use this check to find out: >
7738 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007739< This requires Vim to be built with the |+vtp| feature.
7740
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007741 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007742 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007743
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007744 *'termwinkey'* *'twk'*
7745'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007746 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007747 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007748 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007749 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007750 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007751< The string must be one key stroke but can be multiple bytes.
7752 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007753 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007754 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007755
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007756 *'termwinscroll'* *'twsl'*
7757'termwinscroll' 'twsl' number (default 10000)
7758 local to buffer
7759 {not available when compiled without the
7760 |+terminal| feature}
7761 Number of scrollback lines to keep. When going over this limit the
7762 first 10% of the scrollback lines are deleted. This is just to reduce
7763 the memory usage. See |Terminal-Normal|.
7764
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007765 *'termwinsize'* *'tws'*
7766'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007767 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007768 Size of the |terminal| window. Format: {rows}x{columns} or
7769 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007770 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007771 - When set with a "x" (e.g., "24x80") the terminal size is not
7772 adjusted to the window size. If the window is smaller only the
7773 top-left part is displayed.
7774 - When set with a "*" (e.g., "10*50") the terminal size follows the
7775 window size, but will not be smaller than the specified rows and/or
7776 columns.
7777 - When rows is zero then use the height of the window.
7778 - When columns is zero then use the width of the window.
7779 - Using "0x0" or "0*0" is the same as empty.
7780
7781 Examples:
7782 "30x0" uses 30 rows and the current window width.
7783 "20*0" uses at least 20 rows and the current window width.
7784 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007785 Note that the command running in the terminal window may still change
7786 the size of the terminal. In that case the Vim window will be
7787 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007788
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007789 *'termwintype'* *'twt'*
7790'termwintype' 'twt' string (default "")
7791 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007792 {only available when compiled with the |terminal|
7793 feature on MS-Windows}
7794 Specify the virtual console (pty) used when opening the terminal
7795 window.
7796
7797 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007798 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007799 "winpty" use winpty, fail if not supported
7800 "conpty" use |ConPTY|, fail if not supported
7801
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007802 |ConPTY| support depends on the platform. Windows 10 October 2018
7803 Update is the first version that supports ConPTY, however it is still
7804 considered unstable. ConPTY might become stable in the next release
7805 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007806 supported then you cannot open a terminal window.
7807
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 *'terse'* *'noterse'*
7809'terse' boolean (default off)
7810 global
7811 When set: Add 's' flag to 'shortmess' option (this makes the message
7812 for a search that hits the start or end of the file not being
7813 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7814 shortens a lot of messages}
7815
7816 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7817'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 This option is obsolete. Use 'fileformats'.
7820 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7821 set to the default value for the current system. When 'textauto' is
7822 reset, 'fileformats' is made empty.
7823 NOTE: This option is set to the Vi default value when 'compatible' is
7824 set and to the Vim default value when 'compatible' is reset.
7825
7826 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007827'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 others: default off)
7829 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 This option is obsolete. Use 'fileformat'.
7831 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7832 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7833 "unix".
7834
7835 *'textwidth'* *'tw'*
7836'textwidth' 'tw' number (default 0)
7837 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007838 Maximum width of text that is being inserted. A longer line will be
7839 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007840 this.
7841 'textwidth' is set to 0 when the 'paste' option is set and restored
7842 when 'paste' is reset.
7843 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007844 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007845 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846 NOTE: This option is set to 0 when 'compatible' is set.
7847
7848 *'thesaurus'* *'tsr'*
7849'thesaurus' 'tsr' string (default "")
7850 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007852 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7853
7854 Each line in the file should contain words with similar meaning,
7855 separated by non-keyword characters (white space is preferred).
7856 Maximum line length is 510 bytes.
7857
Bram Moolenaard47d5222018-12-09 20:43:55 +01007858 An English word list was added to this github issue:
7859 https://github.com/vim/vim/issues/629#issuecomment-443293282
7860 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7861 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7862 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007863
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007864 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 after a comma are ignored, otherwise spaces are included in the file
7866 name. See |option-backslash| about using backslashes.
7867 The use of |:set+=| and |:set-=| is preferred when adding or removing
7868 directories from the list. This avoids problems when a future version
7869 uses another default.
7870 Backticks cannot be used in this option for security reasons.
7871
7872 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7873'tildeop' 'top' boolean (default off)
7874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 When on: The tilde command "~" behaves like an operator.
7876 NOTE: This option is reset when 'compatible' is set.
7877
7878 *'timeout'* *'to'* *'notimeout'* *'noto'*
7879'timeout' 'to' boolean (default on)
7880 global
7881 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007882'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 These two options together determine the behavior when part of a
7885 mapped key sequence or keyboard code has been received:
7886
7887 'timeout' 'ttimeout' action ~
7888 off off do not time out
7889 on on or off time out on :mappings and key codes
7890 off on time out on key codes
7891
7892 If both options are off, Vim will wait until either the complete
7893 mapping or key sequence has been received, or it is clear that there
7894 is no mapping or key sequence for the received characters. For
7895 example: if you have mapped "vl" and Vim has received 'v', the next
7896 character is needed to see if the 'v' is followed by an 'l'.
7897 When one of the options is on, Vim will wait for about 1 second for
7898 the next character to arrive. After that the already received
7899 characters are interpreted as single characters. The waiting time can
7900 be changed with the 'timeoutlen' option.
7901 On slow terminals or very busy systems timing out may cause
7902 malfunctioning cursor keys. If both options are off, Vim waits
7903 forever after an entered <Esc> if there are key codes that start
7904 with <Esc>. You will have to type <Esc> twice. If you do not have
7905 problems with key codes, but would like to have :mapped key
7906 sequences not timing out in 1 second, set the 'ttimeout' option and
7907 reset the 'timeout' option.
7908
7909 NOTE: 'ttimeout' is reset when 'compatible' is set.
7910
7911 *'timeoutlen'* *'tm'*
7912'timeoutlen' 'tm' number (default 1000)
7913 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007914
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007916'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 The time in milliseconds that is waited for a key code or mapped key
7919 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7920 when part of a command has been typed.
7921 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7922 different timeout value for key codes is desired set 'ttimeoutlen' to
7923 a non-negative number.
7924
7925 ttimeoutlen mapping delay key code delay ~
7926 < 0 'timeoutlen' 'timeoutlen'
7927 >= 0 'timeoutlen' 'ttimeoutlen'
7928
7929 The timeout only happens when the 'timeout' and 'ttimeout' options
7930 tell so. A useful setting would be >
7931 :set timeout timeoutlen=3000 ttimeoutlen=100
7932< (time out on mapping after three seconds, time out on key codes after
7933 a tenth of a second).
7934
7935 *'title'* *'notitle'*
7936'title' boolean (default off, on when title can be restored)
7937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 {not available when compiled without the |+title|
7939 feature}
7940 When on, the title of the window will be set to the value of
7941 'titlestring' (if it is not empty), or to:
7942 filename [+=-] (path) - VIM
7943 Where:
7944 filename the name of the file being edited
7945 - indicates the file cannot be modified, 'ma' off
7946 + indicates the file was modified
7947 = indicates the file is read-only
7948 =+ indicates the file is read-only and modified
7949 (path) is the path of the file being edited
7950 - VIM the server name |v:servername| or "VIM"
7951 Only works if the terminal supports setting window titles
7952 (currently Amiga console, Win32 console, all GUI versions and
7953 terminals with a non- empty 't_ts' option - these are Unix xterm and
7954 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7955 *X11*
7956 When Vim was compiled with HAVE_X11 defined, the original title will
7957 be restored if possible. The output of ":version" will include "+X11"
7958 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7959 works for the icon name |'icon'|.
7960 But: When Vim was started with the |-X| argument, restoring the title
7961 will not work (except in the GUI).
7962 If the title cannot be restored, it is set to the value of 'titleold'.
7963 You might want to restore the title outside of Vim then.
7964 When using an xterm from a remote machine you can use this command:
7965 rsh machine_name xterm -display $DISPLAY &
7966 then the WINDOWID environment variable should be inherited and the
7967 title of the window should change back to what it should be after
7968 exiting Vim.
7969
7970 *'titlelen'*
7971'titlelen' number (default 85)
7972 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 {not available when compiled without the |+title|
7974 feature}
7975 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007976 title. When the title is longer, only the end of the path name is
7977 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 Using a percentage makes this adapt to the width of the window. But
7979 it won't work perfectly, because the actual number of characters
7980 available also depends on the font used and other things in the title
7981 bar. When 'titlelen' is zero the full path is used. Otherwise,
7982 values from 1 to 30000 percent can be used.
7983 'titlelen' is also used for the 'titlestring' option.
7984
7985 *'titleold'*
7986'titleold' string (default "Thanks for flying Vim")
7987 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 {only available when compiled with the |+title|
7989 feature}
7990 This option will be used for the window title when exiting Vim if the
7991 original title cannot be restored. Only happens if 'title' is on or
7992 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007993 This option cannot be set from a |modeline| or in the |sandbox|, for
7994 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 *'titlestring'*
7996'titlestring' string (default "")
7997 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 {not available when compiled without the |+title|
7999 feature}
8000 When this option is not empty, it will be used for the title of the
8001 window. This happens only when the 'title' option is on.
8002 Only works if the terminal supports setting window titles (currently
8003 Amiga console, Win32 console, all GUI versions and terminals with a
8004 non-empty 't_ts' option).
8005 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008006 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008007
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 When this option contains printf-style '%' items, they will be
8009 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008010 This option cannot be set in a modeline when 'modelineexpr' is off.
8011
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 Example: >
8013 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8014 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8015< The value of 'titlelen' is used to align items in the middle or right
8016 of the available space.
8017 Some people prefer to have the file name first: >
8018 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8019< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008020 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 separating space only when needed.
8022 NOTE: Use of special characters in 'titlestring' may cause the display
8023 to be garbled (e.g., when it contains a CR or NL character).
8024 {not available when compiled without the |+statusline| feature}
8025
8026 *'toolbar'* *'tb'*
8027'toolbar' 'tb' string (default "icons,tooltips")
8028 global
8029 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8030 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008031 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 possible values are:
8033 icons Toolbar buttons are shown with icons.
8034 text Toolbar buttons shown with text.
8035 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008036 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 tooltips Tooltips are active for toolbar buttons.
8038 Tooltips refer to the popup help text which appears after the mouse
8039 cursor is placed over a toolbar button for a brief moment.
8040
8041 If you want the toolbar to be shown with icons as well as text, do the
8042 following: >
8043 :set tb=icons,text
8044< Motif and Athena cannot display icons and text at the same time. They
8045 will show icons if both are requested.
8046
8047 If none of the strings specified in 'toolbar' are valid or if
8048 'toolbar' is empty, this option is ignored. If you want to disable
8049 the toolbar, you need to set the 'guioptions' option. For example: >
8050 :set guioptions-=T
8051< Also see |gui-toolbar|.
8052
8053 *'toolbariconsize'* *'tbis'*
8054'toolbariconsize' 'tbis' string (default "small")
8055 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008056 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008057 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008058 tiny Use tiny icons.
8059 small Use small icons (default).
8060 medium Use medium-sized icons.
8061 large Use large icons.
8062 huge Use even larger icons.
8063 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008065 the current theme. Common dimensions are giant=48x48, huge=32x32,
8066 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067
8068 If 'toolbariconsize' is empty, the global default size as determined
8069 by user preferences or the current theme is used.
8070
8071 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8072'ttybuiltin' 'tbi' boolean (default on)
8073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 When on, the builtin termcaps are searched before the external ones.
8075 When off the builtin termcaps are searched after the external ones.
8076 When this option is changed, you should set the 'term' option next for
8077 the change to take effect, for example: >
8078 :set notbi term=$TERM
8079< See also |termcap|.
8080 Rationale: The default for this option is "on", because the builtin
8081 termcap entries are generally better (many systems contain faulty
8082 xterm entries...).
8083
8084 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8085'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8086 sun-cmd, screen, rxvt, dtterm or
8087 iris-ansi; also on when running Vim in
8088 a DOS console)
8089 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008090 Indicates a fast terminal connection. More characters will be sent to
8091 the screen for redrawing, instead of using insert/delete line
8092 commands. Improves smoothness of redrawing when there are multiple
8093 windows and the terminal does not support a scrolling region.
8094 Also enables the extra writing of characters at the end of each screen
8095 line for lines that wrap. This helps when using copy/paste with the
8096 mouse in an xterm and other terminals.
8097
8098 *'ttymouse'* *'ttym'*
8099'ttymouse' 'ttym' string (default depends on 'term')
8100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008101 {only in Unix and VMS, doesn't work in the GUI; not
8102 available when compiled without |+mouse|}
8103 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008104 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105 *xterm-mouse*
8106 xterm xterm-like mouse handling. The mouse generates
8107 "<Esc>[Mscr", where "scr" is three bytes:
8108 "s" = button state
8109 "c" = column plus 33
8110 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008111 This only works up to 223 columns! See "dec",
8112 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 xterm2 Works like "xterm", but with the xterm reporting the
8114 mouse position while the mouse is dragged. This works
8115 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008116 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117 work. See below for how Vim detects this
8118 automatically.
8119 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008120 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008122 for the row and column. No other mouse events are
8123 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 *dec-mouse*
8125 dec DEC terminal mouse handling. The mouse generates a
8126 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008127 This is also available for an Xterm, if it was
8128 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 *jsbterm-mouse*
8130 jsbterm JSB term mouse handling.
8131 *pterm-mouse*
8132 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008133 *urxvt-mouse*
8134 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008135 The mouse works only if the terminal supports this
8136 encoding style, but it does not have 223 columns limit
8137 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008138 *sgr-mouse*
8139 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008140 mouse reporting. The mouse works even in columns
8141 beyond 223. This option is backward compatible with
8142 "xterm2" because it can also decode "xterm2" style
8143 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144
8145 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008146 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8147 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8149 recognized, if enabled at compile time. DEC terminal mouse codes
8150 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008151 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8152 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008153 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008154 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8155 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8156 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008157 Additionally, if vim is compiled with the |+termresponse| feature and
8158 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008159 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008161 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8162 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8163 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008164 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8165 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166 :set t_RV=
8167<
8168 *'ttyscroll'* *'tsl'*
8169'ttyscroll' 'tsl' number (default 999)
8170 global
8171 Maximum number of lines to scroll the screen. If there are more lines
8172 to scroll the window is redrawn. For terminals where scrolling is
8173 very slow and redrawing is not slow this can be set to a small number,
8174 e.g., 3, to speed up displaying.
8175
8176 *'ttytype'* *'tty'*
8177'ttytype' 'tty' string (default from $TERM)
8178 global
8179 Alias for 'term', see above.
8180
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008181 *'undodir'* *'udir'*
8182'undodir' 'udir' string (default ".")
8183 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008184 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008185 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008186 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008187 "." means using the directory of the file. The undo file name for
8188 "file.txt" is ".file.txt.un~".
8189 For other directories the file name is the full path of the edited
8190 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008191 When writing: The first directory that exists is used. "." always
8192 works, no directories after "." will be used for writing.
8193 When reading all entries are tried to find an undo file. The first
8194 undo file that exists is used. When it cannot be read an error is
8195 given, no further entry is used.
8196 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008197 This option cannot be set from a |modeline| or in the |sandbox|, for
8198 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008199
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008200 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008201'undofile' 'udf' boolean (default off)
8202 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008203 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008204 When on, Vim automatically saves undo history to an undo file when
8205 writing a buffer to a file, and restores undo history from the same
8206 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008207 The directory where the undo file is stored is specified by 'undodir'.
8208 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008209 The undo file is not read when 'undoreload' causes the buffer from
8210 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008211 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008212 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008213
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008215'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008216 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008218 is kept in memory, higher numbers will cause more memory to be used.
8219 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8221 itself: >
8222 set ul=0
8223< But you can also get Vi compatibility by including the 'u' flag in
8224 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008225 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008226 Set to -1 for no undo at all. You might want to do this only for the
8227 current buffer: >
8228 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008230
8231 The local value is set to -123456 when the global value is to be used.
8232
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008233 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008235 *'undoreload'* *'ur'*
8236'undoreload' 'ur' number (default 10000)
8237 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008238 Save the whole buffer for undo when reloading it. This applies to the
8239 ":e!" command and reloading for when the buffer changed outside of
8240 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008241 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008242 of lines is smaller than the value of this option.
8243 Set this option to zero to disable undo for a reload.
8244
8245 When saving undo for a reload, any undo file is not read.
8246
8247 Note that this causes the whole buffer to be stored in memory. Set
8248 this option to a lower value if you run out of memory.
8249
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 *'updatecount'* *'uc'*
8251'updatecount' 'uc' number (default: 200)
8252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 After typing this many characters the swap file will be written to
8254 disk. When zero, no swap file will be created at all (see chapter on
8255 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8256 Vim with the "-n" option, see |startup|. When editing in readonly
8257 mode this option will be initialized to 10000.
8258 The swapfile can be disabled per buffer with |'swapfile'|.
8259 When 'updatecount' is set from zero to non-zero, swap files are
8260 created for all buffers that have 'swapfile' set. When 'updatecount'
8261 is set to zero, existing swap files are not deleted.
8262 Also see |'swapsync'|.
8263 This option has no meaning in buffers where |'buftype'| is "nofile"
8264 or "nowrite".
8265
8266 *'updatetime'* *'ut'*
8267'updatetime' 'ut' number (default 4000)
8268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 If this many milliseconds nothing is typed the swap file will be
8270 written to disk (see |crash-recovery|). Also used for the
8271 |CursorHold| autocommand event.
8272
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008273 *'varsofttabstop'* *'vsts'*
8274'varsofttabstop' 'vsts' string (default "")
8275 local to buffer
8276 {only available when compiled with the |+vartabs|
8277 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008278 A list of the number of spaces that a <Tab> counts for while editing,
8279 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8280 width <Tab>s are being inserted, while in fact a mixture of spaces
8281 and <Tab>s is used. Tab widths are separated with commas, with the
8282 final value applying to all subsequent tabs.
8283
8284 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008285 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008286 to use the following: >
8287 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008288< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8289 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008290
8291 Note that the value of |'softtabstop'| will be ignored while
8292 'varsofttabstop' is set.
8293
8294 *'vartabstop'* *'vts'*
8295'vartabstop' 'vts' string (default "")
8296 local to buffer
8297 {only available when compiled with the |+vartabs|
8298 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008299 A list of the number of spaces that a <Tab> in the file counts for,
8300 separated by commas. Each value corresponds to one tab, with the
8301 final value applying to all subsequent tabs. For example: >
8302 :set vartabstop=4,20,10,8
8303< This will make the first tab 4 spaces wide, the second 20 spaces,
8304 the third 10 spaces, and all following tabs 8 spaces.
8305
8306 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8307 is set.
8308
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 *'verbose'* *'vbs'*
8310'verbose' 'vbs' number (default 0)
8311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 When bigger than zero, Vim will give messages about what it is doing.
8313 Currently, these messages are given:
8314 >= 1 When the viminfo file is read or written.
8315 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008316 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 >= 8 Files for which a group of autocommands is executed.
8318 >= 9 Every executed autocommand.
8319 >= 12 Every executed function.
8320 >= 13 When an exception is thrown, caught, finished, or discarded.
8321 >= 14 Anything pending in a ":finally" clause.
8322 >= 15 Every executed Ex command (truncated at 200 characters).
8323
8324 This option can also be set with the "-V" argument. See |-V|.
8325 This option is also set by the |:verbose| command.
8326
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008327 When the 'verbosefile' option is set then the verbose messages are not
8328 displayed.
8329
8330 *'verbosefile'* *'vfile'*
8331'verbosefile' 'vfile' string (default empty)
8332 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008333 When not empty all messages are written in a file with this name.
8334 When the file exists messages are appended.
8335 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008336 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008337 Setting 'verbosefile' to a new value is like making it empty first.
8338 The difference with |:redir| is that verbose messages are not
8339 displayed when 'verbosefile' is set.
8340
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008342'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 "$VIM/vimfiles/view",
8344 for Unix: "~/.vim/view",
8345 for Macintosh: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008346 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008348 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 feature}
8350 Name of the directory where to store files for |:mkview|.
8351 This option cannot be set from a |modeline| or in the |sandbox|, for
8352 security reasons.
8353
8354 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008355'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008357 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 feature}
8359 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008360 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361 word save and restore ~
8362 cursor cursor position in file and in window
8363 folds manually created folds, opened/closed folds and local
8364 fold options
8365 options options and mappings local to a window or buffer (not
8366 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008367 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 slash backslashes in file names replaced with forward
8369 slashes
8370 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008371 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008372 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008373
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008374 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008376 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377
8378 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008379'viminfo' 'vi' string (Vi default: "", Vim default for
8380 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008381 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8382 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008384 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385 feature}
8386 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008387 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8388 "NONE".
8389 The string should be a comma separated list of parameters, each
8390 consisting of a single character identifying the particular parameter,
8391 followed by a number or string which specifies the value of that
8392 parameter. If a particular character is left out, then the default
8393 value is used for that parameter. The following is a list of the
8394 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008396 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008397 ! When included, save and restore global variables that start
8398 with an uppercase letter, and don't contain a lowercase
8399 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008400 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008401 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008402 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 " Maximum number of lines saved for each register. Old name of
8404 the '<' item, with the disadvantage that you need to put a
8405 backslash before the ", otherwise it will be recognized as the
8406 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008407 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008408 % When included, save and restore the buffer list. If Vim is
8409 started with a file name argument, the buffer list is not
8410 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008411 buffer list is restored from the viminfo file. Quickfix
8412 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8413 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008414 When followed by a number, the number specifies the maximum
8415 number of buffers that are stored. Without a number all
8416 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008417 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 ' Maximum number of previously edited files for which the marks
8419 are remembered. This parameter must always be included when
8420 'viminfo' is non-empty.
8421 Including this item also means that the |jumplist| and the
8422 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008423 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008425 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 patterns are also saved. When not included, the value of
8427 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008428 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008429 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008430 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008431 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 < Maximum number of lines saved for each register. If zero then
8433 registers are not saved. When not included, all lines are
8434 saved. '"' is the old name for this item.
8435 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008436 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008438 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008439 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 c When included, convert the text in the viminfo file from the
8441 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008442 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008443 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 f Whether file marks need to be stored. If zero, file marks ('0
8445 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008446 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008448 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 h Disable the effect of 'hlsearch' when loading the viminfo
8450 file. When not included, it depends on whether ":nohlsearch"
8451 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008452 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008454 the 'n'. Must be at the end of the option! If the
8455 'viminfofile' option is set, that file name overrides the one
8456 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008457 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008458 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 r Removable media. The argument is a string (up to the next
8460 ','). This parameter can be given several times. Each
8461 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008462 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8464 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8465 ignored. Maximum length of each 'r' argument is 50
8466 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008467 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 s Maximum size of an item in Kbyte. If zero then registers are
8469 not saved. Currently only applies to registers. The default
8470 "s10" will exclude registers with more than 10 Kbyte of text.
8471 Also see the '<' item above: line count limit.
8472
8473 Example: >
8474 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8475<
8476 '50 Marks will be remembered for the last 50 files you
8477 edited.
8478 <1000 Contents of registers (up to 1000 lines each) will be
8479 remembered.
8480 s100 Registers with more than 100 Kbyte text are skipped.
8481 :0 Command-line history will not be saved.
8482 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8483 no / Since '/' is not specified, the default will be used,
8484 that is, save all of the search history, and also the
8485 previous search and substitute patterns.
8486 no % The buffer list will not be saved nor read back.
8487 no h 'hlsearch' highlighting will be restored.
8488
8489 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8490 load the contents of the file, this is not done automatically.
8491
8492 This option cannot be set from a |modeline| or in the |sandbox|, for
8493 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008494 NOTE: This option is set to the Vim default value when 'compatible'
8495 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008497 *'viminfofile'* *'vif'*
8498'viminfofile' 'vif' string (default: "")
8499 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008500 {not available when compiled without the |+viminfo|
8501 feature}
8502 When non-empty, overrides the file name used for viminfo.
8503 When equal to "NONE" no viminfo file will be read or written.
8504 This option can be set with the |-i| command line flag. The |--clean|
8505 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008506 This option cannot be set from a |modeline| or in the |sandbox|, for
8507 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008508
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 *'virtualedit'* *'ve'*
8510'virtualedit' 've' string (default "")
8511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 {not available when compiled without the
8513 |+virtualedit| feature}
8514 A comma separated list of these words:
8515 block Allow virtual editing in Visual block mode.
8516 insert Allow virtual editing in Insert mode.
8517 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008518 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008519
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008521 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 of the line. Useful for selecting a rectangle in Visual mode and
8523 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008524 "onemore" is not the same, it will only allow moving the cursor just
8525 after the last character of the line. This makes some commands more
8526 consistent. Previously the cursor was always past the end of the line
8527 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008528 break some plugins or Vim scripts. For example because |l| can move
8529 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008530 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008531 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008532 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008533 It doesn't make sense to combine "all" with "onemore", but you will
8534 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008535 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008536
8537 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8538'visualbell' 'vb' boolean (default off)
8539 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008540 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008542 use: >
8543 :set vb t_vb=
8544< If you want a short flash, you can use this on many terminals: >
8545 :set vb t_vb=[?5h$<100>[?5l
8546< Here $<100> specifies the time, you can use a smaller or bigger value
8547 to get a shorter or longer flash.
8548
8549 Note: Vim will limit the bell to once per half a second. This avoids
8550 having to wait for the flashing to finish when there are lots of
8551 bells, e.g. on key repeat. This also happens without 'visualbell'
8552 set.
8553
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8555 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8556 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008557
8558 Note: When the GUI starts, 't_vb' is reset to its default value. You
8559 might want to set it again in your |gvimrc|.
8560
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 Does not work on the Amiga, you always get a screen flash.
8562 Also see 'errorbells'.
8563
8564 *'warn'* *'nowarn'*
8565'warn' boolean (default on)
8566 global
8567 Give a warning message when a shell command is used while the buffer
8568 has been changed.
8569
8570 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8571'weirdinvert' 'wiv' boolean (default off)
8572 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008573 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 It is provided for backwards compatibility with version 4.x.
8575 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8576 vice versa. Has no effect when the GUI is running.
8577
8578 *'whichwrap'* *'ww'*
8579'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8580 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 Allow specified keys that move the cursor left/right to move to the
8582 previous/next line when the cursor is on the first/last character in
8583 the line. Concatenate characters to allow this for these keys:
8584 char key mode ~
8585 b <BS> Normal and Visual
8586 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008587 h "h" Normal and Visual (not recommended)
8588 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 < <Left> Normal and Visual
8590 > <Right> Normal and Visual
8591 ~ "~" Normal
8592 [ <Left> Insert and Replace
8593 ] <Right> Insert and Replace
8594 For example: >
8595 :set ww=<,>,[,]
8596< allows wrap only when cursor keys are used.
8597 When the movement keys are used in combination with a delete or change
8598 operator, the <EOL> also counts for a character. This makes "3h"
8599 different from "3dh" when the cursor crosses the end of a line. This
8600 is also true for "x" and "X", because they do the same as "dl" and
8601 "dh". If you use this, you may also want to use the mapping
8602 ":map <BS> X" to make backspace delete the character in front of the
8603 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008604 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008605 line (not an empty line) then it will not move to the next line. This
8606 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 NOTE: This option is set to the Vi default value when 'compatible' is
8608 set and to the Vim default value when 'compatible' is reset.
8609
8610 *'wildchar'* *'wc'*
8611'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8612 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613 Character you have to type to start wildcard expansion in the
8614 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008615 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 The character is not recognized when used inside a macro. See
8617 'wildcharm' for that.
8618 Although 'wc' is a number option, you can set it to a special key: >
8619 :set wc=<Esc>
8620< NOTE: This option is set to the Vi default value when 'compatible' is
8621 set and to the Vim default value when 'compatible' is reset.
8622
8623 *'wildcharm'* *'wcm'*
8624'wildcharm' 'wcm' number (default: none (0))
8625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008626 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008627 recognized when used inside a macro. You can find "spare" command-line
8628 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 you'll never actually type 'wildcharm', just use it in mappings that
8630 automatically invoke completion mode, e.g.: >
8631 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008632 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633< Then after typing :ss you can use CTRL-P & CTRL-N.
8634
8635 *'wildignore'* *'wig'*
8636'wildignore' 'wig' string (default "")
8637 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 {not available when compiled without the |+wildignore|
8639 feature}
8640 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008641 patterns is ignored when expanding |wildcards|, completing file or
8642 directory names, and influences the result of |expand()|, |glob()| and
8643 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8645 Also see 'suffixes'.
8646 Example: >
8647 :set wildignore=*.o,*.obj
8648< The use of |:set+=| and |:set-=| is preferred when adding or removing
8649 a pattern from the list. This avoids problems when a future version
8650 uses another default.
8651
Bram Moolenaar94950a92010-12-02 16:01:29 +01008652
Bram Moolenaar81af9252010-12-10 20:35:50 +01008653 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008654'wildignorecase' 'wic' boolean (default off)
8655 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008656 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008657 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008658 Does not apply when the shell is used to expand wildcards, which
8659 happens when there are special characters.
8660
8661
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008663'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 {not available if compiled without the |+wildmenu|
8666 feature}
8667 When 'wildmenu' is on, command-line completion operates in an enhanced
8668 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8669 the possible matches are shown just above the command line, with the
8670 first match highlighted (overwriting the status line, if there is
8671 one). Keys that show the previous/next match, such as <Tab> or
8672 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8673 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8674 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008675 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 If there are more matches than can fit in the line, a ">" is shown on
8677 the right and/or a "<" is shown on the left. The status line scrolls
8678 as needed.
8679 The "wildmenu" mode is abandoned when a key is hit that is not used
8680 for selecting a completion.
8681 While the "wildmenu" is active the following keys have special
8682 meanings:
8683
8684 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8685 <Down> - in filename/menu name completion: move into a
8686 subdirectory or submenu.
8687 <CR> - in menu completion, when the cursor is just after a
8688 dot: move into a submenu.
8689 <Up> - in filename/menu name completion: move up into
8690 parent directory or parent menu.
8691
8692 This makes the menus accessible from the console |console-menus|.
8693
8694 If you prefer the <Left> and <Right> keys to move the cursor instead
8695 of selecting a different match, use this: >
8696 :cnoremap <Left> <Space><BS><Left>
8697 :cnoremap <Right> <Space><BS><Right>
8698<
8699 The "WildMenu" highlighting is used for displaying the current match
8700 |hl-WildMenu|.
8701
8702 *'wildmode'* *'wim'*
8703'wildmode' 'wim' string (Vim default: "full")
8704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008706 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008707 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008708 first part specifies the behavior for the first use of 'wildchar',
8709 The second part for the second use, etc.
8710 These are the possible values for each part:
8711 "" Complete only the first match.
8712 "full" Complete the next full match. After the last match,
8713 the original string is used and then the first match
8714 again.
8715 "longest" Complete till longest common string. If this doesn't
8716 result in a longer string, use the next part.
8717 "longest:full" Like "longest", but also start 'wildmenu' if it is
8718 enabled.
8719 "list" When more than one match, list all matches.
8720 "list:full" When more than one match, list all matches and
8721 complete first match.
8722 "list:longest" When more than one match, list all matches and
8723 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008724 "list:lastused" When more than one buffer matches, sort buffers
8725 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008726 When there is only a single match, it is fully completed in all cases.
8727
8728 Examples: >
8729 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008730< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 :set wildmode=longest,full
8732< Complete longest common string, then each full match >
8733 :set wildmode=list:full
8734< List all matches and complete each full match >
8735 :set wildmode=list,full
8736< List all matches without completing, then each full match >
8737 :set wildmode=longest,list
8738< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008739 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008741 *'wildoptions'* *'wop'*
8742'wildoptions' 'wop' string (default "")
8743 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008744 {not available when compiled without the |+wildignore|
8745 feature}
8746 A list of words that change how command line completion is done.
8747 Currently only one word is allowed:
8748 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008749 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008750 is displayed per line. Often used tag kinds are:
8751 d #define
8752 f function
8753 Also see |cmdline-completion|.
8754
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 *'winaltkeys'* *'wak'*
8756'winaltkeys' 'wak' string (default "menu")
8757 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 {only used in Win32, Motif, GTK and Photon GUI}
8759 Some GUI versions allow the access to menu entries by using the ALT
8760 key in combination with a character that appears underlined in the
8761 menu. This conflicts with the use of the ALT key for mappings and
8762 entering special characters. This option tells what to do:
8763 no Don't use ALT keys for menus. ALT key combinations can be
8764 mapped, but there is no automatic handling. This can then be
8765 done with the |:simalt| command.
8766 yes ALT key handling is done by the windowing system. ALT key
8767 combinations cannot be mapped.
8768 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008769 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 keys can be mapped.
8771 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8772 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008773 This option is not used for <F10>; on Win32 and with GTK <F10> will
8774 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008776 *'wincolor'* *'wcr'*
8777'wincolor' 'wcr' string (default empty)
8778 local to window
8779 Highlight group name to use for this window instead of the Normal
8780 color |hl-Normal|.
8781
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008782 *'window'* *'wi'*
8783'window' 'wi' number (default screen height - 1)
8784 global
8785 Window height. Do not confuse this with the height of the Vim window,
8786 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008787 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8788 value is smaller than 'lines' minus one. The screen will scroll
8789 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008790 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8791 in a much smarter way, taking care of wrapping lines.
8792 When resizing the Vim window, the value is smaller than 1 or more than
8793 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008794
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795 *'winheight'* *'wh'* *E591*
8796'winheight' 'wh' number (default 1)
8797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008799 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008800 focus goes to a window that is smaller, its size is increased, at the
8801 cost of the height of other windows.
8802 Set 'winheight' to a small number for normal editing.
8803 Set it to 999 to make the current window fill most of the screen.
8804 Other windows will be only 'winminheight' high. This has the drawback
8805 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8806 to create only two windows, set the option after startup is done,
8807 using the |VimEnter| event: >
8808 au VimEnter * set winheight=999
8809< Minimum value is 1.
8810 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 height of the current window.
8812 'winheight' applies to the current window. Use 'winminheight' to set
8813 the minimal height for other windows.
8814
8815 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8816'winfixheight' 'wfh' boolean (default off)
8817 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008819 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8820 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 The height may be changed anyway when running out of room.
8822
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008823 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8824'winfixwidth' 'wfw' boolean (default off)
8825 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008826 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008827 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008828 The width may be changed anyway when running out of room.
8829
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830 *'winminheight'* *'wmh'*
8831'winminheight' 'wmh' number (default 1)
8832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 The minimal height of a window, when it's not the current window.
8834 This is a hard minimum, windows will never become smaller.
8835 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8836 status bar) if necessary. They will return to at least one line when
8837 they become active (since the cursor has to have somewhere to go.)
8838 Use 'winheight' to set the minimal height of the current window.
8839 This option is only checked when making a window smaller. Don't use a
8840 large number, it will cause errors when opening more than a few
8841 windows. A value of 0 to 3 is reasonable.
8842
8843 *'winminwidth'* *'wmw'*
8844'winminwidth' 'wmw' number (default 1)
8845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 The minimal width of a window, when it's not the current window.
8847 This is a hard minimum, windows will never become smaller.
8848 When set to zero, windows may be "squashed" to zero columns (i.e. just
8849 a vertical separator) if necessary. They will return to at least one
8850 line when they become active (since the cursor has to have somewhere
8851 to go.)
8852 Use 'winwidth' to set the minimal width of the current window.
8853 This option is only checked when making a window smaller. Don't use a
8854 large number, it will cause errors when opening more than a few
8855 windows. A value of 0 to 12 is reasonable.
8856
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008857 *'winptydll'*
8858'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8859 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008860 {only available when compiled with the |terminal|
8861 feature on MS-Windows}
8862 Specifies the name of the winpty shared library, used for the
8863 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008864 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008865 a fallback.
8866 Environment variables are expanded |:set_env|.
8867 This option cannot be set from a |modeline| or in the |sandbox|, for
8868 security reasons.
8869
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870 *'winwidth'* *'wiw'* *E592*
8871'winwidth' 'wiw' number (default 20)
8872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873 Minimal number of columns for the current window. This is not a hard
8874 minimum, Vim will use fewer columns if there is not enough room. If
8875 the current window is smaller, its size is increased, at the cost of
8876 the width of other windows. Set it to 999 to make the current window
8877 always fill the screen. Set it to a small number for normal editing.
8878 The width is not adjusted after one of the commands to change the
8879 width of the current window.
8880 'winwidth' applies to the current window. Use 'winminwidth' to set
8881 the minimal width for other windows.
8882
8883 *'wrap'* *'nowrap'*
8884'wrap' boolean (default on)
8885 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 This option changes how text is displayed. It doesn't change the text
8887 in the buffer, see 'textwidth' for that.
8888 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008889 displaying continues on the next line. When off lines will not wrap
8890 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 moved to a part that is not shown, the screen will scroll
8892 horizontally.
8893 The line will be broken in the middle of a word if necessary. See
8894 'linebreak' to get the break at a word boundary.
8895 To make scrolling horizontally a bit more useful, try this: >
8896 :set sidescroll=5
8897 :set listchars+=precedes:<,extends:>
8898< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008899 This option can't be set from a |modeline| when the 'diff' option is
8900 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901
8902 *'wrapmargin'* *'wm'*
8903'wrapmargin' 'wm' number (default 0)
8904 local to buffer
8905 Number of characters from the right window border where wrapping
8906 starts. When typing text beyond this limit, an <EOL> will be inserted
8907 and inserting continues on the next line.
8908 Options that add a margin, such as 'number' and 'foldcolumn', cause
8909 the text width to be further reduced. This is Vi compatible.
8910 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008911 This option is set to 0 when 'paste' is set and restored when 'paste'
8912 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008913 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008914
8915 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8916'wrapscan' 'ws' boolean (default on) *E384* *E385*
8917 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008918 Searches wrap around the end of the file. Also applies to |]s| and
8919 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008920
8921 *'write'* *'nowrite'*
8922'write' boolean (default on)
8923 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008924 Allows writing files. When not set, writing a file is not allowed.
8925 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008926 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008927 argument. Filtering text is still possible, even though this requires
8928 writing a temporary file.
8929
8930 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8931'writeany' 'wa' boolean (default off)
8932 global
8933 Allows writing to any file with no need for "!" override.
8934
8935 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8936'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8937 otherwise)
8938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 Make a backup before overwriting a file. The backup is removed after
8940 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008941 also on.
8942 WARNING: Switching this option off means that when Vim fails to write
8943 your buffer correctly and then, for whatever reason, Vim exits, you
8944 lose both the original file and what you were writing. Only reset
8945 this option if your file system is almost full and it makes the write
8946 fail (and make sure not to exit Vim until the write was successful).
8947 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008949 Depending on 'backupcopy' the backup is a new file or the original
8950 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008951 NOTE: This option is set to the default value when 'compatible' is
8952 set.
8953
8954 *'writedelay'* *'wd'*
8955'writedelay' 'wd' number (default 0)
8956 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008957 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008959 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008960
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008961 vim:tw=78:ts=8:noet:ft=help:norl: