xref: /vim-8.2.3635/runtime/doc/options.txt (revision 777175b0)
1*options.txt*	For Vim version 8.2.  Last change: 2021 Nov 15
2
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
13For an overview of options see quickref.txt |option-list|.
14
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==============================================================================
221. Setting options					*set-option* *E764*
23
24							*:se* *:set*
25:se[t][!]		Show all options that differ from their default value.
26			When [!] is present every option is on a separate
27			line.
28
29:se[t][!] all		Show all but terminal options.
30			When [!] is present every option is on a separate
31			line.
32
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
47							   *:set-!* *:set-inv*
48:se[t] {option}!   or
49:se[t] inv{option}	Toggle option: Invert value.
50
51				*:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}&	Reset option to its default value.  May depend on the
53			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.
56
57:se[t] all&		Set all options to their default value.  The values of
58			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.
69
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,
75			hex (preceded with 0x) or octal (preceded with '0').
76			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
91			are removed.  When adding a flag that was already
92			present the option value doesn't change.
93			Also see |:set-args| above.
94
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.
101
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.
113
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?
123<  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 ~
127This 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.
130When 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'.
134A few special texts:
135	Last set from modeline line 1 ~
136		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
148{not available when compiled without the |+eval| feature}
149
150							*:set-termcap* *E522*
151For {option} the form "t_xx" may be used to set a terminal option.  This will
152override 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
161You 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
173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
176The listing from ":set" looks different from Vi.  Long string options are put
177at the end of the list.  The number of options is quite large.  The output of
178"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
191The "|" character separates a ":set" command from a following command.  To
192include the "|" in the option value, use "\|" instead.  This example sets the
193'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
198Similarly, in legacy script the double quote character starts a comment.  To
199include the '"' in the option value, use '\"' instead.  This example sets the
200'titlestring' option to 'hi "there"': >
201   :set titlestring=hi\ \"there\"
202
203In |Vim9| script it's simpler, comments start with a '#' character, and only
204when preceded by white space.  A backslash is needed less often: >
205   vim9script
206   set titlestring=hi\ "there"
207   set titlestring=hi#there#
208   set titlestring=hi\ \#there#
209
210For Win32 backslashes in file names are mostly not removed.  More precise: For
211options that expect a file name (those where environment variables are
212expanded) a backslash before a normal file name character is not removed.  But
213a backslash before a special character (space, backslash, comma, etc.) is used
214like explained above.
215There is one special situation, when the value starts with "\\": >
216   :set dir=\\machine\path	    results in "\\machine\path"
217   :set dir=\\\\machine\\path	    results in "\\machine\path"
218   :set dir=\\path\\file	    results in "\\path\file" (wrong!)
219For the first one the start is kept, but for the second one the backslashes
220are halved.  This makes sure it works both when you expect backslashes to be
221halved and when you expect the backslashes to be kept.  The third gives a
222result which is probably not what you want.  Avoid it.
223
224				*add-option-flags* *remove-option-flags*
225				*E539* *E550* *E551* *E552*
226Some options are a list of flags.  When you want to add a flag to such an
227option, without changing the existing ones, you can do it like this: >
228   :set guioptions+=a
229Remove a flag from an option like this: >
230   :set guioptions-=a
231This removes the 'a' flag from 'guioptions'.
232Note that you should add or remove one flag at a time.  If 'guioptions' has
233the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
234doesn't appear.
235
236			   *:set_env* *expand-env* *expand-environment-var*
237Environment variables in specific string options will be expanded.  If the
238environment variable exists the '$' and the following environment variable
239name is replaced with its value.  If it does not exist the '$' and the name
240are not modified.  Any non-id character (not a letter, digit or '_') may
241follow the environment variable name.  That character and what follows is
242appended to the value of the environment variable.  Examples: >
243   :set term=$TERM.new
244   :set path=/usr/$INCLUDE,$HOME/include,.
245When adding or removing a string from an option with ":set opt-=val" or ":set
246opt+=val" the expansion is done before the adding or removing.
247
248
249Handling of local options			*local-options*
250
251Some of the options only apply to a window or buffer.  Each window or buffer
252has its own copy of this option, thus each can have its own value.  This
253allows you to set 'list' in one window but not in another.  And set
254'shiftwidth' to 3 in one buffer and 4 in another.
255
256The following explains what happens to these local options in specific
257situations.  You don't really need to know all of this, since Vim mostly uses
258the option values you would expect.  Unfortunately, doing what the user
259expects is a bit complicated...
260
261When splitting a window, the local options are copied to the new window.  Thus
262right after the split the contents of the two windows look the same.
263
264When editing a new buffer, its local option values must be initialized.  Since
265the local options of the current buffer might be specifically for that buffer,
266these are not used.  Instead, for each buffer-local option there also is a
267global value, which is used for new buffers.  With ":set" both the local and
268global value is changed.  With "setlocal" only the local value is changed,
269thus this value is not used when editing a new buffer.
270
271When editing a buffer that has been edited before, the options from the window
272that was last closed are used again.  If this buffer has been edited in this
273window, the values from back then are used.  Otherwise the values from the
274last closed window where the buffer was edited last are used.
275
276It's possible to set a local window option specifically for a type of buffer.
277When you edit another buffer in the same window, you don't want to keep
278using these local window options.  Therefore Vim keeps a global value of the
279local window options, which is used when editing another buffer.  Each window
280has its own copy of these values.  Thus these are local to the window, but
281global to all buffers in the window.  With this you can do: >
282	:e one
283	:set list
284	:e two
285Now the 'list' option will also be set in "two", since with the ":set list"
286command you have also set the global value. >
287	:set nolist
288	:e one
289	:setlocal list
290	:e two
291Now the 'list' option is not set, because ":set nolist" resets the global
292value, ":setlocal list" only changes the local value and ":e two" gets the
293global value.  Note that if you do this next: >
294	:e one
295You will get back the 'list' value as it was the last time you edited "one".
296The options local to a window are remembered for each buffer.  This also
297happens when the buffer is not loaded, but they are lost when the buffer is
298wiped out |:bwipe|.
299
300							*:setl* *:setlocal*
301:setl[ocal][!] ...	Like ":set" but set only the value local to the
302			current buffer or window.  Not all options have a
303			local value.  If the option does not have a local
304			value the global value is set.
305			With the "all" argument: display local values for all
306			local options.
307			Without argument: Display local values for all local
308			options which are different from the default.
309			When displaying a specific local option, show the
310			local value.  For a global/local boolean option, when
311			the global value is being used, "--" is displayed
312			before the option name.
313			For a global option the global value is
314			shown (but that might change in the future).
315
316:setl[ocal] {option}<	Set the local value of {option} to its global value by
317			copying the value.
318
319:se[t] {option}<	For |global-local| options: Remove the local value of
320			{option}, so that the global value will be used.
321
322							*:setg* *:setglobal*
323:setg[lobal][!] ...	Like ":set" but set only the global value for a local
324			option without changing the local value.
325			When displaying an option, the global value is shown.
326			With the "all" argument: display global values for all
327			local options.
328			Without argument: display global values for all local
329			options which are different from the default.
330
331For buffer-local and window-local options:
332	Command		 global value	    local value ~
333      :set option=value	     set		set
334 :setlocal option=value	      -			set
335:setglobal option=value	     set		 -
336      :set option?	      -		       display
337 :setlocal option?	      -		       display
338:setglobal option?	    display		 -
339
340
341Global options with a local value			*global-local*
342
343Options are global when you mostly use one value for all buffers and windows.
344For some global options it's useful to sometimes have a different local value.
345You can set the local value with ":setlocal".  That buffer or window will then
346use the local value, while other buffers and windows continue using the global
347value.
348
349For example, you have two windows, both on C source code.  They use the global
350'makeprg' option.  If you do this in one of the two windows: >
351	:set makeprg=gmake
352then the other window will switch to the same value.  There is no need to set
353the 'makeprg' option in the other C source window too.
354However, if you start editing a Perl file in a new window, you want to use
355another 'makeprg' for it, without changing the value used for the C source
356files.  You use this command: >
357	:setlocal makeprg=perlmake
358You can switch back to using the global value by making the local value empty: >
359	:setlocal makeprg=
360This only works for a string option.  For a number or boolean option you need
361to use the "<" flag, like this: >
362	:setlocal autoread<
363Note that for non-boolean and non-number options using "<" copies the global
364value to the local value, it doesn't switch back to using the global value
365(that matters when the global value changes later).  You can also use: >
366	:set path<
367This will make the local value of 'path' empty, so that the global value is
368used.  Thus it does the same as: >
369	:setlocal path=
370Note: In the future more global options can be made global-local.  Using
371":setlocal" on a global option might work differently then.
372
373
374						*option-value-function*
375Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
376'operatorfunc', 'quickfixtextfunc' and 'tagfunc') are set to a function name
377or a function reference or a lambda function.  Examples:
378>
379	set opfunc=MyOpFunc
380	set opfunc=function("MyOpFunc")
381	set opfunc=funcref("MyOpFunc")
382	set opfunc={t\ ->\ MyOpFunc(t)}
383<
384
385Setting the filetype
386
387:setf[iletype] [FALLBACK] {filetype}			*:setf* *:setfiletype*
388			Set the 'filetype' option to {filetype}, but only if
389			not done yet in a sequence of (nested) autocommands.
390			This is short for: >
391				:if !did_filetype()
392				:  setlocal filetype={filetype}
393				:endif
394<			This command is used in a filetype.vim file to avoid
395			setting the 'filetype' option twice, causing different
396			settings and syntax files to be loaded.
397
398			When the optional FALLBACK argument is present, a
399			later :setfiletype command will override the
400			'filetype'.  This is to be used for filetype
401			detections that are just a guess.  |did_filetype()|
402			will return false after this command.
403
404				*option-window* *optwin*
405:bro[wse] se[t]			*:set-browse* *:browse-set* *:opt* *:options*
406:opt[ions]		Open a window for viewing and setting all options.
407			Options are grouped by function.
408			Offers short help for each option.  Hit <CR> on the
409			short help to open a help window with more help for
410			the option.
411			Modify the value of the option and hit <CR> on the
412			"set" line to set the new value.  For window and
413			buffer specific options, the last accessed window is
414			used to set the option value in, unless this is a help
415			window, in which case the window below help window is
416			used (skipping the option-window).
417			{not available when compiled without the |+eval|
418			feature}
419
420								*$HOME*
421Using "~" is like using "$HOME", but it is only recognized at the start of an
422option and after a space or comma.
423
424On Unix systems "~user" can be used too.  It is replaced by the home directory
425of user "user".  Example: >
426    :set path=~mool/include,/usr/include,.
427
428On Unix systems the form "${HOME}" can be used too.  The name between {} can
429contain non-id characters then.  Note that if you want to use this for the
430"gf" command, you need to add the '{' and '}' characters to 'isfname'.
431
432NOTE: expanding environment variables and "~/" is only done with the ":set"
433command, not when assigning a value to an option with ":let".
434
435							*$HOME-windows*
436On MS-Windows, if $HOME is not defined as an environment variable, then
437at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
438If $HOMEDRIVE is not set then $USERPROFILE is used.
439
440This expanded value is not exported to the environment, this matters when
441running an external command: >
442	:echo system('set | findstr ^HOME=')
443and >
444	:echo luaeval('os.getenv("HOME")')
445should echo nothing (an empty string) despite exists('$HOME') being true.
446When setting $HOME to a non-empty string it will be exported to the
447subprocesses.
448
449
450Note the maximum length of an expanded option is limited.  How much depends on
451the system, mostly it is something like 256 or 1024 characters.
452
453							*:fix* *:fixdel*
454:fix[del]		Set the value of 't_kD':
455				't_kb' is     't_kD' becomes	~
456				  CTRL-?	CTRL-H
457				not CTRL-?	CTRL-?
458
459			(CTRL-? is 0o177 octal, 0x7f hex)
460
461			If your delete key terminal code is wrong, but the
462			code for backspace is alright, you can put this in
463			your .vimrc: >
464				:fixdel
465<			This works no matter what the actual code for
466			backspace is.
467
468			If the backspace key terminal code is wrong you can
469			use this: >
470				:if &term == "termname"
471				:  set t_kb=^V<BS>
472				:  fixdel
473				:endif
474<			Where "^V" is CTRL-V and "<BS>" is the backspace key
475			(don't type four characters!).  Replace "termname"
476			with your terminal name.
477
478			If your <Delete> key sends a strange key sequence (not
479			CTRL-? or CTRL-H) you cannot use ":fixdel".  Then use: >
480				:if &term == "termname"
481				:  set t_kD=^V<Delete>
482				:endif
483<			Where "^V" is CTRL-V and "<Delete>" is the delete key
484			(don't type eight characters!).  Replace "termname"
485			with your terminal name.
486
487							*Linux-backspace*
488			Note about Linux: By default the backspace key
489			produces CTRL-?, which is wrong.  You can fix it by
490			putting this line in your rc.local: >
491				echo "keycode 14 = BackSpace" | loadkeys
492<
493							*NetBSD-backspace*
494			Note about NetBSD: If your backspace doesn't produce
495			the right code, try this: >
496				xmodmap -e "keycode 22 = BackSpace"
497<			If this works, add this in your .Xmodmap file: >
498				keysym 22 = BackSpace
499<			You need to restart for this to take effect.
500
501==============================================================================
5022. Automatically setting options			*auto-setting*
503
504Besides changing options with the ":set" command, there are three alternatives
505to set options automatically for one or more files:
506
5071. When starting Vim initializations are read from various places.  See
508   |initialization|.  Most of them are performed for all editing sessions,
509   and some of them depend on the directory where Vim is started.
510   You can create an initialization file with |:mkvimrc|, |:mkview| and
511   |:mksession|.
5122. If you start editing a new file, the automatic commands are executed.
513   This can be used to set options for files matching a particular pattern and
514   many other things.  See |autocommand|.
5153. If you start editing a new file, and the 'modeline' option is on, a
516   number of lines at the beginning and end of the file are checked for
517   modelines.  This is explained here.
518
519					*modeline* *vim:* *vi:* *ex:* *E520*
520There are two forms of modelines.  The first form:
521	[text{white}]{vi:|vim:|ex:}[white]{options}
522
523[text{white}]		empty or any text followed by at least one blank
524			character (<Space> or <Tab>); "ex:" always requires at
525			least one blank character
526{vi:|vim:|ex:}		the string "vi:", "vim:" or "ex:"
527[white]			optional white space
528{options}		a list of option settings, separated with white space
529			or ':', where each part between ':' is the argument
530			for a ":set" command (can be empty)
531
532Examples:
533   vi:noai:sw=3 ts=6 ~
534   vim: tw=77 ~
535
536The second form (this is compatible with some versions of Vi):
537
538	[text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
539
540[text{white}]		empty or any text followed by at least one blank
541			character (<Space> or <Tab>); "ex:" always requires at
542			least one blank character
543{vi:|vim:|Vim:|ex:}	the string "vi:", "vim:", "Vim:" or "ex:"
544[white]			optional white space
545se[t]			the string "set " or "se " (note the space); When
546			"Vim" is used it must be "set".
547{options}		a list of options, separated with white space, which
548			is the argument for a ":set" command
549:			a colon
550[text]			any text or empty
551
552Examples:
553   /* vim: set ai tw=75: */ ~
554   /* Vim: set ai tw=75: */ ~
555
556The white space before {vi:|vim:|Vim:|ex:} is required.  This minimizes the
557chance that a normal word like "lex:" is caught.  There is one exception:
558"vi:" and "vim:" can also be at the start of the line (for compatibility with
559version 3.0).  Using "ex:" at the start of the line will be ignored (this
560could be short for "example:").
561
562If the modeline is disabled within a modeline, subsequent modelines will be
563ignored.  This is to allow turning off modeline on a per-file basis.  This is
564useful when a line looks like a modeline but isn't.  For example, it would be
565good to start a YAML file containing strings like "vim:" with
566    # vim: nomodeline ~
567so as to avoid modeline misdetection.  Following options on the same line
568after modeline deactivation, if any, are still evaluated (but you would
569normally not have any).
570
571							*modeline-local*
572The options are set like with ":setlocal": The new value only applies to the
573buffer and window that contain the file.  Although it's possible to set global
574options from a modeline, this is unusual.  If you have two windows open and
575the files in it set the same global option to a different value, the result
576depends on which one was opened last.
577
578When editing a file that was already loaded, only the window-local options
579from the modeline are used.  Thus if you manually changed a buffer-local
580option after opening the file, it won't be changed if you edit the same buffer
581in another window.  But window-local options will be set.
582
583							*modeline-version*
584If the modeline is only to be used for some versions of Vim, the version
585number can be specified where "vim:" or "Vim:" is used:
586	vim{vers}:	version {vers} or later
587	vim<{vers}:	version before {vers}
588	vim={vers}:	version {vers}
589	vim>{vers}:	version after {vers}
590{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
591For example, to use a modeline only for Vim 7.0:
592	/* vim700: set foldmethod=marker */ ~
593To use a modeline for Vim after version 7.2:
594	/* vim>702: set cole=2: */ ~
595There can be no blanks between "vim" and the ":".
596
597
598The number of lines that are checked can be set with the 'modelines' option.
599If 'modeline' is off or 'modelines' is 0 no lines are checked.
600
601Note that for the first form all of the rest of the line is used, thus a line
602like:
603   /* vi:ts=4: */ ~
604will give an error message for the trailing "*/".  This line is OK:
605   /* vi:set ts=4: */ ~
606
607If an error is detected the rest of the line is skipped.
608
609If you want to include a ':' in a set command precede it with a '\'.  The
610backslash in front of the ':' will be removed.  Example:
611   /* vi:set fillchars=stl\:^,vert\:\|: */ ~
612This sets the 'fillchars' option to "stl:^,vert:\|".  Only a single backslash
613before the ':' is removed.  Thus to include "\:" you have to specify "\\:".
614							*E992*
615No other commands than "set" are supported, for security reasons (somebody
616might create a Trojan horse text file with modelines).  And not all options
617can be set.  For some options a flag is set, so that when the value is used
618the |sandbox| is effective.  Some options can only be set from the modeline
619when 'modelineexpr' is set (the default is off).
620
621Still, there is always a small risk that a modeline causes trouble.  E.g.,
622when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
623So disable modelines before editing untrusted text.  The mail ftplugin does
624this, for example.
625
626Hint: If you would like to do something else than setting an option, you could
627define an autocommand that checks the file for a specific string.  For
628example: >
629	au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
630And define a function SetVar() that does something with the line containing
631"VAR".
632
633==============================================================================
6343. Options summary					*option-summary*
635
636In the list below all the options are mentioned with their full name and with
637an abbreviation if there is one.  Both forms may be used.
638
639In this document when a boolean option is "set" that means that ":set option"
640is entered.  When an option is "reset", ":set nooption" is used.
641
642For some options there are two default values: The "Vim default", which is
643used when 'compatible' is not set, and the "Vi default", which is used when
644'compatible' is set.
645
646Most options are the same in all windows and buffers.  There are a few that
647are specific to how the text is presented in a window.  These can be set to a
648different value in each window.  For example the 'list' option can be set in
649one window and reset in another for the same text, giving both types of view
650at the same time.  There are a few options that are specific to a certain
651file.  These can have a different value for each file or buffer.  For example
652the 'textwidth' option can be 78 for a normal text file and 0 for a C
653program.
654
655	global			one option for all buffers and windows
656	local to window		each window has its own copy of this option
657	local to buffer		each buffer has its own copy of this option
658
659When creating a new window the option values from the currently active window
660are used as a default value for the window-specific options.  For the
661buffer-specific options this depends on the 's' and 'S' flags in the
662'cpoptions' option.  If 's' is included (which is the default) the values for
663buffer options are copied from the currently active buffer when a buffer is
664first entered.  If 'S' is present the options are copied each time the buffer
665is entered, this is almost like having global options.  If 's' and 'S' are not
666present, the options are copied from the currently active buffer when the
667buffer is created.
668
669Hidden options						*hidden-options*
670
671Not all options are supported in all versions.  This depends on the supported
672features and sometimes on the system.  A remark about this is in curly braces
673below.  When an option is not supported it may still be set without getting an
674error, this is called a hidden option.  You can't get the value of a hidden
675option though, it is not stored.
676
677To test if option "foo" can be used with ":set" use something like this: >
678	if exists('&foo')
679This also returns true for a hidden option.  To test if option "foo" is really
680supported use something like this: >
681	if exists('+foo')
682<
683							*E355*
684A jump table for the options with a short description can be found at |Q_op|.
685
686					*'aleph'* *'al'* *aleph* *Aleph*
687'aleph' 'al'		number	(default 128 for MS-Windows, 224 otherwise)
688			global
689			{only available when compiled with the |+rightleft|
690			feature}
691	The ASCII code for the first letter of the Hebrew alphabet.  The
692	routine that maps the keyboard in Hebrew mode, both in Insert mode
693	(when hkmap is set) and on the command-line (when hitting CTRL-_)
694	outputs the Hebrew characters in the range [aleph..aleph+26].
695	aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
696	See |rileft.txt|.
697
698			*'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
699'allowrevins' 'ari'	boolean	(default off)
700			global
701			{only available when compiled with the |+rightleft|
702			feature}
703	Allow CTRL-_ in Insert and Command-line mode.  This is default off, to
704	avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
705	into reverse Insert mode, and don't know how to get out.  See
706	'revins'.
707	NOTE: This option is reset when 'compatible' is set.
708
709			 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
710'altkeymap' 'akm'	boolean (default off)
711			global
712			{only available when compiled with the |+farsi|
713			feature}
714	This option was for using Farsi, which has been removed.  See
715	|farsi.txt|.
716
717						*'ambiwidth'* *'ambw'*
718'ambiwidth' 'ambw'	string (default: "single")
719			global
720	Only effective when 'encoding' is "utf-8" or another Unicode encoding.
721	Tells Vim what to do with characters with East Asian Width Class
722	Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
723	letters, Cyrillic letters).
724
725	There are currently two possible values:
726	"single":	Use the same width as characters in US-ASCII.  This is
727			expected by most users.
728	"double":	Use twice the width of ASCII characters.
729							*E834* *E835*
730	The value "double" cannot be used if 'listchars' or 'fillchars'
731	contains a character that would be double width.  These errors may
732	also be given when calling setcellwidths().
733
734	The values are overruled for characters specified with
735	|setcellwidths()|.
736
737	There are a number of CJK fonts for which the width of glyphs for
738	those characters are solely based on how many octets they take in
739	legacy/traditional CJK encodings.  In those encodings, Euro,
740	Registered sign, Greek/Cyrillic letters are represented by two octets,
741	therefore those fonts have "wide" glyphs for them.  This is also
742	true of some line drawing characters used to make tables in text
743	file.  Therefore, when a CJK font is used for GUI Vim or
744	Vim is running inside a terminal (emulators) that uses a CJK font
745	(or Vim is run inside an xterm invoked with "-cjkwidth" option.),
746	this option should be set to "double" to match the width perceived
747	by Vim with the width of glyphs in the font.  Perhaps it also has
748	to be set to "double" under CJK MS-Windows when the system locale is
749	set to one of CJK locales.  See Unicode Standard Annex #11
750	(http://www.unicode.org/reports/tr11).
751
752	Vim may set this option automatically at startup time when Vim is
753	compiled with the |+termresponse| feature and if |t_u7| is set to the
754	escape sequence to request cursor position report.  The response can
755	be found in |v:termu7resp|.
756
757			*'antialias'* *'anti'* *'noantialias'* *'noanti'*
758'antialias' 'anti'	boolean (default: off)
759			global
760			{only available when compiled with GUI enabled
761			on macOS}
762	This option only has an effect in the GUI version of Vim on macOS
763	v10.2 or later.  When on, Vim will use smooth ("antialiased") fonts,
764	which can be easier to read at certain sizes on certain displays.
765	Setting this option can sometimes cause problems if 'guifont' is set
766	to its default (empty string).
767	NOTE: This option is reset when 'compatible' is set.
768
769			*'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
770'autochdir' 'acd'	boolean (default off)
771			global
772			{only available when compiled with it, use
773			exists("+autochdir") to check}
774	When on, Vim will change the current working directory whenever you
775	open a file, switch buffers, delete a buffer or open/close a window.
776	It will change to the directory containing the file which was opened
777	or selected.
778	Note: When this option is on some plugins may not work.
779
780			*'autoshelldir'* *'asd'* *'noautoshelldir'* *'noasd'*
781'autoshelldir' 'asd'	boolean (default off)
782			global
783	When on, Vim will change the current working directory whenever you
784	change the directory of the shell running in a terminal window. You
785	need proper setting-up, so whenever the shell's pwd changes an OSC 7
786	escape sequence will be emitted. For example, on Linux, you can source
787	/etc/profile.d/vte.sh in your shell profile if you use bash or zsh.
788
789				*'arabic'* *'arab'* *'noarabic'* *'noarab'*
790'arabic' 'arab'		boolean (default off)
791			local to window
792			{only available when compiled with the |+arabic|
793			feature}
794	This option can be set to start editing Arabic text.
795	Setting this option will:
796	- Set the 'rightleft' option, unless 'termbidi' is set.
797	- Set the 'arabicshape' option, unless 'termbidi' is set.
798	- Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
799	  between typing English and Arabic key mapping.
800	- Set the 'delcombine' option
801	Note that 'encoding' must be "utf-8" for working with Arabic text.
802
803	Resetting this option will:
804	- Reset the 'rightleft' option.
805	- Disable the use of 'keymap' (without changing its value).
806	Note that 'arabicshape' and 'delcombine' are not reset (it is a global
807	option).
808	NOTE: This option is reset when 'compatible' is set.
809	Also see |arabic.txt|.
810
811					*'arabicshape'* *'arshape'*
812					*'noarabicshape'* *'noarshape'*
813'arabicshape' 'arshape'	boolean (default on)
814			global
815			{only available when compiled with the |+arabic|
816			feature}
817	When on and 'termbidi' is off, the required visual character
818	corrections that need to take place for displaying the Arabic language
819	take effect.  Shaping, in essence, gets enabled; the term is a broad
820	one which encompasses:
821	  a) the changing/morphing of characters based on their location
822	     within a word (initial, medial, final and stand-alone).
823	  b) the enabling of the ability to compose characters
824	  c) the enabling of the required combining of some characters
825	When disabled the display shows each character's true stand-alone
826	form.
827	Arabic is a complex language which requires other settings, for
828	further details see |arabic.txt|.
829	NOTE: This option is set when 'compatible' is set.
830
831			*'autoindent'* *'ai'* *'noautoindent'* *'noai'*
832'autoindent' 'ai'	boolean	(default off)
833			local to buffer
834	Copy indent from current line when starting a new line (typing <CR>
835	in Insert mode or when using the "o" or "O" command).  If you do not
836	type anything on the new line except <BS> or CTRL-D and then type
837	<Esc>, CTRL-O or <CR>, the indent is deleted again.  Moving the cursor
838	to another line has the same effect, unless the 'I' flag is included
839	in 'cpoptions'.
840	When autoindent is on, formatting (with the "gq" command or when you
841	reach 'textwidth' in Insert mode) uses the indentation of the first
842	line.
843	When 'smartindent' or 'cindent' is on the indent is changed in
844	a different way.
845	The 'autoindent' option is reset when the 'paste' option is set and
846	restored when 'paste' is reset.
847
848				 *'autoread'* *'ar'* *'noautoread'* *'noar'*
849'autoread' 'ar'		boolean	(default off)
850			global or local to buffer |global-local|
851	When a file has been detected to have been changed outside of Vim and
852	it has not been changed inside of Vim, automatically read it again.
853	When the file has been deleted this is not done, so you have the text
854	from before it was deleted.  When it appears again then it is read.
855	|timestamp|
856	If this option has a local value, use this command to switch back to
857	using the global value: >
858		:set autoread<
859<
860				 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
861'autowrite' 'aw'	boolean	(default off)
862			global
863	Write the contents of the file, if it has been modified, on each
864	:next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
865	:make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
866	'{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
867	Note that for some commands the 'autowrite' option is not used, see
868	'autowriteall' for that.
869	Some buffers will not be written, specifically when 'buftype' is
870	"nowrite", "nofile", "terminal" or "prompt".
871
872			 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
873'autowriteall' 'awa'	boolean	(default off)
874			global
875	Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
876	":qall", ":exit", ":xit", ":recover" and closing the Vim window.
877	Setting this option also implies that Vim behaves like 'autowrite' has
878	been set.
879
880							*'background'* *'bg'*
881'background' 'bg'	string	(default "dark" or "light", see below)
882			global
883	When set to "dark", Vim will try to use colors that look good on a
884	dark background.  When set to "light", Vim will try to use colors that
885	look good on a light background.  Any other value is illegal.
886	Vim tries to set the default value according to the terminal used.
887	This will not always be correct.
888	Setting this option does not change the background color, it tells Vim
889	what the background color looks like.  For changing the background
890	color, see |:hi-normal|.
891
892	When 'background' is set Vim will adjust the default color groups for
893	the new value.  But the colors used for syntax highlighting will not
894	change.					*g:colors_name*
895	When a color scheme is loaded (the "g:colors_name" variable is set)
896	setting 'background' will cause the color scheme to be reloaded.  If
897	the color scheme adjusts to the value of 'background' this will work.
898	However, if the color scheme sets 'background' itself the effect may
899	be undone.  First delete the "g:colors_name" variable when needed.
900
901	When setting 'background' to the default value with: >
902		:set background&
903<	Vim will guess the value.  In the GUI this should work correctly,
904	in other cases Vim might not be able to guess the right value.
905	If the GUI supports a dark theme, you can use the "d" flag in
906	'guioptions', see 'go-d'.
907
908	When the |t_RB| option is set, Vim will use it to request the background
909	color from the terminal.  If the returned RGB value is dark/light and
910	'background' is not dark/light, 'background' will be set and the
911	screen is redrawn.  This may have side effects, make t_BG empty in
912	your .vimrc if you suspect this problem.  The response to |t_RB| can
913	be found in |v:termrbgresp|.
914
915	When starting the GUI, the default value for 'background' will be
916	"light".  When the value is not set in the .gvimrc, and Vim detects
917	that the background is actually quite dark, 'background' is set to
918	"dark".  But this happens only AFTER the .gvimrc file has been read
919	(because the window needs to be opened to find the actual background
920	color).  To get around this, force the GUI window to be opened by
921	putting a ":gui" command in the .gvimrc file, before where the value
922	of 'background' is used (e.g., before ":syntax on").
923
924	For MS-Windows the default is "dark".
925	For other systems "dark" is used when 'term' is "linux",
926	"screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
927	background.  Otherwise the default is "light".
928
929	The |:terminal| command and the |term_start()| function use the
930	'background' value to decide whether the terminal window will start
931	with a white or black background.
932
933	Normally this option would be set in the .vimrc file.  Possibly
934	depending on the terminal name.  Example: >
935		:if &term == "pcterm"
936		:  set background=dark
937		:endif
938<	When this option is set, the default settings for the highlight groups
939	will change.  To use other settings, place ":highlight" commands AFTER
940	the setting of the 'background' option.
941	This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
942	to select the colors for syntax highlighting.  After changing this
943	option, you must load syntax.vim again to see the result.  This can be
944	done with ":syntax on".
945
946							*'backspace'* *'bs'*
947'backspace' 'bs'	string	(default "", set to "indent,eol,start"
948							    in |defaults.vim|)
949			global
950	Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
951	mode.  This is a list of items, separated by commas.  Each item allows
952	a way to backspace over something:
953	value	effect	~
954	indent	allow backspacing over autoindent
955	eol	allow backspacing over line breaks (join lines)
956	start	allow backspacing over the start of insert; CTRL-W and CTRL-U
957		stop once at the start of insert.
958	nostop	like start, except CTRL-W and CTRL-U do not stop at the start of
959		insert.
960
961	When the value is empty, Vi compatible backspacing is used.
962
963	For backwards compatibility with version 5.4 and earlier:
964	value	effect	~
965	  0	same as ":set backspace=" (Vi compatible)
966	  1	same as ":set backspace=indent,eol"
967	  2	same as ":set backspace=indent,eol,start"
968	  3	same as ":set backspace=indent,eol,nostop"
969
970	See |:fixdel| if your <BS> or <Del> key does not do what you want.
971	NOTE: This option is set to "" when 'compatible' is set.
972
973				*'backup'* *'bk'* *'nobackup'* *'nobk'*
974'backup' 'bk'		boolean	(default off)
975			global
976	Make a backup before overwriting a file.  Leave it around after the
977	file has been successfully written.  If you do not want to keep the
978	backup file, but you do want a backup while the file is being
979	written, reset this option and set the 'writebackup' option (this is
980	the default).  If you do not want a backup file at all reset both
981	options (use this if your file system is almost full).  See the
982	|backup-table| for more explanations.
983	When the 'backupskip' pattern matches, a backup is not made anyway.
984	When 'patchmode' is set, the backup may be renamed to become the
985	oldest version of a file.
986	NOTE: This option is reset when 'compatible' is set.
987
988						*'backupcopy'* *'bkc'*
989'backupcopy' 'bkc'	string	(Vi default for Unix: "yes", otherwise: "auto")
990			global or local to buffer |global-local|
991	When writing a file and a backup is made, this option tells how it's
992	done.  This is a comma separated list of words.
993
994	The main values are:
995	"yes"	make a copy of the file and overwrite the original one
996	"no"	rename the file and write a new one
997	"auto"	one of the previous, what works best
998
999	Extra values that can be combined with the ones above are:
1000	"breaksymlink"	always break symlinks when writing
1001	"breakhardlink"	always break hardlinks when writing
1002
1003	Making a copy and overwriting the original file:
1004	- Takes extra time to copy the file.
1005	+ When the file has special attributes, is a (hard/symbolic) link or
1006	  has a resource fork, all this is preserved.
1007	- When the file is a link the backup will have the name of the link,
1008	  not of the real file.
1009
1010	Renaming the file and writing a new one:
1011	+ It's fast.
1012	- Sometimes not all attributes of the file can be copied to the new
1013	  file.
1014	- When the file is a link the new file will not be a link.
1015
1016	The "auto" value is the middle way: When Vim sees that renaming file
1017	is possible without side effects (the attributes can be passed on and
1018	the file is not a link) that is used.  When problems are expected, a
1019	copy will be made.
1020
1021	The "breaksymlink" and "breakhardlink" values can be used in
1022	combination with any of "yes", "no" and "auto".  When included, they
1023	force Vim to always break either symbolic or hard links by doing
1024	exactly what the "no" option does, renaming the original file to
1025	become the backup and writing a new file in its place.  This can be
1026	useful for example in source trees where all the files are symbolic or
1027	hard links and any changes should stay in the local source tree, not
1028	be propagated back to the original source.
1029							*crontab*
1030	One situation where "no" and "auto" will cause problems: A program
1031	that opens a file, invokes Vim to edit that file, and then tests if
1032	the open file was changed (through the file descriptor) will check the
1033	backup file instead of the newly created file.  "crontab -e" is an
1034	example.
1035
1036	When a copy is made, the original file is truncated and then filled
1037	with the new text.  This means that protection bits, owner and
1038	symbolic links of the original file are unmodified.  The backup file
1039	however, is a new file, owned by the user who edited the file.  The
1040	group of the backup is set to the group of the original file.  If this
1041	fails, the protection bits for the group are made the same as for
1042	others.
1043
1044	When the file is renamed this is the other way around: The backup has
1045	the same attributes of the original file, and the newly written file
1046	is owned by the current user.  When the file was a (hard/symbolic)
1047	link, the new file will not!  That's why the "auto" value doesn't
1048	rename when the file is a link.  The owner and group of the newly
1049	written file will be set to the same ones as the original file, but
1050	the system may refuse to do this.  In that case the "auto" value will
1051	again not rename the file.
1052
1053	NOTE: This option is set to the Vi default value when 'compatible' is
1054	set and to the Vim default value when 'compatible' is reset.
1055
1056						*'backupdir'* *'bdir'*
1057'backupdir' 'bdir'	string	(default for Amiga: ".,t:",
1058				 for Win32: ".,$TEMP,c:/tmp,c:/temp"
1059				 for Unix: ".,~/tmp,~/")
1060			global
1061	List of directories for the backup file, separated with commas.
1062	- The backup file will be created in the first directory in the list
1063	  where this is possible.  The directory must exist, Vim will not
1064	  create it for you.
1065	- Empty means that no backup file will be created ('patchmode' is
1066	  impossible!).  Writing may fail because of this.
1067	- A directory "." means to put the backup file in the same directory
1068	  as the edited file.
1069	- A directory starting with "./" (or ".\" for MS-Windows) means to put
1070	  the backup file relative to where the edited file is.  The leading
1071	  "." is replaced with the path name of the edited file.
1072	  ("." inside a directory name has no special meaning).
1073	- Spaces after the comma are ignored, other spaces are considered part
1074	  of the directory name.  To have a space at the start of a directory
1075	  name, precede it with a backslash.
1076	- To include a comma in a directory name precede it with a backslash.
1077	- A directory name may end in an '/'.
1078	- For Unix and Win32, if a directory ends in two path separators "//",
1079	  the backup file name will be built from the complete path to the
1080	  file with all path separators changed to percent '%' signs. This
1081	  will ensure file name uniqueness in the backup directory.
1082	  On Win32, it is also possible to end with "\\".  However, When a
1083	  separating comma is following, you must use "//", since "\\" will
1084	  include the comma in the file name. Therefore it is recommended to
1085	  use '//', instead of '\\'.
1086	- Environment variables are expanded |:set_env|.
1087	- Careful with '\' characters, type one before a space, type two to
1088	  get one in the option (see |option-backslash|), for example: >
1089	    :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1090<	- For backwards compatibility with Vim version 3.0 a '>' at the start
1091	  of the option is removed.
1092	See also 'backup' and 'writebackup' options.
1093	If you want to hide your backup files on Unix, consider this value: >
1094		:set backupdir=./.backup,~/.backup,.,/tmp
1095<	You must create a ".backup" directory in each directory and in your
1096	home directory for this to work properly.
1097	The use of |:set+=| and |:set-=| is preferred when adding or removing
1098	directories from the list.  This avoids problems when a future version
1099	uses another default.
1100	This option cannot be set from a |modeline| or in the |sandbox|, for
1101	security reasons.
1102
1103						*'backupext'* *'bex'* *E589*
1104'backupext' 'bex'	string	(default "~", for VMS: "_")
1105			global
1106	String which is appended to a file name to make the name of the
1107	backup file.  The default is quite unusual, because this avoids
1108	accidentally overwriting existing files with a backup file.  You might
1109	prefer using ".bak", but make sure that you don't have files with
1110	".bak" that you want to keep.
1111	Only normal file name characters can be used, "/\*?[|<>" are illegal.
1112
1113	If you like to keep a lot of backups, you could use a BufWritePre
1114	autocommand to change 'backupext' just before writing the file to
1115	include a timestamp. >
1116		:au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1117<	Use 'backupdir' to put the backup in a different directory.
1118
1119						*'backupskip'* *'bsk'*
1120'backupskip' 'bsk'	string	(default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1121				 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1122				 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1123			global
1124			{not available when compiled without the |+wildignore|
1125			feature}
1126	A list of file patterns.  When one of the patterns matches with the
1127	name of the file which is written, no backup file is created.  Both
1128	the specified file name and the full path name of the file are used.
1129	The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1130	Watch out for special characters, see |option-backslash|.
1131	When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
1132	default value.  "/tmp/*" is only used for Unix.
1133
1134	WARNING: Not having a backup file means that when Vim fails to write
1135	your buffer correctly and then, for whatever reason, Vim exits, you
1136	lose both the original file and what you were writing.  Only disable
1137	backups if you don't care about losing the file.
1138
1139	Note that environment variables are not expanded.  If you want to use
1140	$HOME you must expand it explicitly, e.g.: >
1141		:let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1142
1143<	Note that the default also makes sure that "crontab -e" works (when a
1144	backup would be made by renaming the original file crontab won't see
1145	the newly created file).  Also see 'backupcopy' and |crontab|.
1146
1147						*'balloondelay'* *'bdlay'*
1148'balloondelay' 'bdlay'	number	(default: 600)
1149			global
1150			{only available when compiled with the |+balloon_eval|
1151			feature}
1152	Delay in milliseconds before a balloon may pop up.  See |balloon-eval|.
1153
1154		       *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1155'ballooneval' 'beval'	boolean	(default off)
1156			global
1157			{only available when compiled with the |+balloon_eval|
1158			feature}
1159	Switch on the |balloon-eval| functionality for the GUI.
1160
1161		       *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1162		       *'nobevalterm'*
1163'balloonevalterm' 'bevalterm'	boolean	(default off)
1164			global
1165			{only available when compiled with the
1166			|+balloon_eval_term| feature}
1167	Switch on the |balloon-eval| functionality for the terminal.
1168
1169						     *'balloonexpr'* *'bexpr'*
1170'balloonexpr' 'bexpr'	string	(default "")
1171			global or local to buffer |global-local|
1172			{only available when compiled with the |+balloon_eval|
1173			feature}
1174	Expression for text to show in evaluation balloon.  It is only used
1175	when 'ballooneval' or 'balloonevalterm' is on.  These variables can be
1176	used:
1177
1178	v:beval_bufnr	number of the buffer in which balloon is going to show
1179	v:beval_winnr	number of the window
1180	v:beval_winid	ID of the window
1181	v:beval_lnum	line number
1182	v:beval_col	column number (byte index)
1183	v:beval_text	word under or after the mouse pointer
1184
1185	Instead of showing a balloon, which is limited to plain text, consider
1186	using a popup window, see |popup_beval_example|.  A popup window can
1187	use highlighting and show a border.
1188
1189	The evaluation of the expression must not have side effects!
1190	Example: >
1191    function MyBalloonExpr()
1192	return 'Cursor is at line ' . v:beval_lnum .
1193		\', column ' . v:beval_col .
1194		\ ' of file ' .  bufname(v:beval_bufnr) .
1195		\ ' on word "' . v:beval_text . '"'
1196    endfunction
1197    set bexpr=MyBalloonExpr()
1198    set ballooneval
1199<
1200	Also see |balloon_show()|, it can be used if the content of the balloon
1201	is to be fetched asynchronously.  In that case evaluating
1202	'balloonexpr' should result in an empty string.  If you get a balloon
1203	with only "0" you probably didn't return anything from your function.
1204
1205	NOTE: The balloon is displayed only if the cursor is on a text
1206	character.  If the result of evaluating 'balloonexpr' is not empty,
1207	Vim does not try to send a message to an external debugger (Netbeans
1208	or Sun Workshop).
1209
1210	The expression will be evaluated in the |sandbox| when set from a
1211	modeline, see |sandbox-option|.
1212	This option cannot be set in a modeline when 'modelineexpr' is off.
1213
1214	It is not allowed to change text or jump to another window while
1215	evaluating 'balloonexpr', see |textlock|.
1216
1217	To check whether line breaks in the balloon text work use this check: >
1218		if has("balloon_multiline")
1219<	When they are supported "\n" characters will start a new line.  If the
1220	expression evaluates to a |List| this is equal to using each List item
1221	as a string and putting "\n" in between them.
1222	NOTE: This option is set to "" when 'compatible' is set.
1223
1224						*'belloff'* *'bo'*
1225'belloff' 'bo'		string	(default "")
1226			global
1227	Specifies for which events the bell will not be rung. It is a comma
1228	separated list of items. For each item that is present, the bell
1229	will be silenced. This is most useful to specify specific events in
1230	insert mode to be silenced.
1231
1232	item	    meaning when present	~
1233	all	    All events.
1234	backspace   When hitting <BS> or <Del> and deleting results in an
1235		    error.
1236	cursor	    Fail to move around using the cursor keys or
1237		    <PageUp>/<PageDown> in |Insert-mode|.
1238	complete    Error occurred when using |i_CTRL-X_CTRL-K| or
1239		    |i_CTRL-X_CTRL-T|.
1240	copy	    Cannot copy char from insert mode using |i_CTRL-Y| or
1241		    |i_CTRL-E|.
1242	ctrlg	    Unknown Char after <C-G> in Insert mode.
1243	error	    Other Error occurred (e.g. try to join last line)
1244		    (mostly used in |Normal-mode| or |Cmdline-mode|).
1245	esc	    hitting <Esc> in |Normal-mode|.
1246	ex	    In |Visual-mode|, hitting |Q| results in an error.
1247	hangul	    Ignored.
1248	insertmode  Pressing <Esc> in 'insertmode'.
1249	lang	    Calling the beep module for Lua/Mzscheme/TCL.
1250	mess	    No output available for |g<|.
1251	showmatch   Error occurred for 'showmatch' function.
1252	operator    Empty region error |cpo-E|.
1253	register    Unknown register after <C-R> in |Insert-mode|.
1254	shell	    Bell from shell output |:!|.
1255	spell	    Error happened on spell suggest.
1256	wildmode    More matches in |cmdline-completion| available
1257		    (depends on the 'wildmode' setting).
1258
1259	This is most useful to fine tune when in Insert mode the bell should
1260	be rung. For Normal mode and Ex commands, the bell is often rung to
1261	indicate that an error occurred. It can be silenced by adding the
1262	"error" keyword.
1263
1264				     *'binary'* *'bin'* *'nobinary'* *'nobin'*
1265'binary' 'bin'		boolean	(default off)
1266			local to buffer
1267	This option should be set before editing a binary file.  You can also
1268	use the |-b| Vim argument.  When this option is switched on a few
1269	options will be changed (also when it already was on):
1270		'textwidth'  will be set to 0
1271		'wrapmargin' will be set to 0
1272		'modeline'   will be off
1273		'expandtab'  will be off
1274	Also, 'fileformat' and 'fileformats' options will not be used, the
1275	file is read and written like 'fileformat' was "unix" (a single <NL>
1276	separates lines).
1277	The 'fileencoding' and 'fileencodings' options will not be used, the
1278	file is read without conversion.
1279	NOTE: When you start editing a(nother) file while the 'bin' option is
1280	on, settings from autocommands may change the settings again (e.g.,
1281	'textwidth'), causing trouble when editing.  You might want to set
1282	'bin' again when the file has been loaded.
1283	The previous values of these options are remembered and restored when
1284	'bin' is switched from on to off.  Each buffer has its own set of
1285	saved option values.
1286	To edit a file with 'binary' set you can use the |++bin| argument.
1287	This avoids you have to do ":set bin", which would have effect for all
1288	files you edit.
1289	When writing a file the <EOL> for the last line is only written if
1290	there was one in the original file (normally Vim appends an <EOL> to
1291	the last line if there is none; this would make the file longer).  See
1292	the 'endofline' option.
1293
1294			*'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1295'bioskey' 'biosk'	boolean	(default on)
1296			global
1297			{only for MS-DOS}
1298	This was for MS-DOS and is no longer supported.
1299
1300							*'bomb'* *'nobomb'*
1301'bomb'			boolean	(default off)
1302			local to buffer
1303	When writing a file and the following conditions are met, a BOM (Byte
1304	Order Mark) is prepended to the file:
1305	- this option is on
1306	- the 'binary' option is off
1307	- 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1308	  endian variants.
1309	Some applications use the BOM to recognize the encoding of the file.
1310	Often used for UCS-2 files on MS-Windows.  For other applications it
1311	causes trouble, for example: "cat file1 file2" makes the BOM of file2
1312	appear halfway the resulting file.  Gcc doesn't accept a BOM.
1313	When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1314	check for the presence of the BOM is done and 'bomb' set accordingly.
1315	Unless 'binary' is set, it is removed from the first line, so that you
1316	don't see it when editing.  When you don't change the options, the BOM
1317	will be restored when writing the file.
1318
1319						*'breakat'* *'brk'*
1320'breakat' 'brk'		string	(default " ^I!@*-+;:,./?")
1321			global
1322			{not available when compiled without the |+linebreak|
1323			feature}
1324	This option lets you choose which characters might cause a line
1325	break if 'linebreak' is on.  Only works for ASCII and also for 8-bit
1326	characters when 'encoding' is an 8-bit encoding.
1327
1328			*'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
1329'breakindent' 'bri'	boolean (default off)
1330			local to window
1331			{not available when compiled without the |+linebreak|
1332			feature}
1333	Every wrapped line will continue visually indented (same amount of
1334	space as the beginning of that line), thus preserving horizontal blocks
1335	of text.
1336	NOTE: This option is reset when 'compatible' is set.
1337
1338						*'breakindentopt'* *'briopt'*
1339'breakindentopt' 'briopt' string (default empty)
1340			local to window
1341			{not available when compiled without the |+linebreak|
1342			feature}
1343	Settings for 'breakindent'. It can consist of the following optional
1344	items and must be separated by a comma:
1345		min:{n}	    Minimum text width that will be kept after
1346			    applying 'breakindent', even if the resulting
1347			    text should normally be narrower. This prevents
1348			    text indented almost to the right window border
1349			    occupying lot of vertical space when broken.
1350		shift:{n}   After applying 'breakindent', the wrapped line's
1351			    beginning will be shifted by the given number of
1352			    characters.  It permits dynamic French paragraph
1353			    indentation (negative) or emphasizing the line
1354			    continuation (positive).
1355		sbr	    Display the 'showbreak' value before applying the
1356			    additional indent.
1357		list:{n}    Adds an additional indent for lines that match a
1358			    numbered or bulleted list (using the
1359			    'formatlistpat' setting).
1360		list:-1	    Uses the length of a match with 'formatlistpat'
1361			    for indentation.
1362	The default value for min is 20, shift and list is 0.
1363
1364						*'browsedir'* *'bsdir'*
1365'browsedir' 'bsdir'	string	(default: "last")
1366			global
1367			{only for Motif, Athena, GTK, Mac and Win32 GUI}
1368	Which directory to use for the file browser:
1369	   last		Use same directory as with last file browser, where a
1370			file was opened or saved.
1371	   buffer	Use the directory of the related buffer.
1372	   current	Use the current directory.
1373	   {path}	Use the specified directory
1374
1375						*'bufhidden'* *'bh'*
1376'bufhidden' 'bh'	string (default: "")
1377			local to buffer
1378	This option specifies what happens when a buffer is no longer
1379	displayed in a window:
1380	  <empty>	follow the global 'hidden' option
1381	  hide		hide the buffer (don't unload it), also when 'hidden'
1382			is not set
1383	  unload	unload the buffer, also when 'hidden' is set or using
1384			|:hide|
1385	  delete	delete the buffer from the buffer list, also when
1386			'hidden' is set or using |:hide|, like using
1387			|:bdelete|
1388	  wipe		wipe out the buffer from the buffer list, also when
1389			'hidden' is set or using |:hide|, like using
1390			|:bwipeout|
1391
1392	CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1393	are lost without a warning.  Also, these values may break autocommands
1394	that switch between buffers temporarily.
1395	This option is used together with 'buftype' and 'swapfile' to specify
1396	special kinds of buffers.   See |special-buffers|.
1397
1398			*'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1399'buflisted' 'bl'	boolean (default: on)
1400			local to buffer
1401	When this option is set, the buffer shows up in the buffer list.  If
1402	it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1403	This option is reset by Vim for buffers that are only used to remember
1404	a file name or marks.  Vim sets it when starting to edit a buffer.
1405	But not when moving to a buffer with ":buffer".
1406
1407						*'buftype'* *'bt'* *E382*
1408'buftype' 'bt'		string (default: "")
1409			local to buffer
1410	The value of this option specifies the type of a buffer:
1411	  <empty>	normal buffer
1412	  nofile	buffer which is not related to a file and will not be
1413			written
1414	  nowrite	buffer which will not be written
1415	  acwrite	buffer which will always be written with BufWriteCmd
1416			autocommands.
1417	  quickfix	quickfix buffer, contains list of errors |:cwindow|
1418			or list of locations |:lwindow|
1419	  help		help buffer (you are not supposed to set this
1420			manually)
1421	  terminal	buffer for a |terminal| (you are not supposed to set
1422			this manually)
1423	  prompt	buffer where only the last line can be edited, meant
1424			to be used by a plugin, see |prompt-buffer|
1425			{only when compiled with the |+channel| feature}
1426	  popup		buffer used in a popup window, see |popup|.
1427			{only when compiled with the |+textprop| feature}
1428
1429	This option is used together with 'bufhidden' and 'swapfile' to
1430	specify special kinds of buffers.   See |special-buffers|.
1431	Also see |win_gettype()|, which returns the type of the window.
1432
1433	Be careful with changing this option, it can have many side effects!
1434	One such effect is that Vim will not check the timestamp of the file,
1435	if the file is changed by another program this will not be noticed.
1436
1437	A "quickfix" buffer is only used for the error list and the location
1438	list.  This value is set by the |:cwindow| and |:lwindow| commands and
1439	you are not supposed to change it.
1440
1441	"nofile" and "nowrite" buffers are similar:
1442	both:		The buffer is not to be written to disk, ":w" doesn't
1443			work (":w filename" does work though).
1444	both:		The buffer is never considered to be |'modified'|.
1445			There is no warning when the changes will be lost, for
1446			example when you quit Vim.
1447	both:		A swap file is only created when using too much memory
1448			(when 'swapfile' has been reset there is never a swap
1449			file).
1450	nofile only:	The buffer name is fixed, it is not handled like a
1451			file name.  It is not modified in response to a |:cd|
1452			command.
1453	both:		When using ":e bufname" and already editing "bufname"
1454			the buffer is made empty and autocommands are
1455			triggered as usual for |:edit|.
1456							*E676*
1457	"acwrite" implies that the buffer name is not related to a file, like
1458	"nofile", but it will be written.  Thus, in contrast to "nofile" and
1459	"nowrite", ":w" does work and a modified buffer can't be abandoned
1460	without saving.  For writing there must be matching |BufWriteCmd|,
1461	|FileWriteCmd| or |FileAppendCmd| autocommands.
1462
1463						*'casemap'* *'cmp'*
1464'casemap' 'cmp'		string	(default: "internal,keepascii")
1465			global
1466	Specifies details about changing the case of letters.  It may contain
1467	these words, separated by a comma:
1468	internal	Use internal case mapping functions, the current
1469			locale does not change the case mapping.  This only
1470			matters when 'encoding' is a Unicode encoding,
1471			"latin1" or "iso-8859-15".  When "internal" is
1472			omitted, the towupper() and towlower() system library
1473			functions are used when available.
1474	keepascii	For the ASCII characters (0x00 to 0x7f) use the US
1475			case mapping, the current locale is not effective.
1476			This probably only matters for Turkish.
1477
1478						*'cdpath'* *'cd'* *E344* *E346*
1479'cdpath' 'cd'		string	(default: equivalent to $CDPATH or ",,")
1480			global
1481			{not available when compiled without the
1482			|+file_in_path| feature}
1483	This is a list of directories which will be searched when using the
1484	|:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1485	searched for has a relative path, not an absolute part starting with
1486	"/", "./" or "../", the 'cdpath' option is not used then.
1487	The 'cdpath' option's value has the same form and semantics as
1488	|'path'|.  Also see |file-searching|.
1489	The default value is taken from $CDPATH, with a "," prepended to look
1490	in the current directory first.
1491	If the default value taken from $CDPATH is not what you want, include
1492	a modified version of the following command in your vimrc file to
1493	override it: >
1494	  :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1495<	This option cannot be set from a |modeline| or in the |sandbox|, for
1496	security reasons.
1497	(parts of 'cdpath' can be passed to the shell to expand file names).
1498
1499						*'cedit'*
1500'cedit'			string	(Vi default: "", Vim default: CTRL-F)
1501			global
1502	The key used in Command-line Mode to open the command-line window.
1503	The default is CTRL-F when 'compatible' is off.
1504	Only non-printable keys are allowed.
1505	The key can be specified as a single character, but it is difficult to
1506	type.  The preferred way is to use the <> notation.  Examples: >
1507		:exe "set cedit=\<C-Y>"
1508		:exe "set cedit=\<Esc>"
1509<	|Nvi| also has this option, but it only uses the first character.
1510	See |cmdwin|.
1511	NOTE: This option is set to the Vim default value when 'compatible'
1512	is reset.
1513
1514				*'charconvert'* *'ccv'* *E202* *E214* *E513*
1515'charconvert' 'ccv'	string (default "")
1516			global
1517			{only available when compiled with the |+eval| feature}
1518	An expression that is used for character encoding conversion.  It is
1519	evaluated when a file that is to be read or has been written has a
1520	different encoding from what is desired.
1521	'charconvert' is not used when the internal iconv() function is
1522	supported and is able to do the conversion.  Using iconv() is
1523	preferred, because it is much faster.
1524	'charconvert' is not used when reading stdin |--|, because there is no
1525	file to convert from.  You will have to save the text in a file first.
1526	The expression must return zero or an empty string for success,
1527	non-zero for failure.
1528	The possible encoding names encountered are in 'encoding'.
1529	Additionally, names given in 'fileencodings' and 'fileencoding' are
1530	used.
1531	Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1532	is done internally by Vim, 'charconvert' is not used for this.
1533	'charconvert' is also used to convert the viminfo file, if the 'c'
1534	flag is present in 'viminfo'.  Also used for Unicode conversion.
1535	Example: >
1536		set charconvert=CharConvert()
1537		fun CharConvert()
1538		  system("recode "
1539			\ . v:charconvert_from . ".." . v:charconvert_to
1540			\ . " <" . v:fname_in . " >" v:fname_out)
1541		  return v:shell_error
1542		endfun
1543<	The related Vim variables are:
1544		v:charconvert_from	name of the current encoding
1545		v:charconvert_to	name of the desired encoding
1546		v:fname_in		name of the input file
1547		v:fname_out		name of the output file
1548	Note that v:fname_in and v:fname_out will never be the same.
1549	Note that v:charconvert_from and v:charconvert_to may be different
1550	from 'encoding'.  Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1551	Encryption is not done by Vim when using 'charconvert'.  If you want
1552	to encrypt the file after conversion, 'charconvert' should take care
1553	of this.
1554	This option cannot be set from a |modeline| or in the |sandbox|, for
1555	security reasons.
1556
1557				   *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1558'cindent' 'cin'		boolean	(default off)
1559			local to buffer
1560			{not available when compiled without the |+cindent|
1561			feature}
1562	Enables automatic C program indenting.  See 'cinkeys' to set the keys
1563	that trigger reindenting in insert mode and 'cinoptions' to set your
1564	preferred indent style.
1565	If 'indentexpr' is not empty, it overrules 'cindent'.
1566	If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1567	the "=" operator indents using this algorithm rather than calling an
1568	external program.
1569	See |C-indenting|.
1570	When you don't like the way 'cindent' works, try the 'smartindent'
1571	option or 'indentexpr'.
1572	This option is not used when 'paste' is set.
1573	NOTE: This option is reset when 'compatible' is set.
1574
1575							*'cinkeys'* *'cink'*
1576'cinkeys' 'cink'	string	(default "0{,0},0),0],:,0#,!^F,o,O,e")
1577			local to buffer
1578			{not available when compiled without the |+cindent|
1579			feature}
1580	A list of keys that, when typed in Insert mode, cause reindenting of
1581	the current line.  Only used if 'cindent' is on and 'indentexpr' is
1582	empty.
1583	For the format of this option see |cinkeys-format|.
1584	See |C-indenting|.
1585
1586						*'cinoptions'* *'cino'*
1587'cinoptions' 'cino'	string	(default "")
1588			local to buffer
1589			{not available when compiled without the |+cindent|
1590			feature}
1591	The 'cinoptions' affect the way 'cindent' reindents lines in a C
1592	program.  See |cinoptions-values| for the values of this option, and
1593	|C-indenting| for info on C indenting in general.
1594
1595
1596						*'cinwords'* *'cinw'*
1597'cinwords' 'cinw'	string	(default "if,else,while,do,for,switch")
1598			local to buffer
1599			{not available when compiled without both the
1600			|+cindent| and the |+smartindent| features}
1601	These keywords start an extra indent in the next line when
1602	'smartindent' or 'cindent' is set.  For 'cindent' this is only done at
1603	an appropriate place (inside {}).
1604	Note that 'ignorecase' isn't used for 'cinwords'.  If case doesn't
1605	matter, include the keyword both the uppercase and lowercase:
1606	"if,If,IF".
1607
1608						*'clipboard'* *'cb'*
1609'clipboard' 'cb'	string	(default "autoselect,exclude:cons\|linux"
1610						  for X-windows, "" otherwise)
1611			global
1612			{only in GUI versions or when the |+xterm_clipboard|
1613			feature is included}
1614	This option is a list of comma separated names.
1615	Note: if one of the items is "exclude:", then you can't add an item
1616	after that.  Therefore do append an item with += but use ^= to
1617	prepend, e.g.: >
1618		set clipboard^=unnamed
1619<	These names are recognized:
1620
1621						*clipboard-unnamed*
1622	unnamed		When included, Vim will use the clipboard register '*'
1623			for all yank, delete, change and put operations which
1624			would normally go to the unnamed register.  When a
1625			register is explicitly specified, it will always be
1626			used regardless of whether "unnamed" is in 'clipboard'
1627			or not.  The clipboard register can always be
1628			explicitly accessed using the "* notation.  Also see
1629			|gui-clipboard|.
1630
1631						*clipboard-unnamedplus*
1632	unnamedplus	A variant of the "unnamed" flag which uses the
1633			clipboard register '+' (|quoteplus|) instead of
1634			register '*' for all yank, delete, change and put
1635			operations which would normally go to the unnamed
1636			register.  When "unnamed" is also included to the
1637			option, yank operations (but not delete, change or
1638			put) will additionally copy the text into register
1639			'*'.
1640			Only available with the |+X11| feature.
1641			Availability can be checked with: >
1642				if has('unnamedplus')
1643<
1644						*clipboard-autoselect*
1645	autoselect	Works like the 'a' flag in 'guioptions': If present,
1646			then whenever Visual mode is started, or the Visual
1647			area extended, Vim tries to become the owner of the
1648			windowing system's global selection or put the
1649			selected text on the clipboard used by the selection
1650			register "*.  See |'go-a'| and |quotestar| for details.
1651			When the GUI is active, the 'a' flag in 'guioptions'
1652			is used, when the GUI is not active, this "autoselect"
1653			flag is used.
1654			Also applies to the modeless selection.
1655
1656						*clipboard-autoselectplus*
1657	autoselectplus  Like "autoselect" but using the + register instead of
1658			the * register.  Compare to the 'P' flag in
1659			'guioptions'.
1660
1661						*clipboard-autoselectml*
1662	autoselectml	Like "autoselect", but for the modeless selection
1663			only.  Compare to the 'A' flag in 'guioptions'.
1664
1665						*clipboard-html*
1666	html		When the clipboard contains HTML, use this when
1667			pasting.  When putting text on the clipboard, mark it
1668			as HTML.  This works to copy rendered HTML from
1669			Firefox, paste it as raw HTML in Vim, select the HTML
1670			in Vim and paste it in a rich edit box in Firefox.
1671			You probably want to add this only temporarily,
1672			possibly use BufEnter autocommands.
1673			Only supported for GTK version 2 and later.
1674
1675						*clipboard-exclude*
1676	exclude:{pattern}
1677			Defines a pattern that is matched against the name of
1678			the terminal 'term'.  If there is a match, no
1679			connection will be made to the X server.  This is
1680			useful in this situation:
1681			- Running Vim in a console.
1682			- $DISPLAY is set to start applications on another
1683			  display.
1684			- You do not want to connect to the X server in the
1685			  console, but do want this in a terminal emulator.
1686			To never connect to the X server use: >
1687				exclude:.*
1688<			This has the same effect as using the |-X| argument.
1689			Note that when there is no connection to the X server
1690			the window title won't be restored and the clipboard
1691			cannot be accessed.
1692			The value of 'magic' is ignored, {pattern} is
1693			interpreted as if 'magic' was on.
1694			The rest of the option value will be used for
1695			{pattern}, this must be the last entry.
1696
1697						*'cmdheight'* *'ch'*
1698'cmdheight' 'ch'	number	(default 1)
1699			global
1700	Number of screen lines to use for the command-line.  Helps avoiding
1701	|hit-enter| prompts.
1702	The value of this option is stored with the tab page, so that each tab
1703	page can have a different value.
1704
1705						*'cmdwinheight'* *'cwh'*
1706'cmdwinheight' 'cwh'	number	(default 7)
1707			global
1708	Number of screen lines to use for the command-line window. |cmdwin|
1709
1710						*'colorcolumn'* *'cc'*
1711'colorcolumn' 'cc'	string	(default "")
1712			local to window
1713			{not available when compiled without the |+syntax|
1714			feature}
1715	'colorcolumn' is a comma separated list of screen columns that are
1716	highlighted with ColorColumn |hl-ColorColumn|.  Useful to align
1717	text.  Will make screen redrawing slower.
1718	The screen column can be an absolute number, or a number preceded with
1719	'+' or '-', which is added to or subtracted from 'textwidth'. >
1720
1721		:set cc=+1  " highlight column after 'textwidth'
1722		:set cc=+1,+2,+3  " highlight three columns after 'textwidth'
1723		:hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1724<
1725	When 'textwidth' is zero then the items with '-' and '+' are not used.
1726	A maximum of 256 columns are highlighted.
1727
1728						*'columns'* *'co'* *E594*
1729'columns' 'co'		number	(default 80 or terminal width)
1730			global
1731	Number of columns of the screen.  Normally this is set by the terminal
1732	initialization and does not have to be set by hand.  Also see
1733	|posix-screen-size|.
1734	When Vim is running in the GUI or in a resizable window, setting this
1735	option will cause the window size to be changed.  When you only want
1736	to use the size for the GUI, put the command in your |gvimrc| file.
1737	When you set this option and Vim is unable to change the physical
1738	number of columns of the display, the display may be messed up.  For
1739	the GUI it is always possible and Vim limits the number of columns to
1740	what fits on the screen.  You can use this command to get the widest
1741	window possible: >
1742		:set columns=9999
1743<	Minimum value is 12, maximum value is 10000.
1744
1745					*'comments'* *'com'* *E524* *E525*
1746'comments' 'com'	string	(default
1747				"s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1748			local to buffer
1749	A comma separated list of strings that can start a comment line.  See
1750	|format-comments|.  See |option-backslash| about using backslashes to
1751	insert a space.
1752
1753					*'commentstring'* *'cms'* *E537*
1754'commentstring' 'cms'	string	(default "/*%s*/")
1755			local to buffer
1756			{not available when compiled without the |+folding|
1757			feature}
1758	A template for a comment.  The "%s" in the value is replaced with the
1759	comment text.  Currently only used to add markers for folding, see
1760	|fold-marker|.
1761
1762			*'compatible'* *'cp'* *'nocompatible'* *'nocp'*
1763'compatible' 'cp'	boolean	(default on, off when a |vimrc| or |gvimrc|
1764					file is found, reset in |defaults.vim|)
1765			global
1766	This option has the effect of making Vim either more Vi-compatible, or
1767	make Vim behave in a more useful way.
1768
1769	This is a special kind of option, because when it's set or reset,
1770	other options are also changed as a side effect.
1771	NOTE: Setting or resetting this option can have a lot of unexpected
1772	effects: Mappings are interpreted in another way, undo behaves
1773	differently, etc.  If you set this option in your vimrc file, you
1774	should probably put it at the very start.
1775
1776	By default this option is on and the Vi defaults are used for the
1777	options.  This default was chosen for those people who want to use Vim
1778	just like Vi, and don't even (want to) know about the 'compatible'
1779	option.
1780	When a |vimrc| or |gvimrc| file is found while Vim is starting up,
1781	this option is switched off, and all options that have not been
1782	modified will be set to the Vim defaults.  Effectively, this means
1783	that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
1784	defaults, otherwise it will use the Vi defaults.  (Note: This doesn't
1785	happen for the system-wide vimrc or gvimrc file, nor for a file given
1786	with the |-u| argument).  Also see |compatible-default| and
1787	|posix-compliance|.
1788	You can also set this option with the "-C" argument, and reset it with
1789	"-N".  See |-C| and |-N|.
1790	See 'cpoptions' for more fine tuning of Vi compatibility.
1791
1792	When this option is set, numerous other options are set to make Vim as
1793	Vi-compatible as possible.  When this option is unset, various options
1794	are set to make Vim more useful.  The table below lists all the
1795	options affected.
1796	The {?} column indicates when the options are affected:
1797	+  Means that the option is set to the value given in {set value} when
1798	   'compatible' is set.
1799	&  Means that the option is set to the value given in {set value} when
1800	   'compatible' is set AND is set to its Vim default value when
1801	   'compatible' is unset.
1802	-  Means the option is NOT changed when setting 'compatible' but IS
1803	   set to its Vim default when 'compatible' is unset.
1804	The {effect} column summarises the change when 'compatible' is set.
1805
1806	option		? set value	effect ~
1807
1808	'allowrevins'	+ off		no CTRL-_ command
1809	'antialias'	+ off		don't use antialiased fonts
1810	'arabic'	+ off	 	reset arabic-related options
1811	'arabicshape'	+ on		correct character shapes
1812	'backspace'	+ ""		normal backspace
1813	'backup'	+ off		no backup file
1814	'backupcopy'	& Unix: "yes"	backup file is a copy
1815			  else: "auto"	copy or rename backup file
1816	'balloonexpr'	+ ""		text to show in evaluation balloon
1817	'breakindent'	+ off		don't indent when wrapping lines
1818	'cedit'		- {unchanged}	{set vim default only on resetting 'cp'}
1819	'cindent'	+ off		no C code indentation
1820	'compatible'	- {unchanged}	{set vim default only on resetting 'cp'}
1821	'copyindent'	+ off		don't copy indent structure
1822	'cpoptions'	& (all flags)	Vi-compatible flags
1823	'cscopepathcomp'+ 0		don't show directories in tags list
1824	'cscoperelative'+ off		don't use basename of path as prefix
1825	'cscopetag'	+ off		don't use cscope for ":tag"
1826	'cscopetagorder'+ 0		see |cscopetagorder|
1827	'cscopeverbose'	+ off		see |cscopeverbose|
1828	'delcombine'	+ off		unicode: delete whole char combination
1829	'digraph'	+ off		no digraphs
1830	'esckeys'	& off		no <Esc>-keys in Insert mode
1831	'expandtab'	+ off		tabs not expanded to spaces
1832	'fileformats'	& ""		no automatic file format detection,
1833			  "dos,unix"	except for MS-Windows
1834	'formatexpr'	+ ""		use 'formatprg' for auto-formatting
1835	'formatoptions'	& "vt"		Vi compatible formatting
1836	'gdefault'	+ off		no default 'g' flag for ":s"
1837	'history'	& 0		no commandline history
1838	'hkmap'		+ off		no Hebrew keyboard mapping
1839	'hkmapp'	+ off		no phonetic Hebrew keyboard mapping
1840	'hlsearch'	+ off		no highlighting of search matches
1841	'incsearch'	+ off		no incremental searching
1842	'indentexpr'	+ ""		no indenting by expression
1843	'insertmode'	+ off		do not start in Insert mode
1844	'iskeyword'	& "@,48-57,_"	keywords contain alphanumeric
1845						characters and '_'
1846	'joinspaces'	+ on		insert 2 spaces after period
1847	'modeline'	& off		no modelines
1848	'more'		& off		no pauses in listings
1849	'mzquantum'	- {unchanged}	{set vim default only on resetting 'cp'}
1850	'numberwidth'	& 8		min number of columns for line number
1851	'preserveindent'+ off		don't preserve current indent structure
1852						when changing it
1853	'revins'	+ off		no reverse insert
1854	'ruler'		+ off		no ruler
1855	'scrolljump'	+ 1		no jump scroll
1856	'scrolloff'	+ 0		no scroll offset
1857	'shelltemp'	- {unchanged}	{set vim default only on resetting 'cp'}
1858	'shiftround'	+ off		indent not rounded to shiftwidth
1859	'shortmess'	& "S"		no shortening of messages
1860	'showcmd'	& off		command characters not shown
1861	'showmode'	& off		current mode not shown
1862	'sidescrolloff'	+ 0		cursor moves to edge of screen in scroll
1863	'smartcase'	+ off		no automatic ignore case switch
1864	'smartindent'	+ off		no smart indentation
1865	'smarttab'	+ off		no smart tab size
1866	'softtabstop'	+ 0		tabs are always 'tabstop' positions
1867	'startofline'	+ on		goto startofline with some commands
1868	'tagcase'	& "followic"	'ignorecase' when searching tags file
1869	'tagrelative'	& off		tag file names are not relative
1870	'termguicolors'	+ off		don't use highlight-(guifg|guibg)
1871	'textauto'	& off		no automatic textmode detection
1872	'textwidth'	+ 0		no automatic line wrap
1873	'tildeop'	+ off		tilde is not an operator
1874	'ttimeout'	+ off		no terminal timeout
1875	'undofile'	+ off		don't use an undo file
1876	'viminfo'       - {unchanged}	{set Vim default only on resetting 'cp'}
1877	'virtualedit'	+ ""		cursor can only be placed on characters
1878	'whichwrap'	& ""		left-right movements don't wrap
1879	'wildchar'	& CTRL-E	only when the current value is <Tab>
1880					use CTRL-E for cmdline completion
1881	'writebackup'	+ on or off	depends on the |+writebackup| feature
1882
1883						*'complete'* *'cpt'* *E535*
1884'complete' 'cpt'	string	(default: ".,w,b,u,t,i")
1885			local to buffer
1886	This option specifies how keyword completion |ins-completion| works
1887	when CTRL-P or CTRL-N are used.  It is also used for whole-line
1888	completion |i_CTRL-X_CTRL-L|.  It indicates the type of completion
1889	and the places to scan.  It is a comma separated list of flags:
1890	.	scan the current buffer ('wrapscan' is ignored)
1891	w	scan buffers from other windows
1892	b	scan other loaded buffers that are in the buffer list
1893	u	scan the unloaded buffers that are in the buffer list
1894	U	scan the buffers that are not in the buffer list
1895	k	scan the files given with the 'dictionary' option
1896	kspell  use the currently active spell checking |spell|
1897	k{dict}	scan the file {dict}.  Several "k" flags can be given,
1898		patterns are valid too.  For example: >
1899			:set cpt=k/usr/dict/*,k~/spanish
1900<	s	scan the files given with the 'thesaurus' option
1901	s{tsr}	scan the file {tsr}.  Several "s" flags can be given, patterns
1902		are valid too.
1903	i	scan current and included files
1904	d	scan current and included files for defined name or macro
1905		|i_CTRL-X_CTRL-D|
1906	]	tag completion
1907	t	same as "]"
1908
1909	Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1910	not executed, this may lead to unexpected completions from some files
1911	(gzipped files for example).  Unloaded buffers are not scanned for
1912	whole-line completion.
1913
1914	The default is ".,w,b,u,t,i", which means to scan:
1915	   1. the current buffer
1916	   2. buffers in other windows
1917	   3. other loaded buffers
1918	   4. unloaded buffers
1919	   5. tags
1920	   6. included files
1921
1922	As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
1923	based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1924	|i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
1925
1926						*'completefunc'* *'cfu'*
1927'completefunc' 'cfu'	string	(default: empty)
1928			local to buffer
1929			{not available when compiled without the |+eval|
1930			feature}
1931	This option specifies a function to be used for Insert mode completion
1932	with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
1933	See |complete-functions| for an explanation of how the function is
1934	invoked and what it should return.
1935	This option cannot be set from a |modeline| or in the |sandbox|, for
1936	security reasons.
1937
1938						*'completeslash'* *'csl'*
1939'completeslash' 'csl'	string	(default: "")
1940			local to buffer
1941			{only for MS-Windows}
1942	When this option is set it overrules 'shellslash' for completion:
1943	- When this option is set to "slash", a forward slash is used for path
1944	  completion in insert mode. This is useful when editing HTML tag, or
1945	  Makefile with 'noshellslash' on MS-Windows.
1946	- When this option is set to "backslash", backslash is used. This is
1947	  useful when editing a batch file with 'shellslash' set on MS-Windows.
1948	- When this option is empty, same character is used as for
1949	  'shellslash'.
1950	For Insert mode completion the buffer-local value is used.  For
1951	command line completion the global value is used.
1952
1953						*'completeopt'* *'cot'*
1954'completeopt' 'cot'	string	(default: "menu,preview")
1955			global
1956	A comma separated list of options for Insert mode completion
1957	|ins-completion|.  The supported values are:
1958
1959	   menu	    Use a popup menu to show the possible completions.  The
1960		    menu is only shown when there is more than one match and
1961		    sufficient colors are available.  |ins-completion-menu|
1962
1963	   menuone  Use the popup menu also when there is only one match.
1964		    Useful when there is additional information about the
1965		    match, e.g., what file it comes from.
1966
1967	   longest  Only insert the longest common text of the matches.  If
1968		    the menu is displayed you can use CTRL-L to add more
1969		    characters.  Whether case is ignored depends on the kind
1970		    of completion.  For buffer text the 'ignorecase' option is
1971		    used.
1972
1973	   preview  Show extra information about the currently selected
1974		    completion in the preview window.  Only works in
1975		    combination with "menu" or "menuone".
1976
1977	   popup    Show extra information about the currently selected
1978		    completion in a popup window.  Only works in combination
1979		    with "menu" or "menuone".  Overrides "preview".
1980		    See |'completepopup'| for specifying properties.
1981		    {only works when compiled with the |+textprop| feature}
1982
1983	   popuphidden
1984		    Just like "popup" but initially hide the popup.  Use a
1985		    |CompleteChanged| autocommand to fetch the info and call
1986		    |popup_show()| once the popup has been filled.
1987		    See the example at |complete-popuphidden|.
1988		    {only works when compiled with the |+textprop| feature}
1989
1990	   noinsert Do not insert any text for a match until the user selects
1991		    a match from the menu. Only works in combination with
1992		    "menu" or "menuone". No effect if "longest" is present.
1993
1994	   noselect Do not select a match in the menu, force the user to
1995		    select one from the menu. Only works in combination with
1996		    "menu" or "menuone".
1997
1998
1999					*'completepopup'* *'cpp'*
2000'completepopup' 'cpp'	string (default empty)
2001			global
2002			{not available when compiled without the |+textprop|
2003			or |+quickfix| feature}
2004	When 'completeopt' contains "popup" then this option is used for the
2005	properties of the info popup when it is created.  If an info popup
2006	window already exists it is closed, so that the option value is
2007	applied when it is created again.
2008	You can also use |popup_findinfo()| and then set properties for an
2009	existing info popup with |popup_setoptions()|.  See |complete-popup|.
2010
2011
2012						*'concealcursor'* *'cocu'*
2013'concealcursor' 'cocu'	string (default: "")
2014			local to window
2015			{not available when compiled without the |+conceal|
2016			feature}
2017	Sets the modes in which text in the cursor line can also be concealed.
2018	When the current mode is listed then concealing happens just like in
2019	other lines.
2020	  n		Normal mode
2021	  v		Visual mode
2022	  i		Insert mode
2023	  c		Command line editing, for 'incsearch'
2024
2025	'v' applies to all lines in the Visual area, not only the cursor.
2026	A useful value is "nc".  This is used in help files.  So long as you
2027	are moving around text is concealed, but when starting to insert text
2028	or selecting a Visual area the concealed text is displayed, so that
2029	you can see what you are doing.
2030	Keep in mind that the cursor position is not always where it's
2031	displayed.  E.g., when moving vertically it may change column.
2032
2033
2034						*'conceallevel'* *'cole'*
2035'conceallevel' 'cole'	number (default 0)
2036			local to window
2037			{not available when compiled without the |+conceal|
2038			feature}
2039	Determine how text with the "conceal" syntax attribute |:syn-conceal|
2040	is shown:
2041
2042	Value		Effect ~
2043	0		Text is shown normally
2044	1		Each block of concealed text is replaced with one
2045			character.  If the syntax item does not have a custom
2046			replacement character defined (see |:syn-cchar|) the
2047			character defined in 'listchars' is used (default is a
2048			space).
2049			It is highlighted with the "Conceal" highlight group.
2050	2		Concealed text is completely hidden unless it has a
2051			custom replacement character defined (see
2052			|:syn-cchar|).
2053	3		Concealed text is completely hidden.
2054
2055	Note: in the cursor line concealed text is not hidden, so that you can
2056	edit and copy the text.  This can be changed with the 'concealcursor'
2057	option.
2058
2059				*'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2060'confirm' 'cf'		boolean (default off)
2061			global
2062	When 'confirm' is on, certain operations that would normally
2063	fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2064	instead raise a |dialog| asking if you wish to save the current
2065	file(s).  You can still use a ! to unconditionally |abandon| a buffer.
2066	If 'confirm' is off you can still activate confirmation for one
2067	command only (this is most useful in mappings) with the |:confirm|
2068	command.
2069	Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2070
2071			*'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2072'conskey' 'consk'	boolean	(default off)
2073			global
2074	This was for MS-DOS and is no longer supported.
2075
2076			*'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2077'copyindent' 'ci'	boolean	(default off)
2078			local to buffer
2079	Copy the structure of the existing lines indent when autoindenting a
2080	new line.  Normally the new indent is reconstructed by a series of
2081	tabs followed by spaces as required (unless |'expandtab'| is enabled,
2082	in which case only spaces are used).  Enabling this option makes the
2083	new line copy whatever characters were used for indenting on the
2084	existing line.  'expandtab' has no effect on these characters, a Tab
2085	remains a Tab.  If the new indent is greater than on the existing
2086	line, the remaining space is filled in the normal manner.
2087	NOTE: This option is reset when 'compatible' is set.
2088	Also see 'preserveindent'.
2089
2090						*'cpoptions'* *'cpo'* *cpo*
2091'cpoptions' 'cpo'	string	(Vim default: "aABceFs",
2092				 Vi default:  all flags)
2093			global
2094	A sequence of single character flags.  When a character is present
2095	this indicates Vi-compatible behavior.  This is used for things where
2096	not being Vi-compatible is mostly or sometimes preferred.
2097	'cpoptions' stands for "compatible-options".
2098	Commas can be added for readability.
2099	To avoid problems with flags that are added in the future, use the
2100	"+=" and "-=" feature of ":set" |add-option-flags|.
2101	NOTE: This option is set to the Vi default value when 'compatible' is
2102	set and to the Vim default value when 'compatible' is reset.
2103	NOTE: This option is set to the POSIX default value at startup when
2104	the Vi default value would be used and the $VIM_POSIX environment
2105	variable exists |posix|.  This means Vim tries to behave like the
2106	POSIX specification.
2107
2108	    contains	behavior	~
2109								*cpo-a*
2110		a	When included, a ":read" command with a file name
2111			argument will set the alternate file name for the
2112			current window.
2113								*cpo-A*
2114		A	When included, a ":write" command with a file name
2115			argument will set the alternate file name for the
2116			current window.
2117								*cpo-b*
2118		b	"\|" in a ":map" command is recognized as the end of
2119			the map command.  The '\' is included in the mapping,
2120			the text after the '|' is interpreted as the next
2121			command.  Use a CTRL-V instead of a backslash to
2122			include the '|' in the mapping.  Applies to all
2123			mapping, abbreviation, menu and autocmd commands.
2124			See also |map_bar|.
2125								*cpo-B*
2126		B	A backslash has no special meaning in mappings,
2127			abbreviations, user commands and the "to" part of the
2128			menu commands.  Remove this flag to be able to use a
2129			backslash like a CTRL-V.  For example, the command
2130			":map X \<Esc>" results in X being mapped to:
2131				'B' included:	"\^["	 (^[ is a real <Esc>)
2132				'B' excluded:	"<Esc>"  (5 characters)
2133				('<' excluded in both cases)
2134								*cpo-c*
2135		c	Searching continues at the end of any match at the
2136			cursor position, but not further than the start of the
2137			next line.  When not present searching continues
2138			one character from the cursor position.  With 'c'
2139			"abababababab" only gets three matches when repeating
2140			"/abab", without 'c' there are five matches.
2141								*cpo-C*
2142		C	Do not concatenate sourced lines that start with a
2143			backslash.  See |line-continuation|.
2144								*cpo-d*
2145		d	Using "./" in the 'tags' option doesn't mean to use
2146			the tags file relative to the current file, but the
2147			tags file in the current directory.
2148								*cpo-D*
2149		D	Can't use CTRL-K to enter a digraph after Normal mode
2150			commands with a character argument, like |r|, |f| and
2151			|t|.
2152								*cpo-e*
2153		e	When executing a register with ":@r", always add a
2154			<CR> to the last line, also when the register is not
2155			linewise.  If this flag is not present, the register
2156			is not linewise and the last line does not end in a
2157			<CR>, then the last line is put on the command-line
2158			and can be edited before hitting <CR>.
2159								*cpo-E*
2160		E	It is an error when using "y", "d", "c", "g~", "gu" or
2161			"gU" on an Empty region.  The operators only work when
2162			at least one character is to be operated on.  Example:
2163			This makes "y0" fail in the first column.
2164								*cpo-f*
2165		f	When included, a ":read" command with a file name
2166			argument will set the file name for the current buffer,
2167			if the current buffer doesn't have a file name yet.
2168								*cpo-F*
2169		F	When included, a ":write" command with a file name
2170			argument will set the file name for the current
2171			buffer, if the current buffer doesn't have a file name
2172			yet.  Also see |cpo-P|.
2173								*cpo-g*
2174		g	Goto line 1 when using ":edit" without argument.
2175								*cpo-H*
2176		H	When using "I" on a line with only blanks, insert
2177			before the last blank.  Without this flag insert after
2178			the last blank.
2179								*cpo-i*
2180		i	When included, interrupting the reading of a file will
2181			leave it modified.
2182								*cpo-I*
2183		I	When moving the cursor up or down just after inserting
2184			indent for 'autoindent', do not delete the indent.
2185								*cpo-j*
2186		j	When joining lines, only add two spaces after a '.',
2187			not after '!' or '?'.  Also see 'joinspaces'.
2188								*cpo-J*
2189		J	A |sentence| has to be followed by two spaces after
2190			the '.', '!' or '?'.  A <Tab> is not recognized as
2191			white space.
2192								*cpo-k*
2193		k	Disable the recognition of raw key codes in
2194			mappings, abbreviations, and the "to" part of menu
2195			commands.  For example, if <Key> sends ^[OA (where ^[
2196			is <Esc>), the command ":map X ^[OA" results in X
2197			being mapped to:
2198				'k' included:	"^[OA"	 (3 characters)
2199				'k' excluded:	"<Key>"  (one key code)
2200			Also see the '<' flag below.
2201								*cpo-K*
2202		K	Don't wait for a key code to complete when it is
2203			halfway a mapping.  This breaks mapping <F1><F1> when
2204			only part of the second <F1> has been read.  It
2205			enables cancelling the mapping by typing <F1><Esc>.
2206								*cpo-l*
2207		l	Backslash in a [] range in a search pattern is taken
2208			literally, only "\]", "\^", "\-" and "\\" are special.
2209			See |/[]|
2210			   'l' included: "/[ \t]"  finds <Space>, '\' and 't'
2211			   'l' excluded: "/[ \t]"  finds <Space> and <Tab>
2212			Also see |cpo-\|.
2213								*cpo-L*
2214		L	When the 'list' option is set, 'wrapmargin',
2215			'textwidth', 'softtabstop' and Virtual Replace mode
2216			(see |gR|) count a <Tab> as two characters, instead of
2217			the normal behavior of a <Tab>.
2218								*cpo-m*
2219		m	When included, a showmatch will always wait half a
2220			second.  When not included, a showmatch will wait half
2221			a second or until a character is typed.  |'showmatch'|
2222								*cpo-M*
2223		M	When excluded, "%" matching will take backslashes into
2224			account.  Thus in "( \( )" and "\( ( \)" the outer
2225			parenthesis match.  When included "%" ignores
2226			backslashes, which is Vi compatible.
2227								*cpo-n*
2228		n	When included, the column used for 'number' and
2229			'relativenumber' will also be used for text of wrapped
2230			lines.
2231								*cpo-o*
2232		o	Line offset to search command is not remembered for
2233			next search.
2234								*cpo-O*
2235		O	Don't complain if a file is being overwritten, even
2236			when it didn't exist when editing it.  This is a
2237			protection against a file unexpectedly created by
2238			someone else.  Vi didn't complain about this.
2239								*cpo-p*
2240		p	Vi compatible Lisp indenting.  When not present, a
2241			slightly better algorithm is used.
2242								*cpo-P*
2243		P	When included, a ":write" command that appends to a
2244			file will set the file name for the current buffer, if
2245			the current buffer doesn't have a file name yet and
2246			the 'F' flag is also included |cpo-F|.
2247								*cpo-q*
2248		q	When joining multiple lines leave the cursor at the
2249			position where it would be when joining two lines.
2250								*cpo-r*
2251		r	Redo ("." command) uses "/" to repeat a search
2252			command, instead of the actually used search string.
2253								*cpo-R*
2254		R	Remove marks from filtered lines.  Without this flag
2255			marks are kept like |:keepmarks| was used.
2256								*cpo-s*
2257		s	Set buffer options when entering the buffer for the
2258			first time.  This is like it is in Vim version 3.0.
2259			And it is the default.  If not present the options are
2260			set when the buffer is created.
2261								*cpo-S*
2262		S	Set buffer options always when entering a buffer
2263			(except 'readonly', 'fileformat', 'filetype' and
2264			'syntax').  This is the (most) Vi compatible setting.
2265			The options are set to the values in the current
2266			buffer.  When you change an option and go to another
2267			buffer, the value is copied.  Effectively makes the
2268			buffer options global to all buffers.
2269
2270			's'    'S'     copy buffer options
2271			no     no      when buffer created
2272			yes    no      when buffer first entered (default)
2273			 X     yes     each time when buffer entered (vi comp.)
2274								*cpo-t*
2275		t	Search pattern for the tag command is remembered for
2276			"n" command.  Otherwise Vim only puts the pattern in
2277			the history for search pattern, but doesn't change the
2278			last used search pattern.
2279								*cpo-u*
2280		u	Undo is Vi compatible.  See |undo-two-ways|.
2281								*cpo-v*
2282		v	Backspaced characters remain visible on the screen in
2283			Insert mode.  Without this flag the characters are
2284			erased from the screen right away.  With this flag the
2285			screen newly typed text overwrites backspaced
2286			characters.
2287								*cpo-w*
2288		w	When using "cw" on a blank character, only change one
2289			character and not all blanks until the start of the
2290			next word.
2291								*cpo-W*
2292		W	Don't overwrite a readonly file.  When omitted, ":w!"
2293			overwrites a readonly file, if possible.
2294								*cpo-x*
2295		x	<Esc> on the command-line executes the command-line.
2296			The default in Vim is to abandon the command-line,
2297			because <Esc> normally aborts a command.  |c_<Esc>|
2298								*cpo-X*
2299		X	When using a count with "R" the replaced text is
2300			deleted only once.  Also when repeating "R" with "."
2301			and a count.
2302								*cpo-y*
2303		y	A yank command can be redone with ".".  Think twice if
2304			you really want to use this, it may break some
2305			plugins, since most people expect "." to only repeat a
2306			change.
2307								*cpo-Z*
2308		Z	When using "w!" while the 'readonly' option is set,
2309			don't reset 'readonly'.
2310								*cpo-!*
2311		!	When redoing a filter command, use the last used
2312			external command, whatever it was.  Otherwise the last
2313			used -filter- command is used.
2314								*cpo-$*
2315		$	When making a change to one line, don't redisplay the
2316			line, but put a '$' at the end of the changed text.
2317			The changed text will be overwritten when you type the
2318			new text.  The line is redisplayed if you type any
2319			command that moves the cursor from the insertion
2320			point.
2321								*cpo-%*
2322		%	Vi-compatible matching is done for the "%" command.
2323			Does not recognize "#if", "#endif", etc.
2324			Does not recognize "/*" and "*/".
2325			Parens inside single and double quotes are also
2326			counted, causing a string that contains a paren to
2327			disturb the matching.  For example, in a line like
2328			"if (strcmp("foo(", s))" the first paren does not
2329			match the last one.  When this flag is not included,
2330			parens inside single and double quotes are treated
2331			specially.  When matching a paren outside of quotes,
2332			everything inside quotes is ignored.  When matching a
2333			paren inside quotes, it will find the matching one (if
2334			there is one).  This works very well for C programs.
2335			This flag is also used for other features, such as
2336			C-indenting.
2337								*cpo--*
2338		-	When included, a vertical movement command fails when
2339			it would go above the first line or below the last
2340			line.  Without it the cursor moves to the first or
2341			last line, unless it already was in that line.
2342			Applies to the commands "-", "k", CTRL-P, "+", "j",
2343			CTRL-N, CTRL-J and ":1234".
2344								*cpo-+*
2345		+	When included, a ":write file" command will reset the
2346			'modified' flag of the buffer, even though the buffer
2347			itself may still be different from its file.
2348								*cpo-star*
2349		*	Use ":*" in the same way as ":@".  When not included,
2350			":*" is an alias for ":'<,'>", select the Visual area.
2351								*cpo-<*
2352		<	Disable the recognition of special key codes in |<>|
2353			form in mappings, abbreviations, and the "to" part of
2354			menu commands.  For example, the command
2355			":map X <Tab>" results in X being mapped to:
2356				'<' included:	"<Tab>"  (5 characters)
2357				'<' excluded:	"^I"	 (^I is a real <Tab>)
2358			Also see the 'k' flag above.
2359								*cpo->*
2360		>	When appending to a register, put a line break before
2361			the appended text.
2362								*cpo-;*
2363		;	When using |,| or |;| to repeat the last |t| search
2364			and the cursor is right in front of the searched
2365			character, the cursor won't move. When not included,
2366			the cursor would skip over it and jump to the
2367			following occurrence.
2368
2369	POSIX flags.  These are not included in the Vi default value, except
2370	when $VIM_POSIX was set on startup. |posix|
2371
2372	    contains	behavior	~
2373								*cpo-#*
2374		#	A count before "D", "o" and "O" has no effect.
2375								*cpo-&*
2376		&	When ":preserve" was used keep the swap file when
2377			exiting normally while this buffer is still loaded.
2378			This flag is tested when exiting.
2379								*cpo-\*
2380		\	Backslash in a [] range in a search pattern is taken
2381			literally, only "\]" is special  See |/[]|
2382			   '\' included: "/[ \-]"  finds <Space>, '\' and '-'
2383			   '\' excluded: "/[ \-]"  finds <Space> and '-'
2384			Also see |cpo-l|.
2385								*cpo-/*
2386		/	When "%" is used as the replacement string in a |:s|
2387			command, use the previous replacement string. |:s%|
2388								*cpo-{*
2389		{	The |{| and |}| commands also stop at a "{" character
2390			at the start of a line.
2391								*cpo-.*
2392		.	The ":chdir" and ":cd" commands fail if the current
2393			buffer is modified, unless ! is used.  Vim doesn't
2394			need this, since it remembers the full path of an
2395			opened file.
2396								*cpo-bar*
2397		|	The value of the $LINES and $COLUMNS environment
2398			variables overrule the terminal size values obtained
2399			with system specific functions.
2400
2401
2402						*'cryptmethod'* *'cm'*
2403'cryptmethod' 'cm'	string	(default "blowfish2")
2404			global or local to buffer |global-local|
2405	Method used for encryption when the buffer is written to a file:
2406							*pkzip*
2407	   zip		PkZip compatible method.  A weak kind of encryption.
2408			Backwards compatible with Vim 7.2 and older.
2409							*blowfish*
2410	   blowfish	Blowfish method.  Medium strong encryption but it has
2411			an implementation flaw.  Requires Vim 7.3 or later,
2412			files can NOT be read by Vim 7.2 and older.  This adds
2413			a "seed" to the file, every time you write the file
2414			the encrypted bytes will be different.
2415							*blowfish2*
2416	   blowfish2	Blowfish method.  Medium strong encryption.  Requires
2417			Vim 7.4.401 or later, files can NOT be read by Vim 7.3
2418			and older.  This adds a "seed" to the file, every time
2419			you write the file the encrypted bytes will be
2420			different.  The whole undo file is encrypted, not just
2421			the pieces of text.
2422					*E1193* *E1194* *E1195* *E1196*
2423					*E1197* *E1198* *E1199* *E1200* *E1201*
2424	   xchacha20	XChaCha20 Cipher with Poly1305 Message Authentication
2425			Code.  Medium strong till strong encryption.
2426			Encryption is provided by the libsodium library, it
2427			requires Vim to be built with |+sodium|.
2428			It adds a seed and a message authentication code (MAC)
2429			to the file.  This needs at least a Vim 8.2.3022 to
2430			read the encrypted file.
2431			Encryption of swap files is not supported, therefore
2432			no swap file will be used when xchacha20 encryption is
2433			enabled.
2434			Encryption of undo files is not yet supported,
2435			therefore no undo file will currently be written.
2436			CURRENTLY EXPERIMENTAL: Files written with this method
2437			might have to be read back with the same version of
2438			Vim if the binary format changes later.
2439
2440	You should use "blowfish2", also to re-encrypt older files.
2441
2442	When reading an encrypted file 'cryptmethod' will be set automatically
2443	to the detected method of the file being read.  Thus if you write it
2444	without changing 'cryptmethod' the same method will be used.
2445	Changing 'cryptmethod' does not mark the file as modified, you have to
2446	explicitly write it, you don't get a warning unless there are other
2447	modifications.  Also see |:X|.
2448
2449	When setting the global value to an empty string, it will end up with
2450	the value "blowfish2".  When setting the local value to an empty
2451	string the buffer will use the global value.
2452
2453	When a new encryption method is added in a later version of Vim, and
2454	the current version does not recognize it, you will get	*E821* .
2455	You need to edit this file with the later version of Vim.
2456
2457
2458						*'cscopepathcomp'* *'cspc'*
2459'cscopepathcomp' 'cspc'	number	(default 0)
2460			global
2461			{not available when compiled without the |+cscope|
2462			feature}
2463	Determines how many components of the path to show in a list of tags.
2464	See |cscopepathcomp|.
2465	NOTE: This option is set to 0 when 'compatible' is set.
2466
2467						*'cscopeprg'* *'csprg'*
2468'cscopeprg' 'csprg'	string	(default "cscope")
2469			global
2470			{not available when compiled without the |+cscope|
2471			feature}
2472	Specifies the command to execute cscope.  See |cscopeprg|.
2473	This option cannot be set from a |modeline| or in the |sandbox|, for
2474	security reasons.
2475
2476						*'cscopequickfix'* *'csqf'*
2477'cscopequickfix' 'csqf' string	(default "")
2478			global
2479			{not available when compiled without the |+cscope|
2480			or |+quickfix| features}
2481	Specifies whether to use quickfix window to show cscope results.
2482	See |cscopequickfix|.
2483
2484		*'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
2485'cscoperelative' 'csre' boolean (default off)
2486			global
2487			{not available when compiled without the |+cscope|
2488			feature}
2489	In the absence of a prefix (-P) for cscope. setting this option enables
2490	to use the basename of cscope.out path as the prefix.
2491	See |cscoperelative|.
2492	NOTE: This option is reset when 'compatible' is set.
2493
2494				*'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2495'cscopetag' 'cst'	boolean (default off)
2496			global
2497			{not available when compiled without the |+cscope|
2498			feature}
2499	Use cscope for tag commands.  See |cscope-options|.
2500	NOTE: This option is reset when 'compatible' is set.
2501
2502						*'cscopetagorder'* *'csto'*
2503'cscopetagorder' 'csto'	number	(default 0)
2504			global
2505			{not available when compiled without the |+cscope|
2506			feature}
2507	Determines the order in which ":cstag" performs a search.  See
2508	|cscopetagorder|.
2509	NOTE: This option is set to 0 when 'compatible' is set.
2510
2511					*'cscopeverbose'* *'csverb'*
2512					*'nocscopeverbose'* *'nocsverb'*
2513'cscopeverbose' 'csverb' boolean (default off)
2514			global
2515			{not available when compiled without the |+cscope|
2516			feature}
2517	Give messages when adding a cscope database.  See |cscopeverbose|.
2518	NOTE: This option is reset when 'compatible' is set.
2519
2520			*'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2521'cursorbind' 'crb'	boolean  (default off)
2522			local to window
2523	When this option is set, as the cursor in the current
2524	window moves other cursorbound windows (windows that also have
2525	this option set) move their cursors to the corresponding line and
2526	column.  This option is useful for viewing the
2527	differences between two versions of a file (see 'diff'); in diff mode,
2528	inserted and deleted lines (though not characters within a line) are
2529	taken into account.
2530
2531
2532			*'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2533'cursorcolumn' 'cuc'	boolean	(default off)
2534			local to window
2535			{not available when compiled without the |+syntax|
2536			feature}
2537	Highlight the screen column of the cursor with CursorColumn
2538	|hl-CursorColumn|.  Useful to align text.  Will make screen redrawing
2539	slower.
2540	If you only want the highlighting in the current window you can use
2541	these autocommands: >
2542		au WinLeave * set nocursorline nocursorcolumn
2543		au WinEnter * set cursorline cursorcolumn
2544<
2545
2546			*'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2547'cursorline' 'cul'	boolean	(default off)
2548			local to window
2549			{not available when compiled without the |+syntax|
2550			feature}
2551	Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2552	Useful to easily spot the cursor.  Will make screen redrawing slower.
2553	When Visual mode is active the highlighting isn't used to make it
2554	easier to see the selected text.
2555
2556
2557						*'cursorlineopt'* *'culopt'*
2558'cursorlineopt' 'culopt' string (default: "number,line")
2559			local to window
2560			{not available when compiled without the |+syntax|
2561			feature}
2562	Comma separated list of settings for how 'cursorline' is displayed.
2563	Valid values:
2564	"line"		Highlight the text line of the cursor with
2565			CursorLine |hl-CursorLine|.
2566	"screenline"	Highlight only the screen line of the cursor with
2567			CursorLine |hl-CursorLine|.
2568	"number"	Highlight the line number of the cursor with
2569			CursorLineNr |hl-CursorLineNr|.
2570
2571	Special value:
2572	"both"		Alias for the values "line,number".
2573
2574	"line" and "screenline" cannot be used together.
2575
2576
2577						*'debug'*
2578'debug'			string	(default "")
2579			global
2580	These values can be used:
2581	msg	Error messages that would otherwise be omitted will be given
2582		anyway.
2583	throw	Error messages that would otherwise be omitted will be given
2584		anyway and also throw an exception and set |v:errmsg|.
2585	beep	A message will be given when otherwise only a beep would be
2586		produced.
2587	The values can be combined, separated by a comma.
2588	"msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2589	'indentexpr'.
2590
2591						*'define'* *'def'*
2592'define' 'def'		string	(default "^\s*#\s*define")
2593			global or local to buffer |global-local|
2594	Pattern to be used to find a macro definition.  It is a search
2595	pattern, just like for the "/" command.  This option is used for the
2596	commands like "[i" and "[d" |include-search|.  The 'isident' option is
2597	used to recognize the defined name after the match:
2598		{match with 'define'}{non-ID chars}{defined name}{non-ID char}
2599	See |option-backslash| about inserting backslashes to include a space
2600	or backslash.
2601	The default value is for C programs.  For C++ this value would be
2602	useful, to include const type declarations: >
2603		^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2604<	You can also use "\ze" just before the name and continue the pattern
2605	to check what is following.  E.g. for Javascript, if a function is
2606	defined with "func_name = function(args)": >
2607		^\s*\ze\i\+\s*=\s*function(
2608<	If the function is defined with "func_name : function() {...": >
2609	        ^\s*\ze\i\+\s*[:]\s*(*function\s*(
2610<	When using the ":set" command, you need to double the backslashes!
2611	To avoid that use `:let` with a single quote string: >
2612		let &l:define = '^\s*\ze\k\+\s*=\s*function('
2613<
2614
2615			*'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2616'delcombine' 'deco'	boolean (default off)
2617			global
2618	If editing Unicode and this option is set, backspace and Normal mode
2619	"x" delete each combining character on its own.  When it is off (the
2620	default) the character along with its combining characters are
2621	deleted.
2622	Note: When 'delcombine' is set "xx" may work differently from "2x"!
2623
2624	This is useful for Arabic, Hebrew and many other languages where one
2625	may have combining characters overtop of base characters, and want
2626	to remove only the combining ones.
2627	NOTE: This option is reset when 'compatible' is set.
2628
2629						*'dictionary'* *'dict'*
2630'dictionary' 'dict'	string	(default "")
2631			global or local to buffer |global-local|
2632	List of file names, separated by commas, that are used to lookup words
2633	for keyword completion commands |i_CTRL-X_CTRL-K|.  Each file should
2634	contain a list of words.  This can be one word per line, or several
2635	words per line, separated by non-keyword characters (white space is
2636	preferred).  Maximum line length is 510 bytes.
2637
2638	When this option is empty or an entry "spell" is present, and spell
2639	checking is enabled, words in the word lists for the currently active
2640	'spelllang' are used. See |spell|.
2641
2642	To include a comma in a file name precede it with a backslash.  Spaces
2643	after a comma are ignored, otherwise spaces are included in the file
2644	name.  See |option-backslash| about using backslashes.
2645	This has nothing to do with the |Dictionary| variable type.
2646	Where to find a list of words?
2647	- On FreeBSD, there is the file "/usr/share/dict/words".
2648	- In the Simtel archive, look in the "msdos/linguist" directory.
2649	- In "miscfiles" of the GNU collection.
2650	The use of |:set+=| and |:set-=| is preferred when adding or removing
2651	directories from the list.  This avoids problems when a future version
2652	uses another default.
2653	Backticks cannot be used in this option for security reasons.
2654
2655							*'diff'* *'nodiff'*
2656'diff'			boolean	(default off)
2657			local to window
2658			{not available when compiled without the |+diff|
2659			feature}
2660	Join the current window in the group of windows that shows differences
2661	between files.  See |vimdiff|.
2662
2663						*'dex'* *'diffexpr'*
2664'diffexpr' 'dex'	string	(default "")
2665			global
2666			{not available when compiled without the |+diff|
2667			feature}
2668	Expression which is evaluated to obtain a diff file (either ed-style
2669	or unified-style) from two versions of a file.  See |diff-diffexpr|.
2670	This option cannot be set from a |modeline| or in the |sandbox|, for
2671	security reasons.
2672
2673						*'dip'* *'diffopt'*
2674'diffopt' 'dip'		string	(default "internal,filler,closeoff")
2675			global
2676			{not available when compiled without the |+diff|
2677			feature}
2678	Option settings for diff mode.  It can consist of the following items.
2679	All are optional.  Items must be separated by a comma.
2680
2681		filler		Show filler lines, to keep the text
2682				synchronized with a window that has inserted
2683				lines at the same position.  Mostly useful
2684				when windows are side-by-side and 'scrollbind'
2685				is set.
2686
2687		context:{n}	Use a context of {n} lines between a change
2688				and a fold that contains unchanged lines.
2689				When omitted a context of six lines is used.
2690				When using zero the context is actually one,
2691				since folds require a line in between, also
2692				for a deleted line.
2693				See |fold-diff|.
2694
2695		iblank		Ignore changes where lines are all blank.  Adds
2696				the "-B" flag to the "diff" command if
2697				'diffexpr' is empty.  Check the documentation
2698				of the "diff" command for what this does
2699				exactly.
2700				NOTE: the diff windows will get out of sync,
2701				because no differences between blank lines are
2702				taken into account.
2703
2704		icase		Ignore changes in case of text.  "a" and "A"
2705				are considered the same.  Adds the "-i" flag
2706				to the "diff" command if 'diffexpr' is empty.
2707
2708		iwhite		Ignore changes in amount of white space.  Adds
2709				the "-b" flag to the "diff" command if
2710				'diffexpr' is empty.  Check the documentation
2711				of the "diff" command for what this does
2712				exactly.  It should ignore adding trailing
2713				white space, but not leading white space.
2714
2715		iwhiteall	Ignore all white space changes.  Adds
2716				the "-w" flag to the "diff" command if
2717				'diffexpr' is empty.  Check the documentation
2718				of the "diff" command for what this does
2719				exactly.
2720
2721		iwhiteeol	Ignore white space changes at end of line.
2722				Adds the "-Z" flag to the "diff" command if
2723				'diffexpr' is empty.  Check the documentation
2724				of the "diff" command for what this does
2725				exactly.
2726
2727		horizontal	Start diff mode with horizontal splits (unless
2728				explicitly specified otherwise).
2729
2730		vertical	Start diff mode with vertical splits (unless
2731				explicitly specified otherwise).
2732
2733		closeoff	When a window is closed where 'diff' is set
2734				and there is only one window remaining in the
2735				same tab page with 'diff' set, execute
2736				`:diffoff` in that window.  This undoes a
2737				`:diffsplit` command.
2738
2739		hiddenoff	Do not use diff mode for a buffer when it
2740				becomes hidden.
2741
2742		foldcolumn:{n}	Set the 'foldcolumn' option to {n} when
2743				starting diff mode.  Without this 2 is used.
2744
2745		followwrap	Follow the 'wrap' option and leave as it is.
2746
2747		internal	Use the internal diff library.  This is
2748				ignored when 'diffexpr' is set.  *E960*
2749				When running out of memory when writing a
2750				buffer this item will be ignored for diffs
2751				involving that buffer.  Set the 'verbose'
2752				option to see when this happens.
2753
2754		indent-heuristic
2755				Use the indent heuristic for the internal
2756				diff library.
2757
2758                algorithm:{text} Use the specified diff algorithm with the
2759				internal diff engine. Currently supported
2760				algorithms are:
2761				myers      the default algorithm
2762				minimal    spend extra time to generate the
2763					   smallest possible diff
2764				patience   patience diff algorithm
2765				histogram  histogram diff algorithm
2766
2767	Examples: >
2768		:set diffopt=internal,filler,context:4
2769		:set diffopt=
2770		:set diffopt=internal,filler,foldcolumn:3
2771		:set diffopt-=internal  " do NOT use the internal diff parser
2772<
2773				     *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2774'digraph' 'dg'		boolean	(default off)
2775			global
2776			{not available when compiled without the |+digraphs|
2777			feature}
2778	Enable the entering of digraphs in Insert mode with {char1} <BS>
2779	{char2}.  See |digraphs|.
2780	NOTE: This option is reset when 'compatible' is set.
2781
2782						*'directory'* *'dir'*
2783'directory' 'dir'	string	(default for Amiga: ".,t:",
2784				 for Win32: ".,$TEMP,c:\tmp,c:\temp"
2785				 for Unix: ".,~/tmp,/var/tmp,/tmp")
2786			global
2787	List of directory names for the swap file, separated with commas.
2788	Recommended value:  ".,~/vimswap//" - this will put the swap file next
2789	to the edited file if possible, and in your personal swap directory
2790	otherwise.  Make sure "~/vimswap//" is only readable for you.
2791
2792	Possible items:
2793	- The swap file will be created in the first directory where this is
2794	  possible.
2795	- Empty means that no swap file will be used (recovery is
2796	  impossible!) and no |E303| error will be given.
2797	- A directory "." means to put the swap file in the same directory as
2798	  the edited file.  On Unix, a dot is prepended to the file name, so
2799	  it doesn't show in a directory listing.  On MS-Windows the "hidden"
2800	  attribute is set and a dot prepended if possible.
2801	- A directory starting with "./" (or ".\" for MS-Windows) means to put
2802	  the swap file relative to where the edited file is.  The leading "."
2803	  is replaced with the path name of the edited file.
2804	- For Unix and Win32, if a directory ends in two path separators "//",
2805	  the swap file name will be built from the complete path to the file
2806	  with all path separators replaced by percent '%' signs (including
2807	  the colon following the drive letter on Win32). This will ensure
2808	  file name uniqueness in the preserve directory.
2809	  On Win32, it is also possible to end with "\\".  However, When a
2810	  separating comma is following, you must use "//", since "\\" will
2811	  include the comma in the file name. Therefore it is recommended to
2812	  use '//', instead of '\\'.
2813	- Spaces after the comma are ignored, other spaces are considered part
2814	  of the directory name.  To have a space at the start of a directory
2815	  name, precede it with a backslash.
2816	- To include a comma in a directory name precede it with a backslash.
2817	- A directory name may end in an ':' or '/'.
2818	- Environment variables are expanded |:set_env|.
2819	- Careful with '\' characters, type one before a space, type two to
2820	  get one in the option (see |option-backslash|), for example: >
2821	    :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2822<	- For backwards compatibility with Vim version 3.0 a '>' at the start
2823	  of the option is removed.
2824	Using "." first in the list is recommended.  This means that editing
2825	the same file twice will result in a warning.  Using "/tmp" on Unix is
2826	discouraged: When the system crashes you lose the swap file.
2827	"/var/tmp" is often not cleared when rebooting, thus is a better
2828	choice than "/tmp".  But others on the computer may be able to see the
2829	files, and it can contain a lot of files, your swap files get lost in
2830	the crowd.  That is why a "tmp" directory in your home directory is
2831	tried first.
2832	The use of |:set+=| and |:set-=| is preferred when adding or removing
2833	directories from the list.  This avoids problems when a future version
2834	uses another default.
2835	This option cannot be set from a |modeline| or in the |sandbox|, for
2836	security reasons.
2837
2838					*'display'* *'dy'*
2839'display' 'dy'		string	(default "", set to "truncate" in
2840							       |defaults.vim|)
2841			global
2842	Change the way text is displayed.  This is comma separated list of
2843	flags:
2844	lastline	When included, as much as possible of the last line
2845			in a window will be displayed.  "@@@" is put in the
2846			last columns of the last screen line to indicate the
2847			rest of the line is not displayed.
2848	truncate	Like "lastline", but "@@@" is displayed in the first
2849			column of the last screen line.  Overrules "lastline".
2850	uhex		Show unprintable characters hexadecimal as <xx>
2851			instead of using ^C and ~C.
2852
2853	When neither "lastline" nor "truncate" is included, a last line that
2854	doesn't fit is replaced with "@" lines.
2855
2856						*'eadirection'* *'ead'*
2857'eadirection' 'ead'	string	(default "both")
2858			global
2859	Tells when the 'equalalways' option applies:
2860		ver	vertically, width of windows is not affected
2861		hor	horizontally, height of windows is not affected
2862		both	width and height of windows is affected
2863
2864			   *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2865'edcompatible' 'ed'	boolean	(default off)
2866			global
2867	Makes the 'g' and 'c' flags of the ":substitute" command to be
2868	toggled each time the flag is given.  See |complex-change|.  See
2869	also 'gdefault' option.
2870	Switching this option on may break plugins!
2871	This option is not used in |Vim9| script.
2872
2873					*'emoji'* *'emo'* *'noemoji'* *'noemo'*
2874'emoji' 'emo'	boolean (default: on)
2875			global
2876	When on all Unicode emoji characters are considered to be full width.
2877	This excludes "text emoji" characters, which are normally displayed as
2878	single width.  Unfortunately there is no good specification for this
2879	and it has been determined on trial-and-error basis.  Use the
2880	|setcellwidths()| function to change the behavior.
2881
2882					*'encoding'* *'enc'* *E543*
2883'encoding' 'enc'	string (default for MS-Windows: "utf-8",
2884				otherwise: value from $LANG or "latin1")
2885			global
2886	Sets the character encoding used inside Vim.  It applies to text in
2887	the buffers, registers, Strings in expressions, text stored in the
2888	viminfo file, etc.  It sets the kind of characters which Vim can work
2889	with.  See |encoding-names| for the possible values.
2890
2891	NOTE: Changing this option will not change the encoding of the
2892	existing text in Vim.  It may cause non-ASCII text to become invalid.
2893	It should normally be kept at its default value, or set when Vim
2894	starts up.  See |multibyte|.  To reload the menus see |:menutrans|.
2895
2896	This option cannot be set from a |modeline|.  It would most likely
2897	corrupt the text.
2898
2899	NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2900	to "utf-8".  Although care has been taken to allow different values of
2901	'encoding', "utf-8" is the natural choice for the environment and
2902	avoids unnecessary conversion overhead.  "utf-8" has not been made
2903	the default to prevent different behavior of the GUI and terminal
2904	versions, and to avoid changing the encoding of newly created files
2905	without your knowledge (in case 'fileencodings' is empty).
2906
2907	The character encoding of files can be different from 'encoding'.
2908	This is specified with 'fileencoding'.  The conversion is done with
2909	iconv() or as specified with 'charconvert'.
2910
2911	If you need to know whether 'encoding' is a multibyte encoding, you
2912	can use: >
2913		if has("multi_byte_encoding")
2914<
2915	Normally 'encoding' will be equal to your current locale.  This will
2916	be the default if Vim recognizes your environment settings.  If
2917	'encoding' is not set to the current locale, 'termencoding' must be
2918	set to convert typed and displayed text.  See |encoding-table|.
2919
2920	When you set this option, it fires the |EncodingChanged| autocommand
2921	event so that you can set up fonts if necessary.
2922
2923	When the option is set, the value is converted to lowercase.  Thus
2924	you can set it with uppercase values too.  Underscores are translated
2925	to '-' signs.
2926	When the encoding is recognized, it is changed to the standard name.
2927	For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2928	"iso-8859-2" and "utf8" becomes "utf-8".
2929
2930	Note: "latin1" is also used when the encoding could not be detected.
2931	This only works when editing files in the same encoding!  When the
2932	actual character set is not latin1, make sure 'fileencoding' and
2933	'fileencodings' are empty.  When conversion is needed, switch to using
2934	utf-8.
2935
2936	When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2937	You don't notice this while editing, but it does matter for the
2938	|viminfo-file|.  And Vim expects the terminal to use utf-8 too.  Thus
2939	setting 'encoding' to one of these values instead of utf-8 only has
2940	effect for encoding used for files when 'fileencoding' is empty.
2941
2942	When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2943	not set yet, the default for 'fileencodings' is changed.
2944
2945			*'endofline'* *'eol'* *'noendofline'* *'noeol'*
2946'endofline' 'eol'	boolean	(default on)
2947			local to buffer
2948	When writing a file and this option is off and the 'binary' option
2949	is on, or 'fixeol' option is off, no <EOL> will be written for the
2950	last line in the file.  This option is automatically set or reset when
2951	starting to edit a new file, depending on whether file has an <EOL>
2952	for the last line in the file.  Normally you don't have to set or
2953	reset this option.
2954	When 'binary' is off and 'fixeol' is on the value is not used when
2955	writing the file.  When 'binary' is on or 'fixeol' is off it is used
2956	to remember the presence of a <EOL> for the last line in the file, so
2957	that when you write the file the situation from the original file can
2958	be kept.  But you can change it if you want to.
2959
2960			     *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2961'equalalways' 'ea'	boolean	(default on)
2962			global
2963	When on, all the windows are automatically made the same size after
2964	splitting or closing a window.  This also happens the moment the
2965	option is switched on.  When off, splitting a window will reduce the
2966	size of the current window and leave the other windows the same.  When
2967	closing a window the extra lines are given to the window next to it
2968	(depending on 'splitbelow' and 'splitright').
2969	When mixing vertically and horizontally split windows, a minimal size
2970	is computed and some windows may be larger if there is room.  The
2971	'eadirection' option tells in which direction the size is affected.
2972	Changing the height and width of a window can be avoided by setting
2973	'winfixheight' and 'winfixwidth', respectively.
2974	If a window size is specified when creating a new window sizes are
2975	currently not equalized (it's complicated, but may be implemented in
2976	the future).
2977
2978						*'equalprg'* *'ep'*
2979'equalprg' 'ep'		string	(default "")
2980			global or local to buffer |global-local|
2981	External program to use for "=" command.  When this option is empty
2982	the internal formatting functions are used; either 'lisp', 'cindent'
2983	or 'indentexpr'.  When Vim was compiled without internal formatting,
2984	the "indent" program is used.
2985	Environment variables are expanded |:set_env|.  See |option-backslash|
2986	about including spaces and backslashes.
2987	This option cannot be set from a |modeline| or in the |sandbox|, for
2988	security reasons.
2989
2990			*'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2991'errorbells' 'eb'	boolean	(default off)
2992			global
2993	Ring the bell (beep or screen flash) for error messages.  This only
2994	makes a difference for error messages, the bell will be used always
2995	for a lot of errors without a message (e.g., hitting <Esc> in Normal
2996	mode).  See 'visualbell' on how to make the bell behave like a beep,
2997	screen flash or do nothing. See 'belloff' to finetune when to ring the
2998	bell.
2999
3000						*'errorfile'* *'ef'*
3001'errorfile' 'ef'	string	(Amiga default: "AztecC.Err",
3002					others: "errors.err")
3003			global
3004			{not available when compiled without the |+quickfix|
3005			feature}
3006	Name of the errorfile for the QuickFix mode (see |:cf|).
3007	When the "-q" command-line argument is used, 'errorfile' is set to the
3008	following argument.  See |-q|.
3009	NOT used for the ":make" command.  See 'makeef' for that.
3010	Environment variables are expanded |:set_env|.
3011	See |option-backslash| about including spaces and backslashes.
3012	This option cannot be set from a |modeline| or in the |sandbox|, for
3013	security reasons.
3014
3015						*'errorformat'* *'efm'*
3016'errorformat' 'efm'	string	(default is very long)
3017			global or local to buffer |global-local|
3018			{not available when compiled without the |+quickfix|
3019			feature}
3020	Scanf-like description of the format for the lines in the error file
3021	(see |errorformat|).
3022
3023				     *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
3024'esckeys' 'ek'		boolean	(Vim default: on, Vi default: off)
3025			global
3026	Function keys that start with an <Esc> are recognized in Insert
3027	mode.  When this option is off, the cursor and function keys cannot be
3028	used in Insert mode if they start with an <Esc>.  The advantage of
3029	this is that the single <Esc> is recognized immediately, instead of
3030	after one second.  Instead of resetting this option, you might want to
3031	try changing the values for 'timeoutlen' and 'ttimeoutlen'.  Note that
3032	when 'esckeys' is off, you can still map anything, but the cursor keys
3033	won't work by default.
3034	NOTE: This option is set to the Vi default value when 'compatible' is
3035	set and to the Vim default value when 'compatible' is reset.
3036	NOTE: when this option is off then the |modifyOtherKeys| functionality
3037	is disabled while in Insert mode to avoid ending Insert mode with any
3038	key that has a modifier.
3039
3040						*'eventignore'* *'ei'*
3041'eventignore' 'ei'	string	(default "")
3042			global
3043	A list of autocommand event names, which are to be ignored.
3044	When set to "all" or when "all" is one of the items, all autocommand
3045	events are ignored, autocommands will not be executed.
3046	Otherwise this is a comma separated list of event names.  Example: >
3047	    :set ei=WinEnter,WinLeave
3048<
3049				 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
3050'expandtab' 'et'	boolean	(default off)
3051			local to buffer
3052	In Insert mode: Use the appropriate number of spaces to insert a
3053	<Tab>.  Spaces are used in indents with the '>' and '<' commands and
3054	when 'autoindent' is on.  To insert a real tab when 'expandtab' is
3055	on, use CTRL-V<Tab>.  See also |:retab| and |ins-expandtab|.
3056	This option is reset when the 'paste' option is set and restored when
3057	the 'paste' option is reset.
3058	NOTE: This option is reset when 'compatible' is set.
3059
3060					*'exrc'* *'ex'* *'noexrc'* *'noex'*
3061'exrc' 'ex'		boolean (default off)
3062			global
3063	Enables the reading of .vimrc, .exrc and .gvimrc in the current
3064	directory.
3065
3066	Setting this option is a potential security leak.  E.g., consider
3067	unpacking a package or fetching files from github, a .vimrc in there
3068	might be a trojan horse.  BETTER NOT SET THIS OPTION!
3069	Instead, define an autocommand in your .vimrc to set options for a
3070	matching directory.
3071
3072	If you do switch this option on you should also consider setting the
3073	'secure' option (see |initialization|).
3074	Also see |.vimrc| and |gui-init|.
3075	This option cannot be set from a |modeline| or in the |sandbox|, for
3076	security reasons.
3077
3078				*'fileencoding'* *'fenc'* *E213*
3079'fileencoding' 'fenc'	string (default: "")
3080			local to buffer
3081	Sets the character encoding for the file of this buffer.
3082
3083	When 'fileencoding' is different from 'encoding', conversion will be
3084	done when writing the file.  For reading see below.
3085	When 'fileencoding' is empty, the same value as 'encoding' will be
3086	used (no conversion when reading or writing a file).
3087	No error will be given when the value is set, only when it is used,
3088	only when writing a file.
3089	Conversion will also be done when 'encoding' and 'fileencoding' are
3090	both a Unicode encoding and 'fileencoding' is not utf-8.  That's
3091	because internally Unicode is always stored as utf-8.
3092		WARNING: Conversion can cause loss of information!  When
3093		'encoding' is "utf-8" or another Unicode encoding, conversion
3094		is most likely done in a way that the reverse conversion
3095		results in the same text.  When 'encoding' is not "utf-8" some
3096		characters may be lost!
3097
3098	See 'encoding' for the possible values.  Additionally, values may be
3099	specified that can be handled by the converter, see
3100	|mbyte-conversion|.
3101
3102	When reading a file 'fileencoding' will be set from 'fileencodings'.
3103	To read a file in a certain encoding it won't work by setting
3104	'fileencoding', use the |++enc| argument.  One exception: when
3105	'fileencodings' is empty the value of 'fileencoding' is used.
3106	For a new file the global value of 'fileencoding' is used.
3107
3108	Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3109	When the option is set, the value is converted to lowercase.  Thus
3110	you can set it with uppercase values too.  '_' characters are
3111	replaced with '-'.  If a name is recognized from the list for
3112	'encoding', it is replaced by the standard name.  For example
3113	"ISO8859-2" becomes "iso-8859-2".
3114
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
3118	Keep in mind that changing 'fenc' from a modeline happens
3119	AFTER the text has been read, thus it applies to when the file will be
3120	written.  If you do set 'fenc' in a modeline, you might want to set
3121	'nomodified' to avoid not being able to ":q".
3122
3123	This option can not be changed when 'modifiable' is off.
3124
3125							*'fe'*
3126	NOTE: Before version 6.0 this option specified the encoding for the
3127	whole of Vim, this was a mistake.  Now use 'encoding' instead.  The
3128	old short name was 'fe', which is no longer used.
3129
3130					*'fileencodings'* *'fencs'*
3131'fileencodings' 'fencs'	string (default: "ucs-bom",
3132				    "ucs-bom,utf-8,default,latin1" when
3133				    'encoding' is set to a Unicode value)
3134			global
3135	This is a list of character encodings considered when starting to edit
3136	an existing file.  When a file is read, Vim tries to use the first
3137	mentioned character encoding.  If an error is detected, the next one
3138	in the list is tried.  When an encoding is found that works,
3139	'fileencoding' is set to it.  If all fail, 'fileencoding' is set to
3140	an empty string, which means the value of 'encoding' is used.
3141		WARNING: Conversion can cause loss of information!  When
3142		'encoding' is "utf-8" (or one of the other Unicode variants)
3143		conversion is most likely done in a way that the reverse
3144		conversion results in the same text.  When 'encoding' is not
3145		"utf-8" some non-ASCII characters may be lost!  You can use
3146		the |++bad| argument to specify what is done with characters
3147		that can't be converted.
3148	For an empty file or a file with only ASCII characters most encodings
3149	will work and the first entry of 'fileencodings' will be used (except
3150	"ucs-bom", which requires the BOM to be present).  If you prefer
3151	another encoding use an BufReadPost autocommand event to test if your
3152	preferred encoding is to be used.  Example: >
3153		au BufReadPost * if search('\S', 'w') == 0 |
3154			\ set fenc=iso-2022-jp | endif
3155<	This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3156	non-blank characters.
3157	When the |++enc| argument is used then the value of 'fileencodings' is
3158	not used.
3159	Note that 'fileencodings' is not used for a new file, the global value
3160	of 'fileencoding' is used instead.  You can set it with: >
3161		:setglobal fenc=iso-8859-2
3162<	This means that a non-existing file may get a different encoding than
3163	an empty file.
3164	The special value "ucs-bom" can be used to check for a Unicode BOM
3165	(Byte Order Mark) at the start of the file.  It must not be preceded
3166	by "utf-8" or another Unicode encoding for this to work properly.
3167	An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3168	because Vim cannot detect an error, thus the encoding is always
3169	accepted.
3170	The special value "default" can be used for the encoding from the
3171	environment.  On MS-Windows this is the system encoding.  Otherwise
3172	this is the default value for 'encoding'.  It is useful when
3173	'encoding' is set to "utf-8" and your environment uses a non-latin1
3174	encoding, such as Russian.
3175	When 'encoding' is "utf-8" and a file contains an illegal byte
3176	sequence it won't be recognized as UTF-8.  You can use the |8g8|
3177	command to find the illegal byte sequence.
3178	WRONG VALUES:			WHAT'S WRONG:
3179		latin1,utf-8		"latin1" will always be used
3180		utf-8,ucs-bom,latin1	BOM won't be recognized in an utf-8
3181					file
3182		cp1250,latin1		"cp1250" will always be used
3183	If 'fileencodings' is empty, 'fileencoding' is not modified.
3184	See 'fileencoding' for the possible values.
3185	Setting this option does not have an effect until the next time a file
3186	is read.
3187
3188					*'fileformat'* *'ff'*
3189'fileformat' 'ff'	string (MS-Windows default: "dos",
3190				Unix, macOS default: "unix")
3191			local to buffer
3192	This gives the <EOL> of the current buffer, which is used for
3193	reading/writing the buffer from/to a file:
3194	    dos	    <CR><NL>
3195	    unix    <NL>
3196	    mac	    <CR>
3197	When "dos" is used, CTRL-Z at the end of a file is ignored.
3198	See |file-formats| and |file-read|.
3199	For the character encoding of the file see 'fileencoding'.
3200	When 'binary' is set, the value of 'fileformat' is ignored, file I/O
3201	works like it was set to "unix".
3202	This option is set automatically when starting to edit a file and
3203	'fileformats' is not empty and 'binary' is off.
3204	When this option is set, after starting to edit a file, the 'modified'
3205	option is set, because the file would be different when written.
3206	This option can not be changed when 'modifiable' is off.
3207	For backwards compatibility: When this option is set to "dos",
3208	'textmode' is set, otherwise 'textmode' is reset.
3209
3210					*'fileformats'* *'ffs'*
3211'fileformats' 'ffs'	string (default:
3212				Vim+Vi	MS-Windows: "dos,unix",
3213				Vim	Unix, macOS: "unix,dos",
3214				Vi	Cygwin: "unix,dos",
3215				Vi	others: "")
3216			global
3217	This gives the end-of-line (<EOL>) formats that will be tried when
3218	starting to edit a new buffer and when reading a file into an existing
3219	buffer:
3220	- When empty, the format defined with 'fileformat' will be used
3221	  always.  It is not set automatically.
3222	- When set to one name, that format will be used whenever a new buffer
3223	  is opened.  'fileformat' is set accordingly for that buffer.  The
3224	  'fileformats' name will be used when a file is read into an existing
3225	  buffer, no matter what 'fileformat' for that buffer is set to.
3226	- When more than one name is present, separated by commas, automatic
3227	  <EOL> detection will be done when reading a file.  When starting to
3228	  edit a file, a check is done for the <EOL>:
3229	  1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3230	     'fileformat' is set to "dos".
3231	  2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
3232	     is set to "unix".  Note that when a <NL> is found without a
3233	     preceding <CR>, "unix" is preferred over "dos".
3234	  3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3235	     if 'fileformats' includes "mac", 'fileformat' is set to "mac".
3236	     This means that "mac" is only chosen when:
3237	      "unix" is not present or no <NL> is found in the file, and
3238	      "dos" is not present or no <CR><NL> is found in the file.
3239	     Except: if "unix" was chosen, but there is a <CR> before
3240	     the first <NL>, and there appear to be more <CR>s than <NL>s in
3241	     the first few lines, "mac" is used.
3242	  4. If 'fileformat' is still not set, the first name from
3243	     'fileformats' is used.
3244	  When reading a file into an existing buffer, the same is done, but
3245	  this happens like 'fileformat' has been set appropriately for that
3246	  file only, the option is not changed.
3247	When 'binary' is set, the value of 'fileformats' is not used.
3248
3249	When Vim starts up with an empty buffer the first item is used.  You
3250	can overrule this by setting 'fileformat' in your .vimrc.
3251
3252	For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3253	are ":source"ed and for vimrc files, automatic <EOL> detection may be
3254	done:
3255	- When 'fileformats' is empty, there is no automatic detection.  Dos
3256	  format will be used.
3257	- When 'fileformats' is set to one or more names, automatic detection
3258	  is done.  This is based on the first <NL> in the file: If there is a
3259	  <CR> in front of it, Dos format is used, otherwise Unix format is
3260	  used.
3261	Also see |file-formats|.
3262	For backwards compatibility: When this option is set to an empty
3263	string or one format (no comma is included), 'textauto' is reset,
3264	otherwise 'textauto' is set.
3265	NOTE: This option is set to the Vi default value when 'compatible' is
3266	set and to the Vim default value when 'compatible' is reset.
3267
3268		*'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3269'fileignorecase' 'fic'	boolean	(default on for systems where case in file
3270				 names is normally ignored)
3271			global
3272	When set case is ignored when using file names and directories.
3273	See 'wildignorecase' for only ignoring case when doing completion.
3274
3275					*'filetype'* *'ft'*
3276'filetype' 'ft'		string (default: "")
3277			local to buffer
3278	When this option is set, the FileType autocommand event is triggered.
3279	All autocommands that match with the value of this option will be
3280	executed.  Thus the value of 'filetype' is used in place of the file
3281	name.
3282	Otherwise this option does not always reflect the current file type.
3283	This option is normally set when the file type is detected.  To enable
3284	this use the ":filetype on" command. |:filetype|
3285	Setting this option to a different value is most useful in a modeline,
3286	for a file for which the file type is not automatically recognized.
3287	Example, for in an IDL file:
3288		/* vim: set filetype=idl : */ ~
3289	|FileType| |filetypes|
3290	When a dot appears in the value then this separates two filetype
3291	names.  Example:
3292		/* vim: set filetype=c.doxygen : */ ~
3293	This will use the "c" filetype first, then the "doxygen" filetype.
3294	This works both for filetype plugins and for syntax files.  More than
3295	one dot may appear.
3296	This option is not copied to another buffer, independent of the 's' or
3297	'S' flag in 'cpoptions'.
3298	Only normal file name characters can be used, "/\*?[|<>" are illegal.
3299
3300						*'fillchars'* *'fcs'*
3301'fillchars' 'fcs'	string	(default "vert:|,fold:-,eob:~")
3302			global
3303			{not available when compiled without the |+folding|
3304			feature}
3305	Characters to fill the statuslines and vertical separators.
3306	It is a comma separated list of items:
3307
3308	  item		default		Used for ~
3309	  stl:c		' ' or '^'	statusline of the current window
3310	  stlnc:c	' ' or '='	statusline of the non-current windows
3311	  vert:c	'|'		vertical separators |:vsplit|
3312	  fold:c	'-'		filling 'foldtext'
3313	  foldopen:c	'-'		mark the beginning of a fold
3314	  foldclose:c	'+'		show a closed fold
3315	  foldsep:c	'|'		open fold middle character
3316	  diff:c	'-'		deleted lines of the 'diff' option
3317	  eob:c		'~'		empty lines below the end of a buffer
3318
3319	Any one that is omitted will fall back to the default.  For "stl" and
3320	"stlnc" the space will be used when there is highlighting, '^' or '='
3321	otherwise.
3322
3323	Example: >
3324	    :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
3325<	This is similar to the default, except that these characters will also
3326	be used when there is highlighting.
3327
3328	For "stl" and "stlnc" single-byte and multibyte characters are
3329	supported.  But double-width characters are not supported.
3330
3331	The highlighting used for these items:
3332	  item		highlight group ~
3333	  stl:c		StatusLine		|hl-StatusLine|
3334	  stlnc:c	StatusLineNC		|hl-StatusLineNC|
3335	  vert:c	VertSplit		|hl-VertSplit|
3336	  fold:c	Folded			|hl-Folded|
3337	  diff:c	DiffDelete		|hl-DiffDelete|
3338	  eob:c		EndOfBuffer		|hl-EndOfBuffer|
3339
3340		*'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3341'fixendofline' 'fixeol'	boolean	(default on)
3342			local to buffer
3343	When writing a file and this option is on, <EOL> at the end of file
3344	will be restored if missing. Turn this option off if you want to
3345	preserve the situation from the original file.
3346	When the 'binary' option is set the value of this option doesn't
3347	matter.
3348	See the 'endofline' option.
3349
3350					*'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3351'fkmap' 'fk'		boolean (default off)
3352			global
3353			{only available when compiled with the |+rightleft|
3354			feature}
3355	This option was for using Farsi, which has been removed.  See
3356	|farsi.txt|.
3357
3358						*'foldclose'* *'fcl'*
3359'foldclose' 'fcl'	string (default "")
3360			global
3361			{not available when compiled without the |+folding|
3362			feature}
3363	When set to "all", a fold is closed when the cursor isn't in it and
3364	its level is higher than 'foldlevel'.  Useful if you want folds to
3365	automatically close when moving out of them.
3366
3367						*'foldcolumn'* *'fdc'*
3368'foldcolumn' 'fdc'	number (default 0)
3369			local to window
3370			{not available when compiled without the |+folding|
3371			feature}
3372	When non-zero, a column with the specified width is shown at the side
3373	of the window which indicates open and closed folds.  The maximum
3374	value is 12.
3375	See |folding|.
3376
3377			*'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3378'foldenable' 'fen'	boolean (default on)
3379			local to window
3380			{not available when compiled without the |+folding|
3381			feature}
3382	When off, all folds are open.  This option can be used to quickly
3383	switch between showing all text unfolded and viewing the text with
3384	folds (including manually opened or closed folds).  It can be toggled
3385	with the |zi| command.  The 'foldcolumn' will remain blank when
3386	'foldenable' is off.
3387	This option is set by commands that create a new fold or close a fold.
3388	See |folding|.
3389
3390						*'foldexpr'* *'fde'*
3391'foldexpr' 'fde'	string (default: "0")
3392			local to window
3393			{not available when compiled without the |+folding|
3394			or |+eval| features}
3395	The expression used for when 'foldmethod' is "expr".  It is evaluated
3396	for each line to obtain its fold level.  See |fold-expr|.
3397
3398	The expression will be evaluated in the |sandbox| if set from a
3399	modeline, see |sandbox-option|.
3400	This option can't be set from a |modeline| when the 'diff' option is
3401	on or the 'modelineexpr' option is off.
3402
3403	It is not allowed to change text or jump to another window while
3404	evaluating 'foldexpr' |textlock|.
3405
3406						*'foldignore'* *'fdi'*
3407'foldignore' 'fdi'	string (default: "#")
3408			local to window
3409			{not available when compiled without the |+folding|
3410			feature}
3411	Used only when 'foldmethod' is "indent".  Lines starting with
3412	characters in 'foldignore' will get their fold level from surrounding
3413	lines.  White space is skipped before checking for this character.
3414	The default "#" works well for C programs.  See |fold-indent|.
3415
3416						*'foldlevel'* *'fdl'*
3417'foldlevel' 'fdl'	number (default: 0)
3418			local to window
3419			{not available when compiled without the |+folding|
3420			feature}
3421	Sets the fold level: Folds with a higher level will be closed.
3422	Setting this option to zero will close all folds.  Higher numbers will
3423	close fewer folds.
3424	This option is set by commands like |zm|, |zM| and |zR|.
3425	See |fold-foldlevel|.
3426
3427						*'foldlevelstart'* *'fdls'*
3428'foldlevelstart' 'fdls'	number (default: -1)
3429			global
3430			{not available when compiled without the |+folding|
3431			feature}
3432	Sets 'foldlevel' when starting to edit another buffer in a window.
3433	Useful to always start editing with all folds closed (value zero),
3434	some folds closed (one) or no folds closed (99).
3435	This is done before reading any modeline, thus a setting in a modeline
3436	overrules this option.  Starting to edit a file for |diff-mode| also
3437	ignores this option and closes all folds.
3438	It is also done before BufReadPre autocommands, to allow an autocmd to
3439	overrule the 'foldlevel' value for specific files.
3440	When the value is negative, it is not used.
3441
3442						*'foldmarker'* *'fmr'* *E536*
3443'foldmarker' 'fmr'	string (default: "{{{,}}}")
3444			local to window
3445			{not available when compiled without the |+folding|
3446			feature}
3447	The start and end marker used when 'foldmethod' is "marker".  There
3448	must be one comma, which separates the start and end marker.  The
3449	marker is a literal string (a regular expression would be too slow).
3450	See |fold-marker|.
3451
3452						*'foldmethod'* *'fdm'*
3453'foldmethod' 'fdm'	string (default: "manual")
3454			local to window
3455			{not available when compiled without the |+folding|
3456			feature}
3457	The kind of folding used for the current window.  Possible values:
3458	|fold-manual|	manual	    Folds are created manually.
3459	|fold-indent|	indent	    Lines with equal indent form a fold.
3460	|fold-expr|	expr	    'foldexpr' gives the fold level of a line.
3461	|fold-marker|	marker	    Markers are used to specify folds.
3462	|fold-syntax|	syntax	    Syntax highlighting items specify folds.
3463	|fold-diff|	diff	    Fold text that is not changed.
3464
3465						*'foldminlines'* *'fml'*
3466'foldminlines' 'fml'	number (default: 1)
3467			local to window
3468			{not available when compiled without the |+folding|
3469			feature}
3470	Sets the number of screen lines above which a fold can be displayed
3471	closed.  Also for manually closed folds.  With the default value of
3472	one a fold can only be closed if it takes up two or more screen lines.
3473	Set to zero to be able to close folds of just one screen line.
3474	Note that this only has an effect on what is displayed.  After using
3475	"zc" to close a fold, which is displayed open because it's smaller
3476	than 'foldminlines', a following "zc" may close a containing fold.
3477
3478						*'foldnestmax'* *'fdn'*
3479'foldnestmax' 'fdn'	number (default: 20)
3480			local to window
3481			{not available when compiled without the |+folding|
3482			feature}
3483	Sets the maximum nesting of folds for the "indent" and "syntax"
3484	methods.  This avoids that too many folds will be created.  Using more
3485	than 20 doesn't work, because the internal limit is 20.
3486
3487						*'foldopen'* *'fdo'*
3488'foldopen' 'fdo'	string (default: "block,hor,mark,percent,quickfix,
3489							     search,tag,undo")
3490			global
3491			{not available when compiled without the |+folding|
3492			feature}
3493	Specifies for which type of commands folds will be opened, if the
3494	command moves the cursor into a closed fold.  It is a comma separated
3495	list of items.
3496	NOTE: When the command is part of a mapping this option is not used.
3497	Add the |zv| command to the mapping to get the same effect.
3498	(rationale: the mapping may want to control opening folds itself)
3499
3500		item		commands ~
3501		all		any
3502		block		"(", "{", "[[", "[{", etc.
3503		hor		horizontal movements: "l", "w", "fx", etc.
3504		insert		any command in Insert mode
3505		jump		far jumps: "G", "gg", etc.
3506		mark		jumping to a mark: "'m", CTRL-O, etc.
3507		percent		"%"
3508		quickfix	":cn", ":crew", ":make", etc.
3509		search		search for a pattern: "/", "n", "*", "gd", etc.
3510				(not for a search pattern in a ":" command)
3511				Also for |[s| and |]s|.
3512		tag		jumping to a tag: ":ta", CTRL-T, etc.
3513		undo		undo or redo: "u" and CTRL-R
3514	When a movement command is used for an operator (e.g., "dl" or "y%")
3515	this option is not used.  This means the operator will include the
3516	whole closed fold.
3517	Note that vertical movements are not here, because it would make it
3518	very difficult to move onto a closed fold.
3519	In insert mode the folds containing the cursor will always be open
3520	when text is inserted.
3521	To close folds you can re-apply 'foldlevel' with the |zx| command or
3522	set the 'foldclose' option to "all".
3523
3524						*'foldtext'* *'fdt'*
3525'foldtext' 'fdt'	string (default: "foldtext()")
3526			local to window
3527			{not available when compiled without the |+folding|
3528			feature}
3529	An expression which is used to specify the text displayed for a closed
3530	fold.  See |fold-foldtext|.
3531
3532	The expression will be evaluated in the |sandbox| if set from a
3533	modeline, see |sandbox-option|.
3534	This option cannot be set in a modeline when 'modelineexpr' is off.
3535
3536	It is not allowed to change text or jump to another window while
3537	evaluating 'foldtext' |textlock|.
3538
3539						*'formatexpr'* *'fex'*
3540'formatexpr' 'fex'	string (default "")
3541			local to buffer
3542			{not available when compiled without the |+eval|
3543			feature}
3544	Expression which is evaluated to format a range of lines for the |gq|
3545	operator or automatic formatting (see 'formatoptions').  When this
3546	option is empty 'formatprg' is used.
3547
3548	The |v:lnum|  variable holds the first line to be formatted.
3549	The |v:count| variable holds the number of lines to be formatted.
3550	The |v:char|  variable holds the character that is going to be
3551		      inserted if the expression is being evaluated due to
3552		      automatic formatting.  This can be empty.  Don't insert
3553		      it yet!
3554
3555	Example: >
3556		:set formatexpr=mylang#Format()
3557<	This will invoke the mylang#Format() function in the
3558	autoload/mylang.vim file in 'runtimepath'. |autoload|
3559
3560	The expression is also evaluated when 'textwidth' is set and adding
3561	text beyond that limit.  This happens under the same conditions as
3562	when internal formatting is used.  Make sure the cursor is kept in the
3563	same spot relative to the text then!  The |mode()| function will
3564	return "i" or "R" in this situation.
3565
3566	When the expression evaluates to non-zero Vim will fall back to using
3567	the internal format mechanism.
3568
3569	The expression will be evaluated in the |sandbox| when set from a
3570	modeline, see |sandbox-option|.  That stops the option from working,
3571	since changing the buffer text is not allowed.
3572	This option cannot be set in a modeline when 'modelineexpr' is off.
3573	NOTE: This option is set to "" when 'compatible' is set.
3574
3575					*'formatlistpat'* *'flp'*
3576'formatlistpat' 'flp'	string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3577			local to buffer
3578	A pattern that is used to recognize a list header.  This is used for
3579	the "n" flag in 'formatoptions'.
3580	The pattern must match exactly the text that will be the indent for
3581	the line below it.  You can use |/\ze| to mark the end of the match
3582	while still checking more characters.  There must be a character
3583	following the pattern, when it matches the whole line it is handled
3584	like there is no match.
3585	The default recognizes a number, followed by an optional punctuation
3586	character and white space.
3587
3588					*'formatoptions'* *'fo'*
3589'formatoptions' 'fo'	string (Vim default: "tcq", Vi default: "vt")
3590			local to buffer
3591	This is a sequence of letters which describes how automatic
3592	formatting is to be done.  See |fo-table|.  When the 'paste' option is
3593	on, no formatting is done (like 'formatoptions' is empty).  Commas can
3594	be inserted for readability.
3595	To avoid problems with flags that are added in the future, use the
3596	"+=" and "-=" feature of ":set" |add-option-flags|.
3597	NOTE: This option is set to the Vi default value when 'compatible' is
3598	set and to the Vim default value when 'compatible' is reset.
3599
3600						*'formatprg'* *'fp'*
3601'formatprg' 'fp'	string (default "")
3602			global or local to buffer |global-local|
3603	The name of an external program that will be used to format the lines
3604	selected with the |gq| operator.  The program must take the input on
3605	stdin and produce the output on stdout.  The Unix program "fmt" is
3606	such a program.
3607	If the 'formatexpr' option is not empty it will be used instead.
3608	Otherwise, if 'formatprg' option is an empty string, the internal
3609	format function will be used |C-indenting|.
3610	Environment variables are expanded |:set_env|.  See |option-backslash|
3611	about including spaces and backslashes.
3612	This option cannot be set from a |modeline| or in the |sandbox|, for
3613	security reasons.
3614
3615					*'fsync'* *'fs'* *'nofsync'* *'nofs'*
3616'fsync' 'fs'		boolean	(default on)
3617			global
3618	When on, the library function fsync() will be called after writing a
3619	file.  This will flush a file to disk, ensuring that it is safely
3620	written even on filesystems which do metadata-only journaling.  This
3621	will force the harddrive to spin up on Linux systems running in laptop
3622	mode, so it may be undesirable in some situations.  Be warned that
3623	turning this off increases the chances of data loss after a crash.  On
3624	systems without an fsync() implementation, this variable is always
3625	off.
3626	Also see 'swapsync' for controlling fsync() on swap files.
3627	'fsync' also applies to |writefile()| (unless a flag is used to
3628	overrule it) and when writing undo files (see |undo-persistence|).
3629	This option cannot be set from a |modeline| or in the |sandbox|, for
3630	security reasons.
3631
3632				   *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3633'gdefault' 'gd'		boolean	(default off)
3634			global
3635	When on, the ":substitute" flag 'g' is default on.  This means that
3636	all matches in a line are substituted instead of one.  When a 'g' flag
3637	is given to a ":substitute" command, this will toggle the substitution
3638	of all or one match.  See |complex-change|.
3639
3640		command		'gdefault' on	'gdefault' off	~
3641		:s///		  subst. all	  subst. one
3642		:s///g		  subst. one	  subst. all
3643		:s///gg		  subst. all	  subst. one
3644
3645	NOTE: This option is reset when 'compatible' is set.
3646	DEPRECATED: Setting this option may break plugins that are not aware
3647	of this option.  Also, many users get confused that adding the /g flag
3648	has the opposite effect of that it normally does.
3649	This option is not used in |Vim9| script.
3650
3651						*'grepformat'* *'gfm'*
3652'grepformat' 'gfm'	string	(default "%f:%l:%m,%f:%l%m,%f  %l%m")
3653			global
3654	Format to recognize for the ":grep" command output.
3655	This is a scanf-like string that uses the same format as the
3656	'errorformat' option: see |errorformat|.
3657
3658						*'grepprg'* *'gp'*
3659'grepprg' 'gp'		string	(default "grep -n ",
3660					Unix: "grep -n $* /dev/null",
3661					Win32: "findstr /n" or "grep -n",
3662						      VMS: "SEARCH/NUMBERS ")
3663			global or local to buffer |global-local|
3664	Program to use for the |:grep| command.  This option may contain '%'
3665	and '#' characters, which are expanded like when used in a command-
3666	line.  The placeholder "$*" is allowed to specify where the arguments
3667	will be included.  Environment variables are expanded |:set_env|.  See
3668	|option-backslash| about including spaces and backslashes.
3669	When your "grep" accepts the "-H" argument, use this to make ":grep"
3670	also work well with a single file: >
3671		:set grepprg=grep\ -nH
3672<	Special value: When 'grepprg' is set to "internal" the |:grep| command
3673	works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3674	|:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
3675	See also the section |:make_makeprg|, since most of the comments there
3676	apply equally to 'grepprg'.
3677	For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3678	otherwise it's "grep -n".
3679	This option cannot be set from a |modeline| or in the |sandbox|, for
3680	security reasons.
3681
3682			*'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3683'guicursor' 'gcr'	string	(default "n-v-c:block-Cursor/lCursor,
3684					ve:ver35-Cursor,
3685					o:hor50-Cursor,
3686					i-ci:ver25-Cursor/lCursor,
3687					r-cr:hor20-Cursor/lCursor,
3688					sm:block-Cursor
3689					-blinkwait175-blinkoff150-blinkon175",
3690				for Win32 console:
3691					"n-v-c:block,o:hor50,i-ci:hor15,
3692					r-cr:hor30,sm:block")
3693			global
3694			{only available when compiled with GUI enabled, and
3695			for Win32 console}
3696	This option tells Vim what the cursor should look like in different
3697	modes.  It fully works in the GUI.  In a Win32 console, only the
3698	height of the cursor can be changed.  This can be done by specifying a
3699	block cursor, or a percentage for a vertical or horizontal cursor.
3700	For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3701	used.
3702
3703	The option is a comma separated list of parts.  Each part consist of a
3704	mode-list and an argument-list:
3705		mode-list:argument-list,mode-list:argument-list,..
3706	The mode-list is a dash separated list of these modes:
3707		n	Normal mode
3708		v	Visual mode
3709		ve	Visual mode with 'selection' "exclusive" (same as 'v',
3710			if not specified)
3711		o	Operator-pending mode
3712		i	Insert mode
3713		r	Replace mode
3714		c	Command-line Normal (append) mode
3715		ci	Command-line Insert mode
3716		cr	Command-line Replace mode
3717		sm	showmatch in Insert mode
3718		a	all modes
3719	The argument-list is a dash separated list of these arguments:
3720		hor{N}	horizontal bar, {N} percent of the character height
3721		ver{N}	vertical bar, {N} percent of the character width
3722		block	block cursor, fills the whole character
3723			[only one of the above three should be present]
3724		blinkwait{N}				*cursor-blinking*
3725		blinkon{N}
3726		blinkoff{N}
3727			blink times for cursor: blinkwait is the delay before
3728			the cursor starts blinking, blinkon is the time that
3729			the cursor is shown and blinkoff is the time that the
3730			cursor is not shown.  The times are in msec.  When one
3731			of the numbers is zero, there is no blinking.  The
3732			default is: "blinkwait700-blinkon400-blinkoff250".
3733			These numbers are used for a missing entry.  This
3734			means that blinking is enabled by default.  To switch
3735			blinking off you can use "blinkon0".  The cursor only
3736			blinks when Vim is waiting for input, not while
3737			executing a command.
3738			To make the cursor blink in an xterm, see
3739			|xterm-blink|.
3740		{group-name}
3741			a highlight group name, that sets the color and font
3742			for the cursor
3743		{group-name}/{group-name}
3744			Two highlight group names, the first is used when
3745			no language mappings are used, the other when they
3746			are. |language-mapping|
3747
3748	Examples of parts:
3749	   n-c-v:block-nCursor	in Normal, Command-line and Visual mode, use a
3750				block cursor with colors from the "nCursor"
3751				highlight group
3752	   i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3753				In Insert and Command-line Insert mode, use a
3754				30% vertical bar cursor with colors from the
3755				"iCursor" highlight group.  Blink a bit
3756				faster.
3757
3758	The 'a' mode is different.  It will set the given argument-list for
3759	all modes.  It does not reset anything to defaults.  This can be used
3760	to do a common setting for all modes.  For example, to switch off
3761	blinking: "a:blinkon0"
3762
3763	Examples of cursor highlighting: >
3764	    :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3765	    :highlight Cursor gui=NONE guifg=bg guibg=fg
3766<
3767					*'guifont'* *'gfn'*
3768						   *E235* *E596*
3769'guifont' 'gfn'		string	(default "")
3770			global
3771			{only available when compiled with GUI enabled}
3772	This is a list of fonts which will be used for the GUI version of Vim.
3773	In its simplest form the value is just one font name.
3774	See |gui-font| for the details.
3775
3776					*'guifontset'* *'gfs'*
3777					*E250* *E252* *E234* *E597* *E598*
3778'guifontset' 'gfs'	string	(default "")
3779			global
3780			{only available when compiled with GUI enabled and
3781			with the |+xfontset| feature}
3782			{not available in the GTK+ GUI}
3783	When not empty, specifies two (or more) fonts to be used.  The first
3784	one for normal English, the second one for your special language.  See
3785	|xfontset|.
3786
3787				*'guifontwide'* *'gfw'* *E231* *E533* *E534*
3788'guifontwide' 'gfw'	string	(default "")
3789			global
3790			{only available when compiled with GUI enabled}
3791	When not empty, specifies a comma-separated list of fonts to be used
3792	for double-width characters.  The first font that can be loaded is
3793	used.  See |gui-fontwide|.
3794
3795						*'guiheadroom'* *'ghr'*
3796'guiheadroom' 'ghr'	number	(default 50)
3797			global
3798			{only for GTK and X11 GUI}
3799	The number of pixels subtracted from the screen height when fitting
3800	the GUI window on the screen.  Set this before the GUI is started,
3801	e.g., in your |gvimrc| file.  When zero, the whole screen height will
3802	be used by the window.  When positive, the specified number of pixel
3803	lines will be left for window decorations and other items on the
3804	screen.  Set it to a negative value to allow windows taller than the
3805	screen.
3806
3807						*'guiligatures'* *'gli'* *E1243*
3808'guiligatures' 'gli'	string	(default "")
3809			global
3810			{only for GTK GUI}
3811	List of ASCII characters that, when combined together, can create more
3812	complex shapes. Each character must be a printable ASCII character
3813	with a value in the 32-127 range.
3814	Example: >
3815		:set guiligatures=!\"#$%&()*+-./:<=>?@[]^_{\|~
3816<	Changing this option updates screen output immediately. Set it to an
3817	empty string to disable ligatures.
3818
3819						*'guioptions'* *'go'*
3820'guioptions' 'go'	string	(default "egmrLtT"   (MS-Windows,
3821					   "t" is removed in |defaults.vim|),
3822					 "aegimrLtT" (GTK, Motif and Athena),
3823					 )
3824			global
3825			{only available when compiled with GUI enabled}
3826	This option only has an effect in the GUI version of Vim.  It is a
3827	sequence of letters which describes what components and options of the
3828	GUI should be used.
3829	To avoid problems with flags that are added in the future, use the
3830	"+=" and "-=" feature of ":set" |add-option-flags|.
3831
3832	Valid characters are as follows:
3833								*'go-!'*
3834	  '!'	External commands are executed in a terminal window.  Without
3835		this flag the MS-Windows GUI will open a console window to
3836		execute the command.  The Unix GUI will simulate a dumb
3837		terminal to list the command output.
3838		The terminal window will be positioned at the bottom, and grow
3839		upwards as needed.
3840								*'go-a'*
3841	  'a'	Autoselect:  If present, then whenever VISUAL mode is started,
3842		or the Visual area extended, Vim tries to become the owner of
3843		the windowing system's global selection.  This means that the
3844		Visually highlighted text is available for pasting into other
3845		applications as well as into Vim itself.  When the Visual mode
3846		ends, possibly due to an operation on the text, or when an
3847		application wants to paste the selection, the highlighted text
3848		is automatically yanked into the "* selection register.
3849		Thus the selection is still available for pasting into other
3850		applications after the VISUAL mode has ended.
3851		    If not present, then Vim won't become the owner of the
3852		windowing system's global selection unless explicitly told to
3853		by a yank or delete operation for the "* register.
3854		The same applies to the modeless selection.
3855								*'go-P'*
3856	  'P'	Like autoselect but using the "+ register instead of the "*
3857		register.
3858								*'go-A'*
3859	  'A'	Autoselect for the modeless selection.  Like 'a', but only
3860		applies to the modeless selection.
3861
3862		    'guioptions'   autoselect Visual  autoselect modeless ~
3863			 ""		 -			 -
3864			 "a"		yes			yes
3865			 "A"		 -			yes
3866			 "aA"		yes			yes
3867
3868								*'go-c'*
3869	  'c'	Use console dialogs instead of popup dialogs for simple
3870		choices.
3871								*'go-d'*
3872	  'd'	Use dark theme variant if available. Currently only works for
3873		GTK+ GUI.
3874								*'go-e'*
3875	  'e'	Add tab pages when indicated with 'showtabline'.
3876		'guitablabel' can be used to change the text in the labels.
3877		When 'e' is missing a non-GUI tab pages line may be used.
3878		The GUI tabs are only supported on some systems, currently
3879		GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
3880								*'go-f'*
3881	  'f'	Foreground: Don't use fork() to detach the GUI from the shell
3882		where it was started.  Use this for programs that wait for the
3883		editor to finish (e.g., an e-mail program).  Alternatively you
3884		can use "gvim -f" or ":gui -f" to start the GUI in the
3885		foreground.  |gui-fork|
3886		Note: Set this option in the vimrc file.  The forking may have
3887		happened already when the |gvimrc| file is read.
3888								*'go-i'*
3889	  'i'	Use a Vim icon.  For GTK with KDE it is used in the left-upper
3890		corner of the window.  It's black&white on non-GTK, because of
3891		limitations of X11.  For a color icon, see |X11-icon|.
3892								*'go-m'*
3893	  'm'	Menu bar is present.
3894								*'go-M'*
3895	  'M'	The system menu "$VIMRUNTIME/menu.vim" is not sourced.  Note
3896		that this flag must be added in the .vimrc file, before
3897		switching on syntax or filetype recognition (when the |gvimrc|
3898		file is sourced the system menu has already been loaded; the
3899		`:syntax on` and `:filetype on` commands load the menu too).
3900								*'go-g'*
3901	  'g'	Grey menu items: Make menu items that are not active grey.  If
3902		'g' is not included inactive menu items are not shown at all.
3903		Exception: Athena will always use grey menu items.
3904								*'go-t'*
3905	  't'	Include tearoff menu items.  Currently only works for Win32,
3906		GTK+, and Motif 1.2 GUI.
3907								*'go-T'*
3908	  'T'	Include Toolbar.  Currently only in Win32, GTK+, Motif, Photon
3909		and Athena GUIs.
3910								*'go-r'*
3911	  'r'	Right-hand scrollbar is always present.
3912								*'go-R'*
3913	  'R'	Right-hand scrollbar is present when there is a vertically
3914		split window.
3915								*'go-l'*
3916	  'l'	Left-hand scrollbar is always present.
3917								*'go-L'*
3918	  'L'	Left-hand scrollbar is present when there is a vertically
3919		split window.
3920								*'go-b'*
3921	  'b'	Bottom (horizontal) scrollbar is present.  Its size depends on
3922		the longest visible line, or on the cursor line if the 'h'
3923		flag is included. |gui-horiz-scroll|
3924								*'go-h'*
3925	  'h'	Limit horizontal scrollbar size to the length of the cursor
3926		line.  Reduces computations. |gui-horiz-scroll|
3927
3928	And yes, you may even have scrollbars on the left AND the right if
3929	you really want to :-).  See |gui-scrollbars| for more information.
3930
3931								*'go-v'*
3932	  'v'	Use a vertical button layout for dialogs.  When not included,
3933		a horizontal layout is preferred, but when it doesn't fit a
3934		vertical layout is used anyway.  Not supported in GTK 3.
3935								*'go-p'*
3936	  'p'	Use Pointer callbacks for X11 GUI.  This is required for some
3937		window managers.  If the cursor is not blinking or hollow at
3938		the right moment, try adding this flag.  This must be done
3939		before starting the GUI.  Set it in your |gvimrc|.  Adding or
3940		removing it after the GUI has started has no effect.
3941								*'go-F'*
3942	  'F'	Add a footer.  Only for Motif.  See |gui-footer|.
3943								*'go-k'*
3944	  'k'	Keep the GUI window size when adding/removing a scrollbar, or
3945		toolbar, tabline, etc.  Instead, the behavior is similar to
3946		when the window is maximized and will adjust 'lines' and
3947		'columns' to fit to the window.  Without the 'k' flag Vim will
3948		try to keep 'lines' and 'columns' the same when adding and
3949		removing GUI components.
3950
3951						*'guipty'* *'noguipty'*
3952'guipty'		boolean	(default on)
3953			global
3954			{only available when compiled with GUI enabled}
3955	Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3956	I/O to/from shell commands.  See |gui-pty|.
3957
3958						*'guitablabel'* *'gtl'*
3959'guitablabel' 'gtl'	string	(default empty)
3960			global
3961			{only available when compiled with GUI enabled}
3962	When nonempty describes the text to use in a label of the GUI tab
3963	pages line.  When empty and when the result is empty Vim will use a
3964	default label.  See |setting-guitablabel| for more info.
3965
3966	The format of this option is like that of 'statusline'.
3967	'guitabtooltip' is used for the tooltip, see below.
3968	The expression will be evaluated in the |sandbox| when set from a
3969	modeline, see |sandbox-option|.
3970	This option cannot be set in a modeline when 'modelineexpr' is off.
3971
3972	Only used when the GUI tab pages line is displayed.  'e' must be
3973	present in 'guioptions'.  For the non-GUI tab pages line 'tabline' is
3974	used.
3975
3976						*'guitabtooltip'* *'gtt'*
3977'guitabtooltip' 'gtt'	string	(default empty)
3978			global
3979			{only available when compiled with GUI enabled}
3980	When nonempty describes the text to use in a tooltip for the GUI tab
3981	pages line.  When empty Vim will use a default tooltip.
3982	This option is otherwise just like 'guitablabel' above.
3983	You can include a line break.  Simplest method is to use |:let|: >
3984		:let &guitabtooltip = "line one\nline two"
3985<
3986
3987						*'helpfile'* *'hf'*
3988'helpfile' 'hf'		string	(default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
3989					 (others) "$VIMRUNTIME/doc/help.txt")
3990			global
3991	Name of the main help file.  All distributed help files should be
3992	placed together in one directory.  Additionally, all "doc" directories
3993	in 'runtimepath' will be used.
3994	Environment variables are expanded |:set_env|.  For example:
3995	"$VIMRUNTIME/doc/help.txt".  If $VIMRUNTIME is not set, $VIM is also
3996	tried.  Also see |$VIMRUNTIME| and |option-backslash| about including
3997	spaces and backslashes.
3998	This option cannot be set from a |modeline| or in the |sandbox|, for
3999	security reasons.
4000
4001						*'helpheight'* *'hh'*
4002'helpheight' 'hh'	number	(default 20)
4003			global
4004	Minimal initial height of the help window when it is opened with the
4005	":help" command.  The initial height of the help window is half of the
4006	current window, or (when the 'ea' option is on) the same as other
4007	windows.  When the height is less than 'helpheight', the height is
4008	set to 'helpheight'.  Set to zero to disable.
4009
4010						*'helplang'* *'hlg'*
4011'helplang' 'hlg'	string	(default: messages language or empty)
4012			global
4013			{only available when compiled with the |+multi_lang|
4014			feature}
4015	Comma separated list of languages.  Vim will use the first language
4016	for which the desired help can be found.  The English help will always
4017	be used as a last resort.  You can add "en" to prefer English over
4018	another language, but that will only find tags that exist in that
4019	language and not in the English help.
4020	Example: >
4021		:set helplang=de,it
4022<	This will first search German, then Italian and finally English help
4023	files.
4024	When using |CTRL-]| and ":help!" in a non-English help file Vim will
4025	try to find the tag in the current language before using this option.
4026	See |help-translated|.
4027
4028				     *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4029'hidden' 'hid'		boolean	(default off)
4030			global
4031	When off a buffer is unloaded when it is |abandon|ed.  When on a
4032	buffer becomes hidden when it is |abandon|ed.  If the buffer is still
4033	displayed in another window, it does not become hidden, of course.
4034	The commands that move through the buffer list sometimes make a buffer
4035	hidden although the 'hidden' option is off: When the buffer is
4036	modified, 'autowrite' is off or writing is not possible, and the '!'
4037	flag was used.  See also |windows.txt|.
4038	To only make one buffer hidden use the 'bufhidden' option.
4039	This option is set for one command with ":hide {command}" |:hide|.
4040	WARNING: It's easy to forget that you have changes in hidden buffers.
4041	Think twice when using ":q!" or ":qa!".
4042
4043						*'highlight'* *'hl'*
4044'highlight' 'hl'	string	(default (as a single string):
4045				     "8:SpecialKey,~:EndOfBuffer,@:NonText,
4046				     d:Directory,e:ErrorMsg,i:IncSearch,
4047				     l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4048				     a:LineNrAbove,b:LineNrBelow,
4049				     N:CursorLineNr,r:Question,s:StatusLine,
4050				     S:StatusLineNC,c:VertSplit,t:Title,
4051				     v:Visual,V:VisualNOS,w:WarningMsg,
4052				     W:WildMenu,f:Folded,F:FoldColumn,
4053				     A:DiffAdd,C:DiffChange,D:DiffDelete,
4054				     T:DiffText,>:SignColumn,-:Conceal,
4055				     B:SpellBad,P:SpellCap,R:SpellRare,
4056				     L:SpellLocal,+:Pmenu,=:PmenuSel,
4057				     x:PmenuSbar,X:PmenuThumb,*:TabLine,
4058				     #:TabLineSel,_:TabLineFill,!:CursorColumn,
4059				     .:CursorLine,o:ColorColumn,q:QuickFixLine,
4060				     z:StatusLineTerm,Z:StatusLineTermNC")
4061			global
4062	This option can be used to set highlighting mode for various
4063	occasions.  It is a comma separated list of character pairs.  The
4064	first character in a pair gives the occasion, the second the mode to
4065	use for that occasion.  The occasions are:
4066	|hl-SpecialKey|	 8  Meta and special keys listed with ":map"
4067	|hl-EndOfBuffer|   ~  lines after the last line in the buffer
4068	|hl-NonText|	 @  '@' at the end of the window and
4069			    characters from 'showbreak'
4070	|hl-Directory|	 d  directories in CTRL-D listing and other special
4071			    things in listings
4072	|hl-ErrorMsg|	 e  error messages
4073			 h  (obsolete, ignored)
4074	|hl-IncSearch|	 i  'incsearch' highlighting
4075	|hl-Search|	 l  last search pattern highlighting (see 'hlsearch')
4076	|hl-MoreMsg|	 m  |more-prompt|
4077	|hl-ModeMsg|	 M  Mode (e.g., "-- INSERT --")
4078	|hl-LineNr|	 n  line number for ":number" and ":#" commands, and
4079			    when 'number' or 'relativenumber' option is set.
4080	|hl-LineNrAbove|   a  line number above the cursor for when the
4081			    'relativenumber' option is set.
4082	|hl-LineNrBelow|   b  line number below the cursor for when the
4083			    'relativenumber' option is set.
4084	|hl-CursorLineNr|  N like n for when 'cursorline' or 'relativenumber' is
4085			    set.
4086	|hl-Question|	 r  |hit-enter| prompt and yes/no questions
4087	|hl-StatusLine|	 s  status line of current window |status-line|
4088	|hl-StatusLineNC|  S  status lines of not-current windows
4089	|hl-Title|	 t  Titles for output from ":set all", ":autocmd" etc.
4090	|hl-VertSplit|	 c  column used to separate vertically split windows
4091	|hl-Visual|	 v  Visual mode
4092	|hl-VisualNOS|	 V  Visual mode when Vim does is "Not Owning the
4093			    Selection" Only X11 Gui's |gui-x11| and
4094			    |xterm-clipboard|.
4095	|hl-WarningMsg|	 w  warning messages
4096	|hl-WildMenu|	 W  wildcard matches displayed for 'wildmenu'
4097	|hl-Folded|	 f  line used for closed folds
4098	|hl-FoldColumn|	 F  'foldcolumn'
4099	|hl-DiffAdd|	 A  added line in diff mode
4100	|hl-DiffChange|	 C  changed line in diff mode
4101	|hl-DiffDelete|	 D  deleted line in diff mode
4102	|hl-DiffText|	 T  inserted text in diff mode
4103	|hl-SignColumn|	 >  column used for |signs|
4104	|hl-Conceal|	 -  the placeholders used for concealed characters
4105			    (see 'conceallevel')
4106	|hl-SpellBad|	 B  misspelled word |spell|
4107	|hl-SpellCap|	 P  word that should start with capital |spell|
4108	|hl-SpellRare|	 R  rare word |spell|
4109	|hl-SpellLocal|	 L  word from other region |spell|
4110	|hl-Pmenu|	 +  popup menu normal line
4111	|hl-PmenuSel|	 =  popup menu selected line
4112	|hl-PmenuSbar|	 x  popup menu scrollbar
4113	|hl-PmenuThumb|	 X  popup menu scrollbar thumb
4114
4115	The display modes are:
4116		r	reverse		(termcap entry "mr" and "me")
4117		i	italic		(termcap entry "ZH" and "ZR")
4118		b	bold		(termcap entry "md" and "me")
4119		s	standout	(termcap entry "so" and "se")
4120		u	underline	(termcap entry "us" and "ue")
4121		c	undercurl	(termcap entry "Cs" and "Ce")
4122		t	strikethrough	(termcap entry "Ts" and "Te")
4123		n	no highlighting
4124		-	no highlighting
4125		:	use a highlight group
4126	The default is used for occasions that are not included.
4127	If you want to change what the display modes do, see |dos-colors|
4128	for an example.
4129	When using the ':' display mode, this must be followed by the name of
4130	a highlight group.  A highlight group can be used to define any type
4131	of highlighting, including using color.  See |:highlight| on how to
4132	define one.  The default uses a different group for each occasion.
4133	See |highlight-default| for the default highlight groups.
4134
4135						*'history'* *'hi'*
4136'history' 'hi'		number	(Vim default: 50, Vi default: 0,
4137						 set to 200 in |defaults.vim|)
4138			global
4139	A history of ":" commands, and a history of previous search patterns
4140	is remembered.  This option decides how many entries may be stored in
4141	each of these histories (see |cmdline-editing|).
4142	The maximum value is 10000.
4143	NOTE: This option is set to the Vi default value when 'compatible' is
4144	set and to the Vim default value when 'compatible' is reset.
4145
4146					 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4147'hkmap' 'hk'		boolean (default off)
4148			global
4149			{only available when compiled with the |+rightleft|
4150			feature}
4151	When on, the keyboard is mapped for the Hebrew character set.
4152	Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4153	toggle this option.  See |rileft.txt|.
4154	NOTE: This option is reset when 'compatible' is set.
4155
4156				 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4157'hkmapp' 'hkp'		boolean (default off)
4158			global
4159			{only available when compiled with the |+rightleft|
4160			feature}
4161	When on, phonetic keyboard mapping is used.  'hkmap' must also be on.
4162	This is useful if you have a non-Hebrew keyboard.
4163	See |rileft.txt|.
4164	NOTE: This option is reset when 'compatible' is set.
4165
4166				 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4167'hlsearch' 'hls'	boolean	(default off)
4168			global
4169			{not available when compiled without the
4170			|+extra_search| feature}
4171	When there is a previous search pattern, highlight all its matches.
4172	The type of highlighting used can be set with the 'l' occasion in the
4173	'highlight' option.  This uses the "Search" highlight group by
4174	default.  Note that only the matching text is highlighted, any offsets
4175	are not applied.
4176	See also: 'incsearch' and |:match|.
4177	When you get bored looking at the highlighted matches, you can turn it
4178	off with |:nohlsearch|.  This does not change the option value, as
4179	soon as you use a search command, the highlighting comes back.
4180	'redrawtime' specifies the maximum time spent on finding matches.
4181	When the search pattern can match an end-of-line, Vim will try to
4182	highlight all of the matched text.  However, this depends on where the
4183	search starts.  This will be the first line in the window or the first
4184	line below a closed fold.  A match in a previous line which is not
4185	drawn may not continue in a newly drawn line.
4186	You can specify whether the highlight status is restored on startup
4187	with the 'h' flag in 'viminfo' |viminfo-h|.
4188	NOTE: This option is reset when 'compatible' is set.
4189
4190						*'icon'* *'noicon'*
4191'icon'			boolean	(default off, on when title can be restored)
4192			global
4193			{not available when compiled without the |+title|
4194			feature}
4195	When on, the icon text of the window will be set to the value of
4196	'iconstring' (if it is not empty), or to the name of the file
4197	currently being edited.  Only the last part of the name is used.
4198	Overridden by the 'iconstring' option.
4199	Only works if the terminal supports setting window icons (currently
4200	only X11 GUI and terminals with a non-empty 't_IS' option - these are
4201	Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4202	builtin termcap).
4203	When Vim was compiled with HAVE_X11 defined, the original icon will be
4204	restored if possible |X11|.  See |X11-icon| for changing the icon on
4205	X11.
4206	For MS-Windows the icon can be changed, see |windows-icon|.
4207
4208						*'iconstring'*
4209'iconstring'		string	(default "")
4210			global
4211			{not available when compiled without the |+title|
4212			feature}
4213	When this option is not empty, it will be used for the icon text of
4214	the window.  This happens only when the 'icon' option is on.
4215	Only works if the terminal supports setting window icon text
4216	(currently only X11 GUI and terminals with a non-empty 't_IS' option).
4217	Does not work for MS-Windows.
4218	When Vim was compiled with HAVE_X11 defined, the original icon will be
4219	restored if possible |X11|.
4220	When this option contains printf-style '%' items, they will be
4221	expanded according to the rules used for 'statusline'.  See
4222	'titlestring' for example settings.
4223	This option cannot be set in a modeline when 'modelineexpr' is off.
4224	{not available when compiled without the |+statusline| feature}
4225
4226			*'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4227'ignorecase' 'ic'	boolean	(default off)
4228			global
4229	Ignore case in search patterns.  Also used when searching in the tags
4230	file.
4231	Also see 'smartcase' and 'tagcase'.
4232	Can be overruled by using "\c" or "\C" in the pattern, see
4233	|/ignorecase|.
4234
4235						*'imactivatefunc'* *'imaf'*
4236'imactivatefunc' 'imaf'	string (default "")
4237			global
4238	This option specifies a function that will be called to
4239	activate or deactivate the Input Method.
4240	It is not used in the MS-Windows GUI version.
4241	The expression will be evaluated in the |sandbox| when set from a
4242	modeline, see |sandbox-option|.
4243
4244	Example: >
4245		function ImActivateFunc(active)
4246		  if a:active
4247		    ... do something
4248		  else
4249		    ... do something
4250		  endif
4251		  " return value is not used
4252		endfunction
4253		set imactivatefunc=ImActivateFunc
4254<
4255						*'imactivatekey'* *'imak'*
4256'imactivatekey' 'imak'	string (default "")
4257			global
4258			{only available when compiled with |+xim| and
4259			|+GUI_GTK|}				*E599*
4260	Specifies the key that your Input Method in X-Windows uses for
4261	activation.  When this is specified correctly, vim can fully control
4262	IM with 'imcmdline', 'iminsert' and 'imsearch'.
4263	You can't use this option to change the activation key, the option
4264	tells Vim what the key is.
4265	Format:
4266		[MODIFIER_FLAG-]KEY_STRING
4267
4268	These characters can be used for MODIFIER_FLAG (case is ignored):
4269		S	    Shift key
4270		L	    Lock key
4271		C	    Control key
4272		1	    Mod1 key
4273		2	    Mod2 key
4274		3	    Mod3 key
4275		4	    Mod4 key
4276		5	    Mod5 key
4277	Combinations are allowed, for example "S-C-space" or "SC-space" are
4278	both shift+ctrl+space.
4279	See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4280
4281	Example: >
4282		:set imactivatekey=S-space
4283<	"S-space" means shift+space.  This is the activation key for kinput2 +
4284	canna (Japanese), and ami (Korean).
4285
4286				*'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4287'imcmdline' 'imc'	boolean (default off)
4288			global
4289	When set the Input Method is always on when starting to edit a command
4290	line, unless entering a search pattern (see 'imsearch' for that).
4291	Setting this option is useful when your input method allows entering
4292	English characters directly, e.g., when it's used to type accented
4293	characters with dead keys.
4294
4295				*'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
4296'imdisable' 'imd'	boolean (default off, on for some systems (SGI))
4297			global
4298	When set the Input Method is never used.  This is useful to disable
4299	the IM when it doesn't work properly.
4300	Currently this option is on by default for SGI/IRIX machines.  This
4301	may change in later releases.
4302
4303						*'iminsert'* *'imi'*
4304'iminsert' 'imi'	number (default 0)
4305			local to buffer
4306	Specifies whether :lmap or an Input Method (IM) is to be used in
4307	Insert mode.  Valid values:
4308		0	:lmap is off and IM is off
4309		1	:lmap is ON and IM is off
4310		2	:lmap is off and IM is ON
4311	To always reset the option to zero when leaving Insert mode with <Esc>
4312	this can be used: >
4313		:inoremap <ESC> <ESC>:set iminsert=0<CR>
4314<	This makes :lmap and IM turn off automatically when leaving Insert
4315	mode.
4316	Note that this option changes when using CTRL-^ in Insert mode
4317	|i_CTRL-^|.
4318	The value is set to 1 when setting 'keymap' to a valid keymap name.
4319	It is also used for the argument of commands like "r" and "f".
4320	The value 0 may not work correctly with Athena and Motif with some XIM
4321	methods.  Use 'imdisable' to disable XIM then.
4322
4323	You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
4324	via external command if Vim is not compiled with the |+xim|,
4325	|+multi_byte_ime| or |global-ime|.
4326
4327						*'imsearch'* *'ims'*
4328'imsearch' 'ims'	number (default -1)
4329			local to buffer
4330	Specifies whether :lmap or an Input Method (IM) is to be used when
4331	entering a search pattern.  Valid values:
4332		-1	the value of 'iminsert' is used, makes it look like
4333			'iminsert' is also used when typing a search pattern
4334		0	:lmap is off and IM is off
4335		1	:lmap is ON and IM is off
4336		2	:lmap is off and IM is ON
4337	Note that this option changes when using CTRL-^ in Command-line mode
4338	|c_CTRL-^|.
4339	The value is set to 1 when it is not -1 and setting the 'keymap'
4340	option to a valid keymap name.
4341	The value 0 may not work correctly with Athena and Motif with some XIM
4342	methods.  Use 'imdisable' to disable XIM then.
4343
4344						*'imstatusfunc'* *'imsf'*
4345'imstatusfunc' 'imsf'	string (default "")
4346			global
4347	This option specifies a function that is called to obtain the status
4348	of Input Method.  It must return a positive number when IME is active.
4349	It is not used in the MS-Windows GUI version.
4350
4351	Example: >
4352		function ImStatusFunc()
4353		  let is_active = ...do something
4354		  return is_active ? 1 : 0
4355		endfunction
4356		set imstatusfunc=ImStatusFunc
4357<
4358	NOTE: This function is invoked very often.  Keep it fast.
4359	The expression will be evaluated in the |sandbox| when set from a
4360	modeline, see |sandbox-option|.
4361
4362						*'imstyle'* *'imst'*
4363'imstyle' 'imst'	number (default 1)
4364			global
4365			{only available when compiled with |+xim| and
4366			|+GUI_GTK|}
4367	This option specifies the input style of Input Method:
4368	0   use on-the-spot style
4369	1   over-the-spot style
4370	See: |xim-input-style|
4371
4372	For a long time on-the-spot style had been used in the GTK version of
4373	vim, however, it is known that it causes troubles when using mappings,
4374	|single-repeat|, etc.  Therefore over-the-spot style becomes the
4375	default now.  This should work fine for most people, however if you
4376	have any problem with it, try using on-the-spot style.
4377	The expression will be evaluated in the |sandbox| when set from a
4378	modeline, see |sandbox-option|.
4379
4380						*'include'* *'inc'*
4381'include' 'inc'		string	(default "^\s*#\s*include")
4382			global or local to buffer |global-local|
4383			{not available when compiled without the
4384			|+find_in_path| feature}
4385	Pattern to be used to find an include command.  It is a search
4386	pattern, just like for the "/" command (See |pattern|).  The default
4387	value is for C programs.  This option is used for the commands "[i",
4388	"]I", "[d", etc.
4389	Normally the 'isfname' option is used to recognize the file name that
4390	comes after the matched pattern.  But if "\zs" appears in the pattern
4391	then the text matched from "\zs" to the end, or until "\ze" if it
4392	appears, is used as the file name.  Use this to include characters
4393	that are not in 'isfname', such as a space.  You can then use
4394	'includeexpr' to process the matched text.
4395	See |option-backslash| about including spaces and backslashes.
4396
4397						*'includeexpr'* *'inex'*
4398'includeexpr' 'inex'	string	(default "")
4399			local to buffer
4400			{not available when compiled without the
4401			|+find_in_path| or |+eval| features}
4402	Expression to be used to transform the string found with the 'include'
4403	option to a file name.  Mostly useful to change "." to "/" for Java: >
4404		:set includeexpr=substitute(v:fname,'\\.','/','g')
4405<	The "v:fname" variable will be set to the file name that was detected.
4406
4407	Also used for the |gf| command if an unmodified file name can't be
4408	found.  Allows doing "gf" on the name after an 'include' statement.
4409	Also used for |<cfile>|.
4410
4411	The expression will be evaluated in the |sandbox| when set from a
4412	modeline, see |sandbox-option|.
4413	This option cannot be set in a modeline when 'modelineexpr' is off.
4414
4415	It is not allowed to change text or jump to another window while
4416	evaluating 'includeexpr' |textlock|.
4417
4418				 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4419'incsearch' 'is'	boolean	(default off, set in |defaults.vim| if the
4420						+reltime feature is supported)
4421			global
4422			{not available when compiled without the
4423			|+extra_search| features}
4424	While typing a search command, show where the pattern, as it was typed
4425	so far, matches.  The matched string is highlighted.  If the pattern
4426	is invalid or not found, nothing is shown.  The screen will be updated
4427	often, this is only useful on fast terminals.
4428	Also applies to the pattern in commands: >
4429		:global
4430		:lvimgrep
4431		:lvimgrepadd
4432		:smagic
4433		:snomagic
4434		:sort
4435		:substitute
4436		:vglobal
4437		:vimgrep
4438		:vimgrepadd
4439<	Note that the match will be shown, but the cursor will return to its
4440	original position when no match is found and when pressing <Esc>.  You
4441	still need to finish the search command with <Enter> to move the
4442	cursor to the match.
4443	You can use the CTRL-G and CTRL-T keys to move to the next and
4444	previous match. |c_CTRL-G| |c_CTRL-T|
4445	When compiled with the |+reltime| feature Vim only searches for about
4446	half a second.  With a complicated pattern and/or a lot of text the
4447	match may not be found.  This is to avoid that Vim hangs while you
4448	are typing the pattern.
4449	The highlighting can be set with the 'i' flag in 'highlight'.
4450	When 'hlsearch' is on, all matched strings are highlighted too while
4451	typing a search command. See also: 'hlsearch'.
4452	If you don't want to turn 'hlsearch' on, but want to highlight all
4453	matches while searching, you can turn on and off 'hlsearch' with
4454	autocmd.  Example: >
4455		augroup vimrc-incsearch-highlight
4456		  autocmd!
4457		  autocmd CmdlineEnter /,\? :set hlsearch
4458		  autocmd CmdlineLeave /,\? :set nohlsearch
4459		augroup END
4460<
4461	CTRL-L can be used to add one character from after the current match
4462	to the command line.  If 'ignorecase' and 'smartcase' are set and the
4463	command line has no uppercase characters, the added character is
4464	converted to lowercase.
4465	CTRL-R CTRL-W can be used to add the word at the end of the current
4466	match, excluding the characters that were already typed.
4467	NOTE: This option is reset when 'compatible' is set.
4468
4469						*'indentexpr'* *'inde'*
4470'indentexpr' 'inde'	string	(default "")
4471			local to buffer
4472			{not available when compiled without the |+cindent|
4473			or |+eval| features}
4474	Expression which is evaluated to obtain the proper indent for a line.
4475	It is used when a new line is created, for the |=| operator and
4476	in Insert mode as specified with the 'indentkeys' option.
4477	When this option is not empty, it overrules the 'cindent' and
4478	'smartindent' indenting.  When 'lisp' is set, this option is
4479	overridden by the Lisp indentation algorithm.
4480	When 'paste' is set this option is not used for indenting.
4481	The expression is evaluated with |v:lnum| set to the line number for
4482	which the indent is to be computed.  The cursor is also in this line
4483	when the expression is evaluated (but it may be moved around).
4484	The expression must return the number of spaces worth of indent.  It
4485	can return "-1" to keep the current indent (this means 'autoindent' is
4486	used for the indent).
4487	Functions useful for computing the indent are |indent()|, |cindent()|
4488	and |lispindent()|.
4489	The evaluation of the expression must not have side effects!  It must
4490	not change the text, jump to another window, etc.  Afterwards the
4491	cursor position is always restored, thus the cursor may be moved.
4492	Normally this option would be set to call a function: >
4493		:set indentexpr=GetMyIndent()
4494<	Error messages will be suppressed, unless the 'debug' option contains
4495	"msg".
4496	See |indent-expression|.
4497	NOTE: This option is set to "" when 'compatible' is set.
4498
4499	The expression will be evaluated in the |sandbox| when set from a
4500	modeline, see |sandbox-option|.
4501	This option cannot be set in a modeline when 'modelineexpr' is off.
4502
4503	It is not allowed to change text or jump to another window while
4504	evaluating 'indentexpr' |textlock|.
4505
4506
4507						*'indentkeys'* *'indk'*
4508'indentkeys' 'indk'	string	(default "0{,0},0),0],:,0#,!^F,o,O,e")
4509			local to buffer
4510			{not available when compiled without the |+cindent|
4511			feature}
4512	A list of keys that, when typed in Insert mode, cause reindenting of
4513	the current line.  Only happens if 'indentexpr' isn't empty.
4514	The format is identical to 'cinkeys', see |indentkeys-format|.
4515	See |C-indenting| and |indent-expression|.
4516
4517			*'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4518'infercase' 'inf'	boolean	(default off)
4519			local to buffer
4520	When doing keyword completion in insert mode |ins-completion|, and
4521	'ignorecase' is also on, the case of the match is adjusted depending
4522	on the typed text.  If the typed text contains a lowercase letter
4523	where the match has an upper case letter, the completed part is made
4524	lowercase.  If the typed text has no lowercase letters and the match
4525	has a lowercase letter where the typed text has an uppercase letter,
4526	and there is a letter before it, the completed part is made uppercase.
4527	With 'noinfercase' the match is used as-is.
4528
4529			*'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4530'insertmode' 'im'	boolean	(default off)
4531			global
4532	Makes Vim work in a way that Insert mode is the default mode.  Useful
4533	if you want to use Vim as a modeless editor.  Used for |evim|.
4534	These Insert mode commands will be useful:
4535	- Use the cursor keys to move around.
4536	- Use CTRL-O to execute one Normal mode command |i_CTRL-O|.  When
4537	  this is a mapping, it is executed as if 'insertmode' was off.
4538	  Normal mode remains active until the mapping is finished.
4539	- Use CTRL-L to execute a number of Normal mode commands, then use
4540	  <Esc> to get back to Insert mode.  Note that CTRL-L moves the cursor
4541	  left, like <Esc> does when 'insertmode' isn't set.  |i_CTRL-L|
4542
4543	These items change when 'insertmode' is set:
4544	- when starting to edit of a file, Vim goes to Insert mode.
4545	- <Esc> in Insert mode is a no-op and beeps.
4546	- <Esc> in Normal mode makes Vim go to Insert mode.
4547	- CTRL-L in Insert mode is a command, it is not inserted.
4548	- CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|.	*i_CTRL-Z*
4549	However, when <Esc> is used inside a mapping, it behaves like
4550	'insertmode' was not set.  This was done to be able to use the same
4551	mappings with 'insertmode' set or not set.
4552	When executing commands with |:normal| 'insertmode' is not used.
4553
4554	NOTE: This option is reset when 'compatible' is set.
4555
4556						*'isfname'* *'isf'*
4557'isfname' 'isf'		string	(default for Win32:
4558			     "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4559			    for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4560			    for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4561			    for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4562			    otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4563			global
4564	The characters specified by this option are included in file names and
4565	path names.  Filenames are used for commands like "gf", "[i" and in
4566	the tags file.  It is also used for "\f" in a |pattern|.
4567	Multi-byte characters 256 and above are always included, only the
4568	characters up to 255 are specified with this option.
4569	For UTF-8 the characters 0xa0 to 0xff are included as well.
4570	Think twice before adding white space to this option.  Although a
4571	space may appear inside a file name, the effect will be that Vim
4572	doesn't know where a file name starts or ends when doing completion.
4573	It most likely works better without a space in 'isfname'.
4574
4575	Note that on systems using a backslash as path separator, Vim tries to
4576	do its best to make it work as you would expect.  That is a bit
4577	tricky, since Vi originally used the backslash to escape special
4578	characters.  Vim will not remove a backslash in front of a normal file
4579	name character on these systems, but it will on Unix and alikes.  The
4580	'&' and '^' are not included by default, because these are special for
4581	cmd.exe.
4582
4583	The format of this option is a list of parts, separated with commas.
4584	Each part can be a single character number or a range.  A range is two
4585	character numbers with '-' in between.  A character number can be a
4586	decimal number between 0 and 255 or the ASCII character itself (does
4587	not work for digits).  Example:
4588		"_,-,128-140,#-43"	(include '_' and '-' and the range
4589					128 to 140 and '#' to 43)
4590	If a part starts with '^', the following character number or range
4591	will be excluded from the option.  The option is interpreted from left
4592	to right.  Put the excluded character after the range where it is
4593	included.  To include '^' itself use it as the last character of the
4594	option or the end of a range.  Example:
4595		"^a-z,#,^"	(exclude 'a' to 'z', include '#' and '^')
4596	If the character is '@', all characters where isalpha() returns TRUE
4597	are included.  Normally these are the characters a to z and A to Z,
4598	plus accented characters.  To include '@' itself use "@-@".  Examples:
4599		"@,^a-z"	All alphabetic characters, excluding lower
4600				case ASCII letters.
4601		"a-z,A-Z,@-@"	All letters plus the '@' character.
4602	A comma can be included by using it where a character number is
4603	expected.  Example:
4604		"48-57,,,_"	Digits, comma and underscore.
4605	A comma can be excluded by prepending a '^'.  Example:
4606		" -~,^,,9"	All characters from space to '~', excluding
4607				comma, plus <Tab>.
4608	See |option-backslash| about including spaces and backslashes.
4609
4610						*'isident'* *'isi'*
4611'isident' 'isi'		string	(default for Win32:
4612					   "@,48-57,_,128-167,224-235"
4613				otherwise: "@,48-57,_,192-255")
4614			global
4615	The characters given by this option are included in identifiers.
4616	Identifiers are used in recognizing environment variables and after a
4617	match of the 'define' option.  It is also used for "\i" in a
4618	|pattern|.  See 'isfname' for a description of the format of this
4619	option.  For '@' only characters up to 255 are used.
4620	Careful: If you change this option, it might break expanding
4621	environment variables.  E.g., when '/' is included and Vim tries to
4622	expand "$HOME/.viminfo".  Maybe you should change 'iskeyword' instead.
4623
4624						*'iskeyword'* *'isk'*
4625'iskeyword' 'isk'	string (Vim default for Win32:
4626					    "@,48-57,_,128-167,224-235"
4627				   otherwise:  "@,48-57,_,192-255"
4628				Vi default: "@,48-57,_")
4629			local to buffer
4630	Keywords are used in searching and recognizing with many commands:
4631	"w", "*", "[i", etc.  It is also used for "\k" in a |pattern|.  See
4632	'isfname' for a description of the format of this option.  For '@'
4633	characters above 255 check the "word" character class (any character
4634	that is not white space or punctuation).
4635	For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
4636	For a help file it is set to all non-blank printable characters except
4637	'*', '"' and '|' (so that CTRL-] on a command finds the help for that
4638	command).
4639	When the 'lisp' option is on the '-' character is always included.
4640	This option also influences syntax highlighting, unless the syntax
4641	uses |:syn-iskeyword|.
4642	NOTE: This option is set to the Vi default value when 'compatible' is
4643	set and to the Vim default value when 'compatible' is reset.
4644
4645						*'isprint'* *'isp'*
4646'isprint' 'isp'	string	(default for Win32 and macOS:
4647				"@,~-255"; otherwise: "@,161-255")
4648			global
4649	The characters given by this option are displayed directly on the
4650	screen.  It is also used for "\p" in a |pattern|.  The characters from
4651	space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4652	even when they are not included in 'isprint' or excluded.  See
4653	'isfname' for a description of the format of this option.
4654
4655	Non-printable characters are displayed with two characters:
4656		  0 -  31	"^@" - "^_"
4657		 32 - 126	always single characters
4658		   127		"^?"
4659		128 - 159	"~@" - "~_"
4660		160 - 254	"| " - "|~"
4661		   255		"~?"
4662	When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4663	displayed as <xx>, with the hexadecimal value of the byte.
4664	When 'display' contains "uhex" all unprintable characters are
4665	displayed as <xx>.
4666	The SpecialKey highlighting will be used for unprintable characters.
4667	|hl-SpecialKey|
4668
4669	Multi-byte characters 256 and above are always included, only the
4670	characters up to 255 are specified with this option.  When a character
4671	is printable but it is not available in the current font, a
4672	replacement character will be shown.
4673	Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4674	There is no option to specify these characters.
4675
4676			*'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4677'joinspaces' 'js'	boolean	(default on)
4678			global
4679	Insert two spaces after a '.', '?' and '!' with a join command.
4680	When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4681	Otherwise only one space is inserted.
4682	NOTE: This option is set when 'compatible' is set.
4683
4684							*'key'*
4685'key'			string	(default "")
4686			local to buffer
4687			{only available when compiled with the |+cryptv|
4688			feature}
4689	The key that is used for encrypting and decrypting the current buffer.
4690	See |encryption| and 'cryptmethod'.
4691	Careful: Do not set the key value by hand, someone might see the typed
4692	key.  Use the |:X| command.  But you can make 'key' empty: >
4693		:set key=
4694<	It is not possible to get the value of this option with ":set key" or
4695	"echo &key".  This is to avoid showing it to someone who shouldn't
4696	know.  It also means you cannot see it yourself once you have set it,
4697	be careful not to make a typing error!
4698	You can use "&key" in an expression to detect whether encryption is
4699	enabled.  When 'key' is set it returns "*****" (five stars).
4700
4701					*'keymap'* *'kmp'* *E544*
4702'keymap' 'kmp'		string	(default "")
4703			local to buffer
4704			{only available when compiled with the |+keymap|
4705			feature}
4706	Name of a keyboard mapping.  See |mbyte-keymap|.
4707	Setting this option to a valid keymap name has the side effect of
4708	setting 'iminsert' to one, so that the keymap becomes effective.
4709	'imsearch' is also set to one, unless it was -1
4710	Only normal file name characters can be used, "/\*?[|<>" are illegal.
4711
4712					*'keymodel'* *'km'*
4713'keymodel' 'km'		string	(default "")
4714			global
4715	List of comma separated words, which enable special things that keys
4716	can do.  These values can be used:
4717	   startsel	Using a shifted special key starts selection (either
4718			Select mode or Visual mode, depending on "key" being
4719			present in 'selectmode').
4720	   stopsel	Using a not-shifted special key stops selection.
4721	Special keys in this context are the cursor keys, <End>, <Home>,
4722	<PageUp> and <PageDown>.
4723	The 'keymodel' option is set by the |:behave| command.
4724
4725					*'keywordprg'* *'kp'*
4726'keywordprg' 'kp'	string	(default "man" or "man -s",  DOS: ":help",
4727								  VMS: "help")
4728			global or local to buffer |global-local|
4729	Program to use for the |K| command.  Environment variables are
4730	expanded |:set_env|.  ":help" may be used to access the Vim internal
4731	help.  (Note that previously setting the global option to the empty
4732	value did this, which is now deprecated.)
4733	When the first character is ":", the command is invoked as a Vim
4734	Ex command prefixed with [count].
4735	When "man", "man -s" or an Ex command is used, Vim will automatically
4736	translate a count for the "K" command and pass it as the first
4737	argument.  For "man -s" the "-s" is removed when there is no count.
4738	See |option-backslash| about including spaces and backslashes.
4739	Example: >
4740		:set keywordprg=man\ -s
4741<	This option cannot be set from a |modeline| or in the |sandbox|, for
4742	security reasons.
4743
4744					*'langmap'* *'lmap'* *E357* *E358*
4745'langmap' 'lmap'	string	(default "")
4746			global
4747			{only available when compiled with the |+langmap|
4748			feature}
4749	This option allows switching your keyboard into a special language
4750	mode.  When you are typing text in Insert mode the characters are
4751	inserted directly.  When in Normal mode the 'langmap' option takes
4752	care of translating these special characters to the original meaning
4753	of the key.  This means you don't have to change the keyboard mode to
4754	be able to execute Normal mode commands.
4755	This is the opposite of the 'keymap' option, where characters are
4756	mapped in Insert mode.
4757	Also consider setting 'langremap' to off, to prevent 'langmap' from
4758	applying to characters resulting from a mapping.
4759	This option cannot be set from a |modeline| or in the |sandbox|, for
4760	security reasons.
4761
4762	Example (for Greek, in UTF-8):				*greek*  >
4763	    :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
4764<	Example (exchanges meaning of z and y for commands): >
4765	    :set langmap=zy,yz,ZY,YZ
4766<
4767	The 'langmap' option is a list of parts, separated with commas.  Each
4768	part can be in one of two forms:
4769	1.  A list of pairs.  Each pair is a "from" character immediately
4770	    followed by the "to" character.  Examples: "aA", "aAbBcC".
4771	2.  A list of "from" characters, a semi-colon and a list of "to"
4772	    characters.  Example: "abc;ABC"
4773	Example: "aA,fgh;FGH,cCdDeE"
4774	Special characters need to be preceded with a backslash.  These are
4775	";", ',', '"', '|' and backslash itself.
4776
4777	This will allow you to activate vim actions without having to switch
4778	back and forth between the languages.  Your language characters will
4779	be understood as normal vim English characters (according to the
4780	langmap mappings) in the following cases:
4781	 o Normal/Visual mode (commands, buffer/register names, user mappings)
4782	 o Insert/Replace Mode: Register names after CTRL-R
4783	 o Insert/Replace Mode: Mappings
4784	Characters entered in Command-line mode will NOT be affected by
4785	this option.   Note that this option can be changed at any time
4786	allowing to switch between mappings for different languages/encodings.
4787	Use a mapping to avoid having to type it each time!
4788
4789					*'langmenu'* *'lm'*
4790'langmenu' 'lm'		string	(default "")
4791			global
4792			{only available when compiled with the |+menu| and
4793			|+multi_lang| features}
4794	Language to use for menu translation.  Tells which file is loaded
4795	from the "lang" directory in 'runtimepath': >
4796		"lang/menu_" . &langmenu . ".vim"
4797<	(without the spaces).  For example, to always use the Dutch menus, no
4798	matter what $LANG is set to: >
4799		:set langmenu=nl_NL.ISO_8859-1
4800<	When 'langmenu' is empty, |v:lang| is used.
4801	Only normal file name characters can be used, "/\*?[|<>" are illegal.
4802	If your $LANG is set to a non-English language but you do want to use
4803	the English menus: >
4804		:set langmenu=none
4805<	This option must be set before loading menus, switching on filetype
4806	detection or syntax highlighting.  Once the menus are defined setting
4807	this option has no effect.  But you could do this: >
4808		:source $VIMRUNTIME/delmenu.vim
4809		:set langmenu=de_DE.ISO_8859-1
4810		:source $VIMRUNTIME/menu.vim
4811<	Warning: This deletes all menus that you defined yourself!
4812
4813			*'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
4814'langnoremap' 'lnr'	boolean (default off, set in |defaults.vim|)
4815			global
4816			{only available when compiled with the |+langmap|
4817			feature}
4818	This is just like 'langremap' but with the value inverted.  It only
4819	exists for backwards compatibility.  When setting 'langremap' then
4820	'langnoremap' is set to the inverted value, and the other way around.
4821
4822			*'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4823'langremap' 'lrm'	boolean (default on, set to off in |defaults.vim|)
4824			global
4825			{only available when compiled with the |+langmap|
4826			feature}
4827	When off, setting 'langmap' does not apply to characters resulting from
4828	a mapping.  This basically means, if you noticed that setting
4829	'langmap' disables some of your mappings, try resetting this option.
4830	This option defaults to on for backwards compatibility.  Set it off if
4831	that works for you to avoid mappings to break.
4832
4833					*'laststatus'* *'ls'*
4834'laststatus' 'ls'	number	(default 1)
4835			global
4836	The value of this option influences when the last window will have a
4837	status line:
4838		0: never
4839		1: only if there are at least two windows
4840		2: always
4841	The screen looks nicer with a status line if you have several
4842	windows, but it takes another screen line. |status-line|
4843
4844			*'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4845'lazyredraw' 'lz'	boolean	(default off)
4846			global
4847	When this option is set, the screen will not be redrawn while
4848	executing macros, registers and other commands that have not been
4849	typed.  Also, updating the window title is postponed.  To force an
4850	update use |:redraw|.
4851
4852			*'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4853'linebreak' 'lbr'	boolean	(default off)
4854			local to window
4855			{not available when compiled without the |+linebreak|
4856			feature}
4857	If on, Vim will wrap long lines at a character in 'breakat' rather
4858	than at the last character that fits on the screen.  Unlike
4859	'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4860	it only affects the way the file is displayed, not its contents.
4861	If 'breakindent' is set, line is visually indented. Then, the value
4862	of 'showbreak' is used to put in front of wrapped lines. This option
4863	is not used when the 'wrap' option is off.
4864	Note that <Tab> characters after an <EOL> are mostly not displayed
4865	with the right amount of white space.
4866
4867						*'lines'* *E593*
4868'lines'			number	(default 24 or terminal height)
4869			global
4870	Number of lines of the Vim window.
4871	Normally you don't need to set this.  It is done automatically by the
4872	terminal initialization code.  Also see |posix-screen-size|.
4873	When Vim is running in the GUI or in a resizable window, setting this
4874	option will cause the window size to be changed.  When you only want
4875	to use the size for the GUI, put the command in your |gvimrc| file.
4876	Vim limits the number of lines to what fits on the screen.  You can
4877	use this command to get the tallest window possible: >
4878		:set lines=999
4879<	Minimum value is 2, maximum value is 1000.
4880	If you get fewer lines than expected, check the 'guiheadroom' option.
4881	When you set this option and Vim is unable to change the physical
4882	number of lines of the display, the display may be messed up.
4883
4884						*'linespace'* *'lsp'*
4885'linespace' 'lsp'	number	(default 0, 1 for Win32 GUI)
4886			global
4887			{only in the GUI}
4888	Number of pixel lines inserted between characters.  Useful if the font
4889	uses the full character cell height, making lines touch each other.
4890	When non-zero there is room for underlining.
4891	With some fonts there can be too much room between lines (to have
4892	space for ascents and descents).  Then it makes sense to set
4893	'linespace' to a negative value.  This may cause display problems
4894	though!
4895
4896						*'lisp'* *'nolisp'*
4897'lisp'			boolean	(default off)
4898			local to buffer
4899			{not available when compiled without the |+lispindent|
4900			feature}
4901	Lisp mode: When <Enter> is typed in insert mode set the indent for
4902	the next line to Lisp standards (well, sort of).  Also happens with
4903	"cc" or "S".  'autoindent' must also be on for this to work.  The 'p'
4904	flag in 'cpoptions' changes the method of indenting: Vi compatible or
4905	better.  Also see 'lispwords'.
4906	The '-' character is included in keyword characters.  Redefines the
4907	"=" operator to use this same indentation algorithm rather than
4908	calling an external program if 'equalprg' is empty.
4909	This option is not used when 'paste' is set.
4910
4911						*'lispwords'* *'lw'*
4912'lispwords' 'lw'	string	(default is very long)
4913			global or local to buffer |global-local|
4914			{not available when compiled without the |+lispindent|
4915			feature}
4916	Comma separated list of words that influence the Lisp indenting.
4917	|'lisp'|
4918
4919						*'list'* *'nolist'*
4920'list'			boolean	(default off)
4921			local to window
4922	List mode: By default show tabs as CTRL-I is displayed, display $
4923	after end of line.  Useful to see the difference between tabs and
4924	spaces and for trailing blanks.  Further changed by the 'listchars'
4925	option.
4926
4927	The cursor is displayed at the start of the space a Tab character
4928	occupies, not at the end as usual in Normal mode.  To get this cursor
4929	position while displaying Tabs with spaces, use: >
4930		:set list lcs=tab:\ \
4931<
4932	Note that list mode will also affect formatting (set with 'textwidth'
4933	or 'wrapmargin') when 'cpoptions' includes 'L'.  See 'listchars' for
4934	changing the way tabs are displayed.
4935
4936						*'listchars'* *'lcs'*
4937'listchars' 'lcs'	string	(default "eol:$")
4938			global or local to window |global-local|
4939	Strings to use in 'list' mode and for the |:list| command.  It is a
4940	comma separated list of string settings.
4941							*lcs-eol*
4942	  eol:c		Character to show at the end of each line.  When
4943			omitted, there is no extra character at the end of the
4944			line.
4945							*lcs-tab*
4946	  tab:xy[z]	Two or three characters to be used to show a tab.
4947			The third character is optional.
4948
4949	  tab:xy	The 'x' is always used, then 'y' as many times as will
4950			fit.  Thus "tab:>-" displays:
4951				>
4952				>-
4953				>--
4954				etc.
4955
4956	  tab:xyz	The 'z' is always used, then 'x' is prepended, and
4957			then 'y' is used as many times as will fit.  Thus
4958			"tab:<->" displays:
4959				>
4960				<>
4961				<->
4962				<-->
4963				etc.
4964
4965			When "tab:" is omitted, a tab is shown as ^I.
4966							*lcs-space*
4967	  space:c	Character to show for a space.  When omitted, spaces
4968			are left blank.
4969							*lcs-multispace*
4970	  multispace:c...
4971	 		One or more characters to use cyclically to show for
4972	 		multiple consecutive spaces.  Overrides the "space"
4973			setting, except for single spaces.  When omitted, the
4974			"space" setting is used.  For example,
4975			`:set listchars=multispace:---+` shows ten consecutive
4976			spaces as:
4977				---+---+--
4978							*lcs-lead*
4979	  lead:c	Character to show for leading spaces.  When omitted,
4980			leading spaces are blank.  Overrides the "space" and
4981			"multispace" settings for leading spaces.  You can
4982			combine it with "tab:", for example: >
4983				:set listchars+=tab:>-,lead:.
4984<							*lcs-trail*
4985	  trail:c	Character to show for trailing spaces.  When omitted,
4986			trailing spaces are blank.  Overrides the "space" and
4987			"multispace" settings for trailing spaces.
4988							*lcs-extends*
4989	  extends:c	Character to show in the last column, when 'wrap' is
4990			off and the line continues beyond the right of the
4991			screen.
4992							*lcs-precedes*
4993	  precedes:c	Character to show in the first visible column of the
4994			physical line, when there is text preceding the
4995			character visible in the first column.
4996							*lcs-conceal*
4997	  conceal:c	Character to show in place of concealed text, when
4998			'conceallevel' is set to 1.
4999							*lcs-nbsp*
5000	  nbsp:c	Character to show for a non-breakable space character
5001			(0xA0 (160 decimal) and U+202F).  Left blank when
5002			omitted.
5003
5004	The characters ':' and ',' should not be used.  UTF-8 characters can
5005	be used when 'encoding' is "utf-8", otherwise only printable
5006	characters are allowed.  All characters must be single width.
5007
5008	Each character can be specified as hex: >
5009		set listchars=eol:\\x24
5010		set listchars=eol:\\u21b5
5011		set listchars=eol:\\U000021b5
5012<	Note that a double backslash is used.  The number of hex characters
5013	must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
5014
5015	Examples: >
5016	    :set lcs=tab:>-,trail:-
5017	    :set lcs=tab:>-,eol:<,nbsp:%
5018	    :set lcs=extends:>,precedes:<
5019<	The "NonText" highlighting will be used for "eol", "extends" and
5020	"precedes".  "SpecialKey" will be used for "tab", "nbsp", "space",
5021	"multispace", "lead" and "trail".
5022	|hl-NonText| |hl-SpecialKey|
5023
5024			*'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5025'loadplugins' 'lpl'	boolean	(default on)
5026			global
5027	When on the plugin scripts are loaded when starting up |load-plugins|.
5028	This option can be reset in your |vimrc| file to disable the loading
5029	of plugins.
5030	Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5031	line arguments reset this option.  See |-u| and |--noplugin|.
5032
5033						*'luadll'*
5034'luadll'		string	(default depends on the build)
5035			global
5036			{only available when compiled with the |+lua/dyn|
5037			feature}
5038	Specifies the name of the Lua shared library. The default is
5039	DYNAMIC_LUA_DLL, which was specified at compile time.
5040	Environment variables are expanded |:set_env|.
5041	This option cannot be set from a |modeline| or in the |sandbox|, for
5042	security reasons.
5043
5044						*'macatsui'* *'nomacatsui'*
5045'macatsui'		boolean	(default on)
5046			global
5047			{not supported}
5048	No longer supported, as the Mac OS X GUI code was removed.
5049
5050						*'magic'* *'nomagic'*
5051'magic'			boolean	(default on)
5052			global
5053	Changes the special characters that can be used in search patterns.
5054	See |pattern|.
5055	WARNING: Switching this option off most likely breaks plugins!  That
5056	is because many patterns assume it's on and will fail when it's off.
5057	Only switch it off when working with old Vi scripts.  In any other
5058	situation write patterns that work when 'magic' is on.  Include "\M"
5059	when you want to |/\M|.
5060	In |Vim9| script the value of 'magic' is ignored, patterns behave like
5061	it is always set.
5062
5063						*'makeef'* *'mef'*
5064'makeef' 'mef'		string	(default: "")
5065			global
5066			{not available when compiled without the |+quickfix|
5067			feature}
5068	Name of the errorfile for the |:make| command (see |:make_makeprg|)
5069	and the |:grep| command.
5070	When it is empty, an internally generated temp file will be used.
5071	When "##" is included, it is replaced by a number to make the name
5072	unique.  This makes sure that the ":make" command doesn't overwrite an
5073	existing file.
5074	NOT used for the ":cf" command.  See 'errorfile' for that.
5075	Environment variables are expanded |:set_env|.
5076	See |option-backslash| about including spaces and backslashes.
5077	This option cannot be set from a |modeline| or in the |sandbox|, for
5078	security reasons.
5079
5080					*'makeencoding'* *'menc'*
5081'makeencoding' 'menc'	string	(default "")
5082			global or local to buffer |global-local|
5083	Encoding used for reading the output of external commands.  When empty,
5084	encoding is not converted.
5085	This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5086	`:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5087	and `:laddfile`.
5088
5089	This would be mostly useful when you use MS-Windows and set 'encoding'
5090	to "utf-8".  If |+iconv| is enabled and GNU libiconv is used, setting
5091	'makeencoding' to "char" has the same effect as setting to the system
5092	locale encoding.  Example: >
5093		:set encoding=utf-8
5094		:set makeencoding=char	" system locale is used
5095<
5096						*'makeprg'* *'mp'*
5097'makeprg' 'mp'		string	(default "make", VMS: "MMS")
5098			global or local to buffer |global-local|
5099	Program to use for the ":make" command.  See |:make_makeprg|.
5100	This option may contain '%' and '#' characters (see  |:_%| and |:_#|),
5101	which are expanded to the current and alternate file name.  Use |::S|
5102	to escape file names in case they contain special characters.
5103	Environment variables are expanded |:set_env|.  See |option-backslash|
5104	about including spaces and backslashes.
5105	Note that a '|' must be escaped twice: once for ":set" and once for
5106	the interpretation of a command.  When you use a filter called
5107	"myfilter" do it like this: >
5108	    :set makeprg=gmake\ \\\|\ myfilter
5109<	The placeholder "$*" can be given (even multiple times) to specify
5110	where the arguments will be included, for example: >
5111	    :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5112<	This option cannot be set from a |modeline| or in the |sandbox|, for
5113	security reasons.
5114
5115						*'matchpairs'* *'mps'*
5116'matchpairs' 'mps'	string	(default "(:),{:},[:]")
5117			local to buffer
5118	Characters that form pairs.  The |%| command jumps from one to the
5119	other.
5120	Only character pairs are allowed that are different, thus you cannot
5121	jump between two double quotes.
5122	The characters must be separated by a colon.
5123	The pairs must be separated by a comma.  Example for including '<' and
5124	'>' (for HTML): >
5125		:set mps+=<:>
5126
5127<	A more exotic example, to jump between the '=' and ';' in an
5128	assignment, useful for languages like C and Java: >
5129		:au FileType c,cpp,java set mps+==:;
5130
5131<	For a more advanced way of using "%", see the matchit.vim plugin in
5132	the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
5133
5134						*'matchtime'* *'mat'*
5135'matchtime' 'mat'	number	(default 5)
5136			global
5137	Tenths of a second to show the matching paren, when 'showmatch' is
5138	set.  Note that this is not in milliseconds, like other options that
5139	set a time.  This is to be compatible with Nvi.
5140
5141						*'maxcombine'* *'mco'*
5142'maxcombine' 'mco'	number (default 2)
5143			global
5144	The maximum number of combining characters supported for displaying.
5145	Only used when 'encoding' is "utf-8".
5146	The default is OK for most languages.  Hebrew may require 4.
5147	Maximum value is 6.
5148	Even when this option is set to 2 you can still edit text with more
5149	combining characters, you just can't see them.  Use |g8| or |ga|.
5150	See |mbyte-combining|.
5151
5152						*'maxfuncdepth'* *'mfd'*
5153'maxfuncdepth' 'mfd'	number	(default 100)
5154			global
5155			{not available when compiled without the |+eval|
5156			feature}
5157	Maximum depth of function calls for user functions.  This normally
5158	catches endless recursion.  When using a recursive function with
5159	more depth, set 'maxfuncdepth' to a bigger number.  But this will use
5160	more memory, there is the danger of failing when memory is exhausted.
5161	Increasing this limit above 200 also changes the maximum for Ex
5162	command recursion, see |E169|.
5163	See also |:function|.
5164
5165						*'maxmapdepth'* *'mmd'* *E223*
5166'maxmapdepth' 'mmd'	number	(default 1000)
5167			global
5168	Maximum number of times a mapping is done without resulting in a
5169	character to be used.  This normally catches endless mappings, like
5170	":map x y" with ":map y x".  It still does not catch ":map g wg",
5171	because the 'w' is used before the next mapping is done.  See also
5172	|key-mapping|.
5173
5174						*'maxmem'* *'mm'*
5175'maxmem' 'mm'		number	(default between 256 to 5120 (system
5176				 dependent) or half the amount of memory
5177				 available)
5178			global
5179	Maximum amount of memory (in Kbyte) to use for one buffer.  When this
5180	limit is reached allocating extra memory for a buffer will cause
5181	other memory to be freed.
5182	The maximum usable value is about 2000000.  Use this to work without a
5183	limit.
5184	The value is ignored when 'swapfile' is off.
5185	Also see 'maxmemtot'.
5186
5187						*'maxmempattern'* *'mmp'*
5188'maxmempattern' 'mmp'	number	(default 1000)
5189			global
5190	Maximum amount of memory (in Kbyte) to use for pattern matching.
5191	The maximum value is about 2000000.  Use this to work without a limit.
5192							*E363*
5193	When Vim runs into the limit it gives an error message and mostly
5194	behaves like CTRL-C was typed.
5195	Running into the limit often means that the pattern is very
5196	inefficient or too complex.  This may already happen with the pattern
5197	"\(.\)*" on a very long line.  ".*" works much better.
5198	Might also happen on redraw, when syntax rules try to match a complex
5199	text structure.
5200	Vim may run out of memory before hitting the 'maxmempattern' limit, in
5201	which case you get an "Out of memory" error instead.
5202
5203						*'maxmemtot'* *'mmt'*
5204'maxmemtot' 'mmt'	number	(default between 2048 and 10240 (system
5205				 dependent) or half the amount of memory
5206				 available)
5207			global
5208	Maximum amount of memory in Kbyte to use for all buffers together.
5209	The maximum usable value is about 2000000 (2 Gbyte).  Use this to work
5210	without a limit.
5211	On 64 bit machines higher values might work.  But hey, do you really
5212	need more than 2 Gbyte for text editing?  Keep in mind that text is
5213	stored in the swap file, one can edit files > 2 Gbyte anyway.  We do
5214	need the memory to store undo info.
5215	Buffers with 'swapfile' off still count to the total amount of memory
5216	used.
5217	Also see 'maxmem'.
5218
5219						*'menuitems'* *'mis'*
5220'menuitems' 'mis'	number	(default 25)
5221			global
5222			{not available when compiled without the |+menu|
5223			feature}
5224	Maximum number of items to use in a menu.  Used for menus that are
5225	generated from a list of items, e.g., the Buffers menu.  Changing this
5226	option has no direct effect, the menu must be refreshed first.
5227
5228						*'mkspellmem'* *'msm'*
5229'mkspellmem' 'msm'	string	(default "460000,2000,500")
5230			global
5231			{not available when compiled without the |+syntax|
5232			feature}
5233	Parameters for |:mkspell|.  This tunes when to start compressing the
5234	word tree.  Compression can be slow when there are many words, but
5235	it's needed to avoid running out of memory.  The amount of memory used
5236	per word depends very much on how similar the words are, that's why
5237	this tuning is complicated.
5238
5239	There are three numbers, separated by commas:
5240		{start},{inc},{added}
5241
5242	For most languages the uncompressed word tree fits in memory.  {start}
5243	gives the amount of memory in Kbyte that can be used before any
5244	compression is done.  It should be a bit smaller than the amount of
5245	memory that is available to Vim.
5246
5247	When going over the {start} limit the {inc} number specifies the
5248	amount of memory in Kbyte that can be allocated before another
5249	compression is done.  A low number means compression is done after
5250	less words are added, which is slow.  A high number means more memory
5251	will be allocated.
5252
5253	After doing compression, {added} times 1024 words can be added before
5254	the {inc} limit is ignored and compression is done when any extra
5255	amount of memory is needed.  A low number means there is a smaller
5256	chance of hitting the {inc} limit, less memory is used but it's
5257	slower.
5258
5259	The languages for which these numbers are important are Italian and
5260	Hungarian.  The default works for when you have about 512 Mbyte.  If
5261	you have 1 Gbyte you could use: >
5262		:set mkspellmem=900000,3000,800
5263<	If you have less than 512 Mbyte |:mkspell| may fail for some
5264	languages, no matter what you set 'mkspellmem' to.
5265
5266	This option cannot be set from a |modeline| or in the |sandbox|.
5267
5268				   *'modeline'* *'ml'* *'nomodeline'* *'noml'*
5269'modeline' 'ml'		boolean	(Vim default: on (off for root),
5270				 Vi default: off)
5271			local to buffer
5272	If 'modeline' is on 'modelines' gives the number of lines that is
5273	checked for set commands.  If 'modeline' is off or 'modelines' is zero
5274	no lines are checked.  See |modeline|.
5275
5276			   *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5277'modelineexpr' 'mle'	boolean (default: off)
5278			global
5279	When on allow some options that are an expression to be set in the
5280	modeline.  Check the option for whether it is affected by
5281	'modelineexpr'.  Also see |modeline|.
5282	This option cannot be set from a |modeline| or in the |sandbox|, for
5283	security reasons.
5284
5285						*'modelines'* *'mls'*
5286'modelines' 'mls'	number	(default 5)
5287			global
5288	If 'modeline' is on 'modelines' gives the number of lines that is
5289	checked for set commands.  If 'modeline' is off or 'modelines' is zero
5290	no lines are checked.  See |modeline|.
5291	NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5292	set and to the Vim default value when 'compatible' is reset.
5293
5294				*'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5295				*E21*
5296'modifiable' 'ma'	boolean	(default on)
5297			local to buffer
5298	When off the buffer contents cannot be changed.  The 'fileformat' and
5299	'fileencoding' options also can't be changed.
5300	Can be reset on startup with the |-M| command line argument.
5301
5302				*'modified'* *'mod'* *'nomodified'* *'nomod'*
5303'modified' 'mod'	boolean	(default off)
5304			local to buffer
5305	When on, the buffer is considered to be modified.  This option is set
5306	when:
5307	1. A change was made to the text since it was last written.  Using the
5308	   |undo| command to go back to the original text will reset the
5309	   option.  But undoing changes that were made before writing the
5310	   buffer will set the option again, since the text is different from
5311	   when it was written.
5312	2. 'fileformat' or 'fileencoding' is different from its original
5313	   value.  The original value is set when the buffer is read or
5314	   written.  A ":set nomodified" command also resets the original
5315	   values to the current values and the 'modified' option will be
5316	   reset.
5317	   Similarly for 'eol' and 'bomb'.
5318	This option is not set when a change is made to the buffer as the
5319	result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5320	FileAppendPost or VimLeave autocommand event.  See |gzip-example| for
5321	an explanation.
5322	When 'buftype' is "nowrite" or "nofile" this option may be set, but
5323	will be ignored.
5324	Note that the text may actually be the same, e.g. 'modified' is set
5325	when using "rA" on an "A".
5326
5327						*'more'* *'nomore'*
5328'more'			boolean	(Vim default: on, Vi default: off)
5329			global
5330	When on, listings pause when the whole screen is filled.  You will get
5331	the |more-prompt|.  When this option is off there are no pauses, the
5332	listing continues until finished.
5333	NOTE: This option is set to the Vi default value when 'compatible' is
5334	set and to the Vim default value when 'compatible' is reset.
5335
5336						*'mouse'*
5337'mouse'			string	(default "", "a" for GUI and Win32,
5338					set to "a" or "nvi" in |defaults.vim|)
5339			global
5340	Enable the use of the mouse.  Works for most terminals (xterm, Win32
5341	|win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5342	with gpm).  For using the mouse in the GUI, see |gui-mouse|.  The
5343	mouse can be enabled for different modes:
5344		n	Normal mode and Terminal modes
5345		v	Visual mode
5346		i	Insert mode
5347		c	Command-line mode
5348		h	all previous modes when editing a help file
5349		a	all previous modes
5350		r	for |hit-enter| and |more-prompt| prompt
5351	Normally you would enable the mouse in all five modes with: >
5352		:set mouse=a
5353<	If your terminal can't overrule the mouse events going to the
5354	application, use: >
5355		:set mouse=nvi
5356<	Then you can press ":", select text for the system, and press Esc to go
5357	back to Vim using the mouse events.
5358	In |defaults.vim| "nvi" is used if the 'term' option is not matching
5359	"xterm".
5360
5361	When the mouse is not enabled, the GUI will still use the mouse for
5362	modeless selection.  This doesn't move the text cursor.
5363
5364	See |mouse-using|.  Also see |'clipboard'|.
5365
5366	Note: When enabling the mouse in a terminal, copy/paste will use the
5367	"* register if there is access to an X-server.  The xterm handling of
5368	the mouse buttons can still be used by keeping the shift key pressed.
5369	Also see the 'clipboard' option.
5370
5371			*'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5372'mousefocus' 'mousef'	boolean	(default off)
5373			global
5374			{only works in the GUI}
5375	The window that the mouse pointer is on is automatically activated.
5376	When changing the window layout or window focus in another way, the
5377	mouse pointer is moved to the window with keyboard focus.  Off is the
5378	default because it makes using the pull down menus a little goofy, as
5379	a pointer transit may activate a window unintentionally.
5380	MS-Windows: Also see 'scrollfocus' for what window is scrolled when
5381	using the mouse scroll wheel.
5382
5383			*'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5384'mousehide' 'mh'	boolean	(default on)
5385			global
5386			{only works in the GUI}
5387	When on, the mouse pointer is hidden when characters are typed.
5388	The mouse pointer is restored when the mouse is moved.
5389
5390						*'mousemodel'* *'mousem'*
5391'mousemodel' 'mousem'	string	(default "extend", "popup" for Win32)
5392			global
5393	Sets the model to use for the mouse.  The name mostly specifies what
5394	the right mouse button is used for:
5395	   extend	Right mouse button extends a selection.  This works
5396			like in an xterm.
5397	   popup	Right mouse button pops up a menu.  The shifted left
5398			mouse button extends a selection.  This works like
5399			with Microsoft Windows.
5400	   popup_setpos Like "popup", but the cursor will be moved to the
5401			position where the mouse was clicked, and thus the
5402			selected operation will act upon the clicked object.
5403			If clicking inside a selection, that selection will
5404			be acted upon, i.e. no cursor move.  This implies of
5405			course, that right clicking outside a selection will
5406			end Visual mode.
5407	Overview of what button does what for each model:
5408	mouse		    extend		popup(_setpos) ~
5409	left click	    place cursor	place cursor
5410	left drag	    start selection	start selection
5411	shift-left	    search word		extend selection
5412	right click	    extend selection	popup menu (place cursor)
5413	right drag	    extend selection	-
5414	middle click	    paste		paste
5415
5416	In the "popup" model the right mouse button produces a pop-up menu.
5417	You need to define this first, see |popup-menu|.
5418
5419	Note that you can further refine the meaning of buttons with mappings.
5420	See |gui-mouse-mapping|.  But mappings are NOT used for modeless
5421	selection (because that's handled in the GUI code directly).
5422
5423	The 'mousemodel' option is set by the |:behave| command.
5424
5425					*'mouseshape'* *'mouses'* *E547*
5426'mouseshape' 'mouses'	string	(default "i-r:beam,s:updown,sd:udsizing,
5427					vs:leftright,vd:lrsizing,m:no,
5428					ml:up-arrow,v:rightup-arrow")
5429			global
5430			{only available when compiled with the |+mouseshape|
5431			feature}
5432	This option tells Vim what the mouse pointer should look like in
5433	different modes.  The option is a comma separated list of parts, much
5434	like used for 'guicursor'.  Each part consist of a mode/location-list
5435	and an argument-list:
5436		mode-list:shape,mode-list:shape,..
5437	The mode-list is a dash separated list of these modes/locations:
5438			In a normal window: ~
5439		n	Normal mode
5440		v	Visual mode
5441		ve	Visual mode with 'selection' "exclusive" (same as 'v',
5442			if not specified)
5443		o	Operator-pending mode
5444		i	Insert mode
5445		r	Replace mode
5446
5447			Others: ~
5448		c	appending to the command-line
5449		ci	inserting in the command-line
5450		cr	replacing in the command-line
5451		m	at the 'Hit ENTER' or 'More' prompts
5452		ml	idem, but cursor in the last line
5453		e	any mode, pointer below last window
5454		s	any mode, pointer on a status line
5455		sd	any mode, while dragging a status line
5456		vs	any mode, pointer on a vertical separator line
5457		vd	any mode, while dragging a vertical separator line
5458		a	everywhere
5459
5460	The shape is one of the following:
5461	avail	name		looks like ~
5462	w x	arrow		Normal mouse pointer
5463	w x	blank		no pointer at all (use with care!)
5464	w x	beam		I-beam
5465	w x	updown		up-down sizing arrows
5466	w x	leftright	left-right sizing arrows
5467	w x	busy		The system's usual busy pointer
5468	w x	no		The system's usual 'no input' pointer
5469	  x	udsizing	indicates up-down resizing
5470	  x	lrsizing	indicates left-right resizing
5471	  x	crosshair	like a big thin +
5472	  x	hand1		black hand
5473	  x	hand2		white hand
5474	  x	pencil		what you write with
5475	  x	question	big ?
5476	  x	rightup-arrow	arrow pointing right-up
5477	w x	up-arrow	arrow pointing up
5478	  x	<number>	any X11 pointer number (see X11/cursorfont.h)
5479
5480	The "avail" column contains a 'w' if the shape is available for Win32,
5481	x for X11.
5482	Any modes not specified or shapes not available use the normal mouse
5483	pointer.
5484
5485	Example: >
5486		:set mouseshape=s:udsizing,m:no
5487<	will make the mouse turn to a sizing arrow over the status lines and
5488	indicate no input when the hit-enter prompt is displayed (since
5489	clicking the mouse has no effect in this state.)
5490
5491						*'mousetime'* *'mouset'*
5492'mousetime' 'mouset'	number	(default 500)
5493			global
5494	Only for GUI, Win32 and Unix with xterm.  Defines the maximum
5495	time in msec between two mouse clicks for the second click to be
5496	recognized as a multi click.
5497
5498						*'mzschemedll'*
5499'mzschemedll'		string	(default depends on the build)
5500			global
5501			{only available when compiled with the |+mzscheme/dyn|
5502			feature}
5503	Specifies the name of the MzScheme shared library. The default is
5504	DYNAMIC_MZSCH_DLL which was specified at compile time.
5505	Environment variables are expanded |:set_env|.
5506	The value must be set in the |vimrc| script or earlier.  In the
5507	startup, before the |load-plugins| step.
5508	This option cannot be set from a |modeline| or in the |sandbox|, for
5509	security reasons.
5510
5511						*'mzschemegcdll'*
5512'mzschemegcdll'		string	(default depends on the build)
5513			global
5514			{only available when compiled with the |+mzscheme/dyn|
5515			feature}
5516	Specifies the name of the MzScheme GC shared library. The default is
5517	DYNAMIC_MZGC_DLL which was specified at compile time.
5518	The value can be equal to 'mzschemedll' if it includes the GC code.
5519	Environment variables are expanded |:set_env|.
5520	This option cannot be set from a |modeline| or in the |sandbox|, for
5521	security reasons.
5522
5523						    *'mzquantum'* *'mzq'*
5524'mzquantum' 'mzq'	number	(default 100)
5525			global
5526			{not available when compiled without the |+mzscheme|
5527			feature}
5528	The number of milliseconds between polls for MzScheme threads.
5529	Negative or zero value means no thread scheduling.
5530	NOTE: This option is set to the Vim default value when 'compatible'
5531	is reset.
5532
5533							*'nrformats'* *'nf'*
5534'nrformats' 'nf'	string	(default "bin,octal,hex",
5535					   set to "bin,hex" in |defaults.vim|)
5536			local to buffer
5537	This defines what bases Vim will consider for numbers when using the
5538	CTRL-A and CTRL-X commands for adding to and subtracting from a number
5539	respectively; see |CTRL-A| for more info on these commands.
5540	alpha	If included, single alphabetical characters will be
5541		incremented or decremented.  This is useful for a list with a
5542		letter index a), b), etc.		*octal-nrformats*
5543	octal	If included, numbers that start with a zero will be considered
5544		to be octal.  Example: Using CTRL-A on "007" results in "010".
5545	hex	If included, numbers starting with "0x" or "0X" will be
5546		considered to be hexadecimal.  Example: Using CTRL-X on
5547		"0x100" results in "0x0ff".
5548	bin	If included, numbers starting with "0b" or "0B" will be
5549		considered to be binary.  Example: Using CTRL-X on
5550		"0b1000" subtracts one, resulting in "0b0111".
5551	unsigned    If included, numbers are recognized as unsigned. Thus a
5552		leading dash or negative sign won't be considered as part of
5553		the number.  Examples:
5554		    Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5555		    (without "unsigned" it would become "9-2021").
5556		    Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5557		    (without "unsigned" it would become "9-2019").
5558		    Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5559		    (2^64 - 1) has no effect, overflow is prevented.
5560	Numbers which simply begin with a digit in the range 1-9 are always
5561	considered decimal.  This also happens for numbers that are not
5562	recognized as octal or hex.
5563
5564				*'number'* *'nu'* *'nonumber'* *'nonu'*
5565'number' 'nu'		boolean	(default off)
5566			local to window
5567	Print the line number in front of each line.  When the 'n' option is
5568	excluded from 'cpoptions' a wrapped line will not use the column of
5569	line numbers (this is the default when 'compatible' isn't set).
5570	The 'numberwidth' option can be used to set the room used for the line
5571	number.
5572	When a long, wrapped line doesn't start with the first character, '-'
5573	characters are put before the number.
5574	See |hl-LineNr|  and |hl-CursorLineNr| for the highlighting used for
5575	the number.
5576						*number_relativenumber*
5577	The 'relativenumber' option changes the displayed number to be
5578	relative to the cursor.  Together with 'number' there are these
5579	four combinations (cursor in line 3):
5580
5581		'nonu'          'nu'            'nonu'          'nu'
5582		'nornu'         'nornu'         'rnu'           'rnu'
5583
5584	    |apple          |  1 apple      |  2 apple      |  2 apple
5585	    |pear           |  2 pear       |  1 pear       |  1 pear
5586	    |nobody         |  3 nobody     |  0 nobody     |3   nobody
5587	    |there          |  4 there      |  1 there      |  1 there
5588
5589						*'numberwidth'* *'nuw'*
5590'numberwidth' 'nuw'	number	(Vim default: 4  Vi default: 8)
5591			local to window
5592			{only available when compiled with the |+linebreak|
5593			feature}
5594	Minimal number of columns to use for the line number.  Only relevant
5595	when the 'number' or 'relativenumber' option is set or printing lines
5596	with a line number. Since one space is always between the number and
5597	the text, there is one less character for the number itself.
5598	The value is the minimum width.  A bigger width is used when needed to
5599	fit the highest line number in the buffer respectively the number of
5600	rows in the window, depending on whether 'number' or 'relativenumber'
5601	is set. Thus with the Vim default of 4 there is room for a line number
5602	up to 999. When the buffer has 1000 lines five columns will be used.
5603	The minimum value is 1, the maximum value is 20.
5604	NOTE: This option is set to the Vi default value when 'compatible' is
5605	set and to the Vim default value when 'compatible' is reset.
5606
5607						*'omnifunc'* *'ofu'*
5608'omnifunc' 'ofu'	string	(default: empty)
5609			local to buffer
5610			{not available when compiled without the |+eval|
5611			feature}
5612	This option specifies a function to be used for Insert mode omni
5613	completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
5614	See |complete-functions| for an explanation of how the function is
5615	invoked and what it should return.
5616	This option is usually set by a filetype plugin:
5617	|:filetype-plugin-on|
5618	This option cannot be set from a |modeline| or in the |sandbox|, for
5619	security reasons.
5620
5621
5622			    *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
5623'opendevice' 'odev'	boolean	(default off)
5624			global
5625			{only for MS-Windows}
5626	Enable reading and writing from devices.  This may get Vim stuck on a
5627	device that can be opened but doesn't actually do the I/O.  Therefore
5628	it is off by default.
5629	Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5630	result in editing a device.
5631
5632
5633						*'operatorfunc'* *'opfunc'*
5634'operatorfunc' 'opfunc'	string	(default: empty)
5635			global
5636	This option specifies a function to be called by the |g@| operator.
5637	See |:map-operator| for more info and an example.  The value can be
5638	the name of a function, a |lambda| or a |Funcref|. See
5639	|option-value-function| for more information.
5640
5641	This option cannot be set from a |modeline| or in the |sandbox|, for
5642	security reasons.
5643
5644
5645					*'osfiletype'* *'oft'*
5646'osfiletype' 'oft'	string (default: "")
5647			local to buffer
5648	This option was supported on RISC OS, which has been removed.
5649
5650
5651				*'packpath'* *'pp'*
5652'packpath' 'pp'		string	(default: see 'runtimepath')
5653	Directories used to find packages.  See |packages|.
5654
5655
5656						*'paragraphs'* *'para'*
5657'paragraphs' 'para'	string	(default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
5658			global
5659	Specifies the nroff macros that separate paragraphs.  These are pairs
5660	of two letters (see |object-motions|).
5661
5662						*'paste'* *'nopaste'*
5663'paste'			boolean	(default off)
5664			global
5665	Put Vim in Paste mode.  This is useful if you want to cut or copy
5666	some text from one window and paste it in Vim.  This will avoid
5667	unexpected effects.
5668	Setting this option is useful when using Vim in a terminal, where Vim
5669	cannot distinguish between typed text and pasted text.  In the GUI, Vim
5670	knows about pasting and will mostly do the right thing without 'paste'
5671	being set.  The same is true for a terminal where Vim handles the
5672	mouse clicks itself.
5673	This option is reset when starting the GUI.  Thus if you set it in
5674	your .vimrc it will work in a terminal, but not in the GUI.  Setting
5675	'paste' in the GUI has side effects: e.g., the Paste toolbar button
5676	will no longer work in Insert mode, because it uses a mapping.
5677	When the 'paste' option is switched on (also when it was already on):
5678		- mapping in Insert mode and Command-line mode is disabled
5679		- abbreviations are disabled
5680		- 'autoindent' is reset
5681		- 'expandtab' is reset
5682		- 'hkmap' is reset
5683		- 'revins' is reset
5684		- 'ruler' is reset
5685		- 'showmatch' is reset
5686		- 'smarttab' is reset
5687		- 'softtabstop' is set to 0
5688		- 'textwidth' is set to 0
5689		- 'wrapmargin' is set to 0
5690		- 'varsofttabstop' is made empty
5691	These options keep their value, but their effect is disabled:
5692		- 'cindent'
5693		- 'formatoptions' is used like it is empty
5694		- 'indentexpr'
5695		- 'lisp'
5696		- 'smartindent'
5697	NOTE: When you start editing another file while the 'paste' option is
5698	on, settings from the modelines or autocommands may change the
5699	settings again, causing trouble when pasting text.  You might want to
5700	set the 'paste' option again.
5701	When the 'paste' option is reset the mentioned options are restored to
5702	the value before the moment 'paste' was switched from off to on.
5703	Resetting 'paste' before ever setting it does not have any effect.
5704	Since mapping doesn't work while 'paste' is active, you need to use
5705	the 'pastetoggle' option to toggle the 'paste' option with some key.
5706
5707						*'pastetoggle'* *'pt'*
5708'pastetoggle' 'pt'	string	(default "")
5709			global
5710	When non-empty, specifies the key sequence that toggles the 'paste'
5711	option.  This is like specifying a mapping: >
5712	    :map {keys} :set invpaste<CR>
5713<	Where {keys} is the value of 'pastetoggle'.
5714	The difference is that it will work even when 'paste' is set.
5715	'pastetoggle' works in Insert mode and Normal mode, but not in
5716	Command-line mode.
5717	Mappings are checked first, thus overrule 'pastetoggle'.  However,
5718	when 'paste' is on mappings are ignored in Insert mode, thus you can do
5719	this: >
5720	    :map <F10> :set paste<CR>
5721	    :map <F11> :set nopaste<CR>
5722	    :imap <F10> <C-O>:set paste<CR>
5723	    :imap <F11> <nop>
5724	    :set pastetoggle=<F11>
5725<	This will make <F10> start paste mode and <F11> stop paste mode.
5726	Note that typing <F10> in paste mode inserts "<F10>", since in paste
5727	mode everything is inserted literally, except the 'pastetoggle' key
5728	sequence.
5729	When the value has several bytes 'ttimeoutlen' applies.
5730
5731						*'pex'* *'patchexpr'*
5732'patchexpr' 'pex'	string	(default "")
5733			global
5734			{not available when compiled without the |+diff|
5735			feature}
5736	Expression which is evaluated to apply a patch to a file and generate
5737	the resulting new version of the file.  See |diff-patchexpr|.
5738
5739					*'patchmode'* *'pm'* *E205* *E206*
5740'patchmode' 'pm'	string	(default "")
5741			global
5742	When non-empty the oldest version of a file is kept.  This can be used
5743	to keep the original version of a file if you are changing files in a
5744	source distribution.  Only the first time that a file is written a
5745	copy of the original file will be kept.  The name of the copy is the
5746	name of the original file with the string in the 'patchmode' option
5747	appended.  This option should start with a dot.  Use a string like
5748	".orig" or ".org".  'backupdir' must not be empty for this to work
5749	(Detail: The backup file is renamed to the patchmode file after the
5750	new file has been successfully written, that's why it must be possible
5751	to write a backup file).  If there was no file to be backed up, an
5752	empty file is created.
5753	When the 'backupskip' pattern matches, a patchmode file is not made.
5754	Using 'patchmode' for compressed files appends the extension at the
5755	end (e.g., "file.gz.orig"), thus the resulting name isn't always
5756	recognized as a compressed file.
5757	Only normal file name characters can be used, "/\*?[|<>" are illegal.
5758
5759				*'path'* *'pa'* *E343* *E345* *E347* *E854*
5760'path' 'pa'		string	(default on Unix: ".,/usr/include,,"
5761				   other systems: ".,,")
5762			global or local to buffer |global-local|
5763	This is a list of directories which will be searched when using the
5764	|gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5765	provided that the file being searched for has a relative path (not
5766	starting with "/", "./" or "../").  The directories in the 'path'
5767	option may be relative or absolute.
5768	- Use commas to separate directory names: >
5769		:set path=.,/usr/local/include,/usr/include
5770<	- Spaces can also be used to separate directory names (for backwards
5771	  compatibility with version 3.0).  To have a space in a directory
5772	  name, precede it with an extra backslash, and escape the space: >
5773		:set path=.,/dir/with\\\ space
5774<	- To include a comma in a directory name precede it with an extra
5775	  backslash: >
5776		:set path=.,/dir/with\\,comma
5777<	- To search relative to the directory of the current file, use: >
5778		:set path=.
5779<	- To search in the current directory use an empty string between two
5780	  commas: >
5781		:set path=,,
5782<	- A directory name may end in a ':' or '/'.
5783	- Environment variables are expanded |:set_env|.
5784	- When using |netrw.vim| URLs can be used.  For example, adding
5785	  "http://www.vim.org" will make ":find index.html" work.
5786	- Search upwards and downwards in a directory tree using "*", "**" and
5787	  ";".  See |file-searching| for info and syntax.
5788	  {not available when compiled without the |+path_extra| feature}
5789	- Careful with '\' characters, type two to get one in the option: >
5790		:set path=.,c:\\include
5791<	  Or just use '/' instead: >
5792		:set path=.,c:/include
5793<	Don't forget "." or files won't even be found in the same directory as
5794	the file!
5795	The maximum length is limited.  How much depends on the system, mostly
5796	it is something like 256 or 1024 characters.
5797	You can check if all the include files are found, using the value of
5798	'path', see |:checkpath|.
5799	The use of |:set+=| and |:set-=| is preferred when adding or removing
5800	directories from the list.  This avoids problems when a future version
5801	uses another default.  To remove the current directory use: >
5802		:set path-=
5803<	To add the current directory use: >
5804		:set path+=
5805<	To use an environment variable, you probably need to replace the
5806	separator.  Here is an example to append $INCL, in which directory
5807	names are separated with a semi-colon: >
5808		:let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5809<	Replace the ';' with a ':' or whatever separator is used.  Note that
5810	this doesn't work when $INCL contains a comma or white space.
5811
5812						*'perldll'*
5813'perldll'		string	(default depends on the build)
5814			global
5815			{only available when compiled with the |+perl/dyn|
5816			feature}
5817	Specifies the name of the Perl shared library. The default is
5818	DYNAMIC_PERL_DLL, which was specified at compile time.
5819	Environment variables are expanded |:set_env|.
5820	This option cannot be set from a |modeline| or in the |sandbox|, for
5821	security reasons.
5822
5823			*'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5824'preserveindent' 'pi'	boolean	(default off)
5825			local to buffer
5826	When changing the indent of the current line, preserve as much of the
5827	indent structure as possible.  Normally the indent is replaced by a
5828	series of tabs followed by spaces as required (unless |'expandtab'| is
5829	enabled, in which case only spaces are used).  Enabling this option
5830	means the indent will preserve as many existing characters as possible
5831	for indenting, and only add additional tabs or spaces as required.
5832	'expandtab' does not apply to the preserved white space, a Tab remains
5833	a Tab.
5834	NOTE: When using ">>" multiple times the resulting indent is a mix of
5835	tabs and spaces.  You might not like this.
5836	NOTE: This option is reset when 'compatible' is set.
5837	Also see 'copyindent'.
5838	Use |:retab| to clean up white space.
5839
5840					*'previewheight'* *'pvh'*
5841'previewheight' 'pvh'	number (default 12)
5842			global
5843			{not available when compiled without the |+quickfix|
5844			feature}
5845	Default height for a preview window.  Used for |:ptag| and associated
5846	commands.  Used for |CTRL-W_}| when no count is given.  Not used when
5847	'previewpopup' is set.
5848
5849					*'previewpopup'* *'pvp'*
5850'previewpopup' 'pvp'	string (default empty)
5851			global
5852			{not available when compiled without the |+textprop|
5853			or |+quickfix| feature}
5854	When not empty a popup window is used for commands that would open a
5855	preview window.  See |preview-popup|.
5856	Not used for the insert completion info, add "popup" to
5857	'completeopt' for that.
5858
5859					*'previewwindow'* *'nopreviewwindow'*
5860					*'pvw'* *'nopvw'* *E590*
5861'previewwindow' 'pvw'	boolean (default off)
5862			local to window
5863			{not available when compiled without the |+quickfix|
5864			feature}
5865	Identifies the preview window.  Only one window can have this option
5866	set.  It's normally not set directly, but by using one of the commands
5867	|:ptag|, |:pedit|, etc.
5868
5869						*'printdevice'* *'pdev'*
5870'printdevice' 'pdev'	string	(default empty)
5871			global
5872			{only available when compiled with the |+printer|
5873			feature}
5874	The name of the printer to be used for |:hardcopy|.
5875	See |pdev-option|.
5876	This option cannot be set from a |modeline| or in the |sandbox|, for
5877	security reasons.
5878
5879						*'printencoding'* *'penc'*
5880'printencoding' 'penc'	string	(default empty, except for some systems)
5881			global
5882			{only available when compiled with the |+printer|
5883			and |+postscript| features}
5884	Sets the character encoding used when printing.
5885	See |penc-option|.
5886
5887						*'printexpr'* *'pexpr'*
5888'printexpr' 'pexpr'	string	(default: see below)
5889			global
5890			{only available when compiled with the |+printer|
5891			and |+postscript| features}
5892	Expression used to print the PostScript produced with |:hardcopy|.
5893	See |pexpr-option|.
5894	This option cannot be set from a |modeline| or in the |sandbox|, for
5895	security reasons.
5896
5897						*'printfont'* *'pfn'*
5898'printfont' 'pfn'	string	(default "courier")
5899			global
5900			{only available when compiled with the |+printer|
5901			feature}
5902	The name of the font that will be used for |:hardcopy|.
5903	See |pfn-option|.
5904
5905						*'printheader'* *'pheader'*
5906'printheader' 'pheader'  string  (default "%<%f%h%m%=Page %N")
5907			global
5908			{only available when compiled with the |+printer|
5909			feature}
5910	The format of the header produced in |:hardcopy| output.
5911	See |pheader-option|.
5912
5913						*'printmbcharset'* *'pmbcs'*
5914'printmbcharset' 'pmbcs'  string (default "")
5915			global
5916			{only available when compiled with the |+printer|
5917			and |+postscript| features}
5918	The CJK character set to be used for CJK output from |:hardcopy|.
5919	See |pmbcs-option|.
5920
5921						*'printmbfont'* *'pmbfn'*
5922'printmbfont' 'pmbfn'	string (default "")
5923			global
5924			{only available when compiled with the |+printer|
5925			and |+postscript| features}
5926	List of font names to be used for CJK output from |:hardcopy|.
5927	See |pmbfn-option|.
5928
5929						*'printoptions'* *'popt'*
5930'printoptions' 'popt' string (default "")
5931			global
5932			{only available when compiled with |+printer| feature}
5933	List of items that control the format of the output of |:hardcopy|.
5934	See |popt-option|.
5935
5936						*'prompt'* *'noprompt'*
5937'prompt'		boolean	(default on)
5938			global
5939	When on a ":" prompt is used in Ex mode.
5940
5941						*'pumheight'* *'ph'*
5942'pumheight' 'ph'	number	(default 0)
5943			global
5944	Determines the maximum number of items to show in the popup menu for
5945	Insert mode completion.  When zero as much space as available is used.
5946	|ins-completion-menu|.
5947
5948						*'pumwidth'* *'pw'*
5949'pumwidth' 'pw'		number	(default 15)
5950			global
5951	Determines the minimum width to use for the popup menu for Insert mode
5952	completion.  |ins-completion-menu|.
5953
5954						*'pythondll'*
5955'pythondll'		string	(default depends on the build)
5956			global
5957			{only available when compiled with the |+python/dyn|
5958			feature}
5959	Specifies the name of the Python 2.x shared library. The default is
5960	DYNAMIC_PYTHON_DLL, which was specified at compile time.
5961	Environment variables are expanded |:set_env|.
5962	This option cannot be set from a |modeline| or in the |sandbox|, for
5963	security reasons.
5964
5965						*'pythonhome'*
5966'pythonhome'		string	(default "")
5967			global
5968			{only available when compiled with the |+python/dyn|
5969			feature}
5970	Specifies the name of the Python 2.x home directory. When 'pythonhome'
5971	and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5972	which was specified at compile time, will be used for the Python 2.x
5973	home directory.
5974	Environment variables are expanded |:set_env|.
5975	This option cannot be set from a |modeline| or in the |sandbox|, for
5976	security reasons.
5977
5978						*'pythonthreedll'*
5979'pythonthreedll'	string	(default depends on the build)
5980			global
5981			{only available when compiled with the |+python3/dyn|
5982			feature}
5983	Specifies the name of the Python 3 shared library. The default is
5984	DYNAMIC_PYTHON3_DLL, which was specified at compile time.
5985	Environment variables are expanded |:set_env|.
5986	This option cannot be set from a |modeline| or in the |sandbox|, for
5987	security reasons.
5988
5989						*'pythonthreehome'*
5990'pythonthreehome'	string	(default "")
5991			global
5992			{only available when compiled with the |+python3/dyn|
5993			feature}
5994	Specifies the name of the Python 3 home directory. When
5995	'pythonthreehome' and the PYTHONHOME environment variable are not set,
5996	PYTHON3_HOME, which was specified at compile time, will be used for
5997	the Python 3 home directory.
5998	Environment variables are expanded |:set_env|.
5999	This option cannot be set from a |modeline| or in the |sandbox|, for
6000	security reasons.
6001
6002						*'pyxversion'* *'pyx'*
6003'pyxversion' 'pyx'	number	(default depends on the build)
6004			global
6005			{only available when compiled with the |+python| or
6006			the |+python3| feature}
6007	Specifies the python version used for pyx* functions and commands
6008	|python_x|.  The default value is as follows:
6009
6010		Compiled with		     Default ~
6011		|+python| and |+python3|	0
6012		only |+python|			2
6013		only |+python3|			3
6014
6015	Available values are 0, 2 and 3.
6016	If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6017	any python2/3 commands or functions.  E.g. `:py` sets to 2, and `:py3`
6018	sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6019	to 2 if Python 2 is available.
6020	See also: |has-pythonx|
6021
6022	If Vim is compiled with only |+python| or |+python3| setting
6023	'pyxversion' has no effect.  The pyx* functions and commands are
6024	always the same as the compiled version.
6025
6026	This option cannot be set from a |modeline| or in the |sandbox|, for
6027	security reasons.
6028
6029						*'quickfixtextfunc'* *'qftf'*
6030'quickfixtextfunc' 'qftf'	string (default "")
6031			global
6032			{only available when compiled with the |+quickfix|
6033			feature}
6034	This option specifies a function to be used to get the text to display
6035	in the quickfix and location list windows.  This can be used to
6036	customize the information displayed in the quickfix or location window
6037	for each entry in the corresponding quickfix or location list.  See
6038	|quickfix-window-function| for an explanation of how to write the
6039	function and an example.  The value can be the name of a function, a
6040	|lambda| or a |Funcref|. See |option-value-function| for more
6041	information.
6042
6043	This option cannot be set from a |modeline| or in the |sandbox|, for
6044	security reasons.
6045
6046						*'quoteescape'* *'qe'*
6047'quoteescape' 'qe'	string	(default "\")
6048			local to buffer
6049	The characters that are used to escape quotes in a string.  Used for
6050	objects like a', a" and a` |a'|.
6051	When one of the characters in this option is found inside a string,
6052	the following character will be skipped.  The default value makes the
6053	text "foo\"bar\\" considered to be one string.
6054
6055				   *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6056'readonly' 'ro'		boolean	(default off)
6057			local to buffer
6058	If on, writes fail unless you use a '!'.  Protects you from
6059	accidentally overwriting a file.  Default on when Vim is started
6060	in read-only mode ("vim -R") or when the executable is called "view".
6061	When using ":w!" the 'readonly' option is reset for the current
6062	buffer, unless the 'Z' flag is in 'cpoptions'.
6063	When using the ":view" command the 'readonly' option is set for the
6064	newly edited buffer.
6065	See 'modifiable' for disallowing changes to the buffer.
6066
6067						*'redrawtime'* *'rdt'*
6068'redrawtime' 'rdt'	number	(default 2000)
6069			global
6070			{only available when compiled with the |+reltime|
6071			feature}
6072	The time in milliseconds for redrawing the display.  This applies to
6073	searching for patterns for 'hlsearch', |:match| highlighting and syntax
6074	highlighting.
6075	When redrawing takes more than this many milliseconds no further
6076	matches will be highlighted.
6077	For syntax highlighting the time applies per window.  When over the
6078	limit syntax highlighting is disabled until |CTRL-L| is used.
6079	This is used to avoid that Vim hangs when using a very complicated
6080	pattern.
6081
6082						*'regexpengine'* *'re'*
6083'regexpengine' 're'	number	(default 0)
6084			global
6085	This selects the default regexp engine. |two-engines|
6086	The possible values are:
6087		0	automatic selection
6088		1	old engine
6089		2	NFA engine
6090	Note that when using the NFA engine and the pattern contains something
6091	that is not supported the pattern will not match.  This is only useful
6092	for debugging the regexp engine.
6093	Using automatic selection enables Vim to switch the engine, if the
6094	default engine becomes too costly.  E.g., when the NFA engine uses too
6095	many states.  This should prevent Vim from hanging on a combination of
6096	a complex pattern with long text.
6097
6098		*'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6099'relativenumber' 'rnu'	boolean	(default off)
6100			local to window
6101	Show the line number relative to the line with the cursor in front of
6102	each line. Relative line numbers help you use the |count| you can
6103	precede some vertical motion commands (e.g. j k + -) with, without
6104	having to calculate it yourself. Especially useful in combination with
6105	other commands (e.g. y d c < > gq gw =).
6106	When the 'n' option is excluded from 'cpoptions' a wrapped
6107	line will not use the column of line numbers (this is the default when
6108	'compatible' isn't set).
6109	The 'numberwidth' option can be used to set the room used for the line
6110	number.
6111	When a long, wrapped line doesn't start with the first character, '-'
6112	characters are put before the number.
6113	See |hl-LineNr|  and |hl-CursorLineNr| for the highlighting used for
6114	the number.
6115
6116	The number in front of the cursor line also depends on the value of
6117	'number', see |number_relativenumber| for all combinations of the two
6118	options.
6119
6120						*'remap'* *'noremap'*
6121'remap'			boolean	(default on)
6122			global
6123	Allows for mappings to work recursively.  If you do not want this for
6124	a single entry, use the :noremap[!] command.
6125	NOTE: To avoid portability problems with Vim scripts, always keep
6126	this option at the default "on".  Only switch it off when working with
6127	old Vi scripts.
6128
6129                                               *'renderoptions'* *'rop'*
6130'renderoptions' 'rop'	string  (default: empty)
6131			global
6132			{only available when compiled with GUI and DIRECTX on
6133			MS-Windows}
6134	Select a text renderer and set its options.  The options depend on the
6135	renderer.
6136
6137	Syntax: >
6138		set rop=type:{renderer}(,{name}:{value})*
6139<
6140	Currently, only one optional renderer is available.
6141
6142	render	behavior    ~
6143	directx	Vim will draw text using DirectX (DirectWrite).  It makes
6144		drawn glyphs more beautiful than default GDI.
6145		It requires 'encoding' is "utf-8", and only works on
6146		MS-Windows Vista or newer version.
6147
6148		Options:
6149		  name	    meaning		type	value       ~
6150		  gamma	    gamma		float	1.0 - 2.2 (maybe)
6151		  contrast  enhancedContrast	float	(unknown)
6152		  level	    clearTypeLevel	float	(unknown)
6153		  geom	    pixelGeometry	int	0 - 2 (see below)
6154		  renmode   renderingMode	int	0 - 6 (see below)
6155		  taamode   textAntialiasMode	int	0 - 3 (see below)
6156		  scrlines  Scroll Lines	int	(deprecated)
6157
6158		See this URL for detail (except for scrlines):
6159		  https://msdn.microsoft.com/en-us/library/dd368190.aspx
6160
6161		For geom: structure of a device pixel.
6162		  0 - DWRITE_PIXEL_GEOMETRY_FLAT
6163		  1 - DWRITE_PIXEL_GEOMETRY_RGB
6164		  2 - DWRITE_PIXEL_GEOMETRY_BGR
6165
6166		See this URL for detail:
6167		  https://msdn.microsoft.com/en-us/library/dd368114.aspx
6168
6169		For renmode: method of rendering glyphs.
6170		  0 - DWRITE_RENDERING_MODE_DEFAULT
6171		  1 - DWRITE_RENDERING_MODE_ALIASED
6172		  2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6173		  3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6174		  4 - DWRITE_RENDERING_MODE_NATURAL
6175		  5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6176		  6 - DWRITE_RENDERING_MODE_OUTLINE
6177
6178		See this URL for detail:
6179		  https://msdn.microsoft.com/en-us/library/dd368118.aspx
6180
6181		For taamode: antialiasing mode used for drawing text.
6182		  0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6183		  1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6184		  2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6185		  3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6186
6187		See this URL for detail:
6188		  https://msdn.microsoft.com/en-us/library/dd368170.aspx
6189
6190		For scrlines:
6191		This was used for optimizing scrolling behavior, however this
6192		is now deprecated.  If specified, it is simply ignored.
6193
6194		Example: >
6195		  set encoding=utf-8
6196		  set gfn=Ricty_Diminished:h12
6197		  set rop=type:directx
6198<
6199		If select a raster font (Courier, Terminal or FixedSys which
6200		have ".fon" extension in file name) to 'guifont', it will be
6201		drawn by GDI as a fallback.
6202
6203		NOTE: It is known that some fonts and options combination
6204		causes trouble on drawing glyphs.
6205
6206		  - 'renmode:5' and 'renmode:6' will not work with some
6207		    special made fonts (True-Type fonts which includes only
6208		    bitmap glyphs).
6209		  - 'taamode:3' will not work with some vector fonts.
6210
6211		NOTE: With this option, you can display colored emoji
6212		(emoticon) in Windows 8.1 or later.  To display colored emoji,
6213		there are some conditions which you should notice.
6214
6215		  - If your font includes non-colored emoji already, it will
6216		    be used.
6217		  - If your font doesn't have emoji, the system chooses an
6218		    alternative symbol font.  On Windows 10, "Segoe UI Emoji"
6219		    will be used.
6220		  - When this alternative font didn't have fixed width glyph,
6221		    emoji might be rendered beyond the bounding box of drawing
6222		    cell.
6223
6224	Other render types are currently not supported.
6225
6226						*'report'*
6227'report'		number	(default 2)
6228			global
6229	Threshold for reporting number of lines changed.  When the number of
6230	changed lines is more than 'report' a message will be given for most
6231	":" commands.  If you want it always, set 'report' to 0.
6232	For the ":substitute" command the number of substitutions is used
6233	instead of the number of lines.
6234
6235			 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6236'restorescreen' 'rs'	boolean	(default on)
6237			global
6238			{only in MS-Windows console version}
6239	When set, the screen contents is restored when exiting Vim.  This also
6240	happens when executing external commands.
6241
6242	For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6243	options in your .vimrc.  To disable restoring:
6244		set t_ti= t_te=
6245	To enable restoring (for an xterm):
6246		set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6247	(Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6248
6249				*'revins'* *'ri'* *'norevins'* *'nori'*
6250'revins' 'ri'		boolean	(default off)
6251			global
6252			{only available when compiled with the |+rightleft|
6253			feature}
6254	Inserting characters in Insert mode will work backwards.  See "typing
6255	backwards" |ins-reverse|.  This option can be toggled with the CTRL-_
6256	command in Insert mode, when 'allowrevins' is set.
6257	NOTE: This option is reset when 'compatible' is set.
6258	This option is reset when 'paste' is set and restored when 'paste' is
6259	reset.
6260
6261				 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6262'rightleft' 'rl'	boolean	(default off)
6263			local to window
6264			{only available when compiled with the |+rightleft|
6265			feature}
6266	When on, display orientation becomes right-to-left, i.e., characters
6267	that are stored in the file appear from the right to the left.
6268	Using this option, it is possible to edit files for languages that
6269	are written from the right to the left such as Hebrew and Arabic.
6270	This option is per window, so it is possible to edit mixed files
6271	simultaneously, or to view the same file in both ways (this is
6272	useful whenever you have a mixed text file with both right-to-left
6273	and left-to-right strings so that both sets are displayed properly
6274	in different windows).  Also see |rileft.txt|.
6275
6276			*'rightleftcmd'* *'rlc'*
6277'rightleftcmd' 'rlc'	string	(default "search")
6278			local to window
6279			{only available when compiled with the |+rightleft|
6280			feature}
6281	Each word in this option enables the command line editing to work in
6282	right-to-left mode for a group of commands:
6283
6284		search		"/" and "?" commands
6285
6286	This is useful for languages such as Hebrew, Arabic and Farsi.
6287	The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6288
6289						*'rubydll'*
6290'rubydll'		string	(default: depends on the build)
6291			global
6292			{only available when compiled with the |+ruby/dyn|
6293			feature}
6294	Specifies the name of the Ruby shared library. The default is
6295	DYNAMIC_RUBY_DLL, which was specified at compile time.
6296	Environment variables are expanded |:set_env|.
6297	This option cannot be set from a |modeline| or in the |sandbox|, for
6298	security reasons.
6299
6300					 *'ruler'* *'ru'* *'noruler'* *'noru'*
6301'ruler' 'ru'		boolean	(default off, set in |defaults.vim|)
6302			global
6303			{not available when compiled without the
6304			|+cmdline_info| feature}
6305	Show the line and column number of the cursor position, separated by a
6306	comma.  When there is room, the relative position of the displayed
6307	text in the file is shown on the far right:
6308		Top	first line is visible
6309		Bot	last line is visible
6310		All	first and last line are visible
6311		45%	relative position in the file
6312	If 'rulerformat' is set, it will determine the contents of the ruler.
6313	Each window has its own ruler.  If a window has a status line, the
6314	ruler is shown there.  Otherwise it is shown in the last line of the
6315	screen.  If the statusline is given by 'statusline' (i.e. not empty),
6316	this option takes precedence over 'ruler' and 'rulerformat'
6317	If the number of characters displayed is different from the number of
6318	bytes in the text (e.g., for a TAB or a multibyte character), both
6319	the text column (byte number) and the screen column are shown,
6320	separated with a dash.
6321	For an empty line "0-1" is shown.
6322	For an empty buffer the line number will also be zero: "0,0-1".
6323	This option is reset when 'paste' is set and restored when 'paste' is
6324	reset.
6325	If you don't want to see the ruler all the time but want to know where
6326	you are, use "g CTRL-G" |g_CTRL-G|.
6327	NOTE: This option is reset when 'compatible' is set.
6328
6329						*'rulerformat'* *'ruf'*
6330'rulerformat' 'ruf'	string	(default empty)
6331			global
6332			{not available when compiled without the |+statusline|
6333			feature}
6334	When this option is not empty, it determines the content of the ruler
6335	string, as displayed for the 'ruler' option.
6336	The format of this option is like that of 'statusline'.
6337	This option cannot be set in a modeline when 'modelineexpr' is off.
6338
6339	The default ruler width is 17 characters.  To make the ruler 15
6340	characters wide, put "%15(" at the start and "%)" at the end.
6341	Example: >
6342		:set rulerformat=%15(%c%V\ %p%%%)
6343<
6344				*'runtimepath'* *'rtp'* *vimfiles*
6345'runtimepath' 'rtp'	string	(default:
6346					Unix:  "$HOME/.vim,
6347						$VIM/vimfiles,
6348						$VIMRUNTIME,
6349						$VIM/vimfiles/after,
6350						$HOME/.vim/after"
6351					Amiga: "home:vimfiles,
6352						$VIM/vimfiles,
6353						$VIMRUNTIME,
6354						$VIM/vimfiles/after,
6355						home:vimfiles/after"
6356					MS-Windows: "$HOME/vimfiles,
6357						$VIM/vimfiles,
6358						$VIMRUNTIME,
6359						$VIM/vimfiles/after,
6360						$HOME/vimfiles/after"
6361					macOS: "$VIM:vimfiles,
6362						$VIMRUNTIME,
6363						$VIM:vimfiles:after"
6364					Haiku: "$BE_USER_SETTINGS/vim,
6365						$VIM/vimfiles,
6366						$VIMRUNTIME,
6367						$VIM/vimfiles/after,
6368						$BE_USER_SETTINGS/vim/after"
6369					VMS:   "sys$login:vimfiles,
6370						$VIM/vimfiles,
6371						$VIMRUNTIME,
6372						$VIM/vimfiles/after,
6373						sys$login:vimfiles/after")
6374			global
6375	This is a list of directories which will be searched for runtime
6376	files:
6377	  filetype.vim	filetypes by file name |new-filetype|
6378	  scripts.vim	filetypes by file contents |new-filetype-scripts|
6379	  autoload/	automatically loaded scripts |autoload-functions|
6380	  colors/	color scheme files |:colorscheme|
6381	  compiler/	compiler files |:compiler|
6382	  doc/		documentation |write-local-help|
6383	  ftplugin/	filetype plugins |write-filetype-plugin|
6384	  import/	files that are found by `:import`
6385	  indent/	indent scripts |indent-expression|
6386	  keymap/	key mapping files |mbyte-keymap|
6387	  lang/		menu translations |:menutrans|
6388	  menu.vim	GUI menus |menu.vim|
6389	  pack/		packages |:packadd|
6390	  plugin/	plugin scripts |write-plugin|
6391	  print/	files for printing |postscript-print-encoding|
6392	  spell/	spell checking files |spell|
6393	  syntax/	syntax files |mysyntaxfile|
6394	  tutor/	files for vimtutor |tutor|
6395
6396	And any other file searched for with the |:runtime| command.
6397
6398	The defaults for most systems are setup to search five locations:
6399	1. In your home directory, for your personal preferences.
6400	2. In a system-wide Vim directory, for preferences from the system
6401	   administrator.
6402	3. In $VIMRUNTIME, for files distributed with Vim.
6403							*after-directory*
6404	4. In the "after" directory in the system-wide Vim directory.  This is
6405	   for the system administrator to overrule or add to the distributed
6406	   defaults (rarely needed)
6407	5. In the "after" directory in your home directory.  This is for
6408	   personal preferences to overrule or add to the distributed defaults
6409	   or system-wide settings (rarely needed).
6410
6411	More entries are added when using |packages|.  If it gets very long
6412	then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6413	string.
6414
6415	Note that, unlike 'path', no wildcards like "**" are allowed.  Normal
6416	wildcards are allowed, but can significantly slow down searching for
6417	runtime files.  For speed, use as few items as possible and avoid
6418	wildcards.
6419	See |:runtime|.
6420	Example: >
6421		:set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6422<	This will use the directory "~/vimruntime" first (containing your
6423	personal Vim runtime files), then "/mygroup/vim" (shared between a
6424	group of people) and finally "$VIMRUNTIME" (the distributed runtime
6425	files).
6426	You probably should always include $VIMRUNTIME somewhere, to use the
6427	distributed runtime files.  You can put a directory before $VIMRUNTIME
6428	to find files which replace a distributed runtime files.  You can put
6429	a directory after $VIMRUNTIME to find files which add to distributed
6430	runtime files.
6431	When Vim is started with |--clean| the home directory entries are not
6432	included.
6433	This option cannot be set from a |modeline| or in the |sandbox|, for
6434	security reasons.
6435
6436						*'scroll'* *'scr'*
6437'scroll' 'scr'		number	(default: half the window height)
6438			local to window
6439	Number of lines to scroll with CTRL-U and CTRL-D commands.  Will be
6440	set to half the number of lines in the window when the window size
6441	changes.  This may happen when enabling the |status-line| or
6442	'tabline' option after setting the 'scroll' option.
6443	If you give a count to the CTRL-U or CTRL-D command it will
6444	be used as the new value for 'scroll'.  Reset to half the window
6445	height with ":set scroll=0".
6446
6447			*'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6448'scrollbind' 'scb'	boolean  (default off)
6449			local to window
6450	See also |scroll-binding|.  When this option is set, the current
6451	window scrolls as other scrollbind windows (windows that also have
6452	this option set) scroll.  This option is useful for viewing the
6453	differences between two versions of a file, see 'diff'.
6454	See |'scrollopt'| for options that determine how this option should be
6455	interpreted.
6456	This option is mostly reset when splitting a window to edit another
6457	file.  This means that ":split | edit file" results in two windows
6458	with scroll-binding, but ":split file" does not.
6459
6460			*'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6461'scrollfocus' 'scf'	boolean  (default off)
6462			global
6463			{only for MS-Windows GUI}
6464	When using the scroll wheel and this option is set, the window under
6465	the mouse pointer is scrolled.  With this option off the current
6466	window is scrolled.
6467	Systems other than MS-Windows always behave like this option is on.
6468
6469						*'scrolljump'* *'sj'*
6470'scrolljump' 'sj'	number	(default 1)
6471			global
6472	Minimal number of lines to scroll when the cursor gets off the
6473	screen (e.g., with "j").  Not used for scroll commands (e.g., CTRL-E,
6474	CTRL-D).  Useful if your terminal scrolls very slowly.
6475	When set to a negative number from -1 to -100 this is used as the
6476	percentage of the window height.  Thus -50 scrolls half the window
6477	height.
6478	NOTE: This option is set to 1 when 'compatible' is set.
6479
6480						*'scrolloff'* *'so'*
6481'scrolloff' 'so'	number	(default 0, set to 5 in |defaults.vim|)
6482			global or local to window |global-local|
6483	Minimal number of screen lines to keep above and below the cursor.
6484	This will make some context visible around where you are working.  If
6485	you set it to a very large value (999) the cursor line will always be
6486	in the middle of the window (except at the start or end of the file or
6487	when long lines wrap).
6488	After using the local value, go back the global value with one of
6489	these two: >
6490		setlocal scrolloff<
6491		setlocal scrolloff=-1
6492<	For scrolling horizontally see 'sidescrolloff'.
6493	NOTE: This option is set to 0 when 'compatible' is set.
6494
6495						*'scrollopt'* *'sbo'*
6496'scrollopt' 'sbo'	string	(default "ver,jump")
6497			global
6498	This is a comma-separated list of words that specifies how
6499	'scrollbind' windows should behave.  'sbo' stands for ScrollBind
6500	Options.
6501	The following words are available:
6502	    ver		Bind vertical scrolling for 'scrollbind' windows
6503	    hor		Bind horizontal scrolling for 'scrollbind' windows
6504	    jump	Applies to the offset between two windows for vertical
6505			scrolling.  This offset is the difference in the first
6506			displayed line of the bound windows.  When moving
6507			around in a window, another 'scrollbind' window may
6508			reach a position before the start or after the end of
6509			the buffer.  The offset is not changed though, when
6510			moving back the 'scrollbind' window will try to scroll
6511			to the desired position when possible.
6512			When now making that window the current one, two
6513			things can be done with the relative offset:
6514			1. When "jump" is not included, the relative offset is
6515			   adjusted for the scroll position in the new current
6516			   window.  When going back to the other window, the
6517			   new relative offset will be used.
6518			2. When "jump" is included, the other windows are
6519			   scrolled to keep the same relative offset.  When
6520			   going back to the other window, it still uses the
6521			   same relative offset.
6522	Also see |scroll-binding|.
6523	When 'diff' mode is active there always is vertical scroll binding,
6524	even when "ver" isn't there.
6525
6526						*'sections'* *'sect'*
6527'sections' 'sect'	string	(default "SHNHH HUnhsh")
6528			global
6529	Specifies the nroff macros that separate sections.  These are pairs of
6530	two letters (See |object-motions|).  The default makes a section start
6531	at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6532
6533						*'secure'* *'nosecure'* *E523*
6534'secure'		boolean	(default off)
6535			global
6536	When on, ":autocmd", shell and write commands are not allowed in
6537	".vimrc" and ".exrc" in the current directory and map commands are
6538	displayed.  Switch it off only if you know that you will not run into
6539	problems, or when the 'exrc' option is off.  On Unix this option is
6540	only used if the ".vimrc" or ".exrc" is not owned by you.  This can be
6541	dangerous if the systems allows users to do a "chown".  You better set
6542	'secure' at the end of your ~/.vimrc then.
6543	This option cannot be set from a |modeline| or in the |sandbox|, for
6544	security reasons.
6545
6546						*'selection'* *'sel'*
6547'selection' 'sel'	string	(default "inclusive")
6548			global
6549	This option defines the behavior of the selection.  It is only used
6550	in Visual and Select mode.
6551	Possible values:
6552	   value	past line     inclusive ~
6553	   old		   no		yes
6554	   inclusive	   yes		yes
6555	   exclusive	   yes		no
6556	"past line" means that the cursor is allowed to be positioned one
6557	character past the line.
6558	"inclusive" means that the last character of the selection is included
6559	in an operation.  For example, when "x" is used to delete the
6560	selection.
6561	When "old" is used and 'virtualedit' allows the cursor to move past
6562	the end of line the line break still isn't included.
6563	Note that when "exclusive" is used and selecting from the end
6564	backwards, you cannot include the last character of a line, when
6565	starting in Normal mode and 'virtualedit' empty.
6566
6567	The 'selection' option is set by the |:behave| command.
6568
6569						*'selectmode'* *'slm'*
6570'selectmode' 'slm'	string	(default "")
6571			global
6572	This is a comma separated list of words, which specifies when to start
6573	Select mode instead of Visual mode, when a selection is started.
6574	Possible values:
6575	   mouse	when using the mouse
6576	   key		when using shifted special keys
6577	   cmd		when using "v", "V" or CTRL-V
6578	See |Select-mode|.
6579	The 'selectmode' option is set by the |:behave| command.
6580
6581						*'sessionoptions'* *'ssop'*
6582'sessionoptions' 'ssop'	string	(default: "blank,buffers,curdir,folds,
6583					 help,options,tabpages,winsize,terminal")
6584			global
6585			{not available when compiled without the |+mksession|
6586			feature}
6587	Changes the effect of the |:mksession| command.  It is a comma
6588	separated list of words.  Each word enables saving and restoring
6589	something:
6590	   word		save and restore ~
6591	   blank	empty windows
6592	   buffers	hidden and unloaded buffers, not just those in windows
6593	   curdir	the current directory
6594	   folds	manually created folds, opened/closed folds and local
6595			fold options
6596	   globals	global variables that start with an uppercase letter
6597			and contain at least one lowercase letter.  Only
6598			String and Number types are stored.
6599	   help		the help window
6600	   localoptions	options and mappings local to a window or buffer (not
6601			global values for local options)
6602	   options	all options and mappings (also global values for local
6603			options)
6604	   skiprtp	exclude 'runtimepath' and 'packpath' from the options
6605	   resize	size of the Vim window: 'lines' and 'columns'
6606	   sesdir	the directory in which the session file is located
6607			will become the current directory (useful with
6608			projects accessed over a network from different
6609			systems)
6610	   slash	backslashes in file names replaced with forward
6611			slashes
6612	   tabpages	all tab pages; without this only the current tab page
6613			is restored, so that you can make a session for each
6614			tab page separately
6615	   terminal	include terminal windows where the command can be
6616			restored
6617	   unix		with Unix end-of-line format (single <NL>), even when
6618			on Windows or DOS
6619	   winpos	position of the whole Vim window
6620	   winsize	window sizes
6621
6622	Don't include both "curdir" and "sesdir".
6623	When neither "curdir" nor "sesdir" is included, file names are stored
6624	with absolute paths.
6625	"slash" and "unix" are useful on Windows when sharing session files
6626	with Unix.  The Unix version of Vim cannot source dos format scripts,
6627	but the Windows version of Vim can source unix format scripts.
6628
6629						*'shell'* *'sh'* *E91*
6630'shell' 'sh'		string	(default $SHELL or "sh", Win32: "cmd.exe")
6631			global
6632	Name of the shell to use for ! and :! commands.  When changing the
6633	value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6634	'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
6635	It is allowed to give an argument to the command, e.g.  "csh -f".
6636	See |option-backslash| about including spaces and backslashes.
6637	Environment variables are expanded |:set_env|.
6638
6639	If the name of the shell contains a space, you need to enclose it in
6640	quotes and escape the space.  Example with quotes: >
6641		:set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6642<	Note the backslash before each quote (to avoid starting a comment) and
6643	each space (to avoid ending the option value).  Also note that the
6644	"-f" is not inside the quotes, because it is not part of the command
6645	name.  Vim automagically recognizes the backslashes that are path
6646	separators.
6647	Example with escaped space (Vim will do this when initializing the
6648	option from $SHELL): >
6649		:set shell=/bin/with\\\ space/sh
6650<	The resulting value of 'shell' is "/bin/with\ space/sh", two
6651	backslashes are consumed by `:set`.
6652
6653	Under MS-Windows, when the executable ends in ".com" it must be
6654	included.  Thus setting the shell to "command.com" or "4dos.com"
6655	works, but "command" and "4dos" do not work for all commands (e.g.,
6656	filtering).
6657	For unknown reasons, when using "4dos.com" the current directory is
6658	changed to "C:\".  To avoid this set 'shell' like this: >
6659		:set shell=command.com\ /c\ 4dos
6660<	This option cannot be set from a |modeline| or in the |sandbox|, for
6661	security reasons.
6662
6663						*'shellcmdflag'* *'shcf'*
6664'shellcmdflag' 'shcf'	string	(default: "-c";
6665				 Win32, when 'shell' contains "powershell":
6666				 "-Command", or when it does not contain "sh"
6667				 somewhere: "/c")
6668			global
6669	Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6670	"bash.exe -c ls", "powershell.exe -Command dir", or "cmd.exe /c dir".
6671	For MS-Windows, the default is set according to the value of 'shell',
6672	to reduce the need to set this option by the user.
6673	On Unix it can have more than one flag.  Each white space separated
6674	part is passed as an argument to the shell command.
6675	See |option-backslash| about including spaces and backslashes.
6676	Also see |dos-shell| and |dos-powershell| for MS-Windows.
6677	This option cannot be set from a |modeline| or in the |sandbox|, for
6678	security reasons.
6679
6680						*'shellpipe'* *'sp'*
6681'shellpipe' 'sp'	string	(default ">", ">%s 2>&1", "| tee", "|& tee"
6682				 "2>&1| tee", or
6683				 "2>&1 | Out-File -Encoding default")
6684			global
6685			{not available when compiled without the |+quickfix|
6686			feature}
6687	String to be used to put the output of the ":make" command in the
6688	error file.  See also |:make_makeprg|.  See |option-backslash| about
6689	including spaces and backslashes.
6690	The name of the temporary file can be represented by "%s" if necessary
6691	(the file name is appended automatically if no %s appears in the value
6692	of this option).
6693	For the Amiga the default is ">".  For MS-Windows using powershell the
6694	default is "2>&1 | Out-File -Encoding default", otherwise the default
6695	is ">%s 2>&1".  The output is directly saved in a file and not echoed
6696	to the screen.
6697	For Unix the default is "| tee".  The stdout of the compiler is saved
6698	in a file and echoed to the screen.  If the 'shell' option is "csh" or
6699	"tcsh" after initializations, the default becomes "|& tee".  If the
6700	'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6701	"bash", "fish", "ash" or "dash" the default becomes "2>&1| tee".  This
6702	means that stderr is also included.  Before using the 'shell' option a
6703	path is removed, thus "/bin/sh" uses "sh".
6704	For Unix and MS-Windows, when the 'shell' option is "pwsh" the default
6705	becomes ">%s 2>&1" and the output is not echoed to the screen.
6706	The initialization of this option is done after reading the ".vimrc"
6707	and the other initializations, so that when the 'shell' option is set
6708	there, the 'shellpipe' option changes automatically, unless it was
6709	explicitly set before.
6710	When 'shellpipe' is set to an empty string, no redirection of the
6711	":make" output will be done.  This is useful if you use a 'makeprg'
6712	that writes to 'makeef' by itself.  If you want no piping, but do
6713	want to include the 'makeef', set 'shellpipe' to a single space.
6714	Don't forget to precede the space with a backslash: ":set sp=\ ".
6715	In the future pipes may be used for filtering and this option will
6716	become obsolete (at least for Unix).
6717	This option cannot be set from a |modeline| or in the |sandbox|, for
6718	security reasons.
6719
6720						*'shellquote'* *'shq'*
6721'shellquote' 'shq'	string	(default: "")
6722			global
6723	Quoting character(s), put around the command passed to the shell, for
6724	the "!" and ":!" commands.  The redirection is kept outside of the
6725	quoting.  See 'shellxquote' to include the redirection.  It's
6726	probably not useful to set both options.
6727	This is an empty string by default.  Only known to be useful for
6728	third-party shells on MS-Windows-like systems, such as the MKS Korn
6729	Shell or bash, where it should be "\"".  See |dos-shell|.
6730	This option cannot be set from a |modeline| or in the |sandbox|, for
6731	security reasons.
6732
6733						*'shellredir'* *'srr'*
6734'shellredir' 'srr'	string	(default ">", ">&", ">%s 2>&1", or
6735				 "2>&1 | Out-File -Encoding default")
6736			global
6737	String to be used to put the output of a filter command in a temporary
6738	file.  See also |:!|.  See |option-backslash| about including spaces
6739	and backslashes.
6740	The name of the temporary file can be represented by "%s" if necessary
6741	(the file name is appended automatically if no %s appears in the value
6742	of this option).
6743	The default is ">".  For Unix, if the 'shell' option is "csh" or
6744	"tcsh" during initializations, the default becomes ">&".  If the
6745	'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6746	"bash", "fish", or "pwsh", the default becomes ">%s 2>&1".  This means
6747	that stderr is also included.  For Win32, the Unix checks are done and
6748	additionally "cmd" is checked for, which makes the default ">%s 2>&1",
6749	and "powershell" is checked for which makes the default
6750	"2>&1 | Out-File -Encoding default" (see |dos-powershell|).  Also, the
6751	same names with ".exe" appended are checked for.
6752	The initialization of this option is done after reading the ".vimrc"
6753	and the other initializations, so that when the 'shell' option is set
6754	there, the 'shellredir' option changes automatically unless it was
6755	explicitly set before.
6756	In the future pipes may be used for filtering and this option will
6757	become obsolete (at least for Unix).
6758	This option cannot be set from a |modeline| or in the |sandbox|, for
6759	security reasons.
6760
6761			*'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6762'shellslash' 'ssl'	boolean	(default off)
6763			global
6764			{only for MS-Windows}
6765	When set, a forward slash is used when expanding file names.  This is
6766	useful when a Unix-like shell is used instead of cmd.exe, pwsh.exe, or
6767	powershell.exe.  Backward slashes can still be typed, but they are
6768	changed to forward slashes by Vim.
6769	Note that setting or resetting this option has no effect for some
6770	existing file names, thus this option needs to be set before opening
6771	any file for best results.  This might change in the future.
6772	'shellslash' only works when a backslash can be used as a path
6773	separator.  To test if this is so use: >
6774		if exists('+shellslash')
6775<	Also see 'completeslash'.
6776
6777			*'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6778'shelltemp' 'stmp'	boolean	(Vi default off, Vim default on)
6779			global
6780	When on, use temp files for shell commands.  When off use a pipe.
6781	When using a pipe is not possible temp files are used anyway.
6782	Currently a pipe is only supported on Unix and MS-Windows 2K and
6783	later.  You can check it with: >
6784		:if has("filterpipe")
6785<	The advantage of using a pipe is that nobody can read the temp file
6786	and the 'shell' command does not need to support redirection.
6787	The advantage of using a temp file is that the file type and encoding
6788	can be detected.
6789	The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6790	|FilterWritePost| autocommands event are not triggered when
6791	'shelltemp' is off.
6792	The `system()` function does not respect this option and always uses
6793	temp files.
6794	NOTE: This option is set to the Vim default value when 'compatible'
6795	is reset.
6796
6797						*'shelltype'* *'st'*
6798'shelltype' 'st'	number	(default 0)
6799			global
6800			{only for the Amiga}
6801	On the Amiga this option influences the way how the commands work
6802	which use a shell.
6803	0 and 1: always use the shell
6804	2 and 3: use the shell only to filter lines
6805	4 and 5: use shell only for ':sh' command
6806	When not using the shell, the command is executed directly.
6807
6808	0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6809	1 and 3: use "shell cmd" to start external commands
6810
6811						*'shellxescape'* *'sxe'*
6812'shellxescape' 'sxe'	string	(default: "";
6813				 for MS-Windows: "\"&|<>()@^")
6814			global
6815	When 'shellxquote' is set to "(" then the characters listed in this
6816	option will be escaped with a '^' character.  This makes it possible
6817	to execute most external commands with cmd.exe.
6818
6819						*'shellxquote'* *'sxq'*
6820'shellxquote' 'sxq'	string	(default: "";
6821					for Win32, when 'shell' is cmd.exe: "("
6822					for Win32, when 'shell' is
6823					powershell.exe: "\""
6824					for Win32, when 'shell' contains "sh"
6825					somewhere: "\""
6826					for Unix, when using system(): "\"")
6827			global
6828	Quoting character(s), put around the command passed to the shell, for
6829	the "!" and ":!" commands.  Includes the redirection.  See
6830	'shellquote' to exclude the redirection.  It's probably not useful
6831	to set both options.
6832	When the value is '(' then ')' is appended. When the value is '"('
6833	then ')"' is appended.
6834	When the value is '(' then also see 'shellxescape'.
6835	This is an empty string by default on most systems, but is known to be
6836	useful for on Win32 version, either for cmd.exe, powershell.exe, or
6837	pwsh.exe which automatically strips off the first and last quote on a
6838	command, or 3rd-party shells such as the MKS Korn Shell or bash, where
6839	it should be "\"".  The default is adjusted according the value of
6840	'shell', to reduce the need to set this option by the user.  See
6841	|dos-shell|.
6842	This option cannot be set from a |modeline| or in the |sandbox|, for
6843	security reasons.
6844
6845			*'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6846'shiftround' 'sr'	boolean	(default off)
6847			global
6848	Round indent to multiple of 'shiftwidth'.  Applies to > and <
6849	commands.  CTRL-T and CTRL-D in Insert mode always round the indent to
6850	a multiple of 'shiftwidth' (this is Vi compatible).
6851	NOTE: This option is reset when 'compatible' is set.
6852
6853						*'shiftwidth'* *'sw'*
6854'shiftwidth' 'sw'	number	(default 8)
6855			local to buffer
6856	Number of spaces to use for each step of (auto)indent.  Used for
6857	|'cindent'|, |>>|, |<<|, etc.
6858	When zero the 'ts' value will be used.  Use the |shiftwidth()|
6859	function to get the effective shiftwidth value.
6860
6861						*'shortmess'* *'shm'*
6862'shortmess' 'shm'	string	(Vim default "filnxtToOS", Vi default: "S",
6863							POSIX default: "AS")
6864			global
6865	This option helps to avoid all the |hit-enter| prompts caused by file
6866	messages, for example  with CTRL-G, and to avoid some other messages.
6867	It is a list of flags:
6868	 flag	meaning when present	~
6869	  f	use "(3 of 5)" instead of "(file 3 of 5)"
6870	  i	use "[noeol]" instead of "[Incomplete last line]"
6871	  l	use "999L, 888B" instead of "999 lines, 888 bytes"
6872	  m	use "[+]" instead of "[Modified]"
6873	  n	use "[New]" instead of "[New File]"
6874	  r	use "[RO]" instead of "[readonly]"
6875	  w	use "[w]" instead of "written" for file write message
6876		and "[a]" instead of "appended" for ':w >> file' command
6877	  x	use "[dos]" instead of "[dos format]", "[unix]" instead of
6878		"[unix format]" and "[mac]" instead of "[mac format]".
6879	  a	all of the above abbreviations
6880
6881	  o	overwrite message for writing a file with subsequent message
6882		for reading a file (useful for ":wn" or when 'autowrite' on)
6883	  O	message for reading a file overwrites any previous message.
6884		Also for quickfix message (e.g., ":cn").
6885	  s	don't give "search hit BOTTOM, continuing at TOP" or "search
6886		hit TOP, continuing at BOTTOM" messages; when using the search
6887		count do not show "W" after the count message (see S below)
6888	  t	truncate file message at the start if it is too long to fit
6889		on the command-line, "<" will appear in the left most column.
6890		Ignored in Ex mode.
6891	  T	truncate other messages in the middle if they are too long to
6892		fit on the command line.  "..." will appear in the middle.
6893		Ignored in Ex mode.
6894	  W	don't give "written" or "[w]" when writing a file
6895	  A	don't give the "ATTENTION" message when an existing swap file
6896		is found.
6897	  I	don't give the intro message when starting Vim |:intro|.
6898	  c	don't give |ins-completion-menu| messages.  For example,
6899		"-- XXX completion (YYY)", "match 1 of 2", "The only match",
6900		"Pattern not found", "Back at original", etc.
6901	  q	use "recording" instead of "recording @a"
6902	  F	don't give the file info when editing a file, like `:silent`
6903		was used for the command; note that this also affects messages
6904		from autocommands
6905	  S     do not show search count message when searching, e.g.
6906	        "[1/5]"
6907
6908	This gives you the opportunity to avoid that a change between buffers
6909	requires you to hit <Enter>, but still gives as useful a message as
6910	possible for the space available.  To get the whole message that you
6911	would have got with 'shm' empty, use ":file!"
6912	Useful values:
6913	    shm=	No abbreviation of message.
6914	    shm=a	Abbreviation, but no loss of information.
6915	    shm=at	Abbreviation, and truncate message when necessary.
6916
6917	NOTE: This option is set to the Vi default value when 'compatible' is
6918	set and to the Vim default value when 'compatible' is reset.
6919
6920				 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6921'shortname' 'sn'	boolean	(default off)
6922			local to buffer
6923	Filenames are assumed to be 8 characters plus one extension of 3
6924	characters.  Multiple dots in file names are not allowed.  When this
6925	option is on, dots in file names are replaced with underscores when
6926	adding an extension (".~" or ".swp").  This option is useful
6927	when editing files on an MS-DOS compatible filesystem, e.g., messydos
6928	or crossdos.
6929
6930						*'showbreak'* *'sbr'* *E595*
6931'showbreak' 'sbr'	string	(default "")
6932			global or local to window |global-local|
6933			{not available when compiled without the |+linebreak|
6934			feature}
6935	String to put at the start of lines that have been wrapped.  Useful
6936	values are "> " or "+++ ": >
6937		:set showbreak=>\
6938<	Note the backslash to escape the trailing space.  It's easier like
6939	this: >
6940		:let &showbreak = '+++ '
6941<	Only printable single-cell characters are allowed, excluding <Tab> and
6942	comma (in a future version the comma might be used to separate the
6943	part that is shown at the end and at the start of a line).
6944	The characters are highlighted according to the '@' flag in
6945	'highlight'.
6946	Note that tabs after the showbreak will be displayed differently.
6947	If you want the 'showbreak' to appear in between line numbers, add the
6948	"n" flag to 'cpoptions'.
6949	A window-local value overrules a global value.  If the global value is
6950	set and you want no value in the current window use NONE: >
6951		:setlocal showbreak=NONE
6952<
6953				     *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6954'showcmd' 'sc'		boolean	(Vim default: on, off for Unix,
6955				       Vi default: off, set in |defaults.vim|)
6956			global
6957			{not available when compiled without the
6958			|+cmdline_info| feature}
6959	Show (partial) command in the last line of the screen.  Set this
6960	option off if your terminal is slow.
6961	In Visual mode the size of the selected area is shown:
6962	- When selecting characters within a line, the number of characters.
6963	  If the number of bytes is different it is also displayed: "2-6"
6964	  means two characters and six bytes.
6965	- When selecting more than one line, the number of lines.
6966	- When selecting a block, the size in screen characters:
6967	  {lines}x{columns}.
6968	NOTE: This option is set to the Vi default value when 'compatible' is
6969	set and to the Vim default value when 'compatible' is reset.
6970
6971			*'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6972'showfulltag' 'sft'	boolean (default off)
6973			global
6974	When completing a word in insert mode (see |ins-completion|) from the
6975	tags file, show both the tag name and a tidied-up form of the search
6976	pattern (if there is one) as possible matches.  Thus, if you have
6977	matched a C function, you can see a template for what arguments are
6978	required (coding style permitting).
6979	Note that this doesn't work well together with having "longest" in
6980	'completeopt', because the completion from the search pattern may not
6981	match the typed text.
6982
6983				 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6984'showmatch' 'sm'	boolean	(default off)
6985			global
6986	When a bracket is inserted, briefly jump to the matching one.  The
6987	jump is only done if the match can be seen on the screen.  The time to
6988	show the match can be set with 'matchtime'.
6989	A Beep is given if there is no match (no matter if the match can be
6990	seen or not).
6991	This option is reset when 'paste' is set and restored when 'paste' is
6992	reset.
6993	When the 'm' flag is not included in 'cpoptions', typing a character
6994	will immediately move the cursor back to where it belongs.
6995	See the "sm" field in 'guicursor' for setting the cursor shape and
6996	blinking when showing the match.
6997	The 'matchpairs' option can be used to specify the characters to show
6998	matches for.  'rightleft' and 'revins' are used to look for opposite
6999	matches.
7000	Also see the matchparen plugin for highlighting the match when moving
7001	around |pi_paren.txt|.
7002	Note: Use of the short form is rated PG.
7003
7004				 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7005'showmode' 'smd'	boolean	(Vim default: on, Vi default: off)
7006			global
7007	If in Insert, Replace or Visual mode put a message on the last line.
7008	Use the 'M' flag in 'highlight' to set the type of highlighting for
7009	this message.
7010	When |XIM| may be used the message will include "XIM".  But this
7011	doesn't mean XIM is really active, especially when 'imactivatekey' is
7012	not set.
7013	NOTE: This option is set to the Vi default value when 'compatible' is
7014	set and to the Vim default value when 'compatible' is reset.
7015
7016						*'showtabline'* *'stal'*
7017'showtabline' 'stal'	number	(default 1)
7018			global
7019	The value of this option specifies when the line with tab page labels
7020	will be displayed:
7021		0: never
7022		1: only if there are at least two tab pages
7023		2: always
7024	This is both for the GUI and non-GUI implementation of the tab pages
7025	line.
7026	See |tab-page| for more information about tab pages.
7027
7028						*'sidescroll'* *'ss'*
7029'sidescroll' 'ss'	number	(default 0)
7030			global
7031	The minimal number of columns to scroll horizontally.  Used only when
7032	the 'wrap' option is off and the cursor is moved off of the screen.
7033	When it is zero the cursor will be put in the middle of the screen.
7034	When using a slow terminal set it to a large number or 0.  When using
7035	a fast terminal use a small number or 1.  Not used for "zh" and "zl"
7036	commands.
7037
7038						*'sidescrolloff'* *'siso'*
7039'sidescrolloff' 'siso'	number (default 0)
7040			global or local to window |global-local|
7041	The minimal number of screen columns to keep to the left and to the
7042	right of the cursor if 'nowrap' is set.  Setting this option to a
7043	value greater than 0 while having |'sidescroll'| also at a non-zero
7044	value makes some context visible in the line you are scrolling in
7045	horizontally (except at beginning of the line).  Setting this option
7046	to a large value (like 999) has the effect of keeping the cursor
7047	horizontally centered in the window, as long as one does not come too
7048	close to the beginning of the line.
7049	After using the local value, go back the global value with one of
7050	these two: >
7051		setlocal sidescrolloff<
7052		setlocal sidescrolloff=-1
7053<	NOTE: This option is set to 0 when 'compatible' is set.
7054
7055	Example: Try this together with 'sidescroll' and 'listchars' as
7056		 in the following example to never allow the cursor to move
7057		 onto the "extends" character: >
7058
7059		 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7060		 :set sidescrolloff=1
7061<
7062						*'signcolumn'* *'scl'*
7063'signcolumn' 'scl'	string	(default "auto")
7064			local to window
7065			{not available when compiled without the |+signs|
7066			feature}
7067	Whether or not to draw the signcolumn. Valid values are:
7068	   "auto"   	only when there is a sign to display
7069	   "no"	    	never
7070	   "yes"    	always
7071	   "number"	display signs in the 'number' column. If the number
7072			column is not present, then behaves like "auto".
7073
7074
7075			*'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7076'smartcase' 'scs'	boolean	(default off)
7077			global
7078	Override the 'ignorecase' option if the search pattern contains upper
7079	case characters.  Only used when the search pattern is typed and
7080	'ignorecase' option is on.  Used for the commands "/", "?", "n", "N",
7081	":g" and ":s".  Not used for "*", "#", "gd", tag search, etc.  After
7082	"*" and "#" you can make 'smartcase' used by doing a "/" command,
7083	recalling the search pattern from history and hitting <Enter>.
7084	NOTE: This option is reset when 'compatible' is set.
7085
7086			     *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7087'smartindent' 'si'	boolean	(default off)
7088			local to buffer
7089			{not available when compiled without the
7090			|+smartindent| feature}
7091	Do smart autoindenting when starting a new line.  Works for C-like
7092	programs, but can also be used for other languages.  'cindent' does
7093	something like this, works better in most cases, but is more strict,
7094	see |C-indenting|.  When 'cindent' is on or 'indentexpr' is set,
7095	setting 'si' has no effect.  'indentexpr' is a more advanced
7096	alternative.
7097	Normally 'autoindent' should also be on when using 'smartindent'.
7098	An indent is automatically inserted:
7099	- After a line ending in '{'.
7100	- After a line starting with a keyword from 'cinwords'.
7101	- Before a line starting with '}' (only with the "O" command).
7102	When typing '}' as the first character in a new line, that line is
7103	given the same indent as the matching '{'.
7104	When typing '#' as the first character in a new line, the indent for
7105	that line is removed, the '#' is put in the first column.  The indent
7106	is restored for the next line.  If you don't want this, use this
7107	mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7108	When using the ">>" command, lines starting with '#' are not shifted
7109	right.
7110	NOTE: This option is reset when 'compatible' is set.
7111	This option is reset when 'paste' is set and restored when 'paste' is
7112	reset.
7113
7114				 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7115'smarttab' 'sta'	boolean	(default off)
7116			global
7117	When on, a <Tab> in front of a line inserts blanks according to
7118	'shiftwidth'.  'tabstop' or 'softtabstop' is used in other places.  A
7119	<BS> will delete a 'shiftwidth' worth of space at the start of the
7120	line.
7121	When off, a <Tab> always inserts blanks according to 'tabstop' or
7122	'softtabstop'.  'shiftwidth' is only used for shifting text left or
7123	right |shift-left-right|.
7124	What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
7125	option.  Also see |ins-expandtab|.  When 'expandtab' is not set, the
7126	number of spaces is minimized by using <Tab>s.
7127	This option is reset when 'paste' is set and restored when 'paste' is
7128	reset.
7129	NOTE: This option is reset when 'compatible' is set.
7130
7131					*'softtabstop'* *'sts'*
7132'softtabstop' 'sts'	number	(default 0)
7133			local to buffer
7134	Number of spaces that a <Tab> counts for while performing editing
7135	operations, like inserting a <Tab> or using <BS>.  It "feels" like
7136	<Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7137	used.  This is useful to keep the 'ts' setting at its standard value
7138	of 8, while being able to edit like it is set to 'sts'.  However,
7139	commands like "x" still work on the actual characters.
7140	When 'sts' is zero, this feature is off.
7141	When 'sts' is negative, the value of 'shiftwidth' is used.
7142	'softtabstop' is set to 0 when the 'paste' option is set and restored
7143	when 'paste' is reset.
7144	See also |ins-expandtab|.  When 'expandtab' is not set, the number of
7145	spaces is minimized by using <Tab>s.
7146	The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7147	set.
7148	NOTE: This option is set to 0 when 'compatible' is set.
7149
7150	If Vim is compiled with the |+vartabs| feature then the value of
7151	'softtabstop' will be ignored if |'varsofttabstop'| is set to
7152	anything other than an empty string.
7153
7154						*'spell'* *'nospell'*
7155'spell'			boolean	(default off)
7156			local to window
7157			{not available when compiled without the |+syntax|
7158			feature}
7159	When on spell checking will be done.  See |spell|.
7160	The languages are specified with 'spelllang'.
7161
7162						*'spellcapcheck'* *'spc'*
7163'spellcapcheck' 'spc'	string	(default "[.?!]\_[\])'" \t]\+")
7164			local to buffer
7165			{not available when compiled without the |+syntax|
7166			feature}
7167	Pattern to locate the end of a sentence.  The following word will be
7168	checked to start with a capital letter.  If not then it is highlighted
7169	with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
7170	When this check is not wanted make this option empty.
7171	Only used when 'spell' is set.
7172	Be careful with special characters, see |option-backslash| about
7173	including spaces and backslashes.
7174	To set this option automatically depending on the language, see
7175	|set-spc-auto|.
7176
7177						*'spellfile'* *'spf'*
7178'spellfile' 'spf'	string	(default empty)
7179			local to buffer
7180			{not available when compiled without the |+syntax|
7181			feature}
7182	Name of the word list file where words are added for the |zg| and |zw|
7183	commands.  It must end in ".{encoding}.add".  You need to include the
7184	path, otherwise the file is placed in the current directory.
7185								*E765*
7186	It may also be a comma separated list of names.  A count before the
7187	|zg| and |zw| commands can be used to access each.  This allows using
7188	a personal word list file and a project word list file.
7189	When a word is added while this option is empty Vim will set it for
7190	you: Using the first directory in 'runtimepath' that is writable.  If
7191	there is no "spell" directory yet it will be created.  For the file
7192	name the first language name that appears in 'spelllang' is used,
7193	ignoring the region.
7194	The resulting ".spl" file will be used for spell checking, it does not
7195	have to appear in 'spelllang'.
7196	Normally one file is used for all regions, but you can add the region
7197	name if you want to.  However, it will then only be used when
7198	'spellfile' is set to it, for entries in 'spelllang' only files
7199	without region name will be found.
7200	This option cannot be set from a |modeline| or in the |sandbox|, for
7201	security reasons.
7202
7203						*'spelllang'* *'spl'*
7204'spelllang' 'spl'	string	(default "en")
7205			local to buffer
7206			{not available when compiled without the |+syntax|
7207			feature}
7208	A comma separated list of word list names.  When the 'spell' option is
7209	on spellchecking will be done for these languages.  Example: >
7210		set spelllang=en_us,nl,medical
7211<	This means US English, Dutch and medical words are recognized.  Words
7212	that are not recognized will be highlighted.
7213	The word list name must consist of alphanumeric characters, a dash or
7214	an underscore.  It should not include a comma or dot.  Using a dash is
7215	recommended to separate the two letter language name from a
7216	specification.  Thus "en-rare" is used for rare English words.
7217	A region name must come last and have the form "_xx", where "xx" is
7218	the two-letter, lower case region name.  You can use more than one
7219	region by listing them: "en_us,en_ca" supports both US and Canadian
7220	English, but not words specific for Australia, New Zealand or Great
7221	Britain. (Note: currently en_au and en_nz dictionaries are older than
7222	en_ca, en_gb and en_us).
7223	If the name "cjk" is included East Asian characters are excluded from
7224	spell checking.  This is useful when editing text that also has Asian
7225	words.
7226	Note that the "medical" dictionary does not exist, it is just an
7227	example of a longer name.
7228							*E757*
7229	As a special case the name of a .spl file can be given as-is.  The
7230	first "_xx" in the name is removed and used as the region name
7231	(_xx is an underscore, two letters and followed by a non-letter).
7232	This is mainly for testing purposes.  You must make sure the correct
7233	encoding is used, Vim doesn't check it.
7234	When 'encoding' is set the word lists are reloaded.  Thus it's a good
7235	idea to set 'spelllang' after setting 'encoding' to avoid loading the
7236	files twice.
7237	How the related spell files are found is explained here: |spell-load|.
7238
7239	If the |spellfile.vim| plugin is active and you use a language name
7240	for which Vim cannot find the .spl file in 'runtimepath' the plugin
7241	will ask you if you want to download the file.
7242
7243	After this option has been set successfully, Vim will source the files
7244	"spell/LANG.vim" in 'runtimepath'.  "LANG" is the value of 'spelllang'
7245	up to the first character that is not an ASCII letter or number and
7246	not a dash.  Also see |set-spc-auto|.
7247
7248						*'spelloptions'* *'spo'*
7249'spelloptions' 'spo'	string	(default "")
7250			local to buffer
7251			{not available when compiled without the |+syntax|
7252			feature}
7253	A comma separated list of options for spell checking:
7254	   camel	When a word is CamelCased, assume "Cased" is a
7255			separate word: every upper-case character in a word
7256			that comes after a lower case character indicates the
7257			start of a new word.
7258
7259						*'spellsuggest'* *'sps'*
7260'spellsuggest' 'sps'	string	(default "best")
7261			global
7262			{not available when compiled without the |+syntax|
7263			feature}
7264	Methods used for spelling suggestions.  Both for the |z=| command and
7265	the |spellsuggest()| function.  This is a comma-separated list of
7266	items:
7267
7268	best		Internal method that works best for English.  Finds
7269			changes like "fast" and uses a bit of sound-a-like
7270			scoring to improve the ordering.
7271
7272	double		Internal method that uses two methods and mixes the
7273			results.  The first method is "fast", the other method
7274			computes how much the suggestion sounds like the bad
7275			word.  That only works when the language specifies
7276			sound folding.  Can be slow and doesn't always give
7277			better results.
7278
7279	fast		Internal method that only checks for simple changes:
7280			character inserts/deletes/swaps.  Works well for
7281			simple typing mistakes.
7282
7283	{number}	The maximum number of suggestions listed for |z=|.
7284			Not used for |spellsuggest()|.  The number of
7285			suggestions is never more than the value of 'lines'
7286			minus two.
7287
7288	file:{filename} Read file {filename}, which must have two columns,
7289			separated by a slash.  The first column contains the
7290			bad word, the second column the suggested good word.
7291			Example:
7292				theribal/terrible ~
7293			Use this for common mistakes that do not appear at the
7294			top of the suggestion list with the internal methods.
7295			Lines without a slash are ignored, use this for
7296			comments.
7297			The word in the second column must be correct,
7298			otherwise it will not be used.  Add the word to an
7299			".add" file if it is currently flagged as a spelling
7300			mistake.
7301			The file is used for all languages.
7302
7303	expr:{expr}	Evaluate expression {expr}.  Use a function to avoid
7304			trouble with spaces.  |v:val| holds the badly spelled
7305			word.  The expression must evaluate to a List of
7306			Lists, each with a suggestion and a score.
7307			Example:
7308				[['the', 33], ['that', 44]] ~
7309			Set 'verbose' and use |z=| to see the scores that the
7310			internal methods use.  A lower score is better.
7311			This may invoke |spellsuggest()| if you temporarily
7312			set 'spellsuggest' to exclude the "expr:" part.
7313			Errors are silently ignored, unless you set the
7314			'verbose' option to a non-zero value.
7315
7316	Only one of "best", "double" or "fast" may be used.  The others may
7317	appear several times in any order.  Example: >
7318		:set sps=file:~/.vim/sugg,best,expr:MySuggest()
7319<
7320	This option cannot be set from a |modeline| or in the |sandbox|, for
7321	security reasons.
7322
7323
7324			*'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7325'splitbelow' 'sb'	boolean	(default off)
7326			global
7327	When on, splitting a window will put the new window below the current
7328	one. |:split|
7329
7330			*'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7331'splitright' 'spr'	boolean	(default off)
7332			global
7333	When on, splitting a window will put the new window right of the
7334	current one. |:vsplit|
7335
7336			   *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7337'startofline' 'sol'	boolean	(default on)
7338			global
7339	When "on" the commands listed below move the cursor to the first
7340	non-blank of the line.  When off the cursor is kept in the same column
7341	(if possible).  This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
7342	CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
7343	with a linewise operator, with "%" with a count and to buffer changing
7344	commands (CTRL-^, :bnext, :bNext, etc.).  Also for an Ex command that
7345	only has a line number, e.g., ":25" or ":+".
7346	In case of buffer changing commands the cursor is placed at the column
7347	where it was the last time the buffer was edited.
7348	NOTE: This option is set when 'compatible' is set.
7349
7350			   *'statusline'* *'stl'* *E540* *E542*
7351'statusline' 'stl'	string	(default empty)
7352			global or local to window |global-local|
7353			{not available when compiled without the |+statusline|
7354			feature}
7355	When nonempty, this option determines the content of the status line.
7356	Also see |status-line|.
7357
7358	The option consists of printf style '%' items interspersed with
7359	normal text.  Each status line item is of the form:
7360	  %-0{minwid}.{maxwid}{item}
7361	All fields except the {item} are optional.  A single percent sign can
7362	be given as "%%".
7363
7364	When the option starts with "%!" then it is used as an expression,
7365	evaluated and the result is used as the option value.  Example: >
7366		:set statusline=%!MyStatusLine()
7367<	The *g:statusline_winid* variable will be set to the |window-ID| of the
7368	window that the status line belongs to.
7369	The result can contain %{} items that will be evaluated too.
7370	Note that the "%!" expression is evaluated in the context of the
7371	current window and buffer, while %{} items are evaluated in the
7372	context of the window that the statusline belongs to.
7373
7374	When there is error while evaluating the option then it will be made
7375	empty to avoid further errors.  Otherwise screen updating would loop.
7376
7377	Note that the only effect of 'ruler' when this option is set (and
7378	'laststatus' is 2) is controlling the output of |CTRL-G|.
7379
7380	field	    meaning ~
7381	-	    Left justify the item.  The default is right justified
7382		    when minwid is larger than the length of the item.
7383	0	    Leading zeroes in numeric items.  Overridden by '-'.
7384	minwid	    Minimum width of the item, padding as set by '-' & '0'.
7385		    Value must be 50 or less.
7386	maxwid	    Maximum width of the item.  Truncation occurs with a '<'
7387		    on the left for text items.  Numeric items will be
7388		    shifted down to maxwid-2 digits followed by '>'number
7389		    where number is the amount of missing digits, much like
7390		    an exponential notation.
7391	item	    A one letter code as described below.
7392
7393	Following is a description of the possible statusline items.  The
7394	second character in "item" is the type:
7395		N for number
7396		S for string
7397		F for flags as described below
7398		- not applicable
7399
7400	item  meaning ~
7401	f S   Path to the file in the buffer, as typed or relative to current
7402	      directory.
7403	F S   Full path to the file in the buffer.
7404	t S   File name (tail) of file in the buffer.
7405	m F   Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
7406	M F   Modified flag, text is ",+" or ",-".
7407	r F   Readonly flag, text is "[RO]".
7408	R F   Readonly flag, text is ",RO".
7409	h F   Help buffer flag, text is "[help]".
7410	H F   Help buffer flag, text is ",HLP".
7411	w F   Preview window flag, text is "[Preview]".
7412	W F   Preview window flag, text is ",PRV".
7413	y F   Type of file in the buffer, e.g., "[vim]".  See 'filetype'.
7414	Y F   Type of file in the buffer, e.g., ",VIM".  See 'filetype'.
7415	q S   "[Quickfix List]", "[Location List]" or empty.
7416	k S   Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7417	      being used: "<keymap>"
7418	n N   Buffer number.
7419	b N   Value of character under cursor.
7420	B N   As above, in hexadecimal.
7421	o N   Byte number in file of byte under cursor, first byte is 1.
7422	      Mnemonic: Offset from start of file (with one added)
7423	      {not available when compiled without |+byte_offset| feature}
7424	O N   As above, in hexadecimal.
7425	N N   Printer page number.  (Only works in the 'printheader' option.)
7426	l N   Line number.
7427	L N   Number of lines in buffer.
7428	c N   Column number (byte index).
7429	v N   Virtual column number (screen column).
7430	V N   Virtual column number as -{num}.  Not displayed if equal to 'c'.
7431	p N   Percentage through file in lines as in |CTRL-G|.
7432	P S   Percentage through file of displayed window.  This is like the
7433	      percentage described for 'ruler'.  Always 3 in length, unless
7434	      translated.
7435	a S   Argument list status as in default title.  ({current} of {max})
7436	      Empty if the argument file count is zero or one.
7437	{ NF  Evaluate expression between '%{' and '}' and substitute result.
7438	      Note that there is no '%' before the closing '}'.  The
7439	      expression cannot contain a '}' character, call a function to
7440	      work around that.  See |stl-%{| below.
7441	{% -  This is almost same as { except the result of the expression is
7442	      re-evaluated as a statusline format string.  Thus if the
7443	      return value of expr contains % items they will get expanded.
7444	      The expression can contain the } character, the end of
7445	      expression is denoted by %}.
7446	      For example: >
7447		func! Stl_filename() abort
7448		    return "%t"
7449		endfunc
7450<	        `stl=%{Stl_filename()}`   results in `"%t"`
7451	        `stl=%{%Stl_filename()%}` results in `"Name of current file"`
7452	%} -  End of `{%` expression
7453	( -   Start of item group.  Can be used for setting the width and
7454	      alignment of a section.  Must be followed by %) somewhere.
7455	) -   End of item group.  No width fields allowed.
7456	T N   For 'tabline': start of tab page N label.  Use %T after the last
7457	      label.  This information is used for mouse clicks.
7458	X N   For 'tabline': start of close tab N label.  Use %X after the
7459	      label, e.g.: %3Xclose%X.  Use %999X for a "close current tab"
7460	      mark.  This information is used for mouse clicks.
7461	< -   Where to truncate line if too long.  Default is at the start.
7462	      No width fields allowed.
7463	= -   Separation point between left and right aligned items.
7464	      No width fields allowed.
7465	# -   Set highlight group.  The name must follow and then a # again.
7466	      Thus use %#HLname# for highlight group HLname.  The same
7467	      highlighting is used, also for the statusline of non-current
7468	      windows.
7469	* -   Set highlight group to User{N}, where {N} is taken from the
7470	      minwid field, e.g. %1*.  Restore normal highlight with %* or %0*.
7471	      The difference between User{N} and StatusLine  will be applied
7472	      to StatusLineNC for the statusline of non-current windows.
7473	      The number N must be between 1 and 9.  See |hl-User1..9|
7474
7475	When displaying a flag, Vim removes the leading comma, if any, when
7476	that flag comes right after plaintext.  This will make a nice display
7477	when flags are used like in the examples below.
7478
7479	When all items in a group becomes an empty string (i.e. flags that are
7480	not set) and a minwid is not set for the group, the whole group will
7481	become empty.  This will make a group like the following disappear
7482	completely from the statusline when none of the flags are set. >
7483		:set statusline=...%(\ [%M%R%H]%)...
7484<	Beware that an expression is evaluated each and every time the status
7485	line is displayed.
7486				*stl-%{* *g:actual_curbuf* *g:actual_curwin*
7487	While evaluating %{} the current buffer and current window will be set
7488	temporarily to that of the window (and buffer) whose statusline is
7489	currently being drawn.  The expression will evaluate in this context.
7490	The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7491	real current buffer and "g:actual_curwin" to the |window-ID| of the
7492	real current window.  These values are strings.
7493
7494	The 'statusline' option will be evaluated in the |sandbox| if set from
7495	a modeline, see |sandbox-option|.
7496	This option cannot be set in a modeline when 'modelineexpr' is off.
7497
7498	It is not allowed to change text or jump to another window while
7499	evaluating 'statusline' |textlock|.
7500
7501	If the statusline is not updated when you want it (e.g., after setting
7502	a variable that's used in an expression), you can force an update by
7503	setting an option without changing its value.  Example: >
7504		:let &ro = &ro
7505
7506<	A result of all digits is regarded a number for display purposes.
7507	Otherwise the result is taken as flag text and applied to the rules
7508	described above.
7509
7510	Watch out for errors in expressions.  They may render Vim unusable!
7511	If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7512	edit your .vimrc or whatever with "vim --clean" to get it right.
7513
7514	Examples:
7515	Emulate standard status line with 'ruler' set >
7516	  :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7517<	Similar, but add ASCII value of char under the cursor (like "ga") >
7518	  :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7519<	Display byte count and byte value, modified flag in red. >
7520	  :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7521	  :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7522<	Display a ,GZ flag if a compressed file is loaded >
7523	  :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7524<	In the |:autocmd|'s: >
7525	  :let b:gzflag = 1
7526<	And: >
7527	  :unlet b:gzflag
7528<	And define this function: >
7529	  :function VarExists(var, val)
7530	  :    if exists(a:var) | return a:val | else | return '' | endif
7531	  :endfunction
7532<
7533						*'suffixes'* *'su'*
7534'suffixes' 'su'		string	(default ".bak,~,.o,.h,.info,.swp,.obj")
7535			global
7536	Files with these suffixes get a lower priority when multiple files
7537	match a wildcard.  See |suffixes|.  Commas can be used to separate the
7538	suffixes.  Spaces after the comma are ignored.  A dot is also seen as
7539	the start of a suffix.  To avoid a dot or comma being recognized as a
7540	separator, precede it with a backslash (see |option-backslash| about
7541	including spaces and backslashes).
7542	See 'wildignore' for completely ignoring files.
7543	The use of |:set+=| and |:set-=| is preferred when adding or removing
7544	suffixes from the list.  This avoids problems when a future version
7545	uses another default.
7546
7547						*'suffixesadd'* *'sua'*
7548'suffixesadd' 'sua'	string	(default "")
7549			local to buffer
7550			{not available when compiled without the
7551			|+file_in_path| feature}
7552	Comma separated list of suffixes, which are used when searching for a
7553	file for the "gf", "[I", etc. commands.  Example: >
7554		:set suffixesadd=.java
7555<
7556				*'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7557'swapfile' 'swf'	boolean (default on)
7558			local to buffer
7559	Use a swapfile for the buffer.  This option can be reset when a
7560	swapfile is not wanted for a specific buffer.  For example, with
7561	confidential information that even root must not be able to access.
7562	Careful: All text will be in memory:
7563		- Don't use this for big files.
7564		- Recovery will be impossible!
7565	A swapfile will only be present when |'updatecount'| is non-zero and
7566	'swapfile' is set.
7567	When 'swapfile' is reset, the swap file for the current buffer is
7568	immediately deleted.  When 'swapfile' is set, and 'updatecount' is
7569	non-zero, a swap file is immediately created.
7570	Also see |swap-file| and |'swapsync'|.
7571	If you want to open a new buffer without creating a swap file for it,
7572	use the |:noswapfile| modifier.
7573	See 'directory' for where the swap file is created.
7574
7575	This option is used together with 'bufhidden' and 'buftype' to
7576	specify special kinds of buffers.   See |special-buffers|.
7577
7578						*'swapsync'* *'sws'*
7579'swapsync' 'sws'	string	(default "fsync")
7580			global
7581	When this option is not empty a swap file is synced to disk after
7582	writing to it.  This takes some time, especially on busy unix systems.
7583	When this option is empty parts of the swap file may be in memory and
7584	not written to disk.  When the system crashes you may lose more work.
7585	On Unix the system does a sync now and then without Vim asking for it,
7586	so the disadvantage of setting this option off is small.  On some
7587	systems the swap file will not be written at all.  For a unix system
7588	setting it to "sync" will use the sync() call instead of the default
7589	fsync(), which may work better on some systems.
7590	The 'fsync' option is used for the actual file.
7591
7592						*'switchbuf'* *'swb'*
7593'switchbuf' 'swb'	string	(default "")
7594			global
7595	This option controls the behavior when switching between buffers.
7596	Mostly for |quickfix| commands some values are also used for other
7597	commands, as mentioned below.
7598	Possible values (comma separated list):
7599	   useopen	If included, jump to the first open window that
7600			contains the specified buffer (if there is one).
7601			Otherwise: Do not examine other windows.
7602			This setting is checked with |quickfix| commands, when
7603			jumping to errors (":cc", ":cn", "cp", etc.).  It is
7604			also used in all buffer related split commands, for
7605			example ":sbuffer", ":sbnext", or ":sbrewind".
7606	   usetab	Like "useopen", but also consider windows in other tab
7607			pages.
7608	   split	If included, split the current window before loading
7609			a buffer for a |quickfix| command that display errors.
7610			Otherwise: do not split, use current window (when used
7611			in the quickfix window: the previously used window or
7612			split if there is no other window).
7613	   vsplit	Just like "split" but split vertically.
7614	   newtab	Like "split", but open a new tab page.  Overrules
7615			"split" when both are present.
7616	   uselast	If included, jump to the previously used window when
7617			jumping to errors with |quickfix| commands.
7618
7619						*'synmaxcol'* *'smc'*
7620'synmaxcol' 'smc'	number	(default 3000)
7621			local to buffer
7622			{not available when compiled without the |+syntax|
7623			feature}
7624	Maximum column in which to search for syntax items.  In long lines the
7625	text after this column is not highlighted and following lines may not
7626	be highlighted correctly, because the syntax state is cleared.
7627	This helps to avoid very slow redrawing for an XML file that is one
7628	long line.
7629	Set to zero to remove the limit.
7630
7631						*'syntax'* *'syn'*
7632'syntax' 'syn'		string	(default empty)
7633			local to buffer
7634			{not available when compiled without the |+syntax|
7635			feature}
7636	When this option is set, the syntax with this name is loaded, unless
7637	syntax highlighting has been switched off with ":syntax off".
7638	Otherwise this option does not always reflect the current syntax (the
7639	b:current_syntax variable does).
7640	This option is most useful in a modeline, for a file which syntax is
7641	not automatically recognized.  Example, in an IDL file:
7642		/* vim: set syntax=idl : */ ~
7643	When a dot appears in the value then this separates two filetype
7644	names.  Example:
7645		/* vim: set syntax=c.doxygen : */ ~
7646	This will use the "c" syntax first, then the "doxygen" syntax.
7647	Note that the second one must be prepared to be loaded as an addition,
7648	otherwise it will be skipped.  More than one dot may appear.
7649	To switch off syntax highlighting for the current file, use: >
7650		:set syntax=OFF
7651<	To switch syntax highlighting on according to the current value of the
7652	'filetype' option: >
7653		:set syntax=ON
7654<	What actually happens when setting the 'syntax' option is that the
7655	Syntax autocommand event is triggered with the value as argument.
7656	This option is not copied to another buffer, independent of the 's' or
7657	'S' flag in 'cpoptions'.
7658	Only normal file name characters can be used, "/\*?[|<>" are illegal.
7659
7660						*'tabline'* *'tal'*
7661'tabline' 'tal'		string	(default empty)
7662			global
7663	When nonempty, this option determines the content of the tab pages
7664	line at the top of the Vim window.  When empty Vim will use a default
7665	tab pages line.  See |setting-tabline| for more info.
7666
7667	The tab pages line only appears as specified with the 'showtabline'
7668	option and only when there is no GUI tab line.  When 'e' is in
7669	'guioptions' and the GUI supports a tab line 'guitablabel' is used
7670	instead.  Note that the two tab pages lines are very different.
7671
7672	The value is evaluated like with 'statusline'.  You can use
7673	|tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
7674	the text to be displayed.  Use "%1T" for the first label, "%2T" for
7675	the second one, etc.  Use "%X" items for closing labels.
7676
7677	When changing something that is used in 'tabline' that does not
7678	trigger it to be updated, use |:redrawtabline|.
7679	This option cannot be set in a modeline when 'modelineexpr' is off.
7680
7681	Keep in mind that only one of the tab pages is the current one, others
7682	are invisible and you can't jump to their windows.
7683
7684
7685						*'tabpagemax'* *'tpm'*
7686'tabpagemax' 'tpm'	number	(default 10)
7687			global
7688	Maximum number of tab pages to be opened by the |-p| command line
7689	argument or the ":tab all" command. |tabpage|
7690
7691
7692						*'tabstop'* *'ts'*
7693'tabstop' 'ts'		number	(default 8)
7694			local to buffer
7695	Number of spaces that a <Tab> in the file counts for.  Also see
7696	|:retab| command, and 'softtabstop' option.
7697
7698	Note: Setting 'tabstop' to any other value than 8 can make your file
7699	appear wrong in many places (e.g., when printing it).
7700
7701	There are four main ways to use tabs in Vim:
7702	1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7703	   (or 3 or whatever you prefer) and use 'noexpandtab'.  Then Vim
7704	   will use a mix of tabs and spaces, but typing <Tab> and <BS> will
7705	   behave like a tab appears every 4 (or 3) characters.
7706	2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7707	   'expandtab'.  This way you will always insert spaces.  The
7708	   formatting will never be messed up when 'tabstop' is changed.
7709	3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
7710	   |modeline| to set these values when editing the file again.  Only
7711	   works when using Vim to edit the file.
7712	4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7713	   'noexpandtab'.  This should then work (for initial indents only)
7714	   for any tabstop setting that people use.  It might be nice to have
7715	   tabs after the first non-blank inserted as spaces if you do this
7716	   though.  Otherwise aligned comments will be wrong when 'tabstop' is
7717	   changed.
7718
7719	If Vim is compiled with the |+vartabs| feature then the value of
7720	'tabstop' will be ignored if |'vartabstop'| is set to anything other
7721	than an empty string.
7722
7723			*'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7724'tagbsearch' 'tbs'	boolean	(default on)
7725			global
7726	When searching for a tag (e.g., for the |:ta| command), Vim can either
7727	use a binary search or a linear search in a tags file.  Binary
7728	searching makes searching for a tag a LOT faster, but a linear search
7729	will find more tags if the tags file wasn't properly sorted.
7730	Vim normally assumes that your tags files are sorted, or indicate that
7731	they are not sorted.  Only when this is not the case does the
7732	'tagbsearch' option need to be switched off.
7733
7734	When 'tagbsearch' is on, binary searching is first used in the tags
7735	files.  In certain situations, Vim will do a linear search instead for
7736	certain files, or retry all files with a linear search.  When
7737	'tagbsearch' is off, only a linear search is done.
7738
7739	Linear searching is done anyway, for one file, when Vim finds a line
7740	at the start of the file indicating that it's not sorted: >
7741   !_TAG_FILE_SORTED	0	/some comment/
7742<	[The whitespace before and after the '0' must be a single <Tab>]
7743
7744	When a binary search was done and no match was found in any of the
7745	files listed in 'tags', and case is ignored or a pattern is used
7746	instead of a normal tag name, a retry is done with a linear search.
7747	Tags in unsorted tags files, and matches with different case will only
7748	be found in the retry.
7749
7750	If a tag file indicates that it is case-fold sorted, the second,
7751	linear search can be avoided when case is ignored.  Use a value of '2'
7752	in the "!_TAG_FILE_SORTED" line for this.  A tag file can be case-fold
7753	sorted with the -f switch to "sort" in most unices, as in the command:
7754	"sort -f -o tags tags".  For "Exuberant ctags" version 5.x or higher
7755	(at least 5.5) the --sort=foldcase switch can be used for this as
7756	well.  Note that case must be folded to uppercase for this to work.
7757
7758	By default, tag searches are case-sensitive.  Case is ignored when
7759	'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7760	"ignore".
7761	Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7762	'tagcase' is "smart", and the pattern contains only lowercase
7763	characters.
7764
7765	When 'tagbsearch' is off, tags searching is slower when a full match
7766	exists, but faster when no full match exists.  Tags in unsorted tags
7767	files may only be found with 'tagbsearch' off.
7768	When the tags file is not sorted, or sorted in a wrong way (not on
7769	ASCII byte value), 'tagbsearch' should be off, or the line given above
7770	must be included in the tags file.
7771	This option doesn't affect commands that find all matching tags (e.g.,
7772	command-line completion and ":help").
7773
7774							*'tagcase'* *'tc'*
7775'tagcase' 'tc'		string	(default "followic")
7776			global or local to buffer |global-local|
7777	This option specifies how case is handled when searching the tags
7778	file:
7779	   followic	Follow the 'ignorecase' option
7780	   followscs    Follow the 'smartcase' and 'ignorecase' options
7781	   ignore	Ignore case
7782	   match	Match case
7783	   smart	Ignore case unless an upper case letter is used
7784	NOTE: This option is set to the Vi default value when 'compatible' is
7785	set and to the Vim default value when 'compatible' is reset.
7786
7787							*'tagfunc'* *'tfu'*
7788'tagfunc' 'tfu'		string	(default: empty)
7789			local to buffer
7790			{not available when compiled without the |+eval|
7791			feature}
7792	This option specifies a function to be used to perform tag searches.
7793	The function gets the tag pattern and should return a List of matching
7794	tags.  See |tag-function| for an explanation of how to write the
7795	function and an example.
7796
7797						*'taglength'* *'tl'*
7798'taglength' 'tl'	number	(default 0)
7799			global
7800	If non-zero, tags are significant up to this number of characters.
7801
7802			*'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7803'tagrelative' 'tr'	boolean	(Vim default: on, Vi default: off)
7804			global
7805	If on and using a tags file in another directory, file names in that
7806	tags file are relative to the directory where the tags file is.
7807	NOTE: This option is set to the Vi default value when 'compatible' is
7808	set and to the Vim default value when 'compatible' is reset.
7809
7810						*'tags'* *'tag'* *E433*
7811'tags' 'tag'		string	(default "./tags,tags", when compiled with
7812				|+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7813			global or local to buffer |global-local|
7814	Filenames for the tag command, separated by spaces or commas.  To
7815	include a space or comma in a file name, precede it with a backslash
7816	(see |option-backslash| about including spaces and backslashes).
7817	When a file name starts with "./", the '.' is replaced with the path
7818	of the current file.  But only when the 'd' flag is not included in
7819	'cpoptions'.  Environment variables are expanded |:set_env|.  Also see
7820	|tags-option|.
7821	"*", "**" and other wildcards can be used to search for tags files in
7822	a directory tree.  See |file-searching|.  E.g., "/lib/**/tags" will
7823	find all files named "tags" below "/lib".  The filename itself cannot
7824	contain wildcards, it is used as-is.  E.g., "/lib/**/tags?" will find
7825	files called "tags?".  {not available when compiled without the
7826	|+path_extra| feature}
7827	The |tagfiles()| function can be used to get a list of the file names
7828	actually used.
7829	If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7830	files are also supported.  They are automatically recognized.  The
7831	default value becomes "./tags,./TAGS,tags,TAGS", unless case
7832	differences are ignored (MS-Windows).  |emacs-tags|
7833	The use of |:set+=| and |:set-=| is preferred when adding or removing
7834	file names from the list.  This avoids problems when a future version
7835	uses another default.
7836
7837				*'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7838'tagstack' 'tgst'	boolean	(default on)
7839			global
7840	When on, the |tagstack| is used normally.  When off, a ":tag" or
7841	":tselect" command with an argument will not push the tag onto the
7842	tagstack.  A following ":tag" without an argument, a ":pop" command or
7843	any other command that uses the tagstack will use the unmodified
7844	tagstack, but does change the pointer to the active entry.
7845	Resetting this option is useful when using a ":tag" command in a
7846	mapping which should not change the tagstack.
7847
7848						*'tcldll'*
7849'tcldll'		string	(default depends on the build)
7850			global
7851			{only available when compiled with the |+tcl/dyn|
7852			feature}
7853	Specifies the name of the Tcl shared library. The default is
7854	DYNAMIC_TCL_DLL, which was specified at compile time.
7855	Environment variables are expanded |:set_env|.
7856	This option cannot be set from a |modeline| or in the |sandbox|, for
7857	security reasons.
7858
7859						*'term'* *E529* *E530* *E531*
7860'term'			string	(default is $TERM, if that fails:
7861				      in the GUI: "builtin_gui"
7862					on Amiga: "amiga"
7863					on Haiku: "xterm"
7864					  on Mac: "mac-ansi"
7865					 on Unix: "ansi"
7866					  on VMS: "ansi"
7867				       on Win 32: "win32")
7868			global
7869	Name of the terminal.  Used for choosing the terminal control
7870	characters.  Environment variables are expanded |:set_env|.
7871	For example: >
7872		:set term=$TERM
7873<	See |termcap|.
7874
7875						*'termbidi'* *'tbidi'*
7876						*'notermbidi'* *'notbidi'*
7877'termbidi' 'tbidi'	boolean (default off, on for "mlterm")
7878			global
7879			{only available when compiled with the |+arabic|
7880			feature}
7881	The terminal is in charge of Bi-directionality of text (as specified
7882	by Unicode).  The terminal is also expected to do the required shaping
7883	that some languages (such as Arabic) require.
7884	Setting this option implies that 'rightleft' will not be set when
7885	'arabic' is set and the value of 'arabicshape' will be ignored.
7886	Note that setting 'termbidi' has the immediate effect that
7887	'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7888	This option is reset when the GUI is started.
7889	For further details see |arabic.txt|.
7890
7891					*'termencoding'* *'tenc'*
7892'termencoding' 'tenc'	string	(default ""; with GTK+ GUI: "utf-8")
7893			global
7894	Encoding used for the terminal.  This specifies what character
7895	encoding the keyboard produces and the display will understand.  For
7896	the GUI it only applies to the keyboard ('encoding' is used for the
7897	display).
7898								*E617* *E950*
7899	Note: This does not apply to the GTK+ GUI.  After the GUI has been
7900	successfully initialized, 'termencoding' is forcibly set to "utf-8".
7901	Any attempts to set a different value will be rejected, and an error
7902	message is shown.
7903	For the Win32 GUI and console versions 'termencoding' is not used,
7904	because the Win32 system always passes Unicode characters.
7905	When empty, the same encoding is used as for the 'encoding' option.
7906	This is the normal value.
7907	Not all combinations for 'termencoding' and 'encoding' are valid.  See
7908	|encoding-table|.
7909	The value for this option must be supported by internal conversions or
7910	iconv().  When this is not possible no conversion will be done and you
7911	will probably experience problems with non-ASCII characters.
7912	Example: You are working with the locale set to euc-jp (Japanese) and
7913	want to edit a UTF-8 file: >
7914		:let &termencoding = &encoding
7915		:set encoding=utf-8
7916<	You need to do this when your system has no locale support for UTF-8.
7917
7918					*'termguicolors'* *'tgc'* *E954*
7919'termguicolors' 'tgc'	boolean (default off)
7920			global
7921			{not available when compiled without the
7922			|+termguicolors| feature}
7923	When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7924	the terminal (thus using 24-bit color).
7925
7926	Requires a ISO-8613-3 compatible terminal.  If setting this option
7927	does not work (produces a colorless UI) reading |xterm-true-color|
7928	might help.
7929
7930	For Win32 console, Windows 10 version 1703 (Creators Update) or later
7931	is required. Use this check to find out: >
7932		if has('vcon')
7933<	This requires Vim to be built with the |+vtp| feature.
7934
7935	Note that the "cterm" attributes are still used, not the "gui" ones.
7936	NOTE: This option is reset when 'compatible' is set.
7937
7938						*'termwinkey'* *'twk'*
7939'termwinkey' 'twk'	string	(default "")
7940			local to window
7941	The key that starts a CTRL-W command in a terminal window.  Other keys
7942	are sent to the job running in the window.
7943	The <> notation can be used, e.g.: >
7944		:set termwinkey=<C-L>
7945<	The string must be one key stroke but can be multiple bytes.
7946	When not set CTRL-W is used, so that CTRL-W : gets you to the command
7947	line.  If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
7948	command line.
7949
7950						*'termwinscroll'* *'twsl'*
7951'termwinscroll' 'twsl'	number	(default 10000)
7952			local to buffer
7953			{not available when compiled without the
7954			|+terminal| feature}
7955	Number of scrollback lines to keep.  When going over this limit the
7956	first 10% of the scrollback lines are deleted.  This is just to reduce
7957	the memory usage.  See |Terminal-Normal|.
7958	Also used as a limit for text sent to the terminal in one write,
7959	multiplied by the number of columns times 3 (average number of bytes
7960	per cell).
7961
7962						*'termwinsize'* *'tws'*
7963'termwinsize' 'tws'	string	(default "")
7964			local to window
7965	Size used when opening the |terminal| window.  Format:
7966		{rows}x{columns} or {rows}*{columns}.
7967	- When empty the terminal gets the size from the window.
7968	- When set with a "x" (e.g., "24x80") the terminal size is not
7969	  adjusted to the window size.  If the window is smaller only the
7970	  top-left part is displayed.
7971	- When set with a "*" (e.g., "10*50") the terminal size follows the
7972	  window size, but will not be smaller than the specified rows and/or
7973	  columns.
7974	- When rows is zero then use the height of the window.
7975	- When columns is zero then use the width of the window.
7976	- Using "0x0" or "0*0" is the same as empty.
7977	- Can be overruled in the |term_start()| options with "term_rows" and
7978	  "term_cols".
7979
7980	Examples:
7981	  "30x0" uses 30 rows and the current window width.
7982	  "20*0" uses at least 20 rows and the current window width.
7983	  "0*40" uses the current window height and at least 40 columns.
7984	Note that the command running in the terminal window may still change
7985	the size of the terminal.  In that case the Vim window will be
7986	adjusted to that size, if possible.
7987
7988						*'termwintype'* *'twt'*
7989'termwintype' 'twt'	string  (default "")
7990			global
7991			{only available when compiled with the |terminal|
7992			feature on MS-Windows}
7993	Specify the virtual console (pty) used when opening the terminal
7994	window.
7995
7996	Possible values are:
7997	    ""		use ConPTY if it is stable, winpty otherwise
7998	    "winpty"	use winpty, fail if not supported
7999	    "conpty"	use |ConPTY|, fail if not supported
8000
8001	|ConPTY| support depends on the platform.  Windows 10 October 2018
8002	Update is the first version that supports ConPTY, however it is still
8003	considered unstable.  ConPTY might become stable in the next release
8004	of Windows 10.  winpty support needs to be installed.  If neither is
8005	supported then you cannot open a terminal window.
8006
8007						*'terse'* *'noterse'*
8008'terse'			boolean	(default off)
8009			global
8010	When set: Add 's' flag to 'shortmess' option (this makes the message
8011	for a search that hits the start or end of the file not being
8012	displayed).  When reset: Remove 's' flag from 'shortmess' option.  {Vi
8013	shortens a lot of messages}
8014
8015				   *'textauto'* *'ta'* *'notextauto'* *'nota'*
8016'textauto' 'ta'		boolean	(Vim default: on, Vi default: off)
8017			global
8018	This option is obsolete.  Use 'fileformats'.
8019	For backwards compatibility, when 'textauto' is set, 'fileformats' is
8020	set to the default value for the current system.  When 'textauto' is
8021	reset, 'fileformats' is made empty.
8022	NOTE: This option is set to the Vi default value when 'compatible' is
8023	set and to the Vim default value when 'compatible' is reset.
8024
8025				   *'textmode'* *'tx'* *'notextmode'* *'notx'*
8026'textmode' 'tx'		boolean	(Win32: default on,
8027				 others: default off)
8028			local to buffer
8029	This option is obsolete.  Use 'fileformat'.
8030	For backwards compatibility, when 'textmode' is set, 'fileformat' is
8031	set to "dos".  When 'textmode' is reset, 'fileformat' is set to
8032	"unix".
8033
8034						*'textwidth'* *'tw'*
8035'textwidth' 'tw'	number	(default 0)
8036			local to buffer
8037	Maximum width of text that is being inserted.  A longer line will be
8038	broken after white space to get this width.  A zero value disables
8039	this.
8040	'textwidth' is set to 0 when the 'paste' option is set and restored
8041	when 'paste' is reset.
8042	When 'textwidth' is zero, 'wrapmargin' may be used.  See also
8043	'formatoptions' and |ins-textwidth|.
8044	When 'formatexpr' is set it will be used to break the line.
8045	NOTE: This option is set to 0 when 'compatible' is set.
8046
8047						*'thesaurus'* *'tsr'*
8048'thesaurus' 'tsr'	string	(default "")
8049			global or local to buffer |global-local|
8050	List of file names, separated by commas, that are used to lookup words
8051	for thesaurus completion commands |i_CTRL-X_CTRL-T|.  See
8052	|compl-thesaurus|.
8053
8054	This option is not used if 'thesaurusfunc' is set, either for the
8055	buffer or globally.
8056
8057	To include a comma in a file name precede it with a backslash.  Spaces
8058	after a comma are ignored, otherwise spaces are included in the file
8059	name.  See |option-backslash| about using backslashes.  The use of
8060	|:set+=| and |:set-=| is preferred when adding or removing directories
8061	from the list.  This avoids problems when a future version uses
8062	another default.  Backticks cannot be used in this option for security
8063	reasons.
8064
8065						*'thesaurusfunc'* *tsrfu'*
8066'thesaurusfunc' 'tsrfu'	string	(default: empty)
8067			global or local to buffer |global-local|
8068			{not available when compiled without the |+eval|
8069			feature}
8070	This option specifies a function to be used for thesaurus completion
8071	with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
8072
8073	This option cannot be set from a |modeline| or in the |sandbox|, for
8074	security reasons.
8075
8076			     *'tildeop'* *'top'* *'notildeop'* *'notop'*
8077'tildeop' 'top'		boolean	(default off)
8078			global
8079	When on: The tilde command "~" behaves like an operator.
8080	NOTE: This option is reset when 'compatible' is set.
8081
8082				*'timeout'* *'to'* *'notimeout'* *'noto'*
8083'timeout' 'to'		boolean (default on)
8084			global
8085						*'ttimeout'* *'nottimeout'*
8086'ttimeout'		boolean (default off, set in |defaults.vim|)
8087			global
8088	These two options together determine the behavior when part of a
8089	mapped key sequence or keyboard code has been received:
8090
8091	'timeout'    'ttimeout'		action	~
8092	   off		off		do not time out
8093	   on		on or off	time out on :mappings and key codes
8094	   off		on		time out on key codes
8095
8096	If both options are off, Vim will wait until either the complete
8097	mapping or key sequence has been received, or it is clear that there
8098	is no mapping or key sequence for the received characters.  For
8099	example: if you have mapped "vl" and Vim has received 'v', the next
8100	character is needed to see if the 'v' is followed by an 'l'.
8101	When one of the options is on, Vim will wait for about 1 second for
8102	the next character to arrive.  After that the already received
8103	characters are interpreted as single characters.  The waiting time can
8104	be changed with the 'timeoutlen' option.
8105	On slow terminals or very busy systems timing out may cause
8106	malfunctioning cursor keys.  If both options are off, Vim waits
8107	forever after an entered <Esc> if there are key codes that start
8108	with <Esc>.  You will have to type <Esc> twice.  If you do not have
8109	problems with key codes, but would like to have :mapped key
8110	sequences not timing out in 1 second, set the 'ttimeout' option and
8111	reset the 'timeout' option.
8112
8113	NOTE: 'ttimeout' is reset when 'compatible' is set.
8114
8115						*'timeoutlen'* *'tm'*
8116'timeoutlen' 'tm'	number	(default 1000)
8117			global
8118
8119						*'ttimeoutlen'* *'ttm'*
8120'ttimeoutlen' 'ttm'	number	(default -1, set to 100 in |defaults.vim|)
8121			global
8122	The time in milliseconds that is waited for a key code or mapped key
8123	sequence to complete.  Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8124	when part of a command has been typed.
8125	Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1.  When a
8126	different timeout value for key codes is desired set 'ttimeoutlen' to
8127	a non-negative number.
8128
8129		ttimeoutlen	mapping delay	   key code delay	~
8130		   < 0		'timeoutlen'	   'timeoutlen'
8131		  >= 0		'timeoutlen'	   'ttimeoutlen'
8132
8133	The timeout only happens when the 'timeout' and 'ttimeout' options
8134	tell so.  A useful setting would be >
8135		:set timeout timeoutlen=3000 ttimeoutlen=100
8136<	(time out on mapping after three seconds, time out on key codes after
8137	a tenth of a second).
8138
8139						*'title'* *'notitle'*
8140'title'			boolean	(default off, on when title can be restored)
8141			global
8142			{not available when compiled without the |+title|
8143			feature}
8144	When on, the title of the window will be set to the value of
8145	'titlestring' (if it is not empty), or to:
8146		filename [+=-] (path) - VIM
8147	Where:
8148		filename	the name of the file being edited
8149		-		indicates the file cannot be modified, 'ma' off
8150		+		indicates the file was modified
8151		=		indicates the file is read-only
8152		=+		indicates the file is read-only and modified
8153		(path)		is the path of the file being edited
8154		- VIM		the server name |v:servername| or "VIM"
8155	Only works if the terminal supports setting window titles
8156	(currently Amiga console, Win32 console, all GUI versions and
8157	terminals with a non-empty 't_ts' option - these are Unix xterm and
8158	iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8159								*X11*
8160	When Vim was compiled with HAVE_X11 defined, the original title will
8161	be restored if possible.  The output of ":version" will include "+X11"
8162	when HAVE_X11 was defined, otherwise it will be "-X11".  This also
8163	works for the icon name |'icon'|.
8164	But: When Vim was started with the |-X| argument, restoring the title
8165	will not work (except in the GUI).
8166	If the title cannot be restored, it is set to the value of 'titleold'.
8167	You might want to restore the title outside of Vim then.
8168	When using an xterm from a remote machine you can use this command:
8169	    rsh machine_name xterm -display $DISPLAY &
8170	then the WINDOWID environment variable should be inherited and the
8171	title of the window should change back to what it should be after
8172	exiting Vim.
8173
8174								*'titlelen'*
8175'titlelen'		number	(default 85)
8176			global
8177			{not available when compiled without the |+title|
8178			feature}
8179	Gives the percentage of 'columns' to use for the length of the window
8180	title.  When the title is longer, only the end of the path name is
8181	shown.  A '<' character before the path name is used to indicate this.
8182	Using a percentage makes this adapt to the width of the window.  But
8183	it won't work perfectly, because the actual number of characters
8184	available also depends on the font used and other things in the title
8185	bar.  When 'titlelen' is zero the full path is used.  Otherwise,
8186	values from 1 to 30000 percent can be used.
8187	'titlelen' is also used for the 'titlestring' option.
8188
8189						*'titleold'*
8190'titleold'		string	(default "Thanks for flying Vim")
8191			global
8192			{only available when compiled with the |+title|
8193			feature}
8194	This option will be used for the window title when exiting Vim if the
8195	original title cannot be restored.  Only happens if 'title' is on or
8196	'titlestring' is not empty.
8197	This option cannot be set from a |modeline| or in the |sandbox|, for
8198	security reasons.
8199						*'titlestring'*
8200'titlestring'		string	(default "")
8201			global
8202			{not available when compiled without the |+title|
8203			feature}
8204	When this option is not empty, it will be used for the title of the
8205	window.  This happens only when the 'title' option is on.
8206	Only works if the terminal supports setting window titles (currently
8207	Amiga console, Win32 console, all GUI versions and terminals with a
8208	non-empty 't_ts' option).
8209	When Vim was compiled with HAVE_X11 defined, the original title will
8210	be restored if possible, see |X11|.
8211
8212	When this option contains printf-style '%' items, they will be
8213	expanded according to the rules used for 'statusline'.
8214	This option cannot be set in a modeline when 'modelineexpr' is off.
8215
8216	Example: >
8217    :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8218    :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8219<	The value of 'titlelen' is used to align items in the middle or right
8220	of the available space.
8221	Some people prefer to have the file name first: >
8222    :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8223<	Note the use of "%{ }" and an expression to get the path of the file,
8224	without the file name.  The "%( %)" constructs are used to add a
8225	separating space only when needed.
8226	NOTE: Use of special characters in 'titlestring' may cause the display
8227	to be garbled (e.g., when it contains a CR or NL character).
8228	{not available when compiled without the |+statusline| feature}
8229
8230				*'toolbar'* *'tb'*
8231'toolbar' 'tb'		string	(default "icons,tooltips")
8232			global
8233			{only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8234			|+GUI_Photon|}
8235	The contents of this option controls various toolbar settings.  The
8236	possible values are:
8237		icons		Toolbar buttons are shown with icons.
8238		text		Toolbar buttons shown with text.
8239		horiz		Icon and text of a toolbar button are
8240				horizontally arranged.  {only in GTK+ 2 GUI}
8241		tooltips	Tooltips are active for toolbar buttons.
8242	Tooltips refer to the popup help text which appears after the mouse
8243	cursor is placed over a toolbar button for a brief moment.
8244
8245	If you want the toolbar to be shown with icons as well as text, do the
8246	following: >
8247		:set tb=icons,text
8248<	Motif and Athena cannot display icons and text at the same time.  They
8249	will show icons if both are requested.
8250
8251	If none of the strings specified in 'toolbar' are valid or if
8252	'toolbar' is empty, this option is ignored.  If you want to disable
8253	the toolbar, you need to set the 'guioptions' option.  For example: >
8254		:set guioptions-=T
8255<	Also see |gui-toolbar|.
8256
8257						*'toolbariconsize'* *'tbis'*
8258'toolbariconsize' 'tbis'	string	(default "small")
8259				global
8260				{only in the GTK+ GUI}
8261	Controls the size of toolbar icons.  The possible values are:
8262		tiny		Use tiny icons.
8263		small		Use small icons (default).
8264		medium		Use medium-sized icons.
8265		large		Use large icons.
8266		huge		Use even larger icons.
8267		giant		Use very big icons.
8268	The exact dimensions in pixels of the various icon sizes depend on
8269	the current theme.  Common dimensions are giant=48x48, huge=32x32,
8270	large=24x24, medium=24x24, small=20x20 and tiny=16x16.
8271
8272	If 'toolbariconsize' is empty, the global default size as determined
8273	by user preferences or the current theme is used.
8274
8275			     *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8276'ttybuiltin' 'tbi'	boolean	(default on)
8277			global
8278	When on, the builtin termcaps are searched before the external ones.
8279	When off the builtin termcaps are searched after the external ones.
8280	When this option is changed, you should set the 'term' option next for
8281	the change to take effect, for example: >
8282		:set notbi term=$TERM
8283<	See also |termcap|.
8284	Rationale: The default for this option is "on", because the builtin
8285	termcap entries are generally better (many systems contain faulty
8286	xterm entries...).
8287
8288				     *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8289'ttyfast' 'tf'		boolean	(default off, on when 'term' is xterm, hpterm,
8290					sun-cmd, screen, rxvt, dtterm or
8291					iris-ansi; also on when running Vim in
8292					a DOS console)
8293			global
8294	Indicates a fast terminal connection.  More characters will be sent to
8295	the screen for redrawing, instead of using insert/delete line
8296	commands.  Improves smoothness of redrawing when there are multiple
8297	windows and the terminal does not support a scrolling region.
8298	Also enables the extra writing of characters at the end of each screen
8299	line for lines that wrap.  This helps when using copy/paste with the
8300	mouse in an xterm and other terminals.
8301
8302						*'ttymouse'* *'ttym'*
8303'ttymouse' 'ttym'	string	(default depends on 'term')
8304			global
8305			{only in Unix and VMS, doesn't work in the GUI; not
8306			available when compiled without |+mouse|}
8307	Name of the terminal type for which mouse codes are to be recognized.
8308	Currently these strings are valid:
8309							*xterm-mouse*
8310	   xterm	xterm-like mouse handling.  The mouse generates
8311			"<Esc>[Mscr", where "scr" is three bytes:
8312				"s"  = button state
8313				"c"  = column plus 33
8314				"r"  = row plus 33
8315			This only works up to 223 columns!  See "dec",
8316			"urxvt", and "sgr" for solutions.
8317	   xterm2	Works like "xterm", but with the xterm reporting the
8318			mouse position while the mouse is dragged.  This works
8319			much faster and more precise.  Your xterm must at
8320			least at patchlevel 88 / XFree 3.3.3 for this to
8321			work.  See below for how Vim detects this
8322			automatically.
8323							*netterm-mouse*
8324	   netterm	NetTerm mouse handling.  A left mouse click generates
8325			"<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8326			for the row and column.  No other mouse events are
8327			supported.
8328							*dec-mouse*
8329	   dec		DEC terminal mouse handling.  The mouse generates a
8330			rather complex sequence, starting with "<Esc>[".
8331			This is also available for an Xterm, if it was
8332			configured with "--enable-dec-locator".
8333							*jsbterm-mouse*
8334	   jsbterm	JSB term mouse handling.
8335							*pterm-mouse*
8336	   pterm	QNX pterm mouse handling.
8337							*urxvt-mouse*
8338	   urxvt	Mouse handling for the urxvt (rxvt-unicode) terminal.
8339			The mouse works only if the terminal supports this
8340			encoding style, but it does not have 223 columns limit
8341			unlike "xterm" or "xterm2".
8342							*sgr-mouse*
8343	   sgr		Mouse handling for the terminal that emits SGR-styled
8344			mouse reporting.  The mouse works even in columns
8345			beyond 223.  This option is backward compatible with
8346			"xterm2" because it can also decode "xterm2" style
8347			mouse codes.
8348
8349	The mouse handling must be enabled at compile time |+mouse_xterm|
8350	|+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8351	|+mouse_sgr|.
8352	Only "xterm"(2) is really recognized.  NetTerm mouse codes are always
8353	recognized, if enabled at compile time.  DEC terminal mouse codes
8354	are recognized if enabled at compile time, and 'ttymouse' is not
8355	"xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8356	with them).
8357	This option is automatically set to "xterm", when the 'term' option is
8358	set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8359	"st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8360	already.
8361	Additionally, if vim is compiled with the |+termresponse| feature and
8362	|t_RV| is set to the escape sequence to request the xterm version
8363	number, more intelligent detection is done.
8364	The "xterm2" value will be set if the xterm version is reported to be
8365	from 95 to 276.  The "sgr" value will be set if Vim detects Mac
8366	Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8367	higher.
8368	If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8369	automatically, set t_RV to an empty string: >
8370		:set t_RV=
8371<
8372						*'ttyscroll'* *'tsl'*
8373'ttyscroll' 'tsl'	number	(default 999)
8374			global
8375	Maximum number of lines to scroll the screen.  If there are more lines
8376	to scroll the window is redrawn.  For terminals where scrolling is
8377	very slow and redrawing is not slow this can be set to a small number,
8378	e.g., 3, to speed up displaying.
8379
8380						*'ttytype'* *'tty'*
8381'ttytype' 'tty'		string	(default from $TERM)
8382			global
8383	Alias for 'term', see above.
8384
8385						*'undodir'* *'udir'*
8386'undodir' 'udir'	string	(default ".")
8387			global
8388			{only when compiled with the |+persistent_undo| feature}
8389	List of directory names for undo files, separated with commas.
8390	See |'backupdir'| for details of the format.
8391	"." means using the directory of the file.  The undo file name for
8392	"file.txt" is ".file.txt.un~".
8393	For other directories the file name is the full path of the edited
8394	file, with path separators replaced with "%".
8395	When writing: The first directory that exists is used. "." always
8396	works, no directories after "." will be used for writing.
8397	When reading all entries are tried to find an undo file.  The first
8398	undo file that exists is used.  When it cannot be read an error is
8399	given, no further entry is used.
8400	See |undo-persistence|.
8401	This option cannot be set from a |modeline| or in the |sandbox|, for
8402	security reasons.
8403
8404				*'undofile'* *'noundofile'* *'udf'* *'noudf'*
8405'undofile' 'udf'	boolean	(default off)
8406			local to buffer
8407			{only when compiled with the |+persistent_undo| feature}
8408	When on, Vim automatically saves undo history to an undo file when
8409	writing a buffer to a file, and restores undo history from the same
8410	file on buffer read.
8411	The directory where the undo file is stored is specified by 'undodir'.
8412	For more information about this feature see |undo-persistence|.
8413	The undo file is not read when 'undoreload' causes the buffer from
8414	before a reload to be saved for undo.
8415	When 'undofile' is turned off the undo file is NOT deleted.
8416	NOTE: This option is reset when 'compatible' is set.
8417
8418						*'undolevels'* *'ul'*
8419'undolevels' 'ul'	number	(default 100, 1000 for Unix, VMS and Win32)
8420			global or local to buffer |global-local|
8421	Maximum number of changes that can be undone.  Since undo information
8422	is kept in memory, higher numbers will cause more memory to be used.
8423	Nevertheless, a single change can already use a large amount of memory.
8424	Set to 0 for Vi compatibility: One level of undo and "u" undoes
8425	itself: >
8426		set ul=0
8427<	But you can also get Vi compatibility by including the 'u' flag in
8428	'cpoptions', and still be able to use CTRL-R to repeat undo.
8429	Also see |undo-two-ways|.
8430	Set to -1 for no undo at all.  You might want to do this only for the
8431	current buffer: >
8432		setlocal ul=-1
8433<	This helps when you run out of memory for a single change.
8434
8435	The local value is set to -123456 when the global value is to be used.
8436
8437	Also see |clear-undo|.
8438
8439						*'undoreload'* *'ur'*
8440'undoreload' 'ur'	number	(default 10000)
8441			global
8442	Save the whole buffer for undo when reloading it.  This applies to the
8443	":e!" command and reloading for when the buffer changed outside of
8444	Vim. |FileChangedShell|
8445	The save only happens when this option is negative or when the number
8446	of lines is smaller than the value of this option.
8447	Set this option to zero to disable undo for a reload.
8448
8449	When saving undo for a reload, any undo file is not read.
8450
8451	Note that this causes the whole buffer to be stored in memory.  Set
8452	this option to a lower value if you run out of memory.
8453
8454						*'updatecount'* *'uc'*
8455'updatecount' 'uc'	number	(default: 200)
8456			global
8457	After typing this many characters the swap file will be written to
8458	disk.  When zero, no swap file will be created at all (see chapter on
8459	recovery |crash-recovery|).  'updatecount' is set to zero by starting
8460	Vim with the "-n" option, see |startup|.  When editing in readonly
8461	mode this option will be initialized to 10000.
8462	The swapfile can be disabled per buffer with |'swapfile'|.
8463	When 'updatecount' is set from zero to non-zero, swap files are
8464	created for all buffers that have 'swapfile' set.  When 'updatecount'
8465	is set to zero, existing swap files are not deleted.
8466	Also see |'swapsync'|.
8467	This option has no meaning in buffers where |'buftype'| is "nofile"
8468	or "nowrite".
8469
8470						*'updatetime'* *'ut'*
8471'updatetime' 'ut'	number	(default 4000)
8472			global
8473	If this many milliseconds nothing is typed the swap file will be
8474	written to disk (see |crash-recovery|).  Also used for the
8475	|CursorHold| autocommand event.
8476
8477					*'varsofttabstop'* *'vsts'*
8478'varsofttabstop' 'vsts'	string	(default "")
8479			local to buffer
8480			{only available when compiled with the |+vartabs|
8481			feature}
8482	A list of the number of spaces that a <Tab> counts for while editing,
8483	such as inserting a <Tab> or using <BS>.  It "feels" like variable-
8484	width <Tab>s are being inserted, while in fact a mixture of spaces
8485	and <Tab>s is used.  Tab widths are separated with commas, with the
8486	final value applying to all subsequent tabs.
8487
8488	For example, when editing assembly language files where statements
8489	start in the 9th column and comments in the 41st, it may be useful
8490	to use the following: >
8491		:set varsofttabstop=8,32,8
8492<	This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8493	for every column thereafter.
8494
8495	Note that the value of |'softtabstop'| will be ignored while
8496	'varsofttabstop' is set.
8497
8498						*'vartabstop'* *'vts'*
8499'vartabstop' 'vts'	string	(default "")
8500			local to buffer
8501			{only available when compiled with the |+vartabs|
8502			feature}
8503	A list of the number of spaces that a <Tab> in the file counts for,
8504	separated by commas.  Each value corresponds to one tab, with the
8505	final value applying to all subsequent tabs. For example: >
8506		:set vartabstop=4,20,10,8
8507<	This will make the first tab 4 spaces wide, the second 20 spaces,
8508	the third 10 spaces, and all following tabs 8 spaces.
8509
8510	Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8511	is set.
8512
8513						*'verbose'* *'vbs'*
8514'verbose' 'vbs'		number	(default 0)
8515			global
8516	When bigger than zero, Vim will give messages about what it is doing.
8517	Currently, these messages are given:
8518	>= 1	When the viminfo file is read or written.
8519	>= 2	When a file is ":source"'ed.
8520	>= 4	Shell commands.
8521	>= 5	Every searched tags file and include file.
8522	>= 8	Files for which a group of autocommands is executed.
8523	>= 9	Every executed autocommand.
8524	>= 11	Finding items in a path
8525	>= 12	Every executed function.
8526	>= 13	When an exception is thrown, caught, finished, or discarded.
8527	>= 14	Anything pending in a ":finally" clause.
8528	>= 15	Every executed Ex command from a script (truncated at 200
8529		characters).
8530	>= 16	Every executed Ex command.
8531
8532	This option can also be set with the "-V" argument.  See |-V|.
8533	This option is also set by the |:verbose| command.
8534
8535	When the 'verbosefile' option is set then the verbose messages are not
8536	displayed.
8537
8538						*'verbosefile'* *'vfile'*
8539'verbosefile' 'vfile'	string	(default empty)
8540			global
8541	When not empty all messages are written in a file with this name.
8542	When the file exists messages are appended.
8543	Writing to the file ends when Vim exits or when 'verbosefile' is made
8544	empty.  Writes are buffered, thus may not show up for some time.
8545	Setting 'verbosefile' to a new value is like making it empty first.
8546	The difference with |:redir| is that verbose messages are not
8547	displayed when 'verbosefile' is set.
8548
8549						*'viewdir'* *'vdir'*
8550'viewdir' 'vdir'	string	(default for Amiga and Win32:
8551							 "$VIM/vimfiles/view",
8552				 for Unix: "~/.vim/view",
8553				 for macOS: "$VIM:vimfiles:view"
8554				 for VMS: "sys$login:vimfiles/view")
8555			global
8556			{not available when compiled without the |+mksession|
8557			feature}
8558	Name of the directory where to store files for |:mkview|.
8559	This option cannot be set from a |modeline| or in the |sandbox|, for
8560	security reasons.
8561
8562						*'viewoptions'* *'vop'*
8563'viewoptions' 'vop'	string	(default: "folds,options,cursor,curdir")
8564			global
8565			{not available when compiled without the |+mksession|
8566			feature}
8567	Changes the effect of the |:mkview| command.  It is a comma separated
8568	list of words.  Each word enables saving and restoring something:
8569	   word		save and restore ~
8570	   cursor	cursor position in file and in window
8571	   folds	manually created folds, opened/closed folds and local
8572			fold options
8573	   options	options and mappings local to a window or buffer (not
8574			global values for local options)
8575	   localoptions same as "options"
8576	   slash	backslashes in file names replaced with forward
8577			slashes
8578	   unix		with Unix end-of-line format (single <NL>), even when
8579			on MS-Windows
8580	   curdir	the window-local directory, if set with `:lcd`
8581
8582	"slash" and "unix" are useful on MS-Windows when sharing view files
8583	with Unix.  The Unix version of Vim cannot source dos format scripts,
8584	but the MS-Windows version of Vim can source unix format scripts.
8585
8586				*'viminfo'* *'vi'* *E526* *E527* *E528*
8587'viminfo' 'vi'		string	(Vi default: "", Vim default for
8588				   MS-Windows: '100,<50,s10,h,rA:,rB:,
8589				   for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8590				   for others: '100,<50,s10,h)
8591			global
8592			{not available when compiled without the |+viminfo|
8593			feature}
8594	When non-empty, the viminfo file is read upon startup and written
8595	when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8596	"NONE".
8597	The string should be a comma separated list of parameters, each
8598	consisting of a single character identifying the particular parameter,
8599	followed by a number or string which specifies the value of that
8600	parameter.  If a particular character is left out, then the default
8601	value is used for that parameter.  The following is a list of the
8602	identifying characters and the effect of their value.
8603	CHAR	VALUE	~
8604							*viminfo-!*
8605	!	When included, save and restore global variables that start
8606		with an uppercase letter, and don't contain a lowercase
8607		letter.  Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
8608		and "_K_L_M" are not.  Nested List and Dict items may not be
8609		read back correctly, you end up with an empty item.
8610							*viminfo-quote*
8611	"	Maximum number of lines saved for each register.  Old name of
8612		the '<' item, with the disadvantage that you need to put a
8613		backslash before the ", otherwise it will be recognized as the
8614		start of a comment!
8615							*viminfo-%*
8616	%	When included, save and restore the buffer list.  If Vim is
8617		started with a file name argument, the buffer list is not
8618		restored.  If Vim is started without a file name argument, the
8619		buffer list is restored from the viminfo file.  Quickfix
8620		('buftype'), unlisted ('buflisted'), unnamed and buffers on
8621		removable media (|viminfo-r|) are not saved.
8622		When followed by a number, the number specifies the maximum
8623		number of buffers that are stored.  Without a number all
8624		buffers are stored.
8625							*viminfo-'*
8626	'	Maximum number of previously edited files for which the marks
8627		are remembered.  This parameter must always be included when
8628		'viminfo' is non-empty.
8629		Including this item also means that the |jumplist| and the
8630		|changelist| are stored in the viminfo file.
8631							*viminfo-/*
8632	/	Maximum number of items in the search pattern history to be
8633		saved.  If non-zero, then the previous search and substitute
8634		patterns are also saved.  When not included, the value of
8635		'history' is used.
8636							*viminfo-:*
8637	:	Maximum number of items in the command-line history to be
8638		saved.  When not included, the value of 'history' is used.
8639							*viminfo-<*
8640	<	Maximum number of lines saved for each register.  If zero then
8641		registers are not saved.  When not included, all lines are
8642		saved.  '"' is the old name for this item.
8643		Also see the 's' item below: limit specified in Kbyte.
8644							*viminfo-@*
8645	@	Maximum number of items in the input-line history to be
8646		saved.  When not included, the value of 'history' is used.
8647							*viminfo-c*
8648	c	When included, convert the text in the viminfo file from the
8649		'encoding' used when writing the file to the current
8650		'encoding'.  See |viminfo-encoding|.
8651							*viminfo-f*
8652	f	Whether file marks need to be stored.  If zero, file marks ('0
8653		to '9, 'A to 'Z) are not stored.  When not present or when
8654		non-zero, they are all stored.  '0 is used for the current
8655		cursor position (when exiting or when doing ":wviminfo").
8656							*viminfo-h*
8657	h	Disable the effect of 'hlsearch' when loading the viminfo
8658		file.  When not included, it depends on whether ":nohlsearch"
8659		has been used since the last search command.
8660							*viminfo-n*
8661	n	Name of the viminfo file.  The name must immediately follow
8662		the 'n'.  Must be at the end of the option!  If the
8663		'viminfofile' option is set, that file name overrides the one
8664		given here with 'viminfo'.  Environment variables are
8665		expanded when opening the file, not when setting the option.
8666							*viminfo-r*
8667	r	Removable media.  The argument is a string (up to the next
8668		',').  This parameter can be given several times.  Each
8669		specifies the start of a path for which no marks will be
8670		stored.  This is to avoid removable media.  For MS-Windows you
8671		could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:".  You can
8672		also use it for temp files, e.g., for Unix: "r/tmp".  Case is
8673		ignored.  Maximum length of each 'r' argument is 50
8674		characters.
8675							*viminfo-s*
8676	s	Maximum size of an item in Kbyte.  If zero then registers are
8677		not saved.  Currently only applies to registers.  The default
8678		"s10" will exclude registers with more than 10 Kbyte of text.
8679		Also see the '<' item above: line count limit.
8680
8681	Example: >
8682	    :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8683<
8684	'50		Marks will be remembered for the last 50 files you
8685			edited.
8686	<1000		Contents of registers (up to 1000 lines each) will be
8687			remembered.
8688	s100		Registers with more than 100 Kbyte text are skipped.
8689	:0		Command-line history will not be saved.
8690	n~/vim/viminfo	The name of the file to use is "~/vim/viminfo".
8691	no /		Since '/' is not specified, the default will be used,
8692			that is, save all of the search history, and also the
8693			previous search and substitute patterns.
8694	no %		The buffer list will not be saved nor read back.
8695	no h		'hlsearch' highlighting will be restored.
8696
8697	When setting 'viminfo' from an empty value you can use |:rviminfo| to
8698	load the contents of the file, this is not done automatically.
8699
8700	This option cannot be set from a |modeline| or in the |sandbox|, for
8701	security reasons.
8702	NOTE: This option is set to the Vim default value when 'compatible'
8703	is reset.
8704
8705				*'viminfofile'* *'vif'*
8706'viminfofile' 'vif'	string	(default: "")
8707			global
8708			{not available when compiled without the |+viminfo|
8709			feature}
8710	When non-empty, overrides the file name used for viminfo.
8711	When equal to "NONE" no viminfo file will be read or written.
8712	This option can be set with the |-i| command line flag.  The |--clean|
8713	command line flag sets it to "NONE".
8714	This option cannot be set from a |modeline| or in the |sandbox|, for
8715	security reasons.
8716
8717					    *'virtualedit'* *'ve'*
8718'virtualedit' 've'	string	(default "")
8719			global or local to window |global-local|
8720	A comma separated list of these words:
8721	    block	Allow virtual editing in Visual block mode.
8722	    insert	Allow virtual editing in Insert mode.
8723	    all		Allow virtual editing in all modes.
8724	    onemore	Allow the cursor to move just past the end of the line
8725	    none	When used as the local value, do not allow virtual
8726			editing even when the global value is set.  When used
8727			as the global value, "none" is the same as "".
8728	    NONE	Alternative spelling of "none".
8729
8730	Virtual editing means that the cursor can be positioned where there is
8731	no actual character.  This can be halfway into a tab or beyond the end
8732	of the line.  Useful for selecting a rectangle in Visual mode and
8733	editing a table.
8734	"onemore" is not the same, it will only allow moving the cursor just
8735	after the last character of the line.  This makes some commands more
8736	consistent.  Previously the cursor was always past the end of the line
8737	if the line was empty.  But it is far from Vi compatible.  It may also
8738	break some plugins or Vim scripts.  For example because |l| can move
8739	the cursor after the last character.  Use with care!
8740	Using the `$` command will move to the last character in the line, not
8741	past it.  This may actually move the cursor to the left!
8742	The `g$` command will move to the end of the screen line.
8743	It doesn't make sense to combine "all" with "onemore", but you will
8744	not get a warning for it.
8745	When combined with other words, "none" is ignored.
8746	NOTE: This option is set to "" when 'compatible' is set.
8747
8748			*'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8749'visualbell' 'vb'	boolean	(default off)
8750			global
8751	Use a visual bell instead of beeping.  The terminal code to display the
8752	visual bell is given with 't_vb'.  When no beep or flash is wanted,
8753	use: >
8754		:set vb t_vb=
8755<	If you want a short flash, you can use this on many terminals: >
8756		:set vb t_vb=[?5h$<100>[?5l
8757<	Here $<100> specifies the time, you can use a smaller or bigger value
8758	to get a shorter or longer flash.
8759
8760	Note: Vim will limit the bell to once per half a second.  This avoids
8761	having to wait for the flashing to finish when there are lots of
8762	bells, e.g. on key repeat.  This also happens without 'visualbell'
8763	set.
8764
8765	In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8766	for 20 msec.  If you want to use a different time, use "<Esc>|40f",
8767	where 40 is the time in msec.
8768
8769	Note: When the GUI starts, 't_vb' is reset to its default value.  You
8770	might want to set it again in your |gvimrc|.
8771
8772	Does not work on the Amiga, you always get a screen flash.
8773	Also see 'errorbells'.
8774
8775						*'warn'* *'nowarn'*
8776'warn'			boolean	(default on)
8777			global
8778	Give a warning message when a shell command is used while the buffer
8779	has been changed.
8780
8781		     *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8782'weirdinvert' 'wiv'	boolean	(default off)
8783			global
8784	This option has the same effect as the 't_xs' terminal option.
8785	It is provided for backwards compatibility with version 4.x.
8786	Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8787	vice versa.  Has no effect when the GUI is running.
8788
8789						*'whichwrap'* *'ww'*
8790'whichwrap' 'ww'	string	(Vim default: "b,s", Vi default: "")
8791			global
8792	Allow specified keys that move the cursor left/right to move to the
8793	previous/next line when the cursor is on the first/last character in
8794	the line.  Concatenate characters to allow this for these keys:
8795		char   key	  mode	~
8796		 b    <BS>	 Normal and Visual
8797		 s    <Space>	 Normal and Visual
8798		 h    "h"	 Normal and Visual (not recommended)
8799		 l    "l"	 Normal and Visual (not recommended)
8800		 <    <Left>	 Normal and Visual
8801		 >    <Right>	 Normal and Visual
8802		 ~    "~"	 Normal
8803		 [    <Left>	 Insert and Replace
8804		 ]    <Right>	 Insert and Replace
8805	For example: >
8806		:set ww=<,>,[,]
8807<	allows wrap only when cursor keys are used.
8808	When the movement keys are used in combination with a delete or change
8809	operator, the <EOL> also counts for a character.  This makes "3h"
8810	different from "3dh" when the cursor crosses the end of a line.  This
8811	is also true for "x" and "X", because they do the same as "dl" and
8812	"dh".  If you use this, you may also want to use the mapping
8813	":map <BS> X" to make backspace delete the character in front of the
8814	cursor.
8815	When 'l' is included and it is used after an operator at the end of a
8816	line (not an empty line) then it will not move to the next line.  This
8817	makes "dl", "cl", "yl" etc. work normally.
8818	NOTE: This option is set to the Vi default value when 'compatible' is
8819	set and to the Vim default value when 'compatible' is reset.
8820
8821						*'wildchar'* *'wc'*
8822'wildchar' 'wc'		number	(Vim default: <Tab>, Vi default: CTRL-E)
8823			global
8824	Character you have to type to start wildcard expansion in the
8825	command-line, as specified with 'wildmode'.
8826	More info here: |cmdline-completion|.
8827	The character is not recognized when used inside a macro.  See
8828	'wildcharm' for that.
8829	Some keys will not work, such as CTRL-C, <CR> and Enter.
8830	Although 'wc' is a number option, you can set it to a special key: >
8831		:set wc=<Tab>
8832<	NOTE: This option is set to the Vi default value when 'compatible' is
8833	set and to the Vim default value when 'compatible' is reset.
8834
8835						*'wildcharm'* *'wcm'*
8836'wildcharm' 'wcm'	number	(default: none (0))
8837			global
8838	'wildcharm' works exactly like 'wildchar', except that it is
8839	recognized when used inside a macro.  You can find "spare" command-line
8840	keys suitable for this option by looking at |ex-edit-index|.  Normally
8841	you'll never actually type 'wildcharm', just use it in mappings that
8842	automatically invoke completion mode, e.g.: >
8843		:set wcm=<C-Z>
8844		:cnoremap ss so $vim/sessions/*.vim<C-Z>
8845<	Then after typing :ss you can use CTRL-P & CTRL-N.
8846
8847						*'wildignore'* *'wig'*
8848'wildignore' 'wig'	string	(default "")
8849			global
8850			{not available when compiled without the |+wildignore|
8851			feature}
8852	A list of file patterns.  A file that matches with one of these
8853	patterns is ignored when expanding |wildcards|, completing file or
8854	directory names, and influences the result of |expand()|, |glob()| and
8855	|globpath()| unless a flag is passed to disable this.
8856	The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8857	Also see 'suffixes'.
8858	Example: >
8859		:set wildignore=*.o,*.obj
8860<	The use of |:set+=| and |:set-=| is preferred when adding or removing
8861	a pattern from the list.  This avoids problems when a future version
8862	uses another default.
8863
8864
8865			*'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
8866'wildignorecase' 'wic'	boolean	(default off)
8867			global
8868	When set case is ignored when completing file names and directories.
8869	Has no effect when 'fileignorecase' is set.
8870	Does not apply when the shell is used to expand wildcards, which
8871	happens when there are special characters.
8872
8873
8874				*'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8875'wildmenu' 'wmnu'	boolean	(default off, set in |defaults.vim|)
8876			global
8877			{not available if compiled without the |+wildmenu|
8878			feature}
8879	When 'wildmenu' is on, command-line completion operates in an enhanced
8880	mode.  On pressing 'wildchar' (usually <Tab>) to invoke completion,
8881	the possible matches are shown just above the command line, with the
8882	first match highlighted (overwriting the status line, if there is
8883	one).  Keys that show the previous/next match, such as <Tab> or
8884	CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8885	When 'wildmode' is used, "wildmenu" mode is used where "full" is
8886	specified.  "longest" and "list" do not start "wildmenu" mode.
8887	You can check the current mode with |wildmenumode()|.
8888	If there are more matches than can fit in the line, a ">" is shown on
8889	the right and/or a "<" is shown on the left.  The status line scrolls
8890	as needed.
8891	The "wildmenu" mode is abandoned when a key is hit that is not used
8892	for selecting a completion.
8893	While the "wildmenu" is active the following keys have special
8894	meanings:
8895
8896	<Left> <Right>	- select previous/next match (like CTRL-P/CTRL-N)
8897	<Down>		- in filename/menu name completion: move into a
8898			  subdirectory or submenu.
8899	<CR>		- in menu completion, when the cursor is just after a
8900			  dot: move into a submenu.
8901	<Up>		- in filename/menu name completion: move up into
8902			  parent directory or parent menu.
8903
8904	This makes the menus accessible from the console |console-menus|.
8905
8906	If you prefer the <Left> and <Right> keys to move the cursor instead
8907	of selecting a different match, use this: >
8908		:cnoremap <Left> <Space><BS><Left>
8909		:cnoremap <Right> <Space><BS><Right>
8910<
8911	The "WildMenu" highlighting is used for displaying the current match
8912	|hl-WildMenu|.
8913
8914						*'wildmode'* *'wim'*
8915'wildmode' 'wim'	string	(Vim default: "full")
8916			global
8917	Completion mode that is used for the character specified with
8918	'wildchar'.  It is a comma separated list of up to four parts.  Each
8919	part specifies what to do for each consecutive use of 'wildchar'.  The
8920	first part specifies the behavior for the first use of 'wildchar',
8921	The second part for the second use, etc.
8922
8923	Each part consists of a colon separated list consisting of the
8924	following possible values:
8925	""		Complete only the first match.
8926	"full"		Complete the next full match.  After the last match,
8927			the original string is used and then the first match
8928			again.  Will also start 'wildmenu' if it is enabled.
8929	"longest"	Complete till longest common string.  If this doesn't
8930			result in a longer string, use the next part.
8931	"list"		When more than one match, list all matches.
8932	"lastused"	When completing buffer names and more than one buffer
8933			matches, sort buffers by time last used (other than
8934			the current buffer).
8935	When there is only a single match, it is fully completed in all cases.
8936
8937	Examples of useful colon-separated values:
8938	"longest:full"	Like "longest", but also start 'wildmenu' if it is
8939			enabled.  Will not complete to the next full match.
8940	"list:full"	When more than one match, list all matches and
8941			complete first match.
8942	"list:longest"	When more than one match, list all matches and
8943			complete till longest common string.
8944	"list:lastused" When more than one buffer matches, list all matches
8945			and sort buffers by time last used (other than the
8946			current buffer).
8947
8948	Examples: >
8949		:set wildmode=full
8950<	Complete first full match, next match, etc.  (the default) >
8951		:set wildmode=longest,full
8952<	Complete longest common string, then each full match >
8953		:set wildmode=list:full
8954<	List all matches and complete each full match >
8955		:set wildmode=list,full
8956<	List all matches without completing, then each full match >
8957		:set wildmode=longest,list
8958<	Complete longest common string, then list alternatives.
8959	More info here: |cmdline-completion|.
8960
8961						*'wildoptions'* *'wop'*
8962'wildoptions' 'wop'	string	(default "")
8963			global
8964			{not available when compiled without the |+wildignore|
8965			feature}
8966	A list of words that change how command line completion is done.
8967	Currently only one word is allowed:
8968	  tagfile	When using CTRL-D to list matching tags, the kind of
8969			tag and the file of the tag is listed.	Only one match
8970			is displayed per line.  Often used tag kinds are:
8971				d	#define
8972				f	function
8973	Also see |cmdline-completion|.
8974
8975						*'winaltkeys'* *'wak'*
8976'winaltkeys' 'wak'	string	(default "menu")
8977			global
8978			{only used in Win32, Motif, GTK and Photon GUI}
8979	Some GUI versions allow the access to menu entries by using the ALT
8980	key in combination with a character that appears underlined in the
8981	menu.  This conflicts with the use of the ALT key for mappings and
8982	entering special characters.  This option tells what to do:
8983	  no	Don't use ALT keys for menus.  ALT key combinations can be
8984		mapped, but there is no automatic handling.  This can then be
8985		done with the |:simalt| command.
8986	  yes	ALT key handling is done by the windowing system.  ALT key
8987		combinations cannot be mapped.
8988	  menu	Using ALT in combination with a character that is a menu
8989		shortcut key, will be handled by the windowing system.  Other
8990		keys can be mapped.
8991	If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8992	key is never used for the menu.
8993	This option is not used for <F10>; on Win32 and with GTK <F10> will
8994	select the menu, unless it has been mapped.
8995
8996						*'wincolor'* *'wcr'*
8997'wincolor' 'wcr' string (default empty)
8998			local to window
8999	Highlight group name to use for this window instead of the Normal
9000	color |hl-Normal|.
9001
9002						*'window'* *'wi'*
9003'window' 'wi'		number  (default screen height - 1)
9004			global
9005	Window height used for |CTRL-F| and |CTRL-B| when there is only one
9006	window and the value is smaller than 'lines' minus one.  The screen
9007	will scroll 'window' minus two lines, with a minimum of one.
9008	When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9009	in a much smarter way, taking care of wrapping lines.
9010	When resizing the Vim window, the value is smaller than 1 or more than
9011	or equal to 'lines' it will be set to 'lines' minus 1.
9012	Note: Do not confuse this with the height of the Vim window, use
9013	'lines' for that.
9014
9015						*'winheight'* *'wh'* *E591*
9016'winheight' 'wh'	number	(default 1)
9017			global
9018	Minimal number of lines for the current window.  This is not a hard
9019	minimum, Vim will use fewer lines if there is not enough room.  If the
9020	focus goes to a window that is smaller, its size is increased, at the
9021	cost of the height of other windows.
9022	Set 'winheight' to a small number for normal editing.
9023	Set it to 999 to make the current window fill most of the screen.
9024	Other windows will be only 'winminheight' high.  This has the drawback
9025	that ":all" will create only two windows.  To avoid "vim -o 1 2 3 4"
9026	to create only two windows, set the option after startup is done,
9027	using the |VimEnter| event: >
9028		au VimEnter * set winheight=999
9029<	Minimum value is 1.
9030	The height is not adjusted after one of the commands that change the
9031	height of the current window.
9032	'winheight' applies to the current window.  Use 'winminheight' to set
9033	the minimal height for other windows.
9034
9035			*'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9036'winfixheight' 'wfh'	boolean	(default off)
9037			local to window
9038	Keep the window height when windows are opened or closed and
9039	'equalalways' is set.  Also for |CTRL-W_=|.  Set by default for the
9040	|preview-window| and |quickfix-window|.
9041	The height may be changed anyway when running out of room.
9042
9043			*'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9044'winfixwidth' 'wfw'	boolean	(default off)
9045			local to window
9046	Keep the window width when windows are opened or closed and
9047	'equalalways' is set.  Also for |CTRL-W_=|.
9048	The width may be changed anyway when running out of room.
9049
9050						*'winminheight'* *'wmh'*
9051'winminheight' 'wmh'	number	(default 1)
9052			global
9053	The minimal height of a window, when it's not the current window.
9054	This is a hard minimum, windows will never become smaller.
9055	When set to zero, windows may be "squashed" to zero lines (i.e. just a
9056	status bar) if necessary.  They will return to at least one line when
9057	they become active (since the cursor has to have somewhere to go.)
9058	Use 'winheight' to set the minimal height of the current window.
9059	This option is only checked when making a window smaller.  Don't use a
9060	large number, it will cause errors when opening more than a few
9061	windows.  A value of 0 to 3 is reasonable.
9062
9063						*'winminwidth'* *'wmw'*
9064'winminwidth' 'wmw'	number	(default 1)
9065			global
9066	The minimal width of a window, when it's not the current window.
9067	This is a hard minimum, windows will never become smaller.
9068	When set to zero, windows may be "squashed" to zero columns (i.e. just
9069	a vertical separator) if necessary.  They will return to at least one
9070	line when they become active (since the cursor has to have somewhere
9071	to go.)
9072	Use 'winwidth' to set the minimal width of the current window.
9073	This option is only checked when making a window smaller.  Don't use a
9074	large number, it will cause errors when opening more than a few
9075	windows.  A value of 0 to 12 is reasonable.
9076
9077						*'winptydll'*
9078'winptydll'		string	(default "winpty32.dll" or "winpty64.dll")
9079			global
9080			{only available when compiled with the |terminal|
9081			feature on MS-Windows}
9082	Specifies the name of the winpty shared library, used for the
9083	|:terminal| command. The default depends on whether Vim was built as a
9084	32-bit or 64-bit executable.  If not found, "winpty.dll" is tried as
9085	a fallback.
9086	Environment variables are expanded |:set_env|.
9087	This option cannot be set from a |modeline| or in the |sandbox|, for
9088	security reasons.
9089
9090						*'winwidth'* *'wiw'* *E592*
9091'winwidth' 'wiw'	number	(default 20)
9092			global
9093	Minimal number of columns for the current window.  This is not a hard
9094	minimum, Vim will use fewer columns if there is not enough room.  If
9095	the current window is smaller, its size is increased, at the cost of
9096	the width of other windows.  Set it to 999 to make the current window
9097	always fill the screen.  Set it to a small number for normal editing.
9098	The width is not adjusted after one of the commands to change the
9099	width of the current window.
9100	'winwidth' applies to the current window.  Use 'winminwidth' to set
9101	the minimal width for other windows.
9102
9103						*'wrap'* *'nowrap'*
9104'wrap'			boolean	(default on)
9105			local to window
9106	This option changes how text is displayed.  It doesn't change the text
9107	in the buffer, see 'textwidth' for that.
9108	When on, lines longer than the width of the window will wrap and
9109	displaying continues on the next line.  When off lines will not wrap
9110	and only part of long lines will be displayed.  When the cursor is
9111	moved to a part that is not shown, the screen will scroll
9112	horizontally.
9113	The line will be broken in the middle of a word if necessary.  See
9114	'linebreak' to get the break at a word boundary.
9115	To make scrolling horizontally a bit more useful, try this: >
9116		:set sidescroll=5
9117		:set listchars+=precedes:<,extends:>
9118<	See 'sidescroll', 'listchars' and |wrap-off|.
9119	This option can't be set from a |modeline| when the 'diff' option is
9120	on.
9121
9122						*'wrapmargin'* *'wm'*
9123'wrapmargin' 'wm'	number	(default 0)
9124			local to buffer
9125	Number of characters from the right window border where wrapping
9126	starts.  When typing text beyond this limit, an <EOL> will be inserted
9127	and inserting continues on the next line.
9128	Options that add a margin, such as 'number' and 'foldcolumn', cause
9129	the text width to be further reduced.  This is Vi compatible.
9130	When 'textwidth' is non-zero, this option is not used.
9131	This option is set to 0 when 'paste' is set and restored when 'paste'
9132	is reset.
9133	See also 'formatoptions' and |ins-textwidth|.
9134
9135				   *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9136'wrapscan' 'ws'		boolean	(default on)			*E384* *E385*
9137			global
9138	Searches wrap around the end of the file.  Also applies to |]s| and
9139	|[s|, searching for spelling mistakes.
9140
9141						   *'write'* *'nowrite'*
9142'write'			boolean	(default on)
9143			global
9144	Allows writing files.  When not set, writing a file is not allowed.
9145	Can be used for a view-only mode, where modifications to the text are
9146	still allowed.  Can be reset with the |-m| or |-M| command line
9147	argument.  Filtering text is still possible, even though this requires
9148	writing a temporary file.
9149
9150				   *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9151'writeany' 'wa'		boolean	(default off)
9152			global
9153	Allows writing to any file with no need for "!" override.
9154
9155			     *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9156'writebackup' 'wb'	boolean	(default on with |+writebackup| feature, off
9157					otherwise)
9158			global
9159	Make a backup before overwriting a file.  The backup is removed after
9160	the file was successfully written, unless the 'backup' option is
9161	also on.
9162	WARNING: Switching this option off means that when Vim fails to write
9163	your buffer correctly and then, for whatever reason, Vim exits, you
9164	lose both the original file and what you were writing.  Only reset
9165	this option if your file system is almost full and it makes the write
9166	fail (and make sure not to exit Vim until the write was successful).
9167	See |backup-table| for another explanation.
9168	When the 'backupskip' pattern matches, a backup is not made anyway.
9169	Depending on 'backupcopy' the backup is a new file or the original
9170	file renamed (and a new file is written).
9171	NOTE: This option is set to the default value when 'compatible' is
9172	set.
9173
9174						*'writedelay'* *'wd'*
9175'writedelay' 'wd'	number	(default 0)
9176			global
9177	The number of milliseconds to wait for each character sent to the
9178	screen.  When non-zero, characters are sent to the terminal one by
9179	one.  For debugging purposes.
9180
9181 vim:tw=78:ts=8:noet:ft=help:norl:
9182