xref: /vim-8.2.3635/runtime/doc/options.txt (revision cfbc5ee4)
1*options.txt*	For Vim version 7.0aa.  Last change: 2004 Jul 02
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 help.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*
23
24							*:se* *:set*
25:se[t]			Show all options that differ from their default value.
26
27:se[t] all		Show all but terminal options.
28
29:se[t] termcap		Show all terminal options.  Note that in the GUI the
30			key codes are not shown, because they are generated
31			internally and can't be changed.  Changing the terminal
32			codes in the GUI is not useful either...
33
34								*E518* *E519*
35:se[t] {option}?	Show value of {option}.
36
37:se[t] {option}		Toggle option: set, switch it on.
38			Number option: show value.
39			String option: show value.
40
41:se[t] no{option}	Toggle option: Reset, switch it off.
42
43:se[t] {option}!   or
44:se[t] inv{option}	Toggle option: Invert value. {not in Vi}
45
46				*:set-default* *:set-&* *:set-&vi* *:set-&vim*
47:se[t] {option}&	Reset option to its default value.  May depend on the
48			current value of 'compatible'. {not in Vi}
49:se[t] {option}&vi	Reset option to its Vi default value. {not in Vi}
50:se[t] {option}&vim	Reset option to its Vim default value. {not in Vi}
51
52:se[t] all&		Set all options, except terminal options, to their
53			default value.  The values of 'term', 'lines' and
54			'columns' are not changed. {not in Vi}
55
56						*:set-args* *E487* *E521*
57:se[t] {option}={value}		or
58:se[t] {option}:{value}
59			Set string or number option to {value}.
60			For numeric options the value can be given in decimal,
61			hex (preceded with 0x) or octal (preceded with '0')
62			(hex and octal are only available for machines which
63			have the strtol() function).
64			The old value can be inserted by typing 'wildchar' (by
65			default this is a <Tab> or CTRL-E if 'compatible' is
66			set).  See |cmdline-completion|.
67			White space between {option} and '=' is allowed and
68			will be ignored.  White space between '=' and {value}
69			is not allowed.
70			See |option-backslash| for using white space and
71			backslashes in {value}.
72
73:se[t] {option}+={value}				*:set+=*
74			Add the {value} to a number option, or append the
75			{value} to a string option.  When the option is a
76			comma separated list, a comma is added, unless the
77			value was empty.
78			If the option is a list of flags, superfluous flags
79			are removed.  Otherwise there is no check for doubled
80			values.  You can avoid this by removing a value first.
81			Example: >
82				:set guioptions-=T guioptions+=T
83<			Also see |:set-args| above.
84			{not in Vi}
85
86:se[t] {option}^={value}				*:set^=*
87			Multiply the {value} to a number option, or prepend
88			the {value} to a string option.  When the option is a
89			comma separated list, a comma is added, unless the
90			value was empty.
91			Also see |:set-args| above.
92			{not in Vi}
93
94:se[t] {option}-={value}				*:set-=*
95			Subtract the {value} from a number option, or remove
96			the {value} from a string option, if it is there.
97			If the {value} is not found in a string option, there
98			is no error or warning.  When the option is a comma
99			separated list, a comma is deleted, unless the option
100			becomes empty.
101			When the option is a list of flags, {value} must be
102			exactly as they appear in the option.  Remove flags
103			one by one to avoid problems.
104			Also see |:set-args| above.
105			{not in Vi}
106
107The {option} arguments to ":set" may be repeated.  For example: >
108	:set ai nosi sw=3 ts=3
109If you make an error in one of the arguments, an error message will be given
110and the following arguments will be ignored.
111
112							*:set-verbose*
113When 'verbose' is non-zero, displaying an option value will also tell where it
114was last set.  Example: >
115	:verbose set shiftwidth cindent?
116	  shiftwidth=4
117		  Last set from modeline
118	  cindent
119		  Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
120This is only done when specific option values are requested, not for ":set
121all" or ":set" without an argument.
122When the option was set by hand there is no "Last set" message.  There is only
123one value for all local options with the same name.  Thus the message applies
124to the option name, not necessarily its value.
125When the option was set while executing a function, user command or
126autocommand, the script in which it was defined is reported.
127Note that an option may also have been set as a side effect of setting
128'compatible'.
129{not available when compiled without the +eval feature}
130
131							*:set-termcap* *E522*
132For {option} the form "t_xx" may be used to set a termcap option.  This will
133override the value from the termcap.  You can then use it in a mapping.  If
134the "xx" part contains special characters, use the <t_xx> form: >
135	:set <t_#4>=^[Ot
136This can also be used to translate a special code for a normal key.  For
137example, if Alt-b produces <Esc>b, use this: >
138	:set <M-b>=^[b
139(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
140The advantage over a mapping is that it works in all situations.
141
142The listing from ":set" looks different from Vi.  Long string options are put
143at the end of the list.  The number of options is quite large.  The output of
144"set all" probably does not fit on the screen, causing Vim to give the
145|more-prompt|.
146
147							*option-backslash*
148To include white space in a string option value it has to be preceded with a
149backslash.  To include a backslash you have to use two.  Effectively this
150means that the number of backslashes in an option value is halved (rounded
151down).
152A few examples: >
153   :set tags=tags\ /usr/tags	    results in "tags /usr/tags"
154   :set tags=tags\\,file	    results in "tags\,file"
155   :set tags=tags\\\ file	    results in "tags\ file"
156
157The "|" character separates a ":set" command from a following command.  To
158include the "|" in the option value, use "\|" instead.  This example sets the
159'titlestring' option to "hi|there": >
160   :set titlestring=hi\|there
161This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
162   :set titlestring=hi|set iconstring=there
163
164For MS-DOS and WIN32 backslashes in file names are mostly not removed.  More
165precise: For options that expect a file name (those where environment
166variables are expanded) a backslash before a normal file name character is not
167removed.  But a backslash before a special character (space, backslash, comma,
168etc.) is used like explained above.
169There is one special situation, when the value starts with "\\": >
170   :set dir=\\machine\path	    results in "\\machine\path"
171   :set dir=\\\\machine\\path	    results in "\\machine\path"
172   :set dir=\\path\\file	    results in "\\path\file" (wrong!)
173For the first one the start is kept, but for the second one the backslashes
174are halved.  This makes sure it works both when you expect backslashes to be
175halved and when you expect the backslashes to be kept.  The third gives a
176result which is probably not what you want.  Avoid it.
177
178				*add-option-flags* *remove-option-flags*
179				*E539* *E550* *E551* *E552*
180Some options are a list of flags.  When you want to add a flag to such an
181option, without changing the existing ones, you can do it like this: >
182   :set guioptions+=a
183Remove a flag from an option like this: >
184   :set guioptions-=a
185This removes the 'a' flag from 'guioptions'.
186Note that you should add or remove one flag at a time.  If 'guioptions' has
187the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
188doesn't appear.
189
190			   *:set_env* *expand-env* *expand-environment-var*
191Environment variables in most string options will be expanded.  If the
192environment variable exists the '$' and the following environment variable
193name is replaced with its value.  If it does not exist the '$' and the name
194are not modified.  Any non-id character (not a letter, digit or '_') may
195follow the environment variable name.  That character and what follows is
196appended to the value of the environment variable.  Examples: >
197   :set term=$TERM.new
198   :set path=/usr/$INCLUDE,$HOME/include,.
199When adding or removing a string from an option with ":set opt-=val" or ":set
200opt+=val" the expansion is done before the adding or removing.
201
202
203Handling of local options			*local-options*
204
205Some of the options only apply to a window or buffer.  Each window or buffer
206has its own copy of this option, thus can each have their own value.  This
207allows you to set 'list' in one window but not in another.  And set
208'shiftwidth' to 3 in one buffer and 4 in another.
209
210The following explains what happens to these local options in specific
211situations.  You don't really need to know all of this, since Vim mostly uses
212the option values you would expect.  Unfortunately, doing what the user
213expects is a bit complicated...
214
215When splitting a window, the local options are copied to the new window.  Thus
216right after the split the contents of the two windows look the same.
217
218When editing a new buffer, its local option values must be initialized.  Since
219the local options of the current buffer might be specifically for that buffer,
220these are not used.  Instead, for each buffer-local option there also is a
221global value, which is used for new buffers.  With ":set" both the local and
222global value is changed.  With "setlocal" only the local value is changed,
223thus this value is not used when editing a new buffer.
224
225When editing a buffer that has been edited before, the last used window
226options are used again.  If this buffer has been edited in this window, the
227values from back then are used.  Otherwise the values from the window where
228the buffer was edited last are used.
229
230It's possible to set a local window option specifically for a type of buffer.
231When you edit another buffer in the same window, you don't want to keep
232using these local window options.  Therefore Vim keeps a global value of the
233local window options, which is used when editing another buffer.  Each window
234has its own copy of these values.  Thus these are local to the window, but
235global to all buffers in the window.  With this you can do: >
236	:e one
237	:set list
238	:e two
239Now the 'list' option will also be set in "two", since with the ":set list"
240command you have also set the global value. >
241	:set nolist
242	:e one
243	:setlocal list
244	:e two
245Now the 'list' option is not set, because ":set nolist" resets the global
246value, ":setlocal list" only changes the local value and ":e two" gets the
247global value.  Note that if you do this next: >
248	:e one
249You will not get back the 'list' value as it was the last time you edited
250"one".  The options local to a window are not remembered for each buffer.
251
252							*:setl* *:setlocal*
253:setl[ocal] ...		Like ":set" but set only the value local to the
254			current buffer or window.  Not all options have a
255			local value.  If the option does not have a local
256			value the global value is set.
257			With the "all" argument: display all local option's
258			local values.
259			Without argument: Display all local option's local
260			values which are different from the default.
261			When displaying a specific local option, show the
262			local value.  For a global option the global value is
263			shown (but that might change in the future).
264			{not in Vi}
265
266:setl[ocal] {option}<	Set the local value of {option} to its global value.
267			{not in Vi}
268
269							*:setg* *:setglobal*
270:setg[lobal] ...	Like ":set" but set only the global value for a local
271			option without changing the local value.
272			When displaying an option, the global value is shown.
273			With the "all" argument: display all local option's
274			global values.
275			Without argument: display all local option's global
276			values which are different from the default.
277			{not in Vi}
278
279For buffer-local and window-local options:
280	Command		 global value	    local value ~
281      :set option=value	     set		set
282 :setlocal option=value	      -			set
283:setglobal option=value	     set		 -
284      :set option?	      -		       display
285 :setlocal option?	      -		       display
286:setglobal option?	    display		 -
287
288
289Global options with a local value			*global-local*
290
291Options are global when you mostly use one value for all buffers.  For some
292global options it's useful to sometimes have a different local value.  You can
293set the local value with ":setlocal".  That buffer will then use the local
294value, while other buffers continue using the global value.
295
296For example, you have two windows, both on C source code.  They use the global
297'makeprg' option.  If you do this in one of the two windows: >
298	:set makeprg=gmake
299then the other window will switch to the same value.  There is no need to set
300the 'makeprg' option in the other C source window too.
301However, if you start editing a Perl file in a new window, you want to use
302another 'makeprog' for it, without changing the value used for the C source
303files.  You use this command: >
304	:setlocal makeprg=perlmake
305You can switch back to using the global value by making the local value empty: >
306	:setlocal makeprg=
307This only works for a string option.  For a boolean option you need to use the
308"<" flag, like this: >
309	:setlocal autoread<
310Note that for non-boolean options using "<" copies the global value to the
311local value, it doesn't switch back to using the global value (that matters
312when changing the global value later).
313Note: In the future more global options can be made global-local.  Using
314":setlocal" on a global option might work differently then.
315
316
317Setting the filetype
318
319:setf[iletype] {filetype}			*:setf* *:setfiletype*
320			Set the 'filetype' option to {filetype}, but only if
321			not done yet in a sequence of (nested) autocommands.
322			This is short for: >
323				:if !did_filetype()
324				:  setlocal filetype={filetype}
325				:endif
326<			This command is used in a filetype.vim file to avoid
327			setting the 'filetype' option twice, causing different
328			settings and syntax files to be loaded.
329			{not in Vi}
330
331:bro[wse] se[t]			*:set-browse* *:browse-set* *:opt* *:options*
332:opt[ions]		Open a window for viewing and setting all options.
333			Options are grouped by function.
334			Offers short help for each option.  Hit <CR> on the
335			short help to open a help window with more help for
336			the option.
337			Modify the value of the option and hit <CR> on the
338			"set" line to set the new value.  For window and
339			buffer specific options, the last accessed window is
340			used to set the option value in, unless this is a help
341			window, in which case the window below help window is
342			used (skipping the option-window).
343			{not available when compiled without the |+eval| or
344			|+autocmd| features}
345
346								*$HOME*
347Using "~" is like using "$HOME", but it is only recognized at the start of an
348option and after a space or comma.
349
350On Unix systems "~user" can be used too.  It is replaced by the home directory
351of user "user".  Example: >
352    :set path=~mool/include,/usr/include,.
353
354On Unix systems the form "${HOME}" can be used too.  The name between {} can
355contain non-id characters then.  Note that if you want to use this for the
356"gf" command, you need to add the '{' and '}' characters to 'isfname'.
357
358NOTE: expanding environment variables and "~/" is only done with the ":set"
359command, not when assigning a value to an option with ":let".
360
361
362Note the maximum length of an expanded option is limited.  How much depends on
363the system, mostly it is something like 256 or 1024 characters.
364
365							*:fix* *:fixdel*
366:fix[del]		Set the value of 't_kD':
367				't_kb' is     't_kD' becomes	~
368				  CTRL-?	CTRL-H
369				not CTRL-?	CTRL-?
370
371			(CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
372
373			If your delete key terminal code is wrong, but the
374			code for backspace is alright, you can put this in
375			your .vimrc: >
376				:fixdel
377<			This works no matter what the actual code for
378			backspace is.
379
380			If the backspace key terminal code is wrong you can
381			use this: >
382				:if &term == "termname"
383				:  set t_kb=^V<BS>
384				:  fixdel
385				:endif
386<			Where "^V" is CTRL-V and "<BS>" is the backspace key
387			(don't type four characters!).  Replace "termname"
388			with your terminal name.
389
390			If your <Delete> key sends a strange key sequence (not
391			CTRL-? or CTRL-H) you cannot use ":fixdel".  Then use: >
392				:if &term == "termname"
393				:  set t_kD=^V<Delete>
394				:endif
395<			Where "^V" is CTRL-V and "<Delete>" is the delete key
396			(don't type eight characters!).  Replace "termname"
397			with your terminal name.
398
399							*Linux-backspace*
400			Note about Linux: By default the backspace key
401			produces CTRL-?, which is wrong.  You can fix it by
402			putting this line in your rc.local: >
403				echo "keycode 14 = BackSpace" | loadkeys
404<
405							*NetBSD-backspace*
406			Note about NetBSD: If your backspace doesn't produce
407			the right code, try this: >
408				xmodmap -e "keycode 22 = BackSpace"
409<			If this works, add this in your .Xmodmap file: >
410				keysym 22 = BackSpace
411<			You need to restart for this to take effect.
412
413==============================================================================
4142. Automatically setting options			*auto-setting*
415
416Besides changing options with the ":set" command, there are three alternatives
417to set options automatically for one or more files:
418
4191. When starting Vim initializations are read from various places.  See
420   |initialization|.  Most of them are performed for all editing sessions,
421   and some of them depend on the directory where Vim is started.
422   You can create an initialization file with |:mkvimrc|, |:mkview| and
423   |:mksession|.
4242. If you start editing a new file, the automatic commands are executed.
425   This can be used to set options for files matching a particular pattern and
426   many other things.  See |autocommand|.
4273. If you start editing a new file, and the 'modeline' option is on, a
428   number of lines at the beginning and end of the file are checked for
429   modelines.  This is explained here.
430
431					*modeline* *vim:* *vi:* *ex:* *E520*
432There are two forms of modelines.  The first form:
433	[text]{white}{vi:|vim:|ex:}[white]{options}
434
435[text]		any text or empty
436{white}		at least one blank character (<Space> or <Tab>)
437{vi:|vim:|ex:}	the string "vi:", "vim:" or "ex:"
438[white]		optional white space
439{options}	a list of option settings, separated with white space or ':',
440		where each part between ':' is the argument for a ":set"
441		command
442
443Example: >
444   vi:noai:sw=3 ts=6
445
446The second form (this is compatible with some versions of Vi):
447
448	[text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
449
450[text]		any text or empty
451{white}		at least one blank character (<Space> or <Tab>)
452{vi:|vim:|ex:}	the string "vi:", "vim:" or "ex:"
453[white]		optional white space
454se[t]		the string "set " or "se " (note the space)
455{options}	a list of options, separated with white space, which is the
456		argument for a ":set" command
457:		a colon
458[text]		any text or empty
459
460Example: >
461   /* vim: set ai tw=75: */
462
463The white space before {vi:|vim:|ex:} is required.  This minimizes the chance
464that a normal word like "lex:" is caught.  There is one exception: "vi:" and
465"vim:" can also be at the start of the line (for compatibility with version
4663.0).  Using "ex:" at the start of the line will be ignored (this could be
467short for "example:").
468
469							*modeline-local*
470The options are set like with ":setlocal": The new value only applies to the
471buffer and window that contain the file.  Although it's possible to set global
472options from a modeline, this is unusual.  If you have two windows open and
473the files in it set the same global option to a different value, the result
474depends on which one was opened last.
475
476							*modeline-version*
477If the modeline is only to be used for some versions of Vim, the version
478number can be specified where "vim:" is used:
479	vim{vers}:	version {vers} or later
480	vim<{vers}:	version before {vers}
481	vim={vers}:	version {vers}
482	vim>{vers}:	version after {vers}
483{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
484For example, to use a modeline only for Vim 6.0 and later: >
485	/* vim600: set foldmethod=marker: */
486To use a modeline for Vim before version 5.7: >
487	/* vim<570: set sw=4: */
488There can be no blanks between "vim" and the ":".
489
490
491The number of lines that are checked can be set with the 'modelines' option.
492If 'modeline' is off or 'modelines' is 0 no lines are checked.
493
494Note that for the first form all of the rest of the line is used, thus a line
495like: >
496   /* vi:ts=4: */
497will give an error message for the trailing "*/".  This line is OK: >
498   /* vi:set ts=4: */
499
500If an error is detected the rest of the line is skipped.
501
502If you want to include a ':' in a set command precede it with a '\'.  The
503backslash in front of the ':' will be removed.  Example: >
504   /* vi:set dir=c\:\tmp: */
505This sets the 'dir' option to "c:\tmp".  Only a single backslash before the
506':' is removed.  Thus to include "\:" you have to specify "\\:".
507
508No other commands than "set" are supported, for security reasons (somebody
509might create a Trojan horse text file with modelines).
510
511Hint: If you would like to do something else than setting an option, you could
512define an autocommand that checks the file for a specific string.  For
513example: >
514	au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
515And define a function SetVar() that does something with the line containing
516"VAR".
517
518==============================================================================
5193. Options summary					*option-summary*
520
521In the list below all the options are mentioned with their full name and with
522an abbreviation if there is one.  Both forms may be used.
523
524In this document when a boolean option is "set" that means that ":set option"
525is entered.  When an option is "reset", ":set nooption" is used.
526
527For some options there are two default values: The "Vim default", which is
528used when 'compatible' is not set, and the "Vi default", which is used when
529'compatible' is set.
530
531Most options are the same in all windows and buffers.  There are a few that
532are specific to how the text is presented in a window.  These can be set to a
533different value in each window.  For example the 'list' option can be set in
534one window and reset in another for the same text, giving both types of view
535at the same time.  There are a few options that are specific to a certain
536file.  These can have a different value for each file or buffer.  For example
537the 'textwidth' option can be 78 for a normal text file and 0 for a C
538program.
539
540	global			one option for all buffers and windows
541	local to window		each window has its own copy of this option
542	local to buffer		each buffer has its own copy of this option
543
544When creating a new window the option values from the currently active window
545are used as a default value for the window-specific options.  For the
546buffer-specific options this depends on the 's' and 'S' flags in the
547'cpoptions' option.  If 's' is included (which is the default) the values for
548buffer options are copied from the currently active buffer when a buffer is
549first entered.  If 'S' is present the options are copied each time the buffer
550is entered, this is almost like having global options.  If 's' and 'S' are not
551present, the options are copied from the currently active buffer when the
552buffer is created.
553
554Not all options are supported in all versions.  To test if option "foo" can be
555used with ":set" use "exists('&foo')".  This doesn't mean the value is
556actually remembered and works.  Some options are hidden, which means that you
557can set them but the value is not remembered.  To test if option "foo" is
558really supported use "exists('+foo')".
559
560							*E355*
561A jump table for the options with a short description can be found at |Q_op|.
562
563					*'aleph'* *'al'* *aleph* *Aleph*
564'aleph' 'al'		number	(default 128 for MS-DOS, 224 otherwise)
565			global
566			{not in Vi}
567			{only available when compiled with the |+rightleft|
568			feature}
569	The ASCII code for the first letter of the Hebrew alphabet.  The
570	routine that maps the keyboard in Hebrew mode, both in Insert mode
571	(when hkmap is set) and on the command-line (when hitting CTRL-_)
572	outputs the Hebrew characters in the range [aleph..aleph+26].
573	aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
574	See |rileft.txt|.
575
576			*'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
577'allowrevins' 'ari'	boolean	(default off)
578			global
579			{not in Vi}
580			{only available when compiled with the |+rightleft|
581			feature}
582	Allow CTRL-_ in Insert and Command-line mode.  This is default off, to
583	avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
584	into reverse Insert mode, and don't know how to get out.  See
585	'revins'.
586	NOTE: This option is reset when 'compatible' is set.
587
588			 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
589'altkeymap' 'akm'	boolean (default off)
590			global
591			{not in Vi}
592			{only available when compiled with the |+farsi|
593			feature}
594	When on, the second language is Farsi. In editing mode CTRL-_ toggles
595	the keyboard map between Farsi and English, when 'allowrevins' set.
596
597	When off, the keyboard map toggles between Hebrew and English. This
598	is useful to start the Vim in native mode i.e. English (left-to-right
599	mode) and have default second language Farsi or Hebrew (right-to-left
600	mode).  See |farsi.txt|.
601
602						*'ambiwidth'* *'ambw'*
603'ambiwidth' 'ambw'	string (default: "single")
604			global
605			{not in Vi}
606			{only available when compiled with the |+multi_byte|
607			feature}
608	Only effective when 'encoding' is "utf-8" or another Unicode encoding.
609	Tells Vim what to do with characters with East Asian Width Class
610	Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
611	letters, Cyrillic letters).
612
613	There are currently two possible values:
614	"single":	Use the same width as characters in US-ASCII. This is
615			expected by most users.
616	"double":	Use twice the width of ASCII characters.
617
618	There are a number of CJK fonts for which the width of glyphs for
619	those characters are solely based on how many octets they take in
620	legacy/traditional CJK encodings.  In those encodings, Euro,
621	Registered sign, Greek/Cyrillic letters are represented by two octets,
622	therefore those fonts have "wide" glyphs for them. This is also
623	true of some line drawing characters used to make tables in text
624	file. Therefore, when a CJK font is used for GUI Vim or
625	Vim is running inside a terminal (emulators) that uses a CJK font
626	(or Vim is run inside an xterm invoked with "-cjkwidth" option.),
627	this option should be set to "double" to match the width perceived
628	by Vim with the width of glyphs in the font.  Perhaps it also has
629	to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
630	when the system locale is set to one of CJK locales.  See Unicode
631	Standard Annex #11 (http://www.unicode.org/reports/tr11).
632
633			*'antialias'* *'anti'* *'noantialias'* *'noanti'*
634'antialias' 'anti'	boolean (default: off)
635			global
636			{not in Vi}
637			{only available when compiled with GUI enabled
638			on Mac OS X}
639	This option only has an effect in the GUI version of Vim on Mac OS X
640	v10.2 or later.  When on, Vim will use smooth ("antialiased") fonts,
641	which can be easier to read at certain sizes on certain displays.
642	Setting this option can sometimes cause problems if 'guifont' is set
643	to its default (empty string).
644
645			*'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
646'autochdir' 'acd'	boolean (default off)
647			global
648			{not in Vi}
649			{only available when compiled with the
650			|+netbeans_intg| or |+sun_workshop| feature}
651	When on, Vim will change its value for the current working directory
652	whenever you open a file, switch buffers, delete a buffer or
653	open/close a window. It will change to the directory containing the
654	file which was opened or selected.  This option is provided for
655	backward compatibility with the Vim released with Sun ONE Studio 4
656	Enterprise Edition.
657
658				*'arabic'* *'arab'* *'noarabic'* *'noarab'*
659'arabic' 'arab'		boolean (default off)
660			local to window
661			{not in Vi}
662			{only available when compiled with the |+arabic|
663			feature}
664	This option can be set to start editing Arabic text.
665	Setting this option will:
666	- Set the 'rightleft' option, unless 'termbidi' is set.
667	- Set the 'arabicshape' option, unless 'termbidi' is set.
668	- Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
669	  between typing English and Arabic key mapping.
670	- Set the 'delcombine' option
671	Note that 'encoding' must be "utf-8" for working with Arabic text.
672
673	Resetting this option will:
674	- Reset the 'rightleft' option.
675	- Disable the use of 'keymap' (without changing its value).
676	Note that 'arabicshape' and 'delcombine' are not reset (it is a global
677	option.
678	Also see |arabic.txt|.
679
680					*'arabicshape'* *'arshape'*
681					*'noarabicshape'* *'noarshape'*
682'arabicshape' 'arshape'	boolean (default on)
683			global
684			{not in Vi}
685			{only available when compiled with the |+arabic|
686			feature}
687	When on and 'termbidi' is off, the required visual character
688	corrections that need to take place for displaying the Arabic language
689	take affect.  Shaping, in essence, gets enabled; the term is a broad
690	one which encompasses:
691	  a) the changing/morphing of characters based on their location
692	     within a word (initial, medial, final and stand-alone).
693	  b) the enabling of the ability to compose characters
694	  c) the enabling of the required combining of some characters
695	When disabled the character display reverts back to each character's
696	true stand-alone form.
697	Arabic is a complex language which requires other settings, for
698	further details see |arabic.txt|.
699
700			*'autoindent'* *'ai'* *'noautoindent'* *'noai'*
701'autoindent' 'ai'	boolean	(default off)
702			local to buffer
703	Copy indent from current line when starting a new line (typing <CR>
704	in Insert mode or when using the "o" or "O" command).  If you do not
705	type anything on the new line except <BS> or CTRL-D and then type
706	<Esc> or <CR>, the indent is deleted again.  Moving the cursor to
707	another line has the same effect, unless the 'I' flag is included in
708	'cpoptions'.
709	When autoindent is on, formatting (with the "gq" command or when you
710	reach 'textwidth' in Insert mode) uses the indentation of the first
711	line.
712	When 'smartindent' or 'cindent' is on the indent is changed in
713	a different way.
714	The 'autoindent' option is reset when the 'paste' option is set.
715	{small difference from Vi: After the indent is deleted when typing
716	<Esc> or <CR>, the cursor position when moving up or down is after the
717	deleted indent; Vi puts the cursor somewhere in the deleted indent}.
718
719				 *'autoread'* *'ar'* *'noautoread'* *'noar'*
720'autoread' 'ar'		boolean	(default off)
721			global or local to buffer |global-local|
722			{not in Vi}
723	When a file has been detected to have been changed outside of Vim and
724	it has not been changed inside of Vim, automatically read it again.
725	When the file has been deleted this is not done.  |timestamp|
726	If this option has a local value, use this command to switch back to
727	using the global value: >
728		:set autoread<
729<
730				 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
731'autowrite' 'aw'	boolean	(default off)
732			global
733	Write the contents of the file, if it has been modified, on each
734	:next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
735	:make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
736	'{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
737	Note that for some commands the 'autowrite' option is not used, see
738	'autowriteall' for that.
739
740			 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
741'autowriteall' 'awa'	boolean	(default off)
742			global
743			{not in Vi}
744	Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
745	":qall", ":exit", ":xit", ":recover" and closing the Vim window.
746	Setting this option also implies that Vim behaves like 'autowrite' has
747	been set.
748
749							*'background'* *'bg'*
750'background' 'bg'	string	(default "dark" or "light")
751			global
752			{not in Vi}
753	When set to "dark", Vim will try to use colors that look good on a
754	dark background.  When set to "light", Vim will try to use colors that
755	look good on a light background.  Any other value is illegal.
756	Vim tries to set the default value according to the terminal used.
757	This will not always be correct.
758	Setting this option does not change the background color, it tells Vim
759	what the background color looks like.  For changing the background
760	color, see |:hi-normal|.
761
762	When 'background' is set Vim will adjust the default color groups for
763	the new value.  But the colors used for syntax highlighting will not
764	change.
765	When a color scheme is loaded (the "colors_name" variable is set)
766	setting 'background' will cause the color scheme to be reloaded.  If
767	the color scheme adjusts to the value of 'background' this will work.
768	However, if the color scheme sets 'background' itself the effect may
769	be undone.  First delete the "colors_name" variable when needed.
770
771	When setting 'background' to the default value with: >
772		:set background&
773<	Vim will guess the value.  In the GUI this should work correctly,
774	in other cases Vim might not be able to guess the right value.
775
776	When starting the GUI, the default value for 'background' will be
777	"light".  When the value is not set in the .gvimrc, and Vim detects
778	that the background is actually quite dark, 'background' is set to
779	"dark".  But this happens only AFTER the .gvimrc file has been read
780	(because the window needs to be opened to find the actual background
781	color).  To get around this, force the GUI window to be opened by
782	putting a ":gui" command in the .gvimrc file, before where the value
783	of 'background' is used (e.g., before ":syntax on").
784	Normally this option would be set in the .vimrc file.  Possibly
785	depending on the terminal name.  Example: >
786		:if &term == "pcterm"
787		:  set background=dark
788		:endif
789<	When this option is set, the default settings for the highlight groups
790	will change.  To use other settings, place ":highlight" commands AFTER
791	the setting of the 'background' option.
792	This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
793	to select the colors for syntax highlighting.  After changing this
794	option, you must load syntax.vim again to see the result.  This can be
795	done with ":syntax on".
796
797							*'backspace'* *'bs'*
798'backspace' 'bs'	string	(default "")
799			global
800			{not in Vi}
801	Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
802	mode.  This is a list of items, separated by commas.  Each item allows
803	a way to backspace over something:
804	value	effect	~
805	indent	allow backspacing over autoindent
806	eol	allow backspacing over line breaks (join lines)
807	start	allow backspacing over the start of insert; CTRL-W and CTRL-U
808		stop once at the start of insert.
809
810	When the value is empty, Vi compatible backspacing is used.
811
812	For backwards compatibility with version 5.4 and earlier:
813	value	effect	~
814	  0	same as ":set backspace=" (Vi compatible)
815	  1	same as ":set backspace=indent,eol"
816	  2	same as ":set backspace=indent,eol,start"
817
818	See |:fixdel| if your <BS> or <Del> key does not do what you want.
819	NOTE: This option is set to "" when 'compatible' is set.
820
821				*'backup'* *'bk'* *'nobackup'* *'nobk'*
822'backup' 'bk'		boolean	(default off)
823			global
824			{not in Vi}
825	Make a backup before overwriting a file.  Leave it around after the
826	file has been successfully written.  If you do not want to keep the
827	backup file, but you do want a backup while the file is being
828	written, reset this option and set the 'writebackup' option (this is
829	the default).  If you do not want a backup file at all reset both
830	options (use this if your file system is almost full).  See the
831	|backup-table| for more explanations.
832	When the 'backupskip' pattern matches, a backup is not made anyway.
833	When 'patchmode' is set, the backup may be renamed to become the
834	oldest version of a file.
835	NOTE: This option is reset when 'compatible' is set.
836
837						*'backupcopy'* *'bkc'*
838'backupcopy' 'bkc'	string	(Vi default for Unix: "yes", otherwise: "auto")
839			global
840			{not in Vi}
841	When writing a file and a backup is made, this option tells how it's
842	done.  This is a comma separated list of words.
843
844	The main values are:
845	"yes"	make a copy of the file and overwrite the original one
846	"no"	rename the file and write a new one
847	"auto"	one of the previous, what works best
848
849	Extra values that can be combined with the ones above are:
850	"breaksymlink"	always break symlinks when writing
851	"breakhardlink"	always break hardlinks when writing
852
853	Making a copy and overwriting the original file:
854	- Takes extra time to copy the file.
855	+ When the file has special attributes, is a (hard/symbolic) link or
856	  has a resource fork, all this is preserved.
857	- When the file is a link the backup will have the name of the link,
858	  not of the real file.
859
860	Renaming the file and writing a new one:
861	+ It's fast.
862	- Sometimes not all attributes of the file can be copied to the new
863	  file.
864	- When the file is a link the new file will not be a link.
865
866	The "auto" value is the middle way: When Vim sees that renaming file
867	is possible without side effects (the attributes can be passed on and
868	and the file is not a link) that is used.  When problems are expected,
869	a copy will be made.
870
871	The "breaksymlink" and "breakhardlink" values can be used in
872	combination with any of "yes", "no" and "auto".  When included, they
873	force Vim to always break either symbolic or hard links by doing
874	exactly what the "no" option does, renaming the original file to
875	become the backup and writing a new file in its place.  This can be
876	useful for example in source trees where all the files are symbolic or
877	hard links and any changes should stay in the local source tree, not
878	be propagated back to the original source.
879							*crontab*
880	One situation where "no" and "auto" will cause problems: A program
881	that opens a file, invokes Vim to edit that file, and then tests if
882	the open file was changed (through the file descriptor) will check the
883	backup file instead of the newly created file.  "crontab -e" is an
884	example.
885
886	When a copy is made, the original file is truncated and then filled
887	with the new text.  This means that protection bits, owner and
888	symbolic links of the original file are unmodified.  The backup file
889	however, is a new file, owned by the user who edited the file.  The
890	group of the backup is set to the group of the original file.  If this
891	fails, the protection bits for the group are made the same as for
892	others.
893
894	When the file is renamed this is the other way around: The backup has
895	the same attributes of the original file, and the newly written file
896	is owned by the current user.  When the file was a (hard/symbolic)
897	link, the new file will not!  That's why the "auto" value doesn't
898	rename when the file is a link.  The owner and group of the newly
899	written file will be set to the same ones as the original file, but
900	the system may refuse to do this.  In that case the "auto" value will
901	again not rename the file.
902
903						*'backupdir'* *'bdir'*
904'backupdir' 'bdir'	string	(default for Amiga: ".,t:",
905				 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
906				 for Unix: ".,~/tmp,~/")
907			global
908			{not in Vi}
909	List of directories for the backup file, separated with commas.
910	- The backup file will be created in the first directory in the list
911	  where this is possible.
912	- Empty means that no backup file will be created ('patchmode' is
913	  impossible!).  Writing may fail because of this.
914	- A directory "." means to put the backup file in the same directory
915	  as the edited file.
916	- A directory starting with "./" (or ".\" for MS-DOS et.al.) means to
917	  put the backup file relative to where the edited file is.  The
918	  leading "." is replaced with the path name of the edited file.
919	  ("." inside a directory name has no special meaning).
920	- Spaces after the comma are ignored, other spaces are considered part
921	  of the directory name.  To have a space at the start of a directory
922	  name, precede it with a backslash.
923	- To include a comma in a directory name precede it with a backslash.
924	- A directory name may end in an '/'.
925	- Environment variables are expanded |:set_env|.
926	- Careful with '\' characters, type one before a space, type two to
927	  get one in the option (see |option-backslash|), for example: >
928	    :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
929<	- For backwards compatibility with Vim version 3.0 a '>' at the start
930	  of the option is removed.
931	See also 'backup' and 'writebackup' options.
932	If you want to hide your backup files on Unix, consider this value: >
933		:set backupdir=./.backup,~/.backup,.,/tmp
934<	You must create a ".backup" directory in each directory and in your
935	home directory for this to work properly.
936	The use of |:set+=| and |:set-=| is preferred when adding or removing
937	directories from the list.  This avoids problems when a future version
938	uses another default.
939	This option cannot be set from a |modeline| or in the |sandbox|, for
940	security reasons.
941
942						*'backupext'* *'bex'* *E589*
943'backupext' 'bex'	string	(default "~", for VMS: "_")
944			global
945			{not in Vi}
946	String which is appended to a file name to make the name of the
947	backup file.  The default is quite unusual, because this avoids
948	accidentally overwriting existing files with a backup file.  You might
949	prefer using ".bak", but make sure that you don't have files with
950	".bak" that you want to keep.
951
952						*'backupskip'* *'bsk'*
953'backupskip' 'bsk'	string	(default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
954			global
955			{not in Vi}
956			{not available when compiled without the |+wildignore|
957			feature}
958	A list of file patterns.  When one of the patterns matches with the
959	name of the file which is written, no backup file is created.  Both
960	the specified file name and the full path name of the file are used.
961	The pattern is used like with |:autocmd|, see |autocmd-patterns|.
962	Watch out for special characters, see |option-backslash|.
963	When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
964	default value. "/tmp/*" is only used for Unix.
965
966						*'balloondelay'* *'bdlay'*
967'balloondelay' 'bdlay'	number	(default: 600)
968			global
969			{not in Vi}
970			{only available when compiled with the |+balloon_eval|
971			feature}
972	Delay in milliseconds before a balloon may pop up.  See |balloon-eval|.
973
974		       *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
975'ballooneval' 'beval'	boolean	(default off)
976			global
977			{not in Vi}
978			{only available when compiled with the |+balloon_eval|
979			and |+sun_workshop| or |+netbeans_intg| features}
980	Switch on the |balloon-eval| functionality.
981
982				     *'binary'* *'bin'* *'nobinary'* *'nobin'*
983'binary' 'bin'		boolean	(default off)
984			local to buffer
985			{not in Vi}
986	This option should be set before editing a binary file.  You can also
987	use the |-b| Vim argument.  When this option is switched on a few
988	options will be changed (also when it already was on):
989		'textwidth'  will be set to 0
990		'wrapmargin' will be set to 0
991		'modeline'   will be off
992		'expandtab'  will be off
993	Also, 'fileformat' and 'fileformats' options will not be used, the
994	file is read and written like 'fileformat' was "unix" (a single <NL>
995	separates lines).
996	The 'fileencoding' and 'fileencodings' options will not be used, the
997	file is read without conversion.
998	NOTE: When you start editing a(nother) file while the 'bin' option is
999	on, settings from autocommands may change the settings again (e.g.,
1000	'textwidth'), causing trouble when editing.  You might want to set
1001	'bin' again when the file has been loaded.
1002	The previous values of these options are remembered and restored when
1003	'bin' is switched from on to off.  Each buffer has its own set of
1004	saved option values.
1005	To edit a file with 'binary' set you can use the |++bin| argument.
1006	This avoids you have to do ":set bin", which would have effect for all
1007	files you edit.
1008	When writing a file the <EOL> for the last line is only written if
1009	there was one in the original file (normally Vim appends an <EOL> to
1010	the last line if there is none; this would make the file longer).  See
1011	the 'endofline' option.
1012
1013			*'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1014'bioskey' 'biosk'	boolean	(default on)
1015			global
1016			{not in Vi}  {only for MS-DOS}
1017	When on the bios is called to obtain a keyboard character.  This works
1018	better to detect CTRL-C, but only works for the console.  When using a
1019	terminal over a serial port reset this option.
1020	Also see |'conskey'|.
1021
1022							*'bomb'* *'nobomb'*
1023'bomb'			boolean	(default off)
1024			local to buffer
1025			{not in Vi}
1026			{only available when compiled with the |+multi_byte|
1027			feature}
1028	When writing a file and the following conditions are met, a BOM (Byte
1029	Order Mark) is prepended to the file:
1030	- this option is on
1031	- the 'binary' option is off
1032	- 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1033	  endian variants.
1034	Some applications use the BOM to recognize the encoding of the file.
1035	Often used for UCS-2 files on MS-Windows.  For other applications it
1036	causes trouble, for example: "cat file1 file2" makes the BOM of file2
1037	appear halfway the resulting file.
1038	When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1039	check for the presence of the BOM is done and 'bomb' set accordingly.
1040	Unless 'binary' is set, it is removed from the first line, so that you
1041	don't see it when editing.  When you don't change the options, the BOM
1042	will be restored when writing the file.
1043
1044						*'breakat'* *'brk'*
1045'breakat' 'brk'		string	(default " ^I!@*-+;:,./?")
1046			global
1047			{not in Vi}
1048			{not available when compiled without the  |+linebreak|
1049			feature}
1050	This option lets you choose which characters might cause a line
1051	break if 'linebreak' is on.
1052
1053						*'browsedir'* *'bsdir'*
1054'browsedir' 'bsdir'	string	(default for "last")
1055			global
1056			{not in Vi} {only for Motif and Win32 GUI}
1057	Which directory to use for the file browser:
1058	   last		Use same directory as with last file browser.
1059	   buffer	Use the directory of the related buffer.
1060	   current	Use the current directory.
1061	   {path}	Use the specified directory
1062
1063						*'bufhidden'* *'bh'*
1064'bufhidden' 'bh'	string (default: "")
1065			local to buffer
1066			{not in Vi}
1067			{not available when compiled without the |+quickfix|
1068			feature}
1069	This option specifies what happens when a buffer is no longer
1070	displayed in a window:
1071	  <empty>	follow the global 'hidden' option
1072	  hide		hide the buffer (don't unload it), also when 'hidden'
1073			is not set
1074	  unload	unload the buffer, also when 'hidden' is set or using
1075			|:hide|
1076	  delete	delete the buffer from the buffer list, also when
1077			'hidden' is set or using |:hide|, like using
1078			|:bdelete|
1079	  wipe		wipe out the buffer from the buffer list, also when
1080			'hidden' is set or using |:hide|, like using
1081			|:bwipeout|
1082
1083	This option is used together with 'buftype' and 'swapfile' to specify
1084	special kinds of buffers.   See |special-buffers|.
1085
1086			*'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1087'buflisted' 'bl'	boolean (default: on)
1088			local to buffer
1089			{not in Vi}
1090	When this option is set, the buffer shows up in the buffer list.  If
1091	it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1092	This option is reset by Vim for buffers that are only used to remember
1093	a file name or marks.  Vim sets it when starting to edit a buffer.
1094	But not when moving to a buffer with ":buffer".
1095
1096						*'buftype'* *'bt'* *E382*
1097'buftype' 'bt'		string (default: "")
1098			local to buffer
1099			{not in Vi}
1100			{not available when compiled without the |+quickfix|
1101			feature}
1102	The value of this option specifies the type of a buffer:
1103	  <empty>	normal buffer
1104	  nofile	buffer which is not related to a file and will not be
1105			written
1106	  nowrite	buffer which will not be written
1107	  quickfix	quickfix buffer, contains list of errors |:cwindow|
1108	  help		help buffer (you are not supposed to set this
1109			manually)
1110
1111	This option is used together with 'bufhidden' and 'swapfile' to
1112	specify special kinds of buffers.   See |special-buffers|.
1113
1114	Be careful with changing this option, it can have many side effects!
1115
1116	A "quickfix" buffer is only used for the error list.  This value is
1117	set by the |:cwindow| command and you are not supposed to change it.
1118
1119	"nofile" and "nowrite" buffers are similar:
1120	both:		The buffer is not to be written to disk, ":w" doesn't
1121			work (":w filename" does work though).
1122	both:		The buffer is never considered to be |'modified'|.
1123			There is no warning when the changes will be lost, for
1124			example when you quit Vim.
1125	both:		A swap file is only created when using too much memory
1126			(when 'swapfile' has been reset there is never a swap
1127			file).
1128	nofile only:	The buffer name is fixed, it is not handled like a
1129			file name.  It is not modified in response to a |:cd|
1130			command.
1131
1132						*'casemap'* *'cmp'*
1133'casemap' 'cmp'		string	(default: "internal,keepascii")
1134			global
1135			{not in Vi}
1136	Specifies details about changing the case of letters.  It may contain
1137	these words, separated by a comma:
1138	internal	Use internal case mapping functions, the current
1139			locale does not change the case mapping.  This only
1140			matters when 'encoding' is a Unicode encoding.  When
1141			"internal" is omitted, the towupper() and towlower()
1142			system library functions are used when available.
1143	keepascii	For the ASCII characters (0x00 to 0x7f) use the US
1144			case mapping, the current locale is not effective.
1145			This probably only matters for Turkish.
1146
1147						*'cdpath'* *'cd'* *E344* *E346*
1148'cdpath' 'cd'		string	(default: equivalent to $CDPATH or ",,")
1149			global
1150			{not in Vi}
1151			{not available when compiled without the
1152			|+file_in_path| feature}
1153	This is a list of directories which will be searched when using the
1154	|:cd| and |:lcd| commands, provided that the directory being searched
1155	for has a relative path (not starting with "/", "./" or "../").
1156	The 'cdpath' option's value has the same form and semantics as
1157	|'path'|.  Also see |file-searching|.
1158	The default value is taken from $CDPATH, with a "," prepended to look
1159	in the current directory first.
1160	If the default value taken from $CDPATH is not what you want, include
1161	a modified version of the following command in your vimrc file to
1162	override it: >
1163	  :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1164<	This option cannot be set from a |modeline| or in the |sandbox|, for
1165	security reasons.
1166	(parts of 'cdpath' can be passed to the shell to expand file names).
1167
1168						*'cedit'*
1169'cedit'			string	(Vi default: "", Vim default: CTRL-F)
1170			global
1171			{not in Vi}
1172			{not available when compiled without the |+vertsplit|
1173			feature}
1174	The key used in Command-line Mode to open the command-line window.
1175	The default is CTRL-F when 'compatible' is off.
1176	Only non-printable keys are allowed.
1177	The key can be specified as a single character, but it is difficult to
1178	type.  The preferred way is to use the <> notation.  Examples: >
1179		:set cedit=<C-Y>
1180		:set cedit=<Esc>
1181<	|Nvi| also has this option, but it only uses the first character.
1182	See |cmdwin|.
1183
1184				*'charconvert'* *'ccv'* *E202* *E214* *E513*
1185'charconvert' 'ccv'	string (default "")
1186			global
1187			{only available when compiled with the |+multi_byte|
1188			feature and the |+eval| feature}
1189			{not in Vi}
1190	An expression that is used for character encoding conversion.  It is
1191	evaluated when a file that is to be read or has been written has a
1192	different encoding from what is desired.
1193	'charconvert' is not used when the internal iconv() function is
1194	supported and is able to do the conversion.  Using iconv() is
1195	preferred, because it is much faster.
1196	'charconvert' is not used when reading stdin |--|, because there is no
1197	file to convert from.  You will have to save the text in a file first.
1198	The expression must return zero or an empty string for success,
1199	non-zero for failure.
1200	The possible encoding names encountered are in 'encoding'.
1201	Additionally, names given in 'fileencodings' and 'fileencoding' are
1202	used.
1203	Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1204	is done internally by Vim, 'charconvert' is not used for this.
1205	'charconvert' is also used to convert the viminfo file, if the 'c'
1206	flag is present in 'viminfo'.  Also used for Unicode conversion.
1207	Example: >
1208		set charconvert=CharConvert()
1209		fun CharConvert()
1210		  system("recode "
1211			\ . v:charconvert_from . ".." . v:charconvert_to
1212			\ . " <" . v:fname_in . " >" v:fname_out)
1213		  return v:shell_error
1214		endfun
1215<	The related Vim variables are:
1216		v:charconvert_from	name of the current encoding
1217		v:charconvert_to	name of the desired encoding
1218		v:fname_in		name of the input file
1219		v:fname_out		name of the output file
1220	Note that v:fname_in and v:fname_out will never be the same.
1221	Note that v:charconvert_from and v:charconvert_to may be different
1222	from 'encoding'.  Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1223	Encryption is not done by Vim when using 'charconvert'.  If you want
1224	to encrypt the file after conversion, 'charconvert' should take care
1225	of this.
1226	This option cannot be set from a |modeline| or in the |sandbox|, for
1227	security reasons.
1228
1229				   *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1230'cindent' 'cin'		boolean	(default off)
1231			local to buffer
1232			{not in Vi}
1233			{not available when compiled without the |+cindent|
1234			feature}
1235	Enables automatic C program indenting  See 'cinkeys' to set the keys
1236	that trigger reindenting in insert mode and 'cinoptions' to set your
1237	preferred indent style.
1238	If 'indentexpr' is not empty, it overrules 'cindent'.
1239	If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1240	the "=" operator indents using this algorithm rather than calling an
1241	external program.
1242	See |C-indenting|.
1243	When you don't like the way 'cindent' works, try the 'smartindent'
1244	option or 'indentexpr'.
1245	This option is not used when 'paste' is set.
1246	NOTE: This option is reset when 'compatible' is set.
1247
1248							*'cinkeys'* *'cink'*
1249'cinkeys' 'cink'	string	(default "0{,0},0),:,0#,!^F,o,O,e")
1250			local to buffer
1251			{not in Vi}
1252			{not available when compiled without the |+cindent|
1253			feature}
1254	A list of keys that, when typed in Insert mode, cause reindenting of
1255	the current line.  Only used if 'cindent' is on and 'indentexpr' is
1256	empty.
1257	For the format of this option see |cinkeys-format|.
1258	See |C-indenting|.
1259
1260						*'cinoptions'* *'cino'*
1261'cinoptions' 'cino'	string	(default "")
1262			local to buffer
1263			{not in Vi}
1264			{not available when compiled without the |+cindent|
1265			feature}
1266	The 'cinoptions' affect the way 'cindent' reindents lines in a C
1267	program.  See |cinoptions-values| for the values of this option, and
1268	|C-indenting| for info on C indenting in general.
1269
1270
1271						*'cinwords'* *'cinw'*
1272'cinwords' 'cinw'	string	(default "if,else,while,do,for,switch")
1273			local to buffer
1274			{not in Vi}
1275			{not available when compiled without both the
1276			|+cindent| and the |+smartindent| features}
1277	These keywords start an extra indent in the next line when
1278	'smartindent' or 'cindent' is set.  For 'cindent' this is only done at
1279	an appropriate place (inside {}).
1280	Note that 'ignorecase' isn't used for 'cinwords'.  If case doesn't
1281	matter, include the keyword both the uppercase and lowercase:
1282	"if,If,IF".
1283
1284						*'clipboard'* *'cb'*
1285'clipboard' 'cb'	string	(default "autoselect,exclude:cons\|linux"
1286						  for X-windows, "" otherwise)
1287			global
1288			{not in Vi}
1289			{only in GUI versions or when the |+xterm_clipboard|
1290			feature is included}
1291	This option is a list of comma separated names.
1292	These names are recognized:
1293
1294	unnamed		When included, Vim will use the clipboard register '*'
1295			for all yank, delete, change and put operations which
1296			would normally go to the unnamed register.  When a
1297			register is explicitly specified, it will always be
1298			used regardless of whether "unnamed" is in 'clipboard'
1299			or not.  The clipboard register can always be
1300			explicitly accessed using the "* notation.  Also see
1301			|gui-clipboard|.
1302
1303	autoselect	Works like the 'a' flag in 'guioptions': If present,
1304			then whenever Visual mode is started, or the Visual
1305			area extended, Vim tries to become the owner of the
1306			windowing system's global selection or put the
1307			selected text on the clipboard used by the selection
1308			register "*.  See |guioptions_a| and |quotestar| for
1309			details.  When the GUI is active, the 'a' flag in
1310			'guioptions' is used, when the GUI is not active, this
1311			"autoselect" flag is used.
1312			Also applies to the modeless selection.
1313
1314	autoselectml	Like "autoselect", but for the modeless selection
1315			only.  Compare to the 'A' flag in 'guioptions'.
1316
1317	exclude:{pattern}
1318			Defines a pattern that is matched against the name of
1319			the terminal 'term'.  If there is a match, no
1320			connection will be made to the X server.  This is
1321			useful in this situation:
1322			- Running Vim in a console.
1323			- $DISPLAY is set to start applications on another
1324			  display.
1325			- You do not want to connect to the X server in the
1326			  console, but do want this in a terminal emulator.
1327			To never connect to the X server use: >
1328				exclude:.*
1329<			This has the same effect as using the |-X| argument.
1330			Note that when there is no connection to the X server
1331			the window title won't be restored and the clipboard
1332			cannot be accessed.
1333			The value of 'magic' is ignored, {pattern} is
1334			interpreted as if 'magic' was on.
1335			The rest of the option value will be used for
1336			{pattern}, this must be the last entry.
1337
1338						*'cmdheight'* *'ch'*
1339'cmdheight' 'ch'	number	(default 1)
1340			global
1341			{not in Vi}
1342	Number of screen lines to use for the command-line.  Helps avoiding
1343	|hit-enter| prompts.
1344
1345						*'cmdwinheight'* *'cwh'*
1346'cmdwinheight' 'cwh'	number	(default 7)
1347			global
1348			{not in Vi}
1349			{not available when compiled without the |+vertsplit|
1350			feature}
1351	Number of screen lines to use for the command-line window. |cmdwin|
1352
1353						*'columns'* *'co'* *E594*
1354'columns' 'co'		number	(default 80 or terminal width)
1355			global
1356			{not in Vi}
1357	Number of columns of the screen.  Normally this is set by the terminal
1358	initialization and does not have to be set by hand.
1359	When Vim is running in the GUI or in a resizable window, setting this
1360	option will cause the window size to be changed.  When you only want
1361	to use the size for the GUI, put the command in your |gvimrc| file.
1362	When you set this option and Vim is unable to change the physical
1363	number of columns of the display, the display may be messed up.
1364
1365					*'comments'* *'com'* *E524* *E525*
1366'comments' 'com'	string	(default
1367				"s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1368			local to buffer
1369			{not in Vi}
1370			{not available when compiled without the |+comments|
1371			feature}
1372	A comma separated list of strings that can start a comment line.  See
1373	|format-comments|.  See |option-backslash| about using backslashes to
1374	insert a space.
1375
1376					*'commentstring'* *'cms'* *E537*
1377'commentstring' 'cms'	string	(default "/*%s*/")
1378			local to buffer
1379			{not in Vi}
1380			{not available when compiled without the |+folding|
1381			feature}
1382	A template for a comment.  The "%s" in the value is replaced with the
1383	comment text.  Currently only used to add markers for folding, see
1384	|fold-marker|.
1385
1386			*'compatible'* *'cp'* *'nocompatible'* *'nocp'*
1387'compatible' 'cp'	boolean	(default on, off when a .vimrc file is found)
1388			global
1389			{not in Vi}
1390	This option has the effect of making Vim either more Vi-compatible, or
1391	make Vim behave in a more useful way.
1392	This is a special kind of option, because when it's set or reset,
1393	other options are also changed as a side effect.  CAREFUL: Setting or
1394	resetting this option can have a lot of unexpected effects: Mappings
1395	are interpreted in another way, undo behaves differently, etc.  If you
1396	set this option in your vimrc file, you should probably put it at the
1397	very start.
1398	By default this option is on and the Vi defaults are used for the
1399	options.  This default was chosen for those people who want to use Vim
1400	just like Vi, and don't even (want to) know about the 'compatible'
1401	option.
1402	When a ".vimrc" file is found while Vim is starting up, this option is
1403	switched off, and all options that have not been modified will be set
1404	to the Vim defaults.  Effectively, this means that when a ".vimrc"
1405	file exists, Vim will use the Vim defaults, otherwise it will use the
1406	Vi defaults.  (Note: This doesn't happen for the system-wide vimrc
1407	file).  Also see |compatible-default|.
1408	You can also set this option with the "-C" argument, and reset it with
1409	"-N".  See |-C| and |-N|.
1410	Switching this option off makes the Vim defaults be used for options
1411	that have a different Vi and Vim default value.  See the options
1412	marked with a '+' below.  Other options are not modified.
1413	At the moment this option is set, several other options will be set
1414	or reset to make Vim as Vi-compatible as possible.  See the table
1415	below.  This can be used if you want to revert to Vi compatible
1416	editing.
1417	See also 'cpoptions'.
1418
1419	option		+ set value	effect	~
1420
1421	'allowrevins'	  off		no CTRL-_ command
1422	'backupcopy'	  Unix: "yes"	  backup file is a copy
1423			  others: "auto"  copy or rename backup file
1424	'backspace'	  ""		normal backspace
1425	'backup'	  off		no backup file
1426	'cindent'	  off		no C code indentation
1427	'cedit'		+ ""		no key to open the |cmdwin|
1428	'cpoptions'	+ (all flags)	Vi-compatible flags
1429	'cscopetag'	  off		don't use cscope for ":tag"
1430	'cscopetagorder'  0		see |cscopetagorder|
1431	'cscopeverbose'	  off		see |cscopeverbose|
1432	'digraph'	  off		no digraphs
1433	'esckeys'	+ off		no <Esc>-keys in Insert mode
1434	'expandtab'	  off		tabs not expanded to spaces
1435	'fileformats'	+ ""		no automatic file format detection,
1436			  "dos,unix"	except for DOS, Windows and OS/2
1437	'formatoptions'	+ "vt"		Vi compatible formatting
1438	'gdefault'	  off		no default 'g' flag for ":s"
1439	'history'	+ 0		no commandline history
1440	'hkmap'		  off		no Hebrew keyboard mapping
1441	'hkmapp'	  off		no phonetic Hebrew keyboard mapping
1442	'hlsearch'	  off		no highlighting of search matches
1443	'incsearch'	  off		no incremental searching
1444	'indentexpr'	  ""		no indenting by expression
1445	'insertmode'	  off		do not start in Insert mode
1446	'iskeyword'	+ "@,48-57,_"	keywords contain alphanumeric
1447						characters and '_'
1448	'joinspaces'	  on		insert 2 spaces after period
1449	'modeline'	+ off		no modelines
1450	'more'		+ off		no pauses in listings
1451	'revins'	  off		no reverse insert
1452	'ruler'		  off		no ruler
1453	'scrolljump'	  1		no jump scroll
1454	'scrolloff'	  0		no scroll offset
1455	'shiftround'	  off		indent not rounded to shiftwidth
1456	'shortmess'	+ ""		no shortening of messages
1457	'showcmd'	+ off		command characters not shown
1458	'showmode'	+ off		current mode not shown
1459	'smartcase'	  off		no automatic ignore case switch
1460	'smartindent'	  off		no smart indentation
1461	'smarttab'	  off		no smart tab size
1462	'softtabstop'	  0		tabs are always 'tabstop' positions
1463	'startofline'	  on		goto startofline with some commands
1464	'tagrelative'	+ off		tag file names are not relative
1465	'textauto'	+ off		no automatic textmode detection
1466	'textwidth'	  0		no automatic line wrap
1467	'tildeop'	  off		tilde is not an operator
1468	'ttimeout'	  off		no terminal timeout
1469	'whichwrap'	+ ""		left-right movements don't wrap
1470	'wildchar'	+ CTRL-E	only when the current value is <Tab>
1471					use CTRL-E for cmdline completion
1472	'writebackup'	  on or off	depends on +writebackup feature
1473
1474						*'complete'* *'cpt'* *E535*
1475'complete' 'cpt'	string	(default: ".,w,b,u,t,i")
1476			local to buffer
1477			{not in Vi}
1478	This option specifies how keyword completion |ins-completion| works
1479	when CTRL-P or CTRL-N are used.  It is also used for whole-line
1480	completion |i_CTRL-X_CTRL-L|.  It indicates the type of completion
1481	and the places to scan.  It is a comma separated list of flags:
1482	.	scan the current buffer ('wrapscan' is ignored)
1483	w	scan buffers from other windows
1484	b	scan other loaded buffers that are in the buffer list
1485	u	scan the unloaded buffers that are in the buffer list
1486	U	scan the buffers that are not in the buffer list
1487	k	scan the files given with the 'dictionary' option
1488	k{dict}	scan the file {dict}.  Several "k" flags can be given,
1489		patterns are valid too.  For example: >
1490			:set cpt=k/usr/dict/*,k~/spanish
1491<	s	scan the files given with the 'thesaurus' option
1492	s{tsr}	scan the file {tsr}.  Several "s" flags can be given, patterns
1493		are valid too.
1494	i	scan current and included files
1495	d	scan current and included files for defined name or macro
1496		|i_CTRL-X_CTRL-D|
1497	]	tag completion
1498	t	same as "]"
1499
1500	Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1501	not executed, this may lead to unexpected completions from some files
1502	(gzipped files for example).  Unloaded buffers are not scanned for
1503	whole-line completion.
1504
1505	The default is ".,w,b,u,t,i", which means to scan:
1506	   1. the current buffer
1507	   2. buffers in other windows
1508	   3. other loaded buffers
1509	   4. unloaded buffers
1510	   5. tags
1511	   6. included files
1512
1513	As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
1514	based expansion (eg dictionary |i_CTRL-X_CTRL-K|, included patterns
1515	|i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions)
1516
1517						*'completefunc'* *'cfu'*
1518'completefunc' 'cfu'	string	(default: empty)
1519			local to buffer
1520			{not in Vi}
1521	This option specifies a completion function to be used for CTRL-X
1522	CTRL-X.  The function will be invoked with four arguments:
1523	   a:line	the text of the current line
1524	   a:base	the text with which matches should match
1525	   a:col        column in a:line where the cursor is, first column is
1526	   		zero
1527	   a:findstart  either 1 or 0
1528	When the a:findstart argument is 1, the function must return the
1529	column of where the completion starts.  It must be a number between
1530	zero and "a:col".  This involves looking at the characters in a:line
1531	before column a:col and include those characters that could be part of
1532	the completed item.
1533	When the a:findstart argument is 0 the function must return a string
1534	with the matching words, separated by newlines.  When there are no
1535	matches return an empty string.
1536	An example that completes the names of the months: >
1537		fun! CompleteMonths(line, base, col, findstart)
1538		  if a:findstart
1539		    " locate start column of word
1540		    let start = a:col
1541		    while start > 0 && a:line[start - 1] =~ '\a'
1542		      let start = start - 1
1543		    endwhile
1544		    return start
1545		  else
1546		    " find months matching with "a:base"
1547		    let res = "Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
1548		    if a:base != ''
1549		      let res = substitute(res, '\c\<\(\(' . a:base . '.\{-}\>\)\|.\{-}\>\)', '\2', 'g')
1550		    endif
1551		    let res = substitute(res, ' \+', "\n", 'g')
1552		    return res
1553		  endif
1554		endfun
1555		set completefunc=CompleteMonths
1556<	Note that a substitute() function is used to reduce the list of
1557	possible values and remove the ones that don't match the base.  The
1558	part before the "\|" matches the base, the part after it is used
1559	when there is no match.  The "\2" in the replacement is empty if the
1560	part before the "\|" does not match.
1561
1562				*'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1563'confirm' 'cf'		boolean (default off)
1564			global
1565			{not in Vi}
1566	When 'confirm' is on, certain operations that would normally
1567	fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1568	instead raise a |dialog| asking if you wish to save the current
1569	file(s).  You can still use a ! to unconditionally |abandon| a buffer.
1570	If 'confirm' is off you can still activate confirmation for one
1571	command only (this is most useful in mappings) with the |:confirm|
1572	command.
1573	Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1574
1575			*'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1576'conskey' 'consk'	boolean	(default off)
1577			global
1578			{not in Vi}  {only for MS-DOS}
1579	When on direct console I/O is used to obtain a keyboard character.
1580	This should work in most cases.  Also see |'bioskey'|.  Together,
1581	three methods of console input are available:
1582	'conskey'   'bioskey'	    action ~
1583	   on	     on or off	    direct console input
1584	   off		on	    BIOS
1585	   off		off	    STDIN
1586
1587			*'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1588'copyindent' 'ci'	boolean	(default off)
1589			local to buffer
1590			{not in Vi}
1591	Copy the structure of the existing lines indent when autoindenting a
1592	new line.  Normally the new indent is reconstructed by a series of
1593	tabs followed by spaces as required (unless |'expandtab'| is enabled,
1594	in which case only spaces are used).  Enabling this option makes the
1595	new line copy whatever characters were used for indenting on the
1596	existing line.  If the new indent is greater than on the existing
1597	line, the remaining space is filled in the normal manner.
1598	NOTE: 'copyindent' is reset when 'compatible' is set.
1599	Also see 'preserveindent'.
1600
1601						*'cpoptions'* *'cpo'*
1602'cpoptions' 'cpo'	string	(Vim default: "aABceFs",
1603				 Vi default:  all flags)
1604			global
1605			{not in Vi}
1606	A sequence of single character flags.  When a character is present
1607	this indicates vi-compatible behavior.  This is used for things where
1608	not being vi-compatible is mostly or sometimes preferred.
1609	'cpoptions' stands for "compatible-options".
1610	Commas can be added for readability.
1611	To avoid problems with flags that are added in the future, use the
1612	"+=" and "-=" feature of ":set" |add-option-flags|.
1613	NOTE: This option is set to the Vi default value when 'compatible' is
1614	set and to the Vim default value when 'compatible' is reset.
1615
1616	    contains	behavior	~
1617								*cpo-a*
1618		a	When included, a ":read" command with a file name
1619			argument will set the alternate file name for the
1620			current window.
1621								*cpo-A*
1622		A	When included, a ":write" command with a file name
1623			argument will set the alternate file name for the
1624			current window.
1625								*cpo-b*
1626		b	"\|" in a ":map" command is recognized as the end of
1627			the map command.  The '\' is included in the mapping,
1628			the text after the '|' is interpreted as the next
1629			command.  Use a CTRL-V instead of a backslash to
1630			include the '|' in the mapping.  Applies to all
1631			mapping, abbreviation, menu and autocmd commands.
1632			See also |map_bar|.
1633								*cpo-B*
1634		B	A backslash has no special meaning in mappings,
1635			abbreviations and the "to" part of the menu commands.
1636			Remove this flag to be able to use a backslash like a
1637			CTRL-V.  For example, the command ":map X \<Esc>"
1638			results in X being mapped to:
1639				'B' included:	"\^["	 (^[ is a real <Esc>)
1640				'B' excluded:	"<Esc>"  (5 characters)
1641				('<' excluded in both cases)
1642								*cpo-c*
1643		c	Searching continues at the end of any match at the
1644			cursor position, but not further than the start of the
1645			next line.  When not present searching continues
1646			one character from the cursor position.  With 'c'
1647			"abababababab" only gets three matches when repeating
1648			"/abab", without 'c' there are five matches.
1649								*cpo-C*
1650		C	Do not concatenate sourced lines that start with a
1651			backslash.  See |line-continuation|.
1652								*cpo-d*
1653		d	Using "./" in the 'tags' option doesn't mean to use
1654			the tags file relative to the current file, but the
1655			tags file in the current directory.
1656								*cpo-D*
1657		D	Can't use CTRL-K to enter a digraph after Normal mode
1658			commands with a character argument, like |r|, |f| and
1659			|t|.
1660								*cpo-e*
1661		e	When executing a register with ":@r", always add a
1662			<CR> to the last line, also when the register is not
1663			linewise.  If this flag is not present, the register
1664			is not linewise and the last line does not end in a
1665			<CR>, then the last line is put on the command-line
1666			and can be edited before hitting <CR>.
1667								*cpo-E*
1668		E	It is an error when using "y", "d", "c", "g~", "gu" or
1669			"gU" on an Empty region.  The operators only work when
1670			at least one character is to be operate on.  Example:
1671			This makes "y0" fail in the first column.
1672								*cpo-f*
1673		f	When included, a ":read" command with a file name
1674			argument will set the file name for the current buffer,
1675			if the current buffer doesn't have a file name yet.
1676								*cpo-F*
1677		F	When included, a ":write" command with a file name
1678			argument will set the file name for the current
1679			buffer, if the current buffer doesn't have a file name
1680			yet.
1681								*cpo-g*
1682		g	Goto line 1 when using ":edit" without argument.
1683								*cpo-i*
1684		i	When included, interrupting the reading of a file will
1685			leave it modified.
1686								*cpo-I*
1687		I	When moving the cursor up or down just after inserting
1688			indent for 'autoindent', do not delete the indent.
1689								*cpo-j*
1690		j	When joining lines, only add two spaces after a '.',
1691			not after '!' or '?'.  Also see 'joinspaces'.
1692								*cpo-J*
1693		J	A |sentence| has to be followed by two spaces after
1694			the '.', '!' or '?'. A <Tab> is not recognized as
1695			white space.
1696								*cpo-k*
1697		k	Disable the recognition of raw key codes in
1698			mappings, abbreviations, and the "to" part of menu
1699			commands.  For example, if <Key> sends ^[OA (where ^[
1700			is <Esc>), the command ":map X ^[OA" results in X
1701			being mapped to:
1702				'k' included:	"^[OA"	 (3 characters)
1703				'k' excluded:	"<Key>"  (one key code)
1704			Also see the '<' flag below.
1705								*cpo-K*
1706		K	Don't wait for a key code to complete when it is
1707			halfway a mapping.  This breaks mapping <F1><F1> when
1708			only part of the second <F1> has been read.  It
1709			enables cancelling the mapping by typing <F1><Esc>.
1710								*cpo-l*
1711		l	Backslash in a [] range in a search pattern is taken
1712			literally, only "\]" is special  See |/[]|
1713			   'l' included: "/[ \t]"  finds <Space>, '\' and 't'
1714			   'l' excluded: "/[ \t]"  finds <Space> and <Tab>
1715								*cpo-L*
1716		L	When the 'list' option is set, 'wrapmargin',
1717			'textwidth', 'softtabstop' and Virtual Replace mode
1718			(see |gR|) count a <Tab> as two characters, instead of
1719			the normal behavior of a <Tab>.
1720								*cpo-m*
1721		m	When included, a showmatch will always wait half a
1722			second.  When not included, a showmatch will wait half
1723			a second or until a character is typed.  |'showmatch'|
1724								*cpo-M*
1725		M	When excluded, "%" matching will take backslashes into
1726			account.  Thus in "( \( )" and "\( ( \)" the outer
1727			parenthesis match.  When included "%" ignores
1728			backslashes, which is Vi compatible.
1729								*cpo-n*
1730		n	When included, the column used for 'number' will also
1731			be used for text of wrapped lines.
1732								*cpo-o*
1733		o	Line offset to search command is not remembered for
1734			next search.
1735								*cpo-O*
1736		O	Don't complain if a file is being overwritten, even
1737			when it didn't exist when editing it.  This is a
1738			protection against a file unexpectedly created by
1739			someone else.  Vi didn't complain about this.
1740								*cpo-p*
1741		p	Vi compatible Lisp indenting.  When not present, a
1742			slightly better algorithm is used.
1743								*cpo-r*
1744		r	Redo ("." command) uses "/" to repeat a search
1745			command, instead of the actually used search string.
1746								*cpo-R*
1747		R	Remove marks from filtered lines.  Without this flag
1748			marks are kept like |:keepmarks| was used.
1749								*cpo-s*
1750		s	Set buffer options when entering the buffer for the
1751			first time.  This is like it is in Vim version 3.0.
1752			And it is the default.  If not present the options are
1753			set when the buffer is created.
1754								*cpo-S*
1755		S	Set buffer options always when entering a buffer
1756			(except 'readonly', 'fileformat', 'filetype' and
1757			'syntax').  This is the (most) Vi compatible setting.
1758			The options are set to the values in the current
1759			buffer.  When you change an option and go to another
1760			buffer, the value is copied.  Effectively makes the
1761			buffer options global to all buffers.
1762
1763			's'    'S'     copy buffer options
1764			no     no      when buffer created
1765			yes    no      when buffer first entered (default)
1766			 X     yes     each time when buffer entered (vi comp.)
1767								*cpo-t*
1768		t	Search pattern for the tag command is remembered for
1769			"n" command.  Otherwise Vim only puts the pattern in
1770			the history for search pattern, but doesn't change the
1771			last used search pattern.
1772								*cpo-u*
1773		u	Undo is Vi compatible.  See |undo-two-ways|.
1774								*cpo-v*
1775		v	Backspaced characters remain visible on the screen in
1776			Insert mode.  Without this flag the characters are
1777			erased from the screen right away.  With this flag the
1778			screen newly typed text overwrites backspaced
1779			characters.
1780								*cpo-w*
1781		w	When using "cw" on a blank character, only change one
1782			character and not all blanks until the start of the
1783			next word.
1784								*cpo-W*
1785		W	Don't overwrite a readonly file.  When omitted, ":w!"
1786			overwrites a readonly file, if possible.
1787								*cpo-x*
1788		x	<Esc> on the command-line executes the command-line.
1789			The default in Vim is to abandon the command-line,
1790			because <Esc> normally aborts a command.  |c_<Esc>|
1791								*cpo-y*
1792		y	A yank command can be redone with ".".
1793								*cpo-!*
1794		!	When redoing a filter command, use the last used
1795			external command, whatever it was.  Otherwise the last
1796			used -filter- command is used.
1797								*cpo-$*
1798		$	When making a change to one line, don't redisplay the
1799			line, but put a '$' at the end of the changed text.
1800			The changed text will be overwritten when you type the
1801			new text.  The line is redisplayed if you type any
1802			command that moves the cursor from the insertion
1803			point.
1804								*cpo-%*
1805		%	Vi-compatible matching is done for the "%" command.
1806			Does not recognize "#if", "#endif", etc.
1807			Does not recognize "/*" and "*/".
1808			Parens inside single and double quotes are also
1809			counted, causing a string that contains a paren to
1810			disturb the matching.  For example, in a line like
1811			"if (strcmp("foo(", s))" the first paren does not
1812			match the last one.  When this flag is not included,
1813			parens inside single and double quotes are treated
1814			specially.  When matching a paren outside of quotes,
1815			everything inside quotes is ignored.  When matching a
1816			paren inside quotes, it will find the matching one (if
1817			there is one).  This works very well for C programs.
1818								*cpo-star*
1819		*	Use ":*" in the same way as ":@".  When not included,
1820			":*" is an alias for ":'<,'>", select the Visual area.
1821								*cpo-<*
1822		<	Disable the recognition of special key codes in |<>|
1823			form in mappings, abbreviations, and the "to" part of
1824			menu commands.  For example, the command
1825			":map X <Tab>" results in X being mapped to:
1826				'<' included:	"<Tab>"  (5 characters)
1827				'<' excluded:	"^I"	 (^I is a real <Tab>)
1828			Also see the 'k' flag above.
1829
1830						*'cscopepathcomp'* *'cspc'*
1831'cscopepathcomp' 'cspc'	number	(default 0)
1832			global
1833			{not available when compiled without the |+cscope|
1834			feature}
1835			{not in Vi}
1836	Determines how many components of the path to show in a list of tags.
1837	See |cscopepathcomp|.
1838
1839						*'cscopeprg'* *'csprg'*
1840'cscopeprg' 'csprg'	string	(default "cscope")
1841			global
1842			{not available when compiled without the |+cscope|
1843			feature}
1844			{not in Vi}
1845	Specifies the command to execute cscope.  See |cscopeprg|.
1846	This option cannot be set from a |modeline| or in the |sandbox|, for
1847	security reasons.
1848
1849						*'cscopequickfix'* *'csqf'*
1850'cscopequickfix' 'csqf' string	(default "")
1851			global
1852			{not available when compiled without the |+cscope|
1853			or |+quickfix| features}
1854			{not in Vi}
1855	Specifies whether to use quickfix window to show cscope results.
1856	See |cscopequickfix|.
1857
1858				*'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
1859'cscopetag' 'cst'	boolean (default off)
1860			global
1861			{not available when compiled without the |+cscope|
1862			feature}
1863			{not in Vi}
1864	Use cscope for tag commands.  See |cscope-options|.
1865	NOTE: This option is reset when 'compatible' is set.
1866
1867						*'cscopetagorder'* *'csto'*
1868'cscopetagorder' 'csto'	number	(default 0)
1869			global
1870			{not available when compiled without the |+cscope|
1871			feature}
1872			{not in Vi}
1873	Determines the order in which ":cstag" performs a search.  See
1874	|cscopetagorder|.
1875	NOTE: This option is set to 0 when 'compatible' is set.
1876
1877					*'cscopeverbose'* *'csverb'*
1878					*'nocscopeverbose'* *'nocsverb'*
1879'cscopeverbose' 'csverb' boolean (default off)
1880			global
1881			{not available when compiled without the |+cscope|
1882			feature}
1883			{not in Vi}
1884	Give messages when adding a cscope database.  See |cscopeverbose|.
1885	NOTE: This option is reset when 'compatible' is set.
1886
1887						*'debug'*
1888'debug'			string	(default "")
1889			global
1890			{not in Vi}
1891	When set to "msg", error messages that would otherwise be omitted will
1892	be given anyway.  This is useful when debugging 'foldexpr' or
1893	'indentexpr'.
1894
1895						*'define'* *'def'*
1896'define' 'def'		string	(default "^\s*#\s*define")
1897			global or local to buffer |global-local|
1898			{not in Vi}
1899	Pattern to be used to find a macro definition.  It is a search
1900	pattern, just like for the "/" command.  This option is used for the
1901	commands like "[i" and "[d" |include-search|.  The 'isident' option is
1902	used to recognize the defined name after the match:
1903		{match with 'define'}{non-ID chars}{defined name}{non-ID char}
1904	See |option-backslash| about inserting backslashes to include a space
1905	or backslash.
1906	The default value is for C programs.  For C++ this value would be
1907	useful, to include const type declarations: >
1908		^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
1909<	When using the ":set" command, you need to double the backslashes!
1910
1911			*'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
1912'delcombine' 'deco'	boolean (default off)
1913			global
1914			{not in Vi}
1915			{only available when compiled with the |+multi_byte|
1916			feature}
1917	If editing Unicode and this option is set, backspace and Normal mode
1918	"x" delete each combining character on its own.  When it is off (the
1919	default) the character along with its combining characters are
1920	deleted.
1921	Note: When 'delcombine' is set "xx" may work different from "2x"!
1922
1923	This is useful for Arabic, Hebrew and many other languages where one
1924	may have combining characters overtop of base characters, and want
1925	to remove only the combining ones.
1926
1927						*'dictionary'* *'dict'*
1928'dictionary' 'dict'	string	(default "")
1929			global or local to buffer |global-local|
1930			{not in Vi}
1931	List of file names, separated by commas, that are used to lookup words
1932	for keyword completion commands |i_CTRL-X_CTRL-K|.  Each file should
1933	contain a list of words.  This can be one word per line, or several
1934	words per line, separated by non-keyword characters (white space is
1935	preferred).  Maximum line length is 510 bytes.
1936	To include a comma in a file name precede it with a backslash.  Spaces
1937	after a comma are ignored, otherwise spaces are included in the file
1938	name.  See |option-backslash| about using backslashes.
1939	Where to find a list of words?
1940	- On FreeBSD, there is the file "/usr/share/dict/words".
1941	- In the Simtel archive, look in the "msdos/linguist" directory.
1942	- In "miscfiles" of the GNU collection.
1943	The use of |:set+=| and |:set-=| is preferred when adding or removing
1944	directories from the list.  This avoids problems when a future version
1945	uses another default.
1946	Backticks cannot be used in this option for security reasons.
1947
1948							*'diff'* *'nodiff'*
1949'diff'			boolean	(default off)
1950			local to window
1951			{not in Vi}
1952			{not available when compiled without the |+diff|
1953			feature}
1954	Join the current window in the group of windows that shows differences
1955	between files.  See |vimdiff|.
1956
1957						*'dex'* *'diffexpr'*
1958'diffexpr' 'dex'	string	(default "")
1959			global
1960			{not in Vi}
1961			{not available when compiled without the |+diff|
1962			feature}
1963	Expression which is evaluated to obtain an ed-style diff file from two
1964	versions of a file.  See |diff-diffexpr|.
1965	This option cannot be set from a |modeline| or in the |sandbox|, for
1966	security reasons.
1967
1968						*'dip'* *'diffopt'*
1969'diffopt' 'dip'		string	(default "filler")
1970			global
1971			{not in Vi}
1972			{not available when compiled without the |+diff|
1973			feature}
1974	Option settings for diff mode.  It can consist of the following items.
1975	All are optional.  Items must be separated by a comma.
1976
1977		filler		Show filler lines, to keep the text
1978				synchronized with a window that has inserted
1979				lines at the same position.  Mostly useful
1980				when windows are side-by-side and 'scrollbind'
1981				is set.
1982
1983		context:{n}	Use a context of {n} lines between a change
1984				and a fold that contains unchanged lines.
1985				When omitted a context of six lines is used.
1986				See |fold-diff|.
1987
1988		icase		Ignore changes in case of text.  "a" and "A"
1989				are considered the same.  Adds the "-i" flag
1990				to the "diff" command if 'diffexpr' is empty.
1991
1992		iwhite		Ignore changes in amount of white space.  Adds
1993				the "-b" flag to the "diff" command if
1994				'diffexpr' is empty.  Check the documentation
1995				of the "diff" command for what this does
1996				exactly.  It should ignore adding trailing
1997				white space, but not leading white space.
1998
1999	Examples: >
2000
2001		:set diffopt=filler,context:4
2002		:set diffopt=
2003		:set diffopt=filler
2004<
2005				     *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2006'digraph' 'dg'		boolean	(default off)
2007			global
2008			{not in Vi}
2009			{not available when compiled without the |+digraphs|
2010			feature}
2011	Enable the entering of digraphs in Insert mode with {char1} <BS>
2012	{char2}.  See |digraphs|.
2013	NOTE: This option is reset when 'compatible' is set.
2014
2015						*'directory'* *'dir'*
2016'directory' 'dir'	string	(default for Amiga: ".,t:",
2017				 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2018				 for Unix: ".,~/tmp,/var/tmp,/tmp")
2019			global
2020	List of directory names for the swap file, separated with commas.
2021	- The swap file will be created in the first directory where this is
2022	  possible.
2023	- Empty means that no swap file will be used (recovery is
2024	  impossible!).
2025	- A directory "." means to put the swap file in the same directory as
2026	  the edited file.  On Unix, a dot is prepended to the file name, so
2027	  it doesn't show in a directory listing.  On MS-Windows the "hidden"
2028	  attribute is set and a dot prepended if possible.
2029	- A directory starting with "./" (or ".\" for MS-DOS et.al.) means to
2030	  put the swap file relative to where the edited file is.  The leading
2031	  "." is replaced with the path name of the edited file.
2032	- For Unix and Win32, if a directory ends in two path separators, the
2033	  swap file name will be built from the complete path to the file
2034	  with all path separators substituted to percent '%' signs. This will
2035	  ensure file name uniqueness in the preserve directory.
2036	- Spaces after the comma are ignored, other spaces are considered part
2037	  of the directory name.  To have a space at the start of a directory
2038	  name, precede it with a backslash.
2039	- To include a comma in a directory name precede it with a backslash.
2040	- A directory name may end in an ':' or '/'.
2041	- Environment variables are expanded |:set_env|.
2042	- Careful with '\' characters, type one before a space, type two to
2043	  get one in the option (see |option-backslash|), for example: >
2044	    :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2045<	- For backwards compatibility with Vim version 3.0 a '>' at the start
2046	  of the option is removed.
2047	Using "." first in the list is recommended.  This means that editing
2048	the same file twice will result in a warning.  Using "/tmp" on Unix is
2049	discouraged: When the system crashes you lose the swap file.
2050	"/var/tmp" is often not cleared when rebooting, thus is a better
2051	choice than "/tmp".  But it can contain a lot of files, your swap
2052	files get lost in the crowd.  That is why a "tmp" directory in your
2053	home directory is tried first.
2054	The use of |:set+=| and |:set-=| is preferred when adding or removing
2055	directories from the list.  This avoids problems when a future version
2056	uses another default.
2057	This option cannot be set from a |modeline| or in the |sandbox|, for
2058	security reasons.
2059	{Vi: directory to put temp file in, defaults to "/tmp"}
2060
2061					*'display'* *'dy'*
2062'display' 'dy'		string	(default "")
2063			global
2064			{not in Vi}
2065	Change the way text is displayed.  This is comma separated list of
2066	flags:
2067	lastline	When included, as much as possible of the last line
2068			in a window will be displayed.  When not included, a
2069			last line that doesn't fit is replaced with "@" lines.
2070	uhex		Show unprintable characters hexadecimal as <xx>
2071			instead of using ^C and ~C.
2072
2073						*'eadirection'* *'ead'*
2074'eadirection' 'ead'	string	(default "both")
2075			global
2076			{not in Vi}
2077			{not available when compiled without the +vertsplit
2078			feature}
2079	Tells when the 'equalalways' option applies:
2080		ver	vertically, width of windows is not affected
2081		hor	horizontally, height of windows is not affected
2082		both	width and height of windows is affected
2083
2084			   *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2085'edcompatible' 'ed'	boolean	(default off)
2086			global
2087	Makes the 'g' and 'c' flags of the ":substitute" command to be
2088	toggled each time the flag is given.  See |complex-change|.  See
2089	also 'gdefault' option.
2090	Switching this option on is discouraged!
2091
2092					*'encoding'* *'enc'* *E543*
2093'encoding' 'enc'	string (default: "latin1" or value from $LANG)
2094			global
2095			{only available when compiled with the |+multi_byte|
2096			feature}
2097			{not in Vi}
2098	Sets the character encoding used inside Vim.  It applies to text in
2099	the buffers, registers, Strings in expressions, text stored in the
2100	viminfo file, etc.  It sets the kind of characters which Vim can work
2101	with.  See |encoding-names| for the possible values.
2102
2103	NOTE: Changing this option will not change the encoding of the
2104	existing text in Vim.  It may cause multi-byte text to become invalid.
2105	It should normally be kept at its default value, or set when Vim
2106	starts up.  See |multibyte|.
2107
2108	NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2109	"utf-8".  Although care has been taken to allow different values of
2110	'encoding', "utf-8" is the natural choice for the environment and
2111	avoids unnecessary conversion overhead.  "utf-8" has not been made
2112	the default to prevent different behavior of the GUI and terminal
2113	versions, and to avoid changing the encoding of newly created files
2114	without your knowledge (in case 'fileencodings' is empty).
2115
2116	The character encoding of files can be different from 'encoding'.
2117	This is specified with 'fileencoding'.  The conversion is done with
2118	iconv() or as specified with 'charconvert'.
2119
2120	Normally 'encoding' will be equal to your current locale.  This will
2121	be the default if Vim recognizes your environment settings.  If
2122	'encoding' is not set to the current locale, 'termencoding' must be
2123	set to convert typed and displayed text.  See |encoding-table|.
2124
2125	When you set this option, it fires the |EncodingChanged| autocommand
2126	event so that you can set up fonts if necessary.
2127
2128	When the option is set, the value is converted to lowercase.  Thus
2129	you can set it with uppercase values too.  Underscores are translated
2130	to '-' signs.
2131	When the encoding is recognized, it is changed to the standard name.
2132	For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2133	"iso-8859-2" and "utf8" becomes "utf-8".
2134
2135	Note: "latin1" is also used when the encoding could not be detected.
2136	This only works when editing files in the same encoding!  When the
2137	actual character set is not latin1, make sure 'fileencoding' and
2138	'fileencodings' are empty.  When conversion is needed, switch to using
2139	utf-8.
2140
2141	When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2142	You don't notice this while editing, but it does matter for the
2143	|viminfo-file|.  And Vim expects the terminal to use utf-8 too.  Thus
2144	setting 'encoding' to one of these values instead of utf-8 only has
2145	effect for encoding used for files when 'fileencoding' is empty.
2146
2147	 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2148	 not set yet, the default for 'fileencodings' is changed.
2149
2150			*'endofline'* *'eol'* *'noendofline'* *'noeol'*
2151'endofline' 'eol'	boolean	(default on)
2152			local to buffer
2153			{not in Vi}
2154	When writing a file and this option is off and the 'binary' option
2155	is on, no <EOL> will be written for the last line in the file.  This
2156	option is automatically set when starting to edit a new file, unless
2157	the file does not have an <EOL> for the last line in the file, in
2158	which case it is reset.  Normally you don't have to set or reset this
2159	option.  When 'binary' is off the value is not used when writing the
2160	file.  When 'binary' is on it is used to remember the presence of a
2161	<EOL> for the last line in the file, so that when you write the file
2162	the situation from the original file can be kept.  But you can change
2163	it if you want to.
2164
2165			     *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2166'equalalways' 'ea'	boolean	(default on)
2167			global
2168			{not in Vi}
2169	When on, all the windows are automatically made the same size after
2170	splitting or closing a window.  When off, splitting a window will
2171	reduce the size of the current window and leave the other windows the
2172	same.  When closing a window the extra lines are given to the window
2173	next to it (depending on 'splitbelow' and 'splitright').
2174	When mixing vertically and horizontally split windows, a minimal size
2175	is computed and some windows may be larger if there is room.  The
2176	'eadirection' option tells in which direction the size is affected.
2177	Changing the height of a window can be avoided by setting
2178	'winfixheight'.
2179
2180						*'equalprg'* *'ep'*
2181'equalprg' 'ep'		string	(default "")
2182			global or local to buffer |global-local|
2183			{not in Vi}
2184	External program to use for "=" command.  When this option is empty
2185	the internal formatting functions are used ('lisp', 'cindent' or
2186	'indentexpr').
2187	Environment variables are expanded |:set_env|.  See |option-backslash|
2188	about including spaces and backslashes.
2189	This option cannot be set from a |modeline| or in the |sandbox|, for
2190	security reasons.
2191
2192			*'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2193'errorbells' 'eb'	boolean	(default off)
2194			global
2195	Ring the bell (beep or screen flash) for error messages.  This only
2196	makes a difference for error messages, the bell will be used always
2197	for a lot of errors without a message (e.g., hitting <Esc> in Normal
2198	mode).  See 'visualbell' on how to make the bell behave like a beep,
2199	screen flash or do nothing.
2200
2201						*'errorfile'* *'ef'*
2202'errorfile' 'ef'	string	(Amiga default: "AztecC.Err",
2203					others: "errors.err")
2204			global
2205			{not in Vi}
2206			{not available when compiled without the |+quickfix|
2207			feature}
2208	Name of the errorfile for the QuickFix mode (see |:cf|).
2209	When the "-q" command-line argument is used, 'errorfile' is set to the
2210	following argument.  See |-q|.
2211	NOT used for the ":make" command.  See 'makeef' for that.
2212	Environment variables are expanded |:set_env|.
2213	See |option-backslash| about including spaces and backslashes.
2214	This option cannot be set from a |modeline| or in the |sandbox|, for
2215	security reasons.
2216
2217						*'errorformat'* *'efm'*
2218'errorformat' 'efm'	string	(default is very long)
2219			global or local to buffer |global-local|
2220			{not in Vi}
2221			{not available when compiled without the |+quickfix|
2222			feature}
2223	Scanf-like description of the format for the lines in the error file
2224	(see |errorformat|).
2225
2226				     *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2227'esckeys' 'ek'		boolean	(Vim default: on, Vi default: off)
2228			global
2229			{not in Vi}
2230	Function keys that start with an <Esc> are recognized in Insert
2231	mode.  When this option is off, the cursor and function keys cannot be
2232	used in Insert mode if they start with an <Esc>.  The advantage of
2233	this is that the single <Esc> is recognized immediately, instead of
2234	after one second.  Instead of resetting this option, you might want to
2235	try changing the values for 'timeoutlen' and 'ttimeoutlen'.  Note that
2236	when 'esckeys' is off, you can still map anything, but the cursor keys
2237	won't work by default.
2238	NOTE: This option is set to the Vi default value when 'compatible' is
2239	set and to the Vim default value when 'compatible' is reset.
2240
2241						*'eventignore'* *'ei'*
2242'eventignore' 'ei'	string	(default "")
2243			global
2244			{not in Vi}
2245			{not available when compiled without the |+autocmd|
2246			feature}
2247	A list of autocommand event names, which are to be ignored.
2248	When set to "all", all autocommand events are ignored, autocommands
2249	will not be executed.
2250	Otherwise this is a comma separated list of event names.  Example: >
2251	    :set ei=WinEnter,WinLeave
2252<
2253				 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2254'expandtab' 'et'	boolean	(default off)
2255			local to buffer
2256			{not in Vi}
2257	In Insert mode: Use the appropriate number of spaces to insert a
2258	<Tab>.  Spaces are used in indents with the '>' and '<' commands and
2259	when 'autoindent' is on.  To insert a real tab when 'expandtab' is
2260	on, use CTRL-V<Tab>.  See also |:retab| and |ins-expandtab|.
2261	NOTE: This option is reset when 'compatible' is set.
2262
2263					*'exrc'* *'ex'* *'noexrc'* *'noex'*
2264'exrc' 'ex'		boolean (default off)
2265			global
2266			{not in Vi}
2267	Enables the reading of .vimrc, .exrc and .gvimrc in the current
2268	directory.  If you switch this option on you should also consider
2269	setting the 'secure' option (see |initialization|).  Using a local
2270	.exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2271	also see |.vimrc| and |gui-init|.
2272	This option cannot be set from a |modeline| or in the |sandbox|, for
2273	security reasons.
2274
2275				*'fileencoding'* *'fenc'* *E213*
2276'fileencoding' 'fenc'	string (default: "")
2277			local to buffer
2278			{only available when compiled with the |+multi_byte|
2279			feature}
2280			{not in Vi}
2281	Sets the character encoding for the file of this buffer.
2282	When 'fileencoding' is different from 'encoding', conversion will be
2283	done when reading and writing the file.
2284	When 'fileencoding' is empty, the same value as 'encoding' will be
2285	used (no conversion when reading or writing a file).
2286		WARNING: Conversion can cause loss of information!  When
2287		'encoding' is "utf-8" conversion is most likely done in a way
2288		that the reverse conversion results in the same text.  When
2289		'encoding' is not "utf-8" some characters may be lost!
2290	See 'encoding' for the possible values.  Additionally, values may be
2291	specified that can be handled by the converter, see
2292	|mbyte-conversion|.
2293	When reading a file 'fileencoding' will be set from 'fileencodings'.
2294	To read a file in a certain encoding it won't work by setting
2295	'fileencoding', use the |++enc| argument.
2296	Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2297	When the option is set, the value is converted to lowercase.  Thus
2298	you can set it with uppercase values too.  '_' characters are
2299	replaced with '-'.  If a name is recognized from the list for
2300	'encoding', it is replaced by the standard name.  For example
2301	"ISO8859-2" becomes "iso-8859-2".
2302	When this option is set, after starting to edit a file, the 'modified'
2303	option is set, because the file would be different when written.
2304	If you do this in a modeline, you might want to set 'nomodified' to
2305	avoid this.
2306	This option can not be changed when 'modifiable' is off.
2307
2308							*'fe'*
2309	NOTE: Before version 6.0 this option specified the encoding for the
2310	whole of Vim, this was a mistake.  Now use 'encoding' instead.  The
2311	old short name was 'fe', which is no longer used.
2312
2313					*'fileencodings'* *'fencs'*
2314'fileencodings' 'fencs'	string (default: "ucs-bom", "ucs-bom,utf-8,latin1"
2315				    when 'encoding' is set to a Unicode value)
2316			global
2317			{only available when compiled with the |+multi_byte|
2318			feature}
2319			{not in Vi}
2320	This is a list of character encodings considered when starting to edit
2321	an existing file.  When a file is read, Vim tries to use the first
2322	mentioned character encoding.  If an error is detected, the next one
2323	in the list is tried.  When an encoding is found that works,
2324	'fileencoding' is set to it.  If all fail, 'fileencoding' is set to
2325	an empty string, which means the value of 'encoding' is used.
2326		WARNING: Conversion can cause loss of information!  When
2327		'encoding' is "utf-8" (or one of the other Unicode variants)
2328		conversion is most likely done in a way that the reverse
2329		conversion results in the same text.  When 'encoding' is not
2330		"utf-8" special characters may be lost!
2331	For an empty file or a file with only ASCII characters most encodings
2332	will work and the first entry of 'fileencodings' will be used (except
2333	"ucs-bom", which requires the BOM to be present).  If you prefer
2334	another encoding use an BufReadPost autocommand event to test if your
2335	preferred encoding is to be used.  Example: >
2336		au BufReadPost * if search('\S', 'w') == 0 |
2337			\ set fenc=iso-2022-jp | endif
2338<	This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2339	non-blank characters.
2340	Note that 'fileencodings' is not used for an new file, 'fileencoding'
2341	is always empty then.  This means that a non-existing file may get a
2342	different encoding than an empty file.
2343	The special value "ucs-bom" can be used to check for a Unicode BOM
2344	(Byte Order Mark) at the start of the file.  It must not be preceded
2345	by "utf-8" or another Unicode encoding for this to work properly.
2346	An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2347	because Vim cannot detect an error, thus the encoding is always
2348	accepted.
2349	WRONG VALUES:			WHAT'S WRONG:
2350		latin1,utf-8		"latin1" will always be used
2351		utf-8,ucs-bom,latin1	BOM won't be recognized in an utf-8
2352					file
2353		cp1250,latin1		"cp1250" will always be used
2354	If 'fileencodings' is empty, 'fileencoding' is not modified.
2355	See 'fileencoding' for the possible values.
2356	Setting this option does not have an effect until the next time a file
2357	is read.
2358
2359					*'fileformat'* *'ff'*
2360'fileformat' 'ff'	string (MS-DOS, MS-Windows, OS/2 default: "dos",
2361				Unix default: "unix",
2362				Macintosh default: "mac")
2363			local to buffer
2364			{not in Vi}
2365	This gives the <EOL> of the current buffer, which is used for
2366	reading/writing the buffer from/to a file:
2367	    dos	    <CR> <NL>
2368	    unix    <NL>
2369	    mac	    <CR>
2370	When "dos" is used, CTRL-Z at the end of a file is ignored.
2371	See |file-formats| and |file-read|.
2372	For the character encoding of the file see 'fileencoding'.
2373	When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2374	works like it was set to "unix'.
2375	This option is set automatically when starting to edit a file and
2376	'fileformats' is not empty and 'binary' is off.
2377	When this option is set, after starting to edit a file, the 'modified'
2378	option is set, because the file would be different when written.
2379	This option can not be changed when 'modifiable' is off.
2380	For backwards compatibility: When this option is set to "dos",
2381	'textmode' is set, otherwise 'textmode' is reset.
2382
2383					*'fileformats'* *'ffs'*
2384'fileformats' 'ffs'	string (default:
2385				Vim+Vi	MS-DOS, MS-Windows OS/2: "dos,unix",
2386				Vim	Unix: "unix,dos",
2387				Vim	Mac: "mac,unix,dos",
2388				Vi	Cygwin: "unix,dos",
2389				Vi	others: "")
2390			global
2391			{not in Vi}
2392	This gives the end-of-line (<EOL>) formats that will be tried when
2393	starting to edit a new buffer and when reading a file into an existing
2394	buffer:
2395	- When empty, the format defined with 'fileformat' will be used
2396	  always.  It is not set automatically.
2397	- When set to one name, that format will be used whenever a new buffer
2398	  is opened.  'fileformat' is set accordingly for that buffer.  The
2399	  'fileformats' name will be used when a file is read into an existing
2400	  buffer, no matter what 'fileformat' for that buffer is set to.
2401	- When more than one name is present, separated by commas, automatic
2402	  <EOL> detection will be done when reading a file.  When starting to
2403	  edit a file, a check is done for the <EOL>:
2404	  1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2405	     'fileformat' is set to "dos".
2406	  2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
2407	     is set to "unix".  Note that when a <NL> is found without a
2408	     preceding <CR>, "unix" is preferred over "dos".
2409	  3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2410	     This means that "mac" is only chosen when "unix" is not present,
2411	     or when no <NL> is found in the file, and when "dos" is not
2412	     present, or no <CR><NL> is present in the file.
2413	     Also if "unix" was first chosen, but the first <CR> is before
2414	     the first <NL> and there appears to be more <CR>'s than <NL>'s in
2415	     the file, then 'fileformat' is set to "mac".
2416	  4. If 'fileformat' is still not set, the first name from
2417	     'fileformats' is used.
2418	  When reading a file into an existing buffer, the same is done, but
2419	  this happens like 'fileformat' has been set appropriately for that
2420	  file only, the option is not changed.
2421	When 'binary' is set, the value of 'fileformats' is not used.
2422
2423	For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2424	are ":source"ed and for vimrc files, automatic <EOL> detection may be
2425	done:
2426	- When 'fileformats' is empty, there is no automatic detection.  Dos
2427	  format will be used.
2428	- When 'fileformats' is set to one or more names, automatic detection
2429	  is done.  This is based on the first <NL> in the file: If there is a
2430	  <CR> in front of it, Dos format is used, otherwise Unix format is
2431	  used.
2432	Also see |file-formats|.
2433	For backwards compatibility: When this option is set to an empty
2434	string or one format (no comma is included), 'textauto' is reset,
2435	otherwise 'textauto' is set.
2436	NOTE: This option is set to the Vi default value when 'compatible' is
2437	set and to the Vim default value when 'compatible' is reset.
2438
2439					*'filetype'* *'ft'*
2440'filetype' 'ft'		string (default: "")
2441			local to buffer
2442			{not in Vi}
2443			{not available when compiled without the |+autocmd|
2444			feature}
2445	When this option is set, the FileType autocommand event is triggered.
2446	All autocommands that match with the value of this option will be
2447	executed.  Thus the value of 'filetype' is used in place of the file
2448	name.
2449	Otherwise this option does not always reflect the current file type.
2450	This option is normally set when the file type is detected.  To enable
2451	this use the ":filetype on" command. |:filetype|
2452	Setting this option to a different value is most useful in a modeline,
2453	for a file for which the file type is not automatically recognized.
2454	Example, for in an IDL file: >
2455		/* vim: set filetype=idl : */
2456<	|FileType| |filetypes|
2457	Do not confuse this option with 'osfiletype', which is for the file
2458	type that is actually stored with the file.
2459	This option is not copied to another buffer, independent of the 's' or
2460	'S' flag in 'cpoptions'.
2461
2462						*'fillchars'* *'fcs'*
2463'fillchars' 'fcs'	string	(default "vert:|,fold:-")
2464			global
2465			{not in Vi}
2466			{not available when compiled without the |+windows|
2467			and |+folding| features}
2468	Characters to fill the statuslines and vertical separators.
2469	It is a comma separated list of items:
2470
2471	  item		default		Used for ~
2472	  stl:c		' ' or '^'	statusline of the current window
2473	  stlnc:c	' ' or '-'	statusline of the non-current windows
2474	  vert:c	'|'		vertical separators |:vsplit|
2475	  fold:c	'-'		filling 'foldtext'
2476	  diff:c	'-'		deleted lines of the 'diff' option
2477
2478	Any one that is omitted will fall back to the default.  For "stl" and
2479	"stlnc" the space will be used when there is highlighting, '^' or '-'
2480	otherwise.
2481
2482	Example: >
2483	    :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2484<	This is similar to the default, except that these characters will also
2485	be used when there is highlighting.
2486
2487	The highlighting used for these items:
2488	  item		highlight group ~
2489	  stl:c		StatusLine		|hl-StatusLine|
2490	  stlnc:c	StatusLineNC		|hl-StatusLineNC|
2491	  vert:c	VertSplit		|hl-VertSplit|
2492	  fold:c	Folded			|hl-Folded|
2493	  diff:c	DiffDelete		|hl-DiffDelete|
2494
2495					*'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2496'fkmap' 'fk'		boolean (default off)			*E198*
2497			global
2498			{not in Vi}
2499			{only available when compiled with the |+rightleft|
2500			feature}
2501	When on, the keyboard is mapped for the Farsi character set.
2502	Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
2503	toggle this option |i_CTRL-_|.  See |farsi.txt|.
2504
2505						*'foldclose'* *'fcl'*
2506'foldclose' 'fcl'	string (default "")
2507			global
2508			{not in Vi}
2509			{not available when compiled without the |+folding|
2510			feature}
2511	When set to "all", a fold is closed when the cursor isn't in it and
2512	its level is higher than 'foldlevel'.  Useful if you want folds to
2513	automatically close when moving out of them.
2514
2515						*'foldcolumn'* *'fdc'*
2516'foldcolumn' 'fdc'	number (default 0)
2517			local to window
2518			{not in Vi}
2519			{not available when compiled without the |+folding|
2520			feature}
2521	When non-zero, a column with the specified width is shown at the side
2522	of the window which indicates open and closed folds.  The maximum
2523	value is 12.
2524	See |folding|.
2525
2526			*'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2527'foldenable' 'fen'	boolean (default on)
2528			local to window
2529			{not in Vi}
2530			{not available when compiled without the |+folding|
2531			feature}
2532	When off, all folds are open.  This option can be used to quickly
2533	switch between showing all text unfolded and viewing the text with
2534	folds (including manually opened or closed folds).  It can be toggled
2535	with the |zi| command.  The 'foldcolumn' will remain blank when
2536	'foldenable' is off.
2537	This option is set by commands that create a new fold or close a fold.
2538	See |folding|.
2539
2540						*'foldexpr'* *'fde'*
2541'foldexpr' 'fde'	string (default: "0")
2542			local to window
2543			{not in Vi}
2544			{not available when compiled without the |+folding|
2545			or |+eval| feature}
2546	The expression used for when 'foldmethod' is "expr".  It is evaluated
2547	for each line to obtain its fold level.  See |fold-expr|.  Also see
2548	|eval-sandbox|.
2549
2550						*'foldignore'* *'fdi'*
2551'foldignore' 'fdi'	string (default: "#")
2552			local to window
2553			{not in Vi}
2554			{not available when compiled without the |+folding|
2555			feature}
2556	Used only when 'foldmethod' is "indent".  Lines starting with
2557	characters in 'foldignore' will get their fold level from surrounding
2558	lines.  White space is skipped before checking for this character.
2559	The default "#" works well for C programs.  See |fold-indent|.
2560
2561						*'foldlevel'* *'fdl'*
2562'foldlevel' 'fdl'	number (default: 0)
2563			local to window
2564			{not in Vi}
2565			{not available when compiled without the |+folding|
2566			feature}
2567	Sets the fold level: Folds with a higher level will be closed.
2568	Setting this option to zero will close all folds.  Higher numbers will
2569	close fewer folds.
2570	This option is set by commands like |zm|, |zM| and |zR|.
2571	See |fold-foldlevel|.
2572
2573						*'foldlevelstart'* *'fdls'*
2574'foldlevelstart' 'fdls'	number (default: -1)
2575			global
2576			{not in Vi}
2577			{not available when compiled without the |+folding|
2578			feature}
2579	Sets 'foldlevel' when starting to edit another buffer in a window.
2580	Useful to always start editing with all folds closed (value zero),
2581	some folds closed (one) or no folds closed (99).
2582	This is done before reading any modeline, thus a setting in a modeline
2583	overrules this option.  Starting to edit a file for |diff-mode| also
2584	ignores this option and closes all folds.
2585	It is also done before BufReadPre autocommands, to allow an autocmd to
2586	overrule the 'foldlevel' value for specific files.
2587	When the value is negative, it is not used.
2588
2589						*'foldmarker'* *'fmr'* *E536*
2590'foldmarker' 'fmr'	string (default: "{{{,}}}")
2591			local to window
2592			{not in Vi}
2593			{not available when compiled without the |+folding|
2594			feature}
2595	The start and end marker used when 'foldmethod' is "marker".  There
2596	must be one comma, which separates the start and end marker.  The
2597	marker is a literal string (a regular expression would be too slow).
2598	See |fold-marker|.
2599
2600						*'foldmethod'* *'fdm'*
2601'foldmethod' 'fdm'	string (default: "manual")
2602			local to window
2603			{not in Vi}
2604			{not available when compiled without the |+folding|
2605			feature}
2606	The kind of folding used for the current window.  Possible values:
2607	|fold-manual|	manual	    Folds are created manually.
2608	|fold-indent|	indent	    Lines with equal indent form a fold.
2609	|fold-expr|	expr	    'foldexpr' gives the fold level of a line.
2610	|fold-marker|	marker	    Markers are used to specify folds.
2611	|fold-syntax|	syntax	    Syntax highlighting items specify folds.
2612	|fold-diff|	diff	    Fold text that is not changed.
2613
2614						*'foldminlines'* *'fml'*
2615'foldminlines' 'fml'	number (default: 1)
2616			local to window
2617			{not in Vi}
2618			{not available when compiled without the |+folding|
2619			feature}
2620	Sets the minimum number of screen lines for a fold to be displayed
2621	closed.  Also for manually closed folds.
2622	Note that this only has an effect of what is displayed.  After using
2623	"zc" to close a fold, which is displayed open because it's smaller
2624	than 'foldminlines', a following "zc" may close a containing fold.
2625
2626						*'foldnestmax'* *'fdn'*
2627'foldnestmax' 'fdn'	number (default: 20)
2628			local to window
2629			{not in Vi}
2630			{not available when compiled without the |+folding|
2631			feature}
2632	Sets the maximum nesting of folds for the "indent" and "syntax"
2633	methods.  This avoids that too many folds will be created.  Using more
2634	than 20 doesn't work, because the internal limit is 20.
2635
2636						*'foldopen'* *'fdo'*
2637'foldopen' 'fdo'	string (default: "block,hor,mark,percent,quickfix,
2638							     search,tag,undo")
2639			global
2640			{not in Vi}
2641			{not available when compiled without the |+folding|
2642			feature}
2643	Specifies for which type of commands folds will be opened, if the
2644	command moves the cursor into a closed fold.  It is a comma separated
2645	list of items.
2646		item		commands ~
2647		all		any
2648		block		"(", "{", "[[", "[{", etc.
2649		hor		horizontal movements: "l", "w", "fx", etc.
2650		insert		any command in Insert mode
2651		jump		far jumps: "G", "gg", etc.
2652		mark		jumping to a mark: "'m", CTRL-O, etc.
2653		percent		"%"
2654		quickfix	":cn", ":crew", ":make", etc.
2655		search		search for a pattern: "/", "n", "*", "gd", etc.
2656				(not for a search pattern in a ":" command)
2657		tag		jumping to a tag: ":ta", CTRL-T, etc.
2658		undo		undo or redo: "u" and CTRL-R
2659	When the command is part of a mapping this option is not used.  Add
2660	the |zv| command to the mapping to get the same effect.
2661	When a movement command is used for an operator (e.g., "dl" or "y%")
2662	this option is not used.  This means the operator will include the
2663	whole closed fold.
2664	Note that vertical movements are not here, because it would make it
2665	very difficult to move onto a closed fold.
2666	In insert mode the folds containing the cursor will always be open
2667	when text is inserted.
2668	To close folds you can re-apply 'foldlevel' with the |zx| command or
2669	set the 'foldclose' option to "all".
2670
2671						*'foldtext'* *'fdt'*
2672'foldtext' 'fdt'	string (default: "foldtext()")
2673			local to window
2674			{not in Vi}
2675			{not available when compiled without the |+folding|
2676			feature}
2677	An expression which is used to specify the text displayed for a closed
2678	fold.  See |fold-foldtext|.
2679
2680					*'formatoptions'* *'fo'*
2681'formatoptions' 'fo'	string (Vim default: "tcq", Vi default: "vt")
2682			local to buffer
2683			{not in Vi}
2684	This is a sequence of letters which describes how automatic
2685	formatting is to be done.  See |fo-table|.  When the 'paste' option is
2686	on, no formatting is done (like 'formatoptions' is empty).  Commas can
2687	be inserted for readability.
2688	To avoid problems with flags that are added in the future, use the
2689	"+=" and "-=" feature of ":set" |add-option-flags|.
2690	NOTE: This option is set to the Vi default value when 'compatible' is
2691	set and to the Vim default value when 'compatible' is reset.
2692
2693						*'formatprg'* *'fp'*
2694'formatprg' 'fp'	string (default "")
2695			global
2696			{not in Vi}
2697	The name of an external program that will be used to format the lines
2698	selected with the "gq" command.  The program must take the input on
2699	stdin and produce the output on stdout.  The Unix program "fmt" is
2700	such a program.  If this option is an empty string, the internal
2701	format function will be used |C-indenting|.  Environment variables are
2702	expanded |:set_env|.  See |option-backslash| about including spaces
2703	and backslashes.
2704	This option cannot be set from a |modeline| or in the |sandbox|, for
2705	security reasons.
2706
2707				   *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2708'gdefault' 'gd'		boolean	(default off)
2709			global
2710			{not in Vi}
2711	When on, the ":substitute" flag 'g' is default on.  This means that
2712	all matches in a line are substituted instead of one.  When a 'g' flag
2713	is given to a ":substitute" command, this will toggle the substitution
2714	of all or one match.  See |complex-change|.
2715
2716		command		'gdefault' on	'gdefault' off	~
2717		:s///		  subst. all	  subst. one
2718		:s///g		  subst. one	  subst. all
2719		:s///gg		  subst. all	  subst. one
2720
2721	NOTE: This option is reset when 'compatible' is set.
2722
2723						*'grepformat'* *'gfm'*
2724'grepformat' 'gfm'	string	(default "%f:%l%m,%f  %l%m")
2725			global
2726			{not in Vi}
2727	Format to recognize for the ":grep" command output.
2728	This is a scanf-like string that uses the same format as the
2729	'errorformat' option: see |errorformat|.
2730
2731						*'grepprg'* *'gp'*
2732'grepprg' 'gp'		string	(default "grep -n ",
2733					Unix: "grep -n $* /dev/null",
2734					Win32: "findstr /n" or "grep -n",
2735						      VMS: "SEARCH/NUMBERS ")
2736			global or local to buffer |global-local|
2737			{not in Vi}
2738	Program to use for the ":grep" command. This option may contain '%'
2739	and '#' characters, which are expanded like when used in a command-
2740	line.  The placeholder "$*" is allowed to specify where the arguments
2741	will be included.  Environment variables are expanded |:set_env|.  See
2742	|option-backslash| about including spaces and backslashes.
2743	When your "grep" accepts the "-H" argument, use this to make ":grep"
2744	also work well with a single file: >
2745		:set grepprg=grep\ -nH
2746<	See also the section |:make_makeprg|, since most of the comments there
2747	apply equally to 'grepprg'.
2748	For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2749	otherwise it's "grep -n".
2750	This option cannot be set from a |modeline| or in the |sandbox|, for
2751	security reasons.
2752
2753			*'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2754'guicursor' 'gcr'	string	(default "n-v-c:block-Cursor/lCursor,
2755					ve:ver35-Cursor,
2756					o:hor50-Cursor,
2757					i-ci:ver25-Cursor/lCursor,
2758					r-cr:hor20-Cursor/lCursor,
2759					sm:block-Cursor
2760					-blinkwait175-blinkoff150-blinkon175",
2761				for MS-DOS and Win32 console:
2762					"n-v-c:block,o:hor50,i-ci:hor15,
2763					r-cr:hor30,sm:block")
2764			global
2765			{not in Vi}
2766			{only available when compiled with GUI enabled, and
2767			for MS-DOS and Win32 console}
2768	This option tells Vim what the cursor should look like in different
2769	modes.  It fully works in the GUI.  In an MSDOS or Win32 console, only
2770	the height of the cursor can be changed.  This can be done by
2771	specifying a block cursor, or a percentage for a vertical or
2772	horizontal cursor.
2773
2774	The option is a comma separated list of parts.  Each part consist of a
2775	mode-list and an argument-list:
2776		mode-list:argument-list,mode-list:argument-list,..
2777	The mode-list is a dash separated list of these modes:
2778		n	Normal mode
2779		v	Visual mode
2780		ve	Visual mode with 'selection' "exclusive" (same as 'v',
2781			if not specified)
2782		o	Operator-pending mode
2783		i	Insert mode
2784		r	Replace mode
2785		c	Command-line Normal (append) mode
2786		ci	Command-line Insert mode
2787		cr	Command-line Replace mode
2788		sm	showmatch in Insert mode
2789		a	all modes
2790	The argument-list is a dash separated list of these arguments:
2791		hor{N}	horizontal bar, {N} percent of the character height
2792		ver{N}	vertical bar, {N} percent of the character width
2793		block	block cursor, fills the whole character
2794			[only one of the above three should be present]
2795		blinkwait{N}				*cursor-blinking*
2796		blinkon{N}
2797		blinkoff{N}
2798			blink times for cursor: blinkwait is the delay before
2799			the cursor starts blinking, blinkon is the time that
2800			the cursor is shown and blinkoff is the time that the
2801			cursor is not shown.  The times are in msec.  When one
2802			of the numbers is zero, there is no blinking.  The
2803			default is: "blinkwait700-blinkon400-blinkoff250".
2804			These numbers are used for a missing entry.  This
2805			means that blinking is enabled by default.  To switch
2806			blinking off you can use "blinkon0".  The cursor only
2807			blinks when Vim is waiting for input, not while
2808			executing a command.
2809			To make the cursor blink in an xterm, see
2810			|xterm-blink|.
2811		{group-name}
2812			a highlight group name, that sets the color and font
2813			for the cursor
2814		{group-name}/{group-name}
2815			Two highlight group names, the first is used when
2816			no language mappings are used, the other when they
2817			are. |language-mapping|
2818
2819	Examples of parts:
2820	   n-c-v:block-nCursor	in Normal, Command-line and Visual mode, use a
2821				block cursor with colors from the "nCursor"
2822				highlight group
2823	   i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
2824				In Insert and Command-line Insert mode, use a
2825				30% vertical bar cursor with colors from the
2826				"iCursor" highlight group.  Blink a bit
2827				faster.
2828
2829	The 'a' mode is different.  It will set the given argument-list for
2830	all modes.  It does not reset anything to defaults.  This can be used
2831	to do a common setting for all modes.  For example, to switch off
2832	blinking: "a:blinkon0"
2833
2834	Examples of cursor highlighting: >
2835	    :highlight Cursor gui=reverse guifg=NONE guibg=NONE
2836	    :highlight Cursor gui=NONE guifg=bg guibg=fg
2837<
2838					*'guifont'* *'gfn'*
2839						   *E235* *E596* *E610* *E611*
2840'guifont' 'gfn'		string	(default "")
2841			global
2842			{not in Vi}
2843			{only available when compiled with GUI enabled}
2844	This is a list of fonts which will be used for the GUI version of Vim.
2845	In its simplest form the value is just one font name.  When
2846	the font cannot be found you will get an error message.  To try other
2847	font names a list can be specified, font names separated with commas.
2848	The first valid font is used.
2849
2850	When 'guifontset' is not empty, 'guifont' is not used.
2851
2852	Spaces after a comma are ignored.  To include a comma in a font name
2853	precede it with a backslash.  Setting an option requires an extra
2854	backslash before a space and a backslash.  See also
2855	|option-backslash|.  For example: >
2856	    :set guifont=Screen15,\ 7x13,font\\,with\\,commas
2857<	will make Vim try to use the font "Screen15" first, and if it fails it
2858	will try to use "7x13" and then "font,with,commas" instead.
2859
2860	If none of the fonts can be loaded, Vim will keep the current setting.
2861	If an empty font list is given, Vim will try using other resource
2862	settings (for X, it will use the Vim.font resource), and finally it
2863	will try some builtin default which should always be there ("7x13" in
2864	the case of X).  The font names given should be "normal" fonts.  Vim
2865	will try to find the related bold and italic fonts.
2866
2867	For Win32, GTK and Photon only: >
2868	    :set guifont=*
2869<	will bring up a font requester, where you can pick the font you want.
2870
2871	The font name depends on the GUI used.  See |setting-guifont| for a
2872	way to set 'guifont' for various systems.
2873
2874	For the GTK+ 2 GUI the font name looks like this: >
2875	    :set guifont=Andale\ Mono\ 11
2876<	That's all.  XLFDs are no longer accepted.
2877								*E236*
2878	Note that the fonts must be mono-spaced (all characters have the same
2879	width).  An exception is GTK 2: all fonts are accepted, but
2880	mono-spaced fonts look best.
2881
2882	To preview a font on X11, you might be able to use the "xfontsel"
2883	program.  The "xlsfonts" program gives a list of all available fonts.
2884
2885	For the Win32 GUI					*E244* *E245*
2886	- takes these options in the font name:
2887		hXX - height is XX (points, can be floating-point)
2888		wXX - width is XX (points, can be floating-point)
2889		b   - bold
2890		i   - italic
2891		u   - underline
2892		s   - strikeout
2893		cXX - character set XX. valid charsets are: ANSI, ARABIC,
2894		      BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
2895		      HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
2896		      SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
2897
2898	  Use a ':' to separate the options.
2899	- A '_' can be used in the place of a space, so you don't need to use
2900	  backslashes to escape the spaces.
2901	- Examples: >
2902	    :set guifont=courier_new:h12:w5:b:cRUSSIAN
2903	    :set guifont=Andale_Mono:h7.5:w4.5
2904<	See also |font-sizes|.
2905
2906					*'guifontset'* *'gfs'*
2907					*E250* *E252* *E234* *E597* *E598*
2908'guifontset' 'gfs'	string	(default "")
2909			global
2910			{not in Vi}
2911			{only available when compiled with GUI enabled and
2912			with the |+xfontset| feature}
2913			{not available in the GTK+ 2 GUI}
2914	When not empty, specifies two (or more) fonts to be used.  The first
2915	one for normal English, the second one for your special language.  See
2916	|xfontset|.
2917	Setting this option also means that all font names will be handled as
2918	a fontset name.  Also the ones used for the "font" argument of the
2919	|:highlight| command.
2920	The fonts must match with the current locale.  If fonts for the
2921	character sets that the current locale uses are not included, setting
2922	'guifontset' will fail.
2923	Note the difference between 'guifont' and 'guifontset': In 'guifont'
2924	the comma-separated names are alternative names, one of which will be
2925	used.  In 'guifontset' the whole string is one fontset name,
2926	including the commas.  It is not possible to specify alternative
2927	fontset names.
2928	This example works on many X11 systems: >
2929		:set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
2930<
2931				*'guifontwide'* *'gfw'* *E231* *E533* *E534*
2932'guifontwide' 'gfw'	string	(default "")
2933			global
2934			{not in Vi}
2935			{only available when compiled with GUI enabled}
2936	When not empty, specifies a comma-separated list of fonts to be used
2937	for double-width characters.  The first font that can be loaded is
2938	used.
2939	Note: The size of these fonts must be exactly twice as wide as the one
2940	specified with 'guifont' and the same height.
2941
2942	All GUI versions but GTK+ 2:
2943
2944	'guifontwide' is only used when 'encoding' is set to "utf-8" and
2945	'guifontset' is empty or invalid.
2946	When 'guifont' is set and a valid font is found in it and
2947	'guifontwide' is empty Vim will attempt to find a matching
2948	double-width font and set 'guifontwide' to it.
2949
2950	GTK+ 2 GUI only:			*guifontwide_gtk2*
2951
2952	If set and valid, 'guifontwide' is always used for double width
2953	characters, even if 'encoding' is not set to "utf-8".
2954	Vim does not attempt to find an appropriate value for 'guifontwide'
2955	automatically.  If 'guifontwide' is empty Pango/Xft will choose the
2956	font for characters not available in 'guifont'.  Thus you do not need
2957	to set 'guifontwide' at all unless you want to override the choice
2958	made by Pango/Xft.
2959
2960						*'guiheadroom'* *'ghr'*
2961'guiheadroom' 'ghr'	number	(default 50)
2962			global
2963			{not in Vi} {only for GTK and X11 GUI}
2964	The number of pixels subtracted from the screen height when fitting
2965	the GUI window on the screen.  Set this before the GUI is started,
2966	e.g., in your |gvimrc| file.  When zero, the whole screen height will
2967	be used by the window.  When positive, the specified number of pixel
2968	lines will be left for window decorations and other items on the
2969	screen.  Set it to a negative value to allow windows taller than the
2970	screen.
2971
2972						*'guioptions'* *'go'*
2973'guioptions' 'go'	string	(default "gmrLtT"   (MS-Windows),
2974					 "agimrLtT" (GTK, Motif and Athena)
2975			global
2976			{not in Vi}
2977			{only available when compiled with GUI enabled}
2978	This option only has an effect in the GUI version of Vim.  It is a
2979	sequence of letters which describes what components and options of the
2980	GUI should be used.
2981	To avoid problems with flags that are added in the future, use the
2982	"+=" and "-=" feature of ":set" |add-option-flags|.
2983
2984	Valid letters are as follows:
2985							*guioptions_a*
2986	  'a'	Autoselect:  If present, then whenever VISUAL mode is started,
2987		or the Visual area extended, Vim tries to become the owner of
2988		the windowing system's global selection.  This means that the
2989		Visually highlighted text is available for pasting into other
2990		applications as well as into Vim itself.  When the Visual mode
2991		ends, possibly due to an operation on the text, or when an
2992		application wants to paste the selection, the highlighted text
2993		is automatically yanked into the "* selection register.
2994		Thus the selection is still available for pasting into other
2995		applications after the VISUAL mode has ended.
2996		    If not present, then Vim won't become the owner of the
2997		windowing system's global selection unless explicitly told to
2998		by a yank or delete operation for the "* register.
2999		The same applies to the modeless selection.
3000
3001	  'A'	Autoselect for the modeless selection.  Like 'a', but only
3002		applies to the modeless selection.
3003
3004		    'guioptions'   autoselect Visual  autoselect modeless ~
3005			 ""		 -			 -
3006			 "a"		yes			yes
3007			 "A"		 -			yes
3008			 "aA"		yes			yes
3009
3010	  'c'	Use console dialogs instead of popup dialogs for simple
3011		choices.
3012
3013	  'f'	Foreground: Don't use fork() to detach the GUI from the shell
3014		where it was started.  Use this for programs that wait for the
3015		editor to finish (e.g., an e-mail program).  Alternatively you
3016		can use "gvim -f" or ":gui -f" to start the GUI in the
3017		foreground.  |gui-fork|
3018		Note: Set this option in the vimrc file.  The forking may have
3019		happened already when the gvimrc file is read.
3020
3021	  'i'	Use a Vim icon.  For GTK with KDE it is used in the left-upper
3022		corner of the window.  It's black&white on non-GTK, because of
3023		limitations of X11.  For a color icon, see |X11-icon|.
3024
3025	  'm'	Menu bar is present.
3026	  'M'	The system menu "$VIMRUNTIME/menu.vim" is not sourced.  Note
3027		that this flag must be added in the .vimrc file, before
3028		switching on syntax or filetype recognition (when the .gvimrc
3029		file is sourced the system menu has already been loaded; the
3030		":syntax on" and ":filetype on" commands load the menu too).
3031	  'g'	Grey menu items: Make menu items that are not active grey.  If
3032		'g' is not included inactive menu items are not shown at all.
3033		Exception: Athena will always use grey menu items.
3034
3035	  't'	Include tearoff menu items.  Currently only works for Win32,
3036		GTK+, and Motif 1.2 GUI.
3037	  'T'	Include Toolbar.  Currently only in Win32, GTK+, Motif, and
3038		Athena GUIs.
3039
3040	  'r'	Right-hand scrollbar is always present.
3041	  'R'	Right-hand scrollbar is present when there is a vertically
3042		split window.
3043	  'l'	Left-hand scrollbar is always present.
3044	  'L'	Left-hand scrollbar is present when there is a vertically
3045		split window.
3046	  'b'	Bottom (horizontal) scrollbar is present.  Its size depends on
3047		the longest visible line, or on the cursor line if the 'h'
3048		flag is included. |gui-horiz-scroll|
3049	  'h'	Limit horizontal scrollbar size to the length of the cursor
3050		line.  Reduces computations. |gui-horiz-scroll|
3051
3052	And yes, you may even have scrollbars on the left AND the right if
3053	you really want to :-).  See |gui-scrollbars| for more information.
3054
3055	  'v'	Use a vertical button layout for dialogs.  When not included,
3056		a horizontal layout is preferred, but when it doesn't fit a
3057		vertical layout is used anyway.
3058	  'p'	Use Pointer callbacks for X11 GUI.  This is required for some
3059		window managers.  If the cursor is not blinking or hollow at
3060		the right moment, try adding this flag.  This must be done
3061		before starting the GUI.  Set it in your gvimrc.  Adding or
3062		removing it after the GUI has started has no effect.
3063	  'F'	Add a footer.  Only for Motif.  See |gui-footer|.
3064
3065						*'guipty'* *'noguipty'*
3066'guipty'		boolean	(default on)
3067			global
3068			{not in Vi}
3069			{only available when compiled with GUI enabled}
3070	Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3071	I/O to/from shell commands.  See |gui-pty|.
3072
3073						*'helpfile'* *'hf'*
3074'helpfile' 'hf'		string	(default (MSDOS)  "$VIMRUNTIME\doc\help.txt"
3075					 (others) "$VIMRUNTIME/doc/help.txt")
3076			global
3077			{not in Vi}
3078	Name of the main help file.  All distributed help files should be
3079	placed together in one directory.  Additionally, all "doc" directories
3080	in 'runtimepath' will be used.
3081	Environment variables are expanded |:set_env|.  For example:
3082	"$VIMRUNTIME/doc/help.txt".  If $VIMRUNTIME is not set, $VIM is also
3083	tried.  Also see |$VIMRUNTIME| and |option-backslash| about including
3084	spaces and backslashes.
3085	This option cannot be set from a |modeline| or in the |sandbox|, for
3086	security reasons.
3087
3088						*'helpheight'* *'hh'*
3089'helpheight' 'hh'	number	(default 20)
3090			global
3091			{not in Vi}
3092			{not available when compiled without the +windows
3093			feature}
3094	Minimal initial height of the help window when it is opened with the
3095	":help" command.  The initial height of the help window is half of the
3096	current window, or (when the 'ea' option is on) the same as other
3097	windows.  When the height is less than 'helpheight', the height is
3098	set to 'helpheight'.  Set to zero to disable.
3099
3100						*'helplang'* *'hlg'*
3101'helplang' 'hlg'	string	(default: messages language or empty)
3102			global
3103			{only available when compiled with the |+multi_lang|
3104			feature}
3105			{not in Vi}
3106	Comma separated list of languages.  Vim will use the first language
3107	for which the desired help can be found.  The English help will always
3108	be used as a last resort.  You can add "en" to prefer English over
3109	another language, but that will only find tags that exist in that
3110	language and not in the English help.
3111	Example: >
3112		:set helplang=de,it
3113<	This will first search German, then Italian and finally English help
3114	files.
3115	When using |CTRL-]| and ":help!" in a non-English help file Vim will
3116	try to find the tag in the current language before using this option.
3117	See |help-translated|.
3118
3119				     *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3120'hidden' 'hid'		boolean	(default off)
3121			global
3122			{not in Vi}
3123	When off a buffer is unloaded when it is |abandon|ed.  When on a
3124	buffer becomes hidden when it is |abandon|ed.  If the buffer is still
3125	displayed in another window, it does not become hidden, of course.
3126	The commands that move through the buffer list sometimes make a buffer
3127	hidden although the 'hidden' option is off: When the buffer is
3128	modified, 'autowrite' is off or writing is not possible, and the '!'
3129	flag was used.  See also |windows.txt|.
3130	To only make one buffer hidden use the 'bufhidden' option.
3131	This option is set for one command with ":hide {command}" |:hide|.
3132	WARNING: It's easy to forget that you have changes in hidden buffers.
3133	Think twice when using ":q!" or ":qa!".
3134
3135						*'highlight'* *'hl'*
3136'highlight' 'hl'	string	(default (as a single string):
3137				     "8:SpecialKey,@:NonText,d:Directory,
3138				     e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3139				     M:ModeMsg,n:LineNr,r:Question,
3140				     s:StatusLine,S:StatusLineNC,c:VertSplit
3141				     t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3142				     f:Folded,F:FoldColumn,A:DiffAdd,
3143				     C:DiffChange,D:DiffDelete,T:DiffText,
3144				     >:SignColumn")
3145			global
3146			{not in Vi}
3147	This option can be used to set highlighting mode for various
3148	occasions.  It is a comma separated list of character pairs.  The
3149	first character in a pair gives the occasion, the second the mode to
3150	use for that occasion.  The occasions are:
3151	|hl-SpecialKey|	 8  Meta and special keys listed with ":map"
3152	|hl-NonText|	 @  '~' and '@' at the end of the window and
3153			    characters from 'showbreak'
3154	|hl-Directory|	 d  directories in CTRL-D listing and other special
3155			    things in listings
3156	|hl-ErrorMsg|	 e  error messages
3157			 h  (obsolete, ignored)
3158	|hl-IncSearch|	 i  'incsearch' highlighting
3159	|hl-Search|	 l  last search pattern highlighting (see 'hlsearch')
3160	|hl-MoreMsg|	 m  |more-prompt|
3161	|hl-ModeMsg|	 M  Mode (e.g., "-- INSERT --")
3162	|hl-LineNr|	 n  line number for ":number" and ":#" commands
3163	|hl-Question|	 r  |hit-enter| prompt and yes/no questions
3164	|hl-StatusLine|	 s  status line of current window |status-line|
3165	|hl-StatusLineNC| S  status lines of not-current windows
3166	|hl-Title|	 t  Titles for output from ":set all", ":autocmd" etc.
3167	|hl-VertSplit|	 c  column used to separate vertically split windows
3168	|hl-Visual|	 v  Visual mode
3169	|hl-VisualNOS|	 V  Visual mode when Vim does is "Not Owning the
3170			    Selection" Only X11 Gui's |gui-x11| and
3171			    |xterm-clipboard|.
3172	|hl-WarningMsg|	 w  warning messages
3173	|hl-WildMenu|	 W  wildcard matches displayed for 'wildmenu'
3174	|hl-Folded|	 f  line used for closed folds
3175	|hl-FoldColumn|	 F  'foldcolumn'
3176	|hl-SignColumn|	 >  column used for |signs|
3177
3178	The display modes are:
3179		r	reverse		(termcap entry "mr" and "me")
3180		i	italic		(termcap entry "ZH" and "ZR")
3181		b	bold		(termcap entry "md" and "me")
3182		s	standout	(termcap entry "so" and "se")
3183		u	underline	(termcap entry "us" and "ue")
3184		n	no highlighting
3185		-	no highlighting
3186		:	use a highlight group
3187	The default is used for occasions that are not included.
3188	If you want to change what the display modes do, see |dos-colors|
3189	for an example.
3190	When using the ':' display mode, this must be followed by the name of
3191	a highlight group.  A highlight group can be used to define any type
3192	of highlighting, including using color.  See |:highlight| on how to
3193	define one.  The default uses a different group for each occasion.
3194	See |highlight-default| for the default highlight groups.
3195
3196				 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3197'hlsearch' 'hls'	boolean	(default off)
3198			global
3199			{not in Vi}
3200			{not available when compiled without the
3201			|+extra_search| feature}
3202	When there is a previous search pattern, highlight all its matches.
3203	The type of highlighting used can be set with the 'l' occasion in the
3204	'highlight' option.  This uses the "Search" highlight group by
3205	default.  Note that only the matching text is highlighted, any offsets
3206	are not applied.
3207	See also: 'incsearch' and |:match|.
3208	When you get bored looking at the highlighted matches, you can turn it
3209	off with |:nohlsearch|.  As soon as you use a search command, the
3210	highlighting comes back.
3211	When the search pattern can match an end-of-line, Vim will try to
3212	highlight all of the matched text.  However, this depends on where the
3213	search starts.  This will be the first line in the window or the first
3214	line below a closed fold.  A match in a previous line which is not
3215	drawn may not continue in an newly drawn line.
3216	NOTE: This option is reset when 'compatible' is set.
3217
3218						*'history'* *'hi'*
3219'history' 'hi'		number	(Vim default: 20, Vi default: 0)
3220			global
3221			{not in Vi}
3222	A history of ":" commands, and a history of previous search patterns
3223	are remembered.  This option decides how many entries may be stored in
3224	each of these histories (see |cmdline-editing|).
3225	NOTE: This option is set to the Vi default value when 'compatible' is
3226	set and to the Vim default value when 'compatible' is reset.
3227
3228					 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3229'hkmap' 'hk'		boolean (default off)
3230			global
3231			{not in Vi}
3232			{only available when compiled with the |+rightleft|
3233			feature}
3234	When on, the keyboard is mapped for the Hebrew character set.
3235	Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3236	toggle this option.  See |rileft.txt|.
3237	NOTE: This option is reset when 'compatible' is set.
3238
3239				 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3240'hkmapp' 'hkp'		boolean (default off)
3241			global
3242			{not in Vi}
3243			{only available when compiled with the |+rightleft|
3244			feature}
3245	When on, phonetic keyboard mapping is used.  'hkmap' must also be on.
3246	This is useful if you have a non-Hebrew keyboard.
3247	See |rileft.txt|.
3248	NOTE: This option is reset when 'compatible' is set.
3249
3250						*'icon'* *'noicon'*
3251'icon'			boolean	(default off, on when title can be restored)
3252			global
3253			{not in Vi}
3254			{not available when compiled without the |+title|
3255			feature}
3256	When on, the icon text of the window will be set to the value of
3257	'iconstring' (if it is not empty), or to the name of the file
3258	currently being edited.  Only the last part of the name is used.
3259	Overridden by the 'iconstring' option.
3260	Only works if the terminal supports setting window icons (currently
3261	only X11 GUI and terminals with a non-empty 't_IS' option - these are
3262	Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3263	builtin termcap).
3264	When Vim was compiled with HAVE_X11 defined, the original icon will be
3265	restored if possible |X11|. See |X11-icon| for changing the icon on
3266	X11.
3267
3268						*'iconstring'*
3269'iconstring'		string	(default "")
3270			global
3271			{not in Vi}
3272			{not available when compiled without the |+title|
3273			feature}
3274	When this option is not empty, it will be used for the icon text of
3275	the window.  This happens only when the 'icon' option is on.
3276	Only works if the terminal supports setting window icon text
3277	(currently only X11 GUI and terminals with a non-empty 't_IS' option).
3278	Does not work for MS Windows.
3279	When Vim was compiled with HAVE_X11 defined, the original icon will be
3280	restored if possible |X11|.
3281	When this option contains printf-style '%' items, they will be
3282	expanded according to the rules used for 'statusline'.  See
3283	'titlestring' for example settings.
3284	{not available when compiled without the |+statusline| feature}
3285
3286			*'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3287'ignorecase' 'ic'	boolean	(default off)
3288			global
3289	Ignore case in search patterns.  Also used when searching in the tags
3290	file.
3291	Also see 'smartcase'.
3292	Can be overruled by using "\c" or "\C" in the pattern, see
3293	|/ignorecase|.
3294
3295						*'imactivatekey'* *'imak'*
3296'imactivatekey' 'imak'	string (default "")
3297			global
3298			{not in Vi}
3299			{only available when compiled with |+xim| and
3300			|+GUI_GTK|}
3301	Specifies the key that your Input Method in X-Windows uses for
3302	activation.  When this is specified correctly, vim can fully control
3303	IM with 'imcmdline', 'iminsert' and 'imsearch'.
3304	You can't use this option to change the activation key, the option
3305	tells Vim what the key is.
3306	Format:
3307		[MODIFIER_FLAG-]KEY_STRING
3308
3309	These characters can be used for MODIFIER_FLAG (case is ignored):
3310		S	    Shift key
3311		L	    Lock key
3312		C	    Control key
3313		1	    Mod1 key
3314		2	    Mod2 key
3315		3	    Mod3 key
3316		4	    Mod4 key
3317		5	    Mod5 key
3318	Combinations are allowed, for example "S-C-space" or "SC-space" are
3319	both shift+ctrl+space.
3320	See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3321
3322	Example: >
3323		:set imactivatekey=S-space
3324<	"S-space" means shift+space.  This is the activation key for kinput2 +
3325	canna (Japanese), and ami (Korean).
3326
3327				*'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3328'imcmdline' 'imc'	boolean (default off)
3329			global
3330			{not in Vi}
3331			{only available when compiled with the |+xim|
3332			|+multi_byte_ime| or |global-ime| feature}
3333	When set the Input Method is always on when starting to edit a command
3334	line, unless entering a search pattern (see 'imsearch' for that).
3335	Setting this option is useful when your input method allows entering
3336	English characters directly, e.g., when it's used to type accented
3337	characters with dead keys.
3338
3339				*'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3340'imdisable' 'imd'	boolean (default off, on for some systems (SGI))
3341			global
3342			{not in Vi}
3343			{only available when compiled with the |+xim|
3344			|+multi_byte_ime| or |global-ime| feature}
3345	When set the Input Method is never used.  This is useful to disable
3346	the IM when it doesn't work properly.
3347	Currently this option is on by default for SGI/IRIX machines.  This
3348	may change in later releases.
3349
3350						*'iminsert'* *'imi'*
3351'iminsert' 'imi'	number (default 0, 2 when an input method is supported)
3352			local to buffer
3353			{not in Vi}
3354	Specifies whether :lmap or an Input Method (IM) is to be used in
3355	Insert mode.  Valid values:
3356		0	:lmap is off and IM is off
3357		1	:lmap is ON and IM is off
3358		2	:lmap is off and IM is ON
3359	2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3360	or |global-ime|.
3361	To always reset the option to zero when leaving Insert mode with <Esc>
3362	this can be used: >
3363		:inoremap <ESC> <ESC>:set iminsert=0<CR>
3364<	This makes :lmap and IM turn off automatically when leaving Insert
3365	mode.
3366	Note that this option changes when using CTRL-^ in Insert mode
3367	|i_CTRL-^|.
3368	The value is set to 1 when setting 'keymap' to a valid keymap name.
3369	It is also used for the argument of commands like "r" and "f".
3370	The value 0 may not work correctly with Athena and Motif with some XIM
3371	methods.  Use 'imdisable' to disable XIM then.
3372
3373						*'imsearch'* *'ims'*
3374'imsearch' 'ims'	number (default 0, 2 when an input method is supported)
3375			local to buffer
3376			{not in Vi}
3377	Specifies whether :lmap or an Input Method (IM) is to be used when
3378	entering a search pattern.  Valid values:
3379		-1	the value of 'iminsert' is used, makes it look like
3380			'iminsert' is also used when typing a search pattern
3381		0	:lmap is off and IM is off
3382		1	:lmap is ON and IM is off
3383		2	:lmap is off and IM is ON
3384	Note that this option changes when using CTRL-^ in Command-line mode
3385	|c_CTRL-^|.
3386	The value is set to 1 when it is not -1 and setting the 'keymap'
3387	option to a valid keymap name.
3388	The value 0 may not work correctly with Athena and Motif with some XIM
3389	methods.  Use 'imdisable' to disable XIM then.
3390
3391						*'include'* *'inc'*
3392'include' 'inc'		string	(default "^\s*#\s*include")
3393			global or local to buffer |global-local|
3394			{not in Vi}
3395			{not available when compiled without the
3396			|+find_in_path| feature}
3397	Pattern to be used to find an include command.  It is a search
3398	pattern, just like for the "/" command (See |pattern|).  The default
3399	value is for C programs.  This option is used for the commands "[i",
3400	"]I", "[d", etc..  The 'isfname' option is used to recognize the file
3401	name that comes after the matched pattern.  See |option-backslash|
3402	about including spaces and backslashes.
3403
3404						*'includeexpr'* *'inex'*
3405'includeexpr' 'inex'	string	(default "")
3406			local to buffer
3407			{not in Vi}
3408			{not available when compiled without the
3409			|+find_in_path| or |+eval| feature}
3410	Expression to be used to transform the string found with the 'include'
3411	option to a file name.  Mostly useful to change "." to "/" for Java: >
3412		:set includeexpr=substitute(v:fname,'\\.','/','g')
3413<	The "v:fname" variable will be set to the file name that was detected.
3414	Evaluated in the |sandbox|.
3415	Also used for the |gf| command if an unmodified file name can't be
3416	found.  Allows doing "gf" on the name after an 'include' statement.
3417	Also used for |<cfile>|.
3418
3419				 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3420'incsearch' 'is'	boolean	(default off)
3421			global
3422			{not in Vi}
3423			{not available when compiled without the
3424			|+extra_search| feature}
3425	While typing a search command, show immediately where the so far
3426	typed pattern matches.  The matched string is highlighted.  If the
3427	pattern is invalid or not found, nothing is shown.  The screen will
3428	be updated often, this is only useful on fast terminals.  Note that
3429	the match will be shown, but the cursor is not actually positioned
3430	there.  You still need to finish the search command with <CR> to move
3431	the cursor.  The highlighting can be set with the 'i' flag in
3432	'highlight'.  See also: 'hlsearch'.
3433	NOTE: This option is reset when 'compatible' is set.
3434
3435						*'indentexpr'* *'inde'*
3436'indentexpr' 'inde'	string	(default "")
3437			local to buffer
3438			{not in Vi}
3439			{not available when compiled without the |+cindent|
3440			or |+eval| features}
3441	Expression which is evaluated to obtain the proper indent for a line.
3442	It is used when a new line is created, for the |=| operator and
3443	in Insert mode as specified with the 'indentkeys' option.
3444	When this option is not empty, it overrules the 'cindent' and
3445	'smartindent' indenting.
3446	When 'paste' is set this option is not used for indenting.
3447	The expression is evaluated with |v:lnum| set to the line number for
3448	which the indent is to be computed.  The cursor is also as this line
3449	when the expression is evaluated (but it may be moved around).
3450	The expression must return the number of spaces worth of indent.  It
3451	can return "-1" to keep the current indent (this means 'autoindent' is
3452	used for the indent).
3453	Functions useful for computing the indent are |indent()|, |cindent()|
3454	and |lispindent()|.
3455	The evaluation of the expression must not have side effects!  It must
3456	not change the text, jump to another window, etc.  Afterwards the
3457	cursor position is always restored, thus the cursor may be moved.
3458	Normally this option would be set to call a function: >
3459		:set indentexpr=GetMyIndent()
3460<	Error messages will be suppressed, unless the 'debug' option contains
3461	"msg".
3462	See |indent-expression|.  Also see |eval-sandbox|.
3463	NOTE: This option is made empty when 'compatible' is set.
3464
3465						*'indentkeys'* *'indk'*
3466'indentkeys' 'indk'	string	(default "0{,0},:,0#,!^F,o,O,e")
3467			local to buffer
3468			{not in Vi}
3469			{not available when compiled without the |+cindent|
3470			feature}
3471	A list of keys that, when typed in Insert mode, cause reindenting of
3472	the current line.  Only happens if 'indentexpr' isn't empty.
3473	The format is identical to 'cinkeys', see |indentkeys-format|.
3474	See |C-indenting| and |indent-expression|.
3475
3476			*'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3477'infercase' 'inf'	boolean	(default off)
3478			local to buffer
3479			{not in Vi}
3480	When doing keyword completion in insert mode |ins-completion|, and
3481	'ignorecase' is also on, the case of the match is adjusted.  If the
3482	typed text contains a lowercase letter where the match has an upper
3483	case letter, the completed part is made lowercase.  If the typed text
3484	has no lowercase letters and the match has a lowercase letter where
3485	the typed text has an uppercase letter, and there is a letter before
3486	it, the completed part is made uppercase.
3487
3488			*'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3489'insertmode' 'im'	boolean	(default off)
3490			global
3491			{not in Vi}
3492	Makes Vim work in a way that Insert mode is the default mode.  Useful
3493	if you want to use Vim as a modeless editor.  Used for |evim|.
3494	These Insert mode commands will be useful:
3495	- Use the cursor keys to move around.
3496	- Use CTRL-O to execute one Normal mode command |i_CTRL-O|).  When
3497	  this is a mapping, it is executed as if 'insertmode' was off.
3498	  Normal mode remains active until the mapping is finished.
3499								*i_CTRL-L*
3500	- Use CTRL-L to execute a number of Normal mode commands, then use
3501	  <Esc> to get back to Insert mode.
3502
3503	These items change when 'insertmode' is set:
3504	- when starting to edit of a file, Vim goes to Insert mode.
3505	- <Esc> in Insert mode is a no-op and beeps.
3506	- <Esc> in Normal mode makes Vim go to Insert mode.
3507	- CTRL-L in Insert mode is a command, it is not inserted.
3508	- CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|.	*i_CTRL-Z*
3509	However, when <Esc> is used inside a mapping, it behaves like
3510	'insertmode' was not set.  This was done to be able to use the same
3511	mappings with 'insertmode' set or not set.
3512	When executing commands with |:normal| 'insertmode' is not used.
3513
3514	NOTE: This option is reset when 'compatible' is set.
3515
3516						*'isfname'* *'isf'*
3517'isfname' 'isf'		string	(default for MS-DOS, Win32 and OS/2:
3518			     "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3519			    for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3520			    for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3521			    for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3522			    otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3523			global
3524			{not in Vi}
3525	The characters specified by this option are included in file names and
3526	path names.  Filenames are used for commands like "gf", "[i" and in
3527	the tags file.  It is also used for "\f" in a |pattern|.
3528	Multi-byte characters 256 and above are always included, only the
3529	characters up to 255 are specified with this option.
3530	For UTF-8 the characters 0xa0 to 0xff are included as well.
3531
3532	Note that on systems using a backslash as path separator, Vim tries to
3533	do its best to make it work as you would expect.  That is a bit
3534	tricky, since Vi originally used the backslash to escape special
3535	characters.  Vim will not remove a backslash in front of a normal file
3536	name character on these systems, but it will on Unix and alikes.  The
3537	'&' and '^' are not included by default, because these are special for
3538	cmd.exe.
3539
3540	The format of this option is a list of parts, separated with commas.
3541	Each part can be a single character number or a range.  A range is two
3542	character numbers with '-' in between.  A character number can be a
3543	decimal number between 0 and 255 or the ASCII character itself (does
3544	not work for digits).  Example:
3545		"_,-,128-140,#-43"	(include '_' and '-' and the range
3546					128 to 140 and '#' to 43)
3547	If a part starts with '^', the following character number or range
3548	will be excluded from the option.  The option is interpreted from left
3549	to right.  Put the excluded character after the range where it is
3550	included.  To include '^' itself use it as the last character of the
3551	option or the end of a range.  Example:
3552		"^a-z,#,^"	(exclude 'a' to 'z', include '#' and '^')
3553	If the character is '@', all characters where isalpha() returns TRUE
3554	are included.  Normally these are the characters a to z and A to Z,
3555	plus accented characters.  To include '@' itself use "@-@".  Examples:
3556		"@,^a-z"	All alphabetic characters, excluding lower
3557				case letters.
3558		"a-z,A-Z,@-@"	All letters plus the '@' character.
3559	A comma can be included by using it where a character number is
3560	expected.  Example:
3561		"48-57,,,_"	Digits, comma and underscore.
3562	A comma can be excluded by prepending a '^'.  Example:
3563		" -~,^,,9"	All characters from space to '~', excluding
3564				comma, plus <Tab>.
3565	See |option-backslash| about including spaces and backslashes.
3566
3567						*'isident'* *'isi'*
3568'isident' 'isi'		string	(default for MS-DOS, Win32 and OS/2:
3569					   "@,48-57,_,128-167,224-235"
3570				otherwise: "@,48-57,_,192-255")
3571			global
3572			{not in Vi}
3573	The characters given by this option are included in identifiers.
3574	Identifiers are used in recognizing environment variables and after a
3575	match of the 'define' option.  It is also used for "\i" in a
3576	|pattern|. See 'isfname' for a description of the format of this
3577	option.
3578	Careful: If you change this option, it might break expanding
3579	environment variables.  E.g., when '/' is included and Vim tries to
3580	expand "$HOME/.viminfo".  Maybe you should change 'iskeyword' instead.
3581
3582						*'iskeyword'* *'isk'*
3583'iskeyword' 'isk'	string (Vim default for MS-DOS and Win32:
3584					    "@,48-57,_,128-167,224-235"
3585				   otherwise:  "@,48-57,_,192-255"
3586				Vi default: "@,48-57,_")
3587			local to buffer
3588			{not in Vi}
3589	Keywords are used in searching and recognizing with many commands:
3590	"w", "*", "[i", etc.  It is also used for "\k" in a |pattern|.  See
3591	'isfname' for a description of the format of this option.  For C
3592	programs you could use "a-z,A-Z,48-57,_,.,-,>".
3593	For a help file it is set to all non-blank printable characters except
3594	'*', '"' and '|' (so that CTRL-] on a command finds the help for that
3595	command).
3596	When the 'lisp' option is on the '-' character is always included.
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						*'isprint'* *'isp'*
3601'isprint' 'isp'	string	(default for MS-DOS, Win32, OS/2 and Macintosh:
3602				"@,~-255"; otherwise: "@,161-255")
3603			global
3604			{not in Vi}
3605	The characters given by this option are displayed directly on the
3606	screen.  It is also used for "\p" in a |pattern|.  The characters from
3607	space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3608	even when they are not included in 'isprint' or excluded.  See
3609	'isfname' for a description of the format of this option.
3610
3611	Non-printable characters are displayed with two characters:
3612		  0 -  31	"^@" - "^_"
3613		 32 - 126	always single characters
3614		   127		"^?"
3615		128 - 159	"~@" - "~_"
3616		160 - 254	"| " - "|~"
3617		   255		"~?"
3618	When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3619	displayed as <xx>, with the hexadecimal value of the byte.
3620	When 'display' contains "uhex" all unprintable characters are
3621	displayed as <xx>.
3622	The NonText highlighting will be used for unprintable characters.
3623	|hl-NonText|
3624
3625	Multi-byte characters 256 and above are always included, only the
3626	characters up to 255 are specified with this option.  When a character
3627	is printable but it is not available in the current font, a
3628	replacement character will be shown.
3629	Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3630	There is no option to specify these characters.
3631
3632			*'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3633'joinspaces' 'js'	boolean	(default on)
3634			global
3635			{not in Vi}
3636	Insert two spaces after a '.', '?' and '!' with a join command.
3637	When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3638	Otherwise only one space is inserted.
3639	NOTE: This option is set when 'compatible' is set.
3640
3641							*'key'*
3642'key'			string	(default "")
3643			local to buffer
3644			{not in Vi}
3645	The key that is used for encrypting and decrypting the current buffer.
3646	See |encryption|.
3647	Careful: Do not set the key value by hand, someone might see the typed
3648	key.  Use the |:X| command.  But you can make 'key' empty: >
3649		:set key=
3650<	It is not possible to get the value of this option with ":set key" or
3651	"echo &key".  This is to avoid showing it to someone who shouldn't
3652	know.  It also means you cannot see it yourself once you have set it,
3653	be careful not to make a typing error!
3654
3655					*'keymap'* *'kmp'* *E544*
3656'keymap' 'kmp'		string	(default "")
3657			local to buffer
3658			{not in Vi}
3659			{only available when compiled with the |+keymap|
3660			feature}
3661	Name of a keyboard mapping.  See |mbyte-keymap|.
3662	Setting this option to a valid keymap name has the side effect of
3663	setting 'iminsert' to one, so that the keymap becomes effective.
3664	'imsearch' is also set to one, unless it was -1
3665
3666					*'keymodel'* *'km'*
3667'keymodel' 'km'		string	(default "")
3668			global
3669			{not in Vi}
3670	List of comma separated words, which enable special things that keys
3671	can do.  These values can be used:
3672	   startsel	Using a shifted special key starts selection (either
3673			Select mode or Visual mode, depending on "key" being
3674			present in 'selectmode').
3675	   stopsel	Using a not-shifted special key stops selection.
3676	Special keys in this context are the cursor keys, <End>, <Home>,
3677	<PageUp> and <PageDown>.
3678	The 'keymodel' option is set by the |:behave| command.
3679
3680					*'keywordprg'* *'kp'*
3681'keywordprg' 'kp'	string	(default "man" or "man -s",  DOS: ":help",
3682						OS/2: "view /", VMS: "help")
3683			global or local to buffer |global-local|
3684			{not in Vi}
3685	Program to use for the |K| command.  Environment variables are
3686	expanded |:set_env|.  ":help" may be used to access the Vim internal
3687	help.  (Note that previously setting the global option to the empty
3688	value did this, which is now deprecated.)
3689	When "man" is used, Vim will automatically translate a count for the
3690	"K" command to a section number.  Also for "man -s", in which case the
3691	"-s" is removed when there is no count.
3692	See |option-backslash| about including spaces and backslashes.
3693	Example: >
3694		:set keywordprg=man\ -s
3695<	This option cannot be set from a |modeline| or in the |sandbox|, for
3696	security reasons.
3697
3698					*'langmap'* *'lmap'* *E357* *E358*
3699'langmap' 'lmap'	string	(default "")
3700			global
3701			{not in Vi}
3702			{only available when compiled with the |+langmap|
3703			feature}
3704	This option allows switching your keyboard into a special language
3705	mode.  When you are typing text in Insert mode the characters are
3706	inserted directly.  When in command mode the 'langmap' option takes
3707	care of translating these special characters to the original meaning
3708	of the key.  This means you don't have to change the keyboard mode to
3709	be able to execute Normal mode commands.
3710	This is the opposite of the 'keymap' option, where characters are
3711	mapped in Insert mode.
3712	This only works for 8-bit characters.  The value of 'langmap' may be
3713	specified with multi-byte characters (e.g., UTF-8), but only the lower
3714	8 bits of each character will be used.
3715
3716	Example (for Greek):					*greek*  >
3717	    :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
3718<	Example (exchanges meaning of z and y for commands): >
3719	    :set langmap=zy,yz,ZY,YZ
3720<
3721	The 'langmap' option is a list of parts, separated with commas.  Each
3722	part can be in one of two forms:
3723	1.  A list of pairs.  Each pair is a "from" character immediately
3724	    followed by the "to" character.  Examples: "aA", "aAbBcC".
3725	2.  A list of "from" characters, a semi-colon and a list of "to"
3726	    characters.  Example: "abc;ABC"
3727	Example: "aA,fgh;FGH,cCdDeE"
3728	Special characters need to be preceded with a backslash.  These are
3729	";", ',' and backslash itself.
3730
3731	This will allow you to activate vim actions without having to switch
3732	back and forth between the languages.  Your language characters will
3733	be understood as normal vim English characters (according to the
3734	langmap mappings) in the following cases:
3735	 o Normal/Visual mode (commands, buffer/register names, user mappings)
3736	 o Insert/Replace Mode: Register names after CTRL-R
3737	 o Insert/Replace Mode: Mappings
3738	Characters entered in Command-line mode will NOT be affected by
3739	this option.   Note that this option can be changed at any time
3740	allowing to switch between mappings for different languages/encodings.
3741	Use a mapping to avoid having to type it each time!
3742
3743					*'langmenu'* *'lm'*
3744'langmenu' 'lm'		string	(default "")
3745			global
3746			{not in Vi}
3747			{only available when compiled with the |+menu| and
3748			|+multi_lang| features}
3749	Language to use for menu translation.  Tells which file is loaded
3750	from the "lang" directory in 'runtimepath': >
3751		"lang/menu_" . &langmenu . ".vim"
3752<	(without the spaces).  For example, to always use the Dutch menus, no
3753	matter what $LANG is set to: >
3754		:set langmenu=nl_NL.ISO_8859-1
3755<	When 'langmenu' is empty, |v:lang| is used.
3756	If your $LANG is set to a non-English language but you do want to use
3757	the English menus: >
3758		:set langmenu=none
3759<	This option must be set before loading menus, switching on filetype
3760	detection or syntax highlighting.  Once the menus are defined setting
3761	this option has no effect.  But you could do this: >
3762		:source $VIMRUNTIME/delmenu.vim
3763		:set langmenu=de_DE.ISO_8859-1
3764		:source $VIMRUNTIME/menu.vim
3765<	Warning: This deletes all menus that you defined yourself!
3766
3767					*'laststatus'* *'ls'*
3768'laststatus' 'ls'	number	(default 1)
3769			global
3770			{not in Vi}
3771	The value of this option influences when the last window will have a
3772	status line:
3773		0: never
3774		1: only if there are at least two windows
3775		2: always
3776	The screen looks nicer with a status line if you have several
3777	windows, but it takes another screen line. |status-line|
3778
3779			*'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3780'lazyredraw' 'lz'	boolean	(default off)
3781			global
3782			{not in Vi}
3783	When this option is set, the screen will not be redrawn while
3784	executing macros, registers and other commands that have not been
3785	typed.  Also, updating the window title is postponed.  To force an
3786	update use |:redraw|.
3787
3788			*'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3789'linebreak' 'lbr'	boolean	(default off)
3790			local to window
3791			{not in Vi}
3792			{not available when compiled without the  |+linebreak|
3793			feature}
3794	If on Vim will wrap long lines at a character in 'breakat' rather
3795	than at the last character that fits on the screen.  Unlike
3796	'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
3797	it only affects the way the file is displayed, not its contents.  The
3798	value of 'showbreak' is used to put in front of wrapped lines.
3799	This option is not used when the 'wrap' option is off or 'list' is on.
3800	Note that <Tab> characters after an <EOL> are mostly not displayed
3801	with the right amount of white space.
3802
3803						*'lines'* *E593*
3804'lines'			number	(default 24 or terminal height)
3805			global
3806	Number of lines of the Vim window.
3807	Normally you don't need to set this.  It is done automatically by the
3808	terminal initialization code.
3809	When Vim is running in the GUI or in a resizable window, setting this
3810	option will cause the window size to be changed.  When you only want
3811	to use the size for the GUI, put the command in your |gvimrc| file.
3812	Vim limits the number of lines to what fits on the screen.  You can
3813	use this command to get the tallest window possible: >
3814		:set lines=999
3815<	If you get less lines than expected, check the 'guiheadroom' option.
3816	When you set this option and Vim is unable to change the physical
3817	number of lines of the display, the display may be messed up.
3818
3819						*'linespace'* *'lsp'*
3820'linespace' 'lsp'	number	(default 0, 1 for Win32 GUI)
3821			global
3822			{not in Vi}
3823			{only in the GUI}
3824	Number of pixel lines inserted between characters.  Useful if the font
3825	uses the full character cell height, making lines touch each other.
3826	When non-zero there is room for underlining.
3827
3828						*'lisp'* *'nolisp'*
3829'lisp'			boolean	(default off)
3830			local to buffer
3831			{not available when compiled without the |+lispindent|
3832			feature}
3833	Lisp mode: When <Enter> is typed in insert mode set the indent for
3834	the next line to Lisp standards (well, sort of).  Also happens with
3835	"cc" or "S".  'autoindent' must also be on for this to work.  The 'p'
3836	flag in 'cpoptions' changes the method of indenting: Vi compatible or
3837	better.  Also see 'lispwords'.
3838	The '-' character is included in keyword characters.  Redefines the
3839	"=" operator to use this same indentation algorithm rather than
3840	calling an external program if 'equalprg' is empty.
3841	This option is not used when 'paste' is set.
3842	{Vi: Does it a little bit differently}
3843
3844						*'lispwords'* *'lw'*
3845'lispwords' 'lw'	string	(default is very long)
3846			global
3847			{not in Vi}
3848			{not available when compiled without the |+lispindent|
3849			feature}
3850	Comma separated list of words that influence the Lisp indenting.
3851	|'lisp'|
3852
3853						*'list'* *'nolist'*
3854'list'			boolean	(default off)
3855			local to window
3856	List mode: Show tabs as CTRL-I, show end of line with $.  Useful to
3857	see the difference between tabs and spaces and for trailing blanks.
3858	Note that this will also affect formatting (set with 'textwidth' or
3859	'wrapmargin') when 'cpoptions' includes 'L'.  See 'listchars' for
3860	changing the way tabs are displayed.
3861
3862						*'listchars'* *'lcs'*
3863'listchars' 'lcs'	string	(default "eol:$")
3864			global
3865			{not in Vi}
3866	Strings to use in 'list' mode.  It is a comma separated list of string
3867	settings.
3868	  eol:c		Character to show at the end of each line.  When
3869			omitted, there is no extra character at the end of the
3870			line.
3871	  tab:xy	Two characters to be used to show a Tab.  The first
3872			char is used once.  The second char is repeated to
3873			fill the space that the Tab normally occupies.
3874			"tab:>-" will show a Tab that takes four spaces as
3875			">---".  When omitted, a Tab is show as ^I.
3876	  trail:c	Character to show for trailing spaces.  When omitted,
3877			trailing spaces are blank.
3878	  extends:c	Character to show in the last column, when 'wrap' is
3879			off and the line continues beyond the right of the
3880			screen.
3881	  precedes:c	Character to show in the first column, when 'wrap'
3882			is off and there is text preceding the character
3883			visible in the first column.
3884	  nbsp:c	Character to show for non-breakable space. Left to
3885			blank when omitted.
3886
3887	The characters ':' and ',' should not be used.  UTF-8 characters can
3888	be used when 'encoding' is "utf-8", otherwise only printable
3889	characters are allowed.
3890
3891	Examples: >
3892	    :set lcs=tab:>-,trail:-
3893	    :set lcs=tab:>-,eol:<,nbsp:%
3894	    :set lcs=extends:>,precedes:<
3895<	The "NonText" highlighting will be used for "eol", "extends" and
3896	"precedes".  "SpecialKey" for "nbsp", "tab" and "trail".
3897
3898			*'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
3899'loadplugins' 'lpl'	boolean	(default on)
3900			global
3901			{not in Vi}
3902	When on the plugin scripts are loaded when starting up |load-plugins|.
3903	This option can be reset in your |vimrc| file to disable the loading
3904	of plugins.
3905	Note that using the "-u NONE" and "--noplugin" command line arguments
3906	reset this option. |-u| |--noplugin|
3907
3908						*'magic'* *'nomagic'*
3909'magic'			boolean	(default on)
3910			global
3911	Changes the special characters that can be used in search patterns.
3912	See |pattern|.
3913	NOTE: To avoid portability problems with using patterns, always keep
3914	this option at the default "on".  Only switch it off when working with
3915	old Vi scripts.  In any other situation write patterns that work when
3916	'magic' is on.
3917
3918						*'makeef'* *'mef'*
3919'makeef' 'mef'		string	(default: "")
3920			global
3921			{not in Vi}
3922			{not available when compiled without the |+quickfix|
3923			feature}
3924	Name of the errorfile for the |:make| command (see |:make_makeprg|)
3925	and the |:grep| command.
3926	When it is empty, an internally generated temp file will be used.
3927	When "##" is included, it is replaced by a number to make the name
3928	unique.  This makes sure that the ":make" command doesn't overwrite an
3929	existing file.
3930	NOT used for the ":cf" command.  See 'errorfile' for that.
3931	Environment variables are expanded |:set_env|.
3932	See |option-backslash| about including spaces and backslashes.
3933	This option cannot be set from a |modeline| or in the |sandbox|, for
3934	security reasons.
3935
3936						*'makeprg'* *'mp'*
3937'makeprg' 'mp'		string	(default "make", VMS: "MMS")
3938			global or local to buffer |global-local|
3939			{not in Vi}
3940	Program to use for the ":make" command.  See |:make_makeprg|.  This
3941	option may contain '%' and '#' characters, which are expanded like
3942	when used in a command-line.  Environment variables are expanded
3943	|:set_env|.  See |option-backslash| about including spaces and
3944	backslashes.  Note that a '|' must be escaped twice: once for ":set"
3945	and once for the interpretation of a command.  When you use a filter
3946	called "myfilter" do it like this: >
3947	    :set makeprg=gmake\ \\\|\ myfilter
3948<	The placeholder "$*" can be given (even multiple times) to specify
3949	where the arguments will be included, for example: >
3950	    :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
3951<	This option cannot be set from a |modeline| or in the |sandbox|, for
3952	security reasons.
3953
3954						*'matchpairs'* *'mps'*
3955'matchpairs' 'mps'	string	(default "(:),{:},[:]")
3956			local to buffer
3957			{not in Vi}
3958	Characters that form pairs.  The |%| command jumps from one to the
3959	other.  Currently only single character pairs are allowed, and they
3960	must be different.  The characters must be separated by a colon.  The
3961	pairs must be separated by a comma.  Example for including '<' and '>'
3962	(HTML): >
3963		:set mps+=<:>
3964
3965<	A more exotic example, to jump between the '=' and ';' in an
3966	assignment, useful for languages like C and Java: >
3967		:au FileType c,cpp,java set mps+==:;
3968
3969<	For a more advanced way of using "%", see the matchit.vim plugin in
3970	the $VIMRUNTIME/macros directory. |add-local-help|
3971
3972						*'matchtime'* *'mat'*
3973'matchtime' 'mat'	number	(default 5)
3974			global
3975			{not in Vi}{in Nvi}
3976	Tenths of a second to show the matching paren, when 'showmatch' is
3977	set.  Note that this is not in milliseconds, like other options that
3978	set a time.  This is to be compatible with Nvi.
3979
3980						*'maxfuncdepth'* *'mfd'*
3981'maxfuncdepth' 'mfd'	number	(default 100)
3982			global
3983			{not in Vi}
3984	Maximum depth of function calls for user functions.  This normally
3985	catches endless recursion.  When using a recursive function with
3986	more depth, set 'maxfuncdepth' to a bigger number.  But this will use
3987	more memory, there is the danger of failing when memory is exhausted.
3988	See also |:function|.
3989
3990						*'maxmapdepth'* *'mmd'* *E223*
3991'maxmapdepth' 'mmd'	number	(default 1000)
3992			global
3993			{not in Vi}
3994	Maximum number of times a mapping is done without resulting in a
3995	character to be used.  This normally catches endless mappings, like
3996	":map x y" with ":map y x".  It still does not catch ":map g wg",
3997	because the 'w' is used before the next mapping is done.  See also
3998	|key-mapping|.
3999
4000						*'maxmem'* *'mm'*
4001'maxmem' 'mm'		number	(default between 256 to 5120 (system
4002				 dependent) or half the amount of memory
4003				 available)
4004			global
4005			{not in Vi}
4006	Maximum amount of memory (in Kbyte) to use for one buffer.  When this
4007	limit is reached allocating extra memory for a buffer will cause
4008	other memory to be freed.  Maximum value 2000000.  Use this to work
4009	without a limit.  Also see 'maxmemtot'.
4010
4011						*'maxmemtot'* *'mmt'*
4012'maxmemtot' 'mmt'	number	(default between 2048 and 10240 (system
4013				 dependent) or half the amount of memory
4014				 available)
4015			global
4016			{not in Vi}
4017	Maximum amount of memory (in Kbyte) to use for all buffers together.
4018	Maximum value 2000000.  Use this to work without a limit.  Also see
4019	'maxmem'.
4020
4021						*'menuitems'* *'mis'*
4022'menuitems' 'mis'	number	(default 25)
4023			global
4024			{not in Vi}
4025			{not available when compiled without the |+menu|
4026			feature}
4027	Maximum number of items to use in a menu.  Used for menus that are
4028	generated from a list of items, e.g., the Buffers menu.  Changing this
4029	option has no direct effect, the menu must be refreshed first.
4030
4031				   *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4032'modeline' 'ml'		boolean	(Vim default: on, Vi default: off)
4033			local to buffer
4034						*'modelines'* *'mls'*
4035'modelines' 'mls'	number	(default 5)
4036			global
4037			{not in Vi}
4038	If 'modeline' is on 'modelines' gives the number of lines that is
4039	checked for set commands.  If 'modeline' is off or 'modelines' is zero
4040	no lines are checked.  See |modeline|.
4041	NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4042	set and to the Vim default value when 'compatible' is reset.
4043
4044				*'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4045'modifiable' 'ma'	boolean	(default on)
4046			local to buffer
4047			{not in Vi}		*E21*
4048	When off the buffer contents cannot be changed.  The 'fileformat' and
4049	'fileencoding' options also can't be changed.
4050	Can be reset with the |-M| command line argument.
4051
4052				*'modified'* *'mod'* *'nomodified'* *'nomod'*
4053'modified' 'mod'	boolean	(default off)
4054			local to buffer
4055			{not in Vi}
4056	When on, the buffer is considered to be modified.  This option is set
4057	when:
4058	1. A change was made to the text since it was last written.  Using the
4059	   |undo| command to go back to the original text will reset the
4060	   option.  But undoing changes that were made before writing the
4061	   buffer will set the option again, since the text is different from
4062	   when it was written.
4063	2. 'fileformat' or 'fileencoding' is different from its original
4064	   value.  The original value is set when the buffer is read or
4065	   written.  A ":set nomodified" command also resets the original
4066	   values to the current values and the 'modified' option will be
4067	   reset.
4068	When 'buftype' is "nowrite" or "nofile" this option may be set, but
4069	will be ignored.
4070
4071						*'more'* *'nomore'*
4072'more'			boolean	(Vim default: on, Vi default: off)
4073			global
4074			{not in Vi}
4075	When on, listings pause when the whole screen is filled.  You will get
4076	the |more-prompt|.  When this option is off there are no pauses, the
4077	listing continues until finished.
4078	NOTE: This option is set to the Vi default value when 'compatible' is
4079	set and to the Vim default value when 'compatible' is reset.
4080
4081						*'mouse'* *E538*
4082'mouse'			string	(default "", "a" for GUI, MS-DOS and Win32)
4083			global
4084			{not in Vi}
4085	Enable the use of the mouse.  Only works for certain terminals
4086	(xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4087	with gpm).  For using the mouse in the GUI, see |gui-mouse|.
4088	The mouse can be enabled for different modes:
4089		n	Normal mode
4090		v	Visual mode
4091		i	Insert mode
4092		c	Command-line mode
4093		h	all previous modes when editing a help file
4094		a	all previous modes
4095		r	for |hit-enter| and |more-prompt| prompt
4096		A	auto-select in Visual mode
4097	Normally you would enable the mouse in all four modes with: >
4098		:set mouse=a
4099<	When the mouse is not enabled, the GUI will still use the mouse for
4100	modeless selection.  This doesn't move the text cursor.
4101
4102	See |mouse-using|.  Also see |'clipboard'|.
4103
4104	Note: When enabling the mouse in a terminal, copy/paste will use the
4105	"* register if there is access to an X-server.  The xterm handling of
4106	the mouse buttons can still be used by keeping the shift key pressed.
4107	Also see the 'clipboard' option.
4108
4109			*'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4110'mousefocus' 'mousef'	boolean	(default off)
4111			global
4112			{not in Vi}
4113			{only works in the GUI}
4114	The window that the mouse pointer is on is automatically activated.
4115	When changing the window layout or window focus in another way, the
4116	mouse pointer is moved to the window with keyboard focus.  Off is the
4117	default because it makes using the pull down menus a little goofy, as
4118	a pointer transit may activate a window unintentionally.
4119
4120			*'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4121'mousehide' 'mh'	boolean	(default on)
4122			global
4123			{not in Vi}
4124			{only works in the GUI}
4125	When on, the mouse pointer is hidden when characters are typed.
4126	The mouse pointer is restored when the mouse is moved.
4127
4128						*'mousemodel'* *'mousem'*
4129'mousemodel' 'mousem'	string	(default "extend", "popup" for MS-DOS and Win32)
4130			global
4131			{not in Vi}
4132	Sets the model to use for the mouse.  The name mostly specifies what
4133	the right mouse button is used for:
4134	   extend	Right mouse button extends a selection.  This works
4135			like in an xterm.
4136	   popup	Right mouse button pops up a menu.  The shifted left
4137			mouse button extends a selection.  This works like
4138			with Microsoft Windows
4139	   popup_setpos Like "popup", but the cursor will be moved to the
4140			position where the mouse was clicked, and thus the
4141			selected operation will act upon the clicked object.
4142			If clicking inside a selection, that selection will
4143			be acted upon, ie. no cursor move.  This implies of
4144			course, that right clicking outside a selection will
4145			end Visual mode.
4146	Overview of what button does what for each model:
4147	mouse		    extend		popup(_setpos) ~
4148	left click	    place cursor	place cursor
4149	left drag	    start selection	start selection
4150	shift-left	    search word		extend selection
4151	right click	    extend selection	popup menu (place cursor)
4152	right drag	    extend selection	-
4153	middle click	    paste		paste
4154
4155	In the "popup" model the right mouse button produces a pop-up menu.
4156	You need to define this first, see |popup-menu|.
4157
4158	Note that you can further refine the meaning of buttons with mappings.
4159	See |gui-mouse-mapping|.  But mappings are NOT used for modeless
4160	selection (because that's handled in the GUI code directly).
4161
4162	The 'mousemodel' option is set by the |:behave| command.
4163
4164					*'mouseshape'* *'mouses'* *E547*
4165'mouseshape' 'mouses'	string	(default "i:beam,r:beam,s:updown,sd:cross,
4166					m:no,ml:up-arrow,v:rightup-arrow"
4167			global
4168			{not in Vi}
4169			{only available when compiled with the |+mouseshape|
4170			feature}
4171	This option tells Vim what the mouse pointer should look like in
4172	different modes.  The option is a comma separated list of parts, much
4173	like used for 'guicursor'.  Each part consist of a mode/location-list
4174	and an argument-list:
4175		mode-list:shape,mode-list:shape,..
4176	The mode-list is a dash separated list of these modes/locations:
4177			In a normal window: ~
4178		n	Normal mode
4179		v	Visual mode
4180		ve	Visual mode with 'selection' "exclusive" (same as 'v',
4181			if not specified)
4182		o	Operator-pending mode
4183		i	Insert mode
4184		r	Replace mode
4185
4186			Others: ~
4187		c	appending to the command-line
4188		ci	inserting in the command-line
4189		cr	replacing in the command-line
4190		m	at the 'Hit ENTER' or 'More' prompts
4191		ml	idem, but cursor in the last line
4192		e	any mode, pointer below last window
4193		s	any mode, pointer on a status line
4194		sd	any mode, while dragging a status line
4195		vs	any mode, pointer on a vertical separator line
4196		vd	any mode, while dragging a vertical separator line
4197		a	everywhere
4198
4199	The shape is one of the following:
4200	avail	name		looks like ~
4201	w x	arrow		Normal mouse pointer
4202	w x	blank		no pointer at all (use with care!)
4203	w x	beam		I-beam
4204	w x	updown		up-down sizing arrows
4205	w x	leftright	left-right sizing arrows
4206	w x	busy		The system's usual busy pointer
4207	w x	no		The system's usual 'no input' pointer
4208	  x	udsizing	indicates up-down resizing
4209	  x	lrsizing	indicates left-right resizing
4210	  x	crosshair	like a big thin +
4211	  x	hand1		black hand
4212	  x	hand2		white hand
4213	  x	pencil		what you write with
4214	  x	question	big ?
4215	  x	rightup-arrow	arrow pointing right-up
4216	w x	up-arrow	arrow pointing up
4217	  x	<number>	any X11 pointer number (see X11/cursorfont.h)
4218
4219	The "avail" column contains a 'w' if the shape is available for Win32,
4220	x for X11.
4221	Any modes not specified or shapes not available use the normal mouse
4222	pointer.
4223
4224	Example: >
4225		:set mouseshape=s:udsizing,m:no
4226<	will make the mouse turn to a sizing arrow over the status lines and
4227	indicate no input when the hit-enter prompt is displayed (since
4228	clicking the mouse has no effect in this state.)
4229
4230						*'mousetime'* *'mouset'*
4231'mousetime' 'mouset'	number	(default 500)
4232			global
4233			{not in Vi}
4234	Only for GUI, MS-DOS, Win32 and Unix with xterm.  Defines the maximum
4235	time in msec between two mouse clicks for the second click to be
4236	recognized as a multi click.
4237
4238							*'nrformats'* *'nf'*
4239'nrformats' 'nf'	string	(default "octal,hex")
4240			local to buffer
4241			{not in Vi}
4242	This defines what bases Vim will consider for numbers when using the
4243	CTRL-A and CTRL-X commands for adding to and subtracting from a number
4244	respectively; see |CTRL-A| for more info on these commands.
4245	alpha	if included, single alphabetical characters will be
4246		incremented or decremented.  This is useful for a list with a
4247		letter index a), b), etc.
4248	octal	if included, numbers that start with a zero will be considered
4249		to be octal.  Example: Using CTRL-A on "007" results in "010".
4250	hex	if included, numbers starting with "0x" or "0X" will be
4251		considered to be hexadecimal.  Example: Using CTRL-X on
4252		"0x100" results in "0x0ff".
4253	Numbers which simply begin with a digit in the range 1-9 are always
4254	considered decimal.  This also happens for numbers that are not
4255	recognized as octal or hex.
4256
4257				*'number'* *'nu'* *'nonumber'* *'nonu'*
4258'number' 'nu'		boolean	(default off)
4259			local to window
4260	Print the line number in front of each line.  When the 'n' option is
4261	excluded from 'cpoptions' a wrapped line will not use the column of
4262	line numbers (this is the default when 'compatible' isn't set).
4263	When a long, wrapped line doesn't start with the first character, '-'
4264	characters are put before the number.
4265	See |hl-LineNr| for the highlighting used for the number.
4266
4267					*'osfiletype'* *'oft'* *E366*
4268'osfiletype' 'oft'	string (RISC-OS default: "Text",
4269				others default: "")
4270			local to buffer
4271			{not in Vi}
4272			{only available when compiled with the |+osfiletype|
4273			feature}
4274	Some operating systems store extra information about files besides
4275	name, datestamp and permissions.  This option contains the extra
4276	information, the nature of which will vary between systems.
4277	The value of this option is usually set when the file is loaded, and
4278	use to set the file type when file is written.
4279	It can affect the pattern matching of the automatic commands.
4280	|autocmd-osfiletypes|
4281
4282						*'paragraphs'* *'para'*
4283'paragraphs' 'para'	string	(default "IPLPPPQPP LIpplpipbp")
4284			global
4285	Specifies the nroff macros that separate paragraphs.  These are pairs
4286	of two letters (see |object-motions|).
4287
4288						*'paste'* *'nopaste'*
4289'paste'			boolean	(default off)
4290			global
4291			{not in Vi}
4292	Put Vim in Paste mode.  This is useful if you want to cut or copy
4293	some text from one window and paste it in Vim.  This will avoid
4294	unexpected effects.
4295	Setting this option is useful when using Vim in a terminal, where Vim
4296	cannot distinguish between typed text and pasted text.  In the GUI, Vim
4297	knows about pasting and will mostly do the right thing without 'paste'
4298	being set.  The same is true for a terminal where Vim handles the
4299	mouse clicks itself.
4300	When the 'paste' option is switched on (also when it was already on):
4301		- mapping in Insert mode and Command-line mode is disabled
4302		- abbreviations are disabled
4303		- 'textwidth' is set to 0
4304		- 'wrapmargin' is set to 0
4305		- 'autoindent' is reset
4306		- 'smartindent' is reset
4307		- 'softtabstop' is set to 0
4308		- 'revins' is reset
4309		- 'ruler' is reset
4310		- 'showmatch' is reset
4311		- 'formatoptions' is used like it is empty
4312	These options keep their value, but their effect is disabled:
4313		- 'lisp'
4314		- 'indentexpr'
4315		- 'cindent'
4316	NOTE: When you start editing another file while the 'paste' option is
4317	on, settings from the modelines or autocommands may change the
4318	settings again, causing trouble when pasting text.  You might want to
4319	set the 'paste' option again.
4320	When the 'paste' option is reset the mentioned options are restored to
4321	the value before the moment 'paste' was switched from off to on.
4322	Resetting 'paste' before ever setting it does not have any effect.
4323	Since mapping doesn't work while 'paste' is active, you need to use
4324	the 'pastetoggle' option to toggle the 'paste' option with some key.
4325
4326						*'pastetoggle'* *'pt'*
4327'pastetoggle' 'pt'	string	(default "")
4328			global
4329			{not in Vi}
4330	When non-empty, specifies the key sequence that toggles the 'paste'
4331	option.  This is like specifying a mapping: >
4332	    :map {keys} :set invpaste<CR>
4333<	Where {keys} is the value of 'pastetoggle'.
4334	The difference is that it will work even when 'paste' is set.
4335	'pastetoggle' works in Insert mode and Normal mode, but not in
4336	Command-line mode.
4337	Mappings are checked first, thus overrule 'pastetoggle'.  However,
4338	when 'paste' is on mappings are ignored in Insert mode, thus you can do
4339	this: >
4340	    :map <F10> :set paste<CR>
4341	    :map <F11> :set nopaste<CR>
4342	    :imap <F10> <C-O>:set paste<CR>
4343	    :imap <F11> <nop>
4344	    :set pastetoggle=<F11>
4345<	This will make <F10> start paste mode and <F11> stop paste mode.
4346	Note that typing <F10> in paste mode inserts "<F10>", since in paste
4347	mode everything is inserted literally, except the 'pastetoggle' key
4348	sequence.
4349
4350						*'pex'* *'patchexpr'*
4351'patchexpr' 'pex'	string	(default "")
4352			global
4353			{not in Vi}
4354			{not available when compiled without the |+diff|
4355			feature}
4356	Expression which is evaluated to apply a patch to a file and generate
4357	the resulting new version of the file.  See |diff-patchexpr|.
4358
4359						*'patchmode'* *'pm'* *E206*
4360'patchmode' 'pm'	string	(default "")
4361			global
4362			{not in Vi}
4363	When non-empty the oldest version of a file is kept.  This can be used
4364	to keep the original version of a file if you are changing files in a
4365	source distribution.  Only the first time that a file is written a
4366	copy of the original file will be kept.  The name of the copy is the
4367	name of the original file with the string in the 'patchmode' option
4368	appended.  This option should start with a dot.  Use a string like
4369	".org".  'backupdir' must not be empty for this to work (Detail: The
4370	backup file is renamed to the patchmode file after the new file has
4371	been successfully written, that's why it must be possible to write a
4372	backup file).  If there was no file to be backed up, an empty file is
4373	created.
4374	When the 'backupskip' pattern matches, a patchmode file is not made.
4375	Using 'patchmode' for compressed files appends the extension at the
4376	end (e.g., "file.gz.orig"), thus the resulting name isn't always
4377	recognized as a compressed file.
4378
4379					*'path'* *'pa'* *E343* *E345* *E347*
4380'path' 'pa'		string	(default on Unix: ".,/usr/include,,"
4381				   on OS/2:	  ".,/emx/include,,"
4382				   other systems: ".,,")
4383			global or local to buffer |global-local|
4384			{not in Vi}
4385	This is a list of directories which will be searched when using the
4386	|gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4387	being searched for has a relative path (not starting with '/').  The
4388	directories in the 'path' option may be relative or absolute.
4389	- Use commas to separate directory names: >
4390		:set path=.,/usr/local/include,/usr/include
4391<	- Spaces can also be used to separate directory names (for backwards
4392	  compatibility with version 3.0).  To have a space in a directory
4393	  name, precede it with an extra backslash, and escape the space: >
4394		:set path=.,/dir/with\\\ space
4395<	- To include a comma in a directory name precede it with an extra
4396	  backslash: >
4397		:set path=.,/dir/with\\,comma
4398<	- To search relative to the directory of the current file, use: >
4399		:set path=.
4400<	- To search in the current directory use an empty string between two
4401	  commas: >
4402		:set path=,,
4403<	- A directory name may end in a ':' or '/'.
4404	- Environment variables are expanded |:set_env|.
4405	- When using |netrw.vim| URLs can be used.  For example, adding
4406	  "http://www.vim.org" will make ":find index.html" work.
4407	- Search upwards and downwards in a directory tree:
4408	  1) "*" matches a sequence of characters, e.g.: >
4409		:set path=/usr/include/*
4410<	     means all subdirectories in /usr/include (but not /usr/include
4411	     itself). >
4412		:set path=/usr/*c
4413<	     matches /usr/doc and /usr/src.
4414	  2) "**" matches a subtree, up to 100 directories deep.  Example: >
4415		:set path=/home/user_x/src/**
4416<	     means search in the whole subtree under "/home/usr_x/src".
4417	  3) If the path ends with a ';', this path is the startpoint
4418	     for upward search.
4419	  See |file-searching| for more info and exact syntax.
4420	  {not available when compiled without the |+path_extra| feature}
4421	- Careful with '\' characters, type two to get one in the option: >
4422		:set path=.,c:\\include
4423<	  Or just use '/' instead: >
4424		:set path=.,c:/include
4425<	Don't forget "." or files won't even be found in the same directory as
4426	the file!
4427	The maximum length is limited.  How much depends on the system, mostly
4428	it is something like 256 or 1024 characters.
4429	You can check if all the include files are found, using the value of
4430	'path', see |:checkpath|.
4431	The use of |:set+=| and |:set-=| is preferred when adding or removing
4432	directories from the list.  This avoids problems when a future version
4433	uses another default.  To remove the current directory use: >
4434		:set path-=
4435<	To add the current directory use: >
4436		:set path+=
4437<	To use an environment variable, you probably need to replace the
4438	separator.  Here is an example to append $INCL, in which directory
4439	names are separated with a semi-colon: >
4440		:let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4441<	Replace the ';' with a ':' or whatever separator is used.  Note that
4442	this doesn't work when $INCL contains a comma or white space.
4443
4444			*'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4445'preserveindent' 'pi'	boolean	(default off)
4446			local to buffer
4447			{not in Vi}
4448	When changing the indent of the current line, preserve as much of the
4449	indent structure as possible.  Normally the indent is replaced by a
4450	series of tabs followed by spaces as required (unless |'expandtab'| is
4451	enabled, in which case only spaces are used).  Enabling this option
4452	means the indent will preserve as many existing characters as possible
4453	for indenting, and only add additional tabs or spaces as required.
4454	NOTE: When using ">>" multiple times the resulting indent is a mix of
4455	tabs and spaces.  You might not like this.
4456	NOTE: 'preserveindent' is reset when 'compatible' is set.
4457	Also see 'copyindent'.
4458	Use |:retab| to clean up white space.
4459
4460					*'previewheight'* *'pvh'*
4461'previewheight' 'pvh'	number (default 12)
4462			global
4463			{not in Vi}
4464			{not available when compiled without the |+windows| or
4465			|+quickfix| feature}
4466	Default height for a preview window.  Used for |:ptag| and associated
4467	commands.  Used for |CTRL-W_}| when no count is given.
4468
4469					*'previewwindow'* *'nopreviewwindow'*
4470					*'pvw'* *'nopvw'* *E590*
4471'previewwindow' 'pvw'	boolean (default off)
4472			local to window
4473			{not in Vi}
4474			{not available when compiled without the |+windows| or
4475			|+quickfix| feature}
4476	Identifies the preview window.  Only one window can have this option
4477	set.  It's normally not set directly, but by using one of the commands
4478	|:ptag|, |:pedit|, etc.
4479
4480						*'printdevice'* *'pdev'*
4481'printdevice' 'pdev'	string	(default empty)
4482			global
4483			{not in Vi}
4484			{only available when compiled with the |+printer|
4485			feature}
4486	This defines the name of the printer to be used when the |:hardcopy|
4487	command is issued with a bang (!) to skip the printer selection
4488	dialog.  On Win32, it should be the printer name exactly as it appears
4489	in the standard printer dialog.
4490	If the option is empty, then vim will use the system default printer
4491	for ":hardcopy!"
4492
4493					*'printencoding'* *'penc'* *E620*
4494'printencoding' 'penc'	String	(default empty, except for:
4495					Windows, OS/2: cp1252,
4496					Macintosh: mac-roman,
4497					VMS: dec-mcs,
4498					HPUX: hp-roman8,
4499					EBCDIC: ebcdic-uk)
4500			global
4501			{not in Vi}
4502			{only available when compiled with the |+printer|
4503			and |+postscript| features}
4504	Sets the character encoding used when printing.  This option tells VIM
4505	which print character encoding file from the "print" directory in
4506	'runtimepath' to use.
4507
4508	This option will accept any value from |encoding-names|.  Any
4509	recognized names are converted to VIM standard names - see 'encoding'
4510	for more details.  Names not recognized by VIM will just be converted
4511	to lower case and underscores replaced with '-' signs.
4512
4513	If 'printencoding' is empty or VIM cannot find the file then it will
4514	use 'encoding' (if VIM is compiled with |+multi_byte| and it is set an
4515	8-bit encoding) to find the print character encoding file.  If VIM is
4516	unable to find a character encoding file then it will use the "latin1"
4517	print character encoding file.
4518
4519	When 'encoding' is set to a multi-byte encoding, VIM will try to
4520	convert characters to the printing encoding for printing (if
4521	'printencoding' is empty then the conversion will be to latin1).
4522	Conversion to a printing encoding other than latin1 will require VIM
4523	to be compiled with the |+iconv| feature.  If no conversion is
4524	possible then printing will fail.  Any characters that cannot be
4525	converted will be replaced with upside down question marks.
4526
4527	Four print character encoding files are provided to support default
4528	Mac, VMS, HPUX, and EBCDIC character encodings and are used by default
4529	on these platforms.  Code page 1252 print character encoding is used
4530	by default on Windows and OS/2 platforms.
4531
4532
4533						*'printexpr'* *'pexpr'*
4534'printexpr' 'pexpr'	String	(default: see below)
4535			global
4536			{not in Vi}
4537			{only available when compiled with the |+printer|
4538			and |+postscript| features}
4539	Expression that is evaluated to print the PostScript produced with
4540	":hardcopy".
4541	The file name to be printed is in |v:fname_in|.
4542	The arguments to the ":hardcopy" command are in |v:cmdarg|.
4543	The expression must take care of deleting the file after printing it.
4544	When there is an error, the expression must return a non-zero number.
4545	If there is no error, return zero or an empty string.
4546	The default for non MS-Windows or VMS systems is to simply use "lpr"
4547	to print the file: >
4548
4549	    system('lpr' . (&printdevice == '' ? '' : ' -P' . &printdevice)
4550		. ' ' . v:fname_in) . delete(v:fname_in) + v:shell_error
4551<
4552	On MS-Dos, MS-Windows and OS/2 machines the default is to copy the
4553	file to the currently specified printdevice: >
4554
4555	    system('copy' . ' ' . v:fname_in . (&printdevice == ''
4556			? ' LPT1:' : (' \"' . &printdevice . '\"')))
4557			. delete(v:fname_in)
4558<
4559	On VMS machines the default is to send the file to either the default
4560	or currently specified printdevice: >
4561
4562	    system('print' . (&printdevice == '' ? '' : ' /queue=' .
4563			&printdevice) . ' ' . v:fname_in) . delete(v:fname_in)
4564<
4565	If you change this option, using a function is an easy way to avoid
4566	having to escape all the spaces.  Example: >
4567
4568		:set printexpr=PrintFile(v:fname_in)
4569		:function PrintFile(fname)
4570		:  call system("ghostview " . a:fname)
4571		:  call delete(a:fname)
4572		:  return v:shell_error
4573		:endfunc
4574
4575<	Be aware that some print programs return control before they have read
4576	the file.  If you delete the file too soon it will not be printed.
4577	These programs usually offer an option to have them remove the file
4578	when printing is done.
4579								*E365*
4580	If evaluating the expression fails or it results in a non-zero number,
4581	you get an error message.  In that case Vim will delete the
4582	file.  In the default value for non-MS-Windows a trick is used: Adding
4583	"v:shell_error" will result in a non-zero number when the system()
4584	call fails.
4585	This option cannot be set from a |modeline| or in the |sandbox|, for
4586	security reasons.
4587
4588						*'printfont'* *'pfn'* *E613*
4589'printfont' 'pfn'	string	(default "courier")
4590			global
4591			{not in Vi}
4592			{only available when compiled with the |+printer|
4593			feature}
4594	This is the name of the font that will be used for the |:hardcopy|
4595	command's output.  It has the same format as the 'guifont' option,
4596	except that only one font may be named, and the special "guifont=*"
4597	syntax is not available.
4598	In the Win32 GUI version this specifies a font name with its extra
4599	attributes, as with the 'guifont' option.
4600	For other systems, only ":h11" is recognized, where "11" is the point
4601	size of the font.  When omitted, the point size is 10.
4602
4603						*'printheader'* *'pheader'*
4604'printheader' 'pheader'  string  (default "%<%f%h%m%=Page %N")
4605			global
4606			{not in Vi}
4607			{only available when compiled with the |+printer|
4608			feature}
4609	This defines the format of the header produced in |:hardcopy| output.
4610	The option is defined in the same way as the 'statusline' option.
4611	If Vim has not been compiled with the |+statusline| feature, this
4612	option has no effect and a simple default header is used, which shows
4613	the page number.
4614
4615						*'printoptions'* *'popt'*
4616'printoptions' 'popt' string (default "")
4617			global
4618			{not in Vi}
4619			{only available when compiled with |+printer| feature}
4620	This is a comma-separated list of items that control the format of
4621	the output of |:hardcopy|:
4622
4623	  left:{spec}		left margin (default: 10pc)
4624	  right:{spec}		right margin (default: 5pc)
4625	  top:{spec}		top margin (default: 5pc)
4626	  bottom:{spec}		bottom margin (default: 5pc)
4627				{spec} is a number followed by "in" for
4628				inches, "pt" for points (1 point is 1/72 of an
4629				inch), "mm" for millimeters or "pc" for a
4630				percentage of the media size.
4631				Weird example:
4632				    left:2in,top:30pt,right:16mm,bottom:3pc
4633				If the unit is not recognized there is no
4634				error and the default value is used.
4635
4636	  header:{nr}		Number of lines to reserve for the header.
4637				Only the first line is actually filled, thus
4638				when {nr} is 2 there is one empty line.  The
4639				header is formatted according to
4640				'printheader'.
4641	  header:0		Do not print a header.
4642	  header:2  (default)	Use two lines for the header
4643
4644	  syntax:n		Do not use syntax highlighting.  This is
4645				faster and thus useful when printing large
4646				files.
4647	  syntax:y		Do syntax highlighting.
4648	  syntax:a  (default)	Use syntax highlighting if the printer appears
4649				to be able to print color or grey.
4650
4651	  number:y		Include line numbers in the printed output.
4652	  number:n  (default)	No line numbers.
4653
4654	  wrap:y    (default)	Wrap long lines.
4655	  wrap:n		Truncate long lines.
4656
4657	  duplex:off		Print on one side.
4658	  duplex:long (default)	Print on both sides (when possible), bind on
4659				long side.
4660	  duplex:short		Print on both sides (when possible), bind on
4661				short side.
4662
4663	  collate:y  (default)	Collating: 1 2 3, 1 2 3, 1 2 3
4664	  collate:n		No collating: 1 1 1, 2 2 2, 3 3 3
4665
4666	  jobsplit:n (default)	Do all copies in one print job
4667	  jobsplit:y		Do each copy as a separate print job.  Useful
4668				when doing N-up postprocessing.
4669
4670	  portrait:y (default)	Orientation is portrait.
4671	  portrait:n		Orientation is landscape.
4672							*a4* *letter*
4673	  paper:A4   (default)	Paper size: A4
4674	  paper:{name}		Paper size from this table:
4675				{name}	    size in cm	     size in inch ~
4676				10x14	    25.4  x 35.57    10    x 14
4677				A3	    29.7  x 42	     11.69 x 16.54
4678				A4	    21	  x 29.7      8.27 x 11.69
4679				A5	    14.8  x 21	      5.83 x  8.27
4680				B4	    25	  x 35.3     10.12 x 14.33
4681				B5	    17.6  x 25	      7.17 x 10.12
4682				executive   18.42 x 26.67     7.25 x 10.5
4683				folio	    21	  x 33	      8.27 x 13
4684				ledger	    43.13 x 27.96    17    x 11
4685				legal	    21.59 x 35.57     8.5  x 14
4686				letter	    21.59 x 27.96     8.5  x 11
4687				quarto	    21.59 x 27.5      8.5  x 10.83
4688				statement   13.97 x 21.59     5.5  x  8.5
4689				tabloid     27.96 x 43.13    11    x 17
4690
4691	  formfeed:n (default)	Treat form feed characters (0x0c) as a normal
4692				print character.
4693	  formfeed:y		When a form feed character is encountered,
4694				continue printing of the current line at the
4695				beginning of the first line on a new page.
4696
4697	The item indicated with (default) is used when the item is not
4698	present.  The values are not always used, especially when using a
4699	dialog to select the printer and options.
4700	Example: >
4701		:set printoptions=paper:letter,duplex:off
4702<
4703						*'quoteescape''* *'qe'*
4704'quoteescape' 'qe'	string	(default "\")
4705			local to buffer
4706			{not in Vi}
4707	The characters that are used to escape quotes in a string.  Used for
4708	objects like a', a" and a` |a'|.
4709	When one of the characters in this option is found inside a string,
4710	the following character will be skipped.  The default value makes the
4711	text "foo\"bar\\" considered to be one string.
4712
4713				   *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4714'readonly' 'ro'		boolean	(default off)
4715			local to buffer
4716	If on, writes fail unless you use a '!'.  Protects you from
4717	accidentally overwriting a file.  Default on when Vim is started
4718	in read-only mode ("vim -R") or when the executable is called "view".
4719	{not in Vi:}  When using the ":view" command the 'readonly' option is
4720	set for the newly edited buffer.  When using ":w!" the 'readonly'
4721	option is reset for the current buffer.
4722
4723						*'remap'* *'noremap'*
4724'remap'			boolean	(default on)
4725			global
4726	Allows for mappings to work recursively.  If you do not want this for
4727	a single entry, use the :noremap[!] command.
4728
4729						*'report'*
4730'report'		number	(default 2)
4731			global
4732	Threshold for reporting number of lines changed.  When the number of
4733	changed lines is more than 'report' a message will be given for most
4734	":" commands.  If you want it always, set 'report' to 0.
4735	For the ":substitute" command the number of substitutions is used
4736	instead of the number of lines.
4737
4738			 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4739'restorescreen' 'rs'	boolean	(default on)
4740			global
4741			{not in Vi}  {only in Windows 95/NT console version}
4742	When set, the screen contents is restored when exiting Vim.  This also
4743	happens when executing external commands.
4744
4745	For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4746	options in your .vimrc.  To disable restoring:
4747		set t_ti= t_te=
4748	To enable restoring (for an xterm):
4749		set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4750	(Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4751
4752				*'revins'* *'ri'* *'norevins'* *'nori'*
4753'revins' 'ri'		boolean	(default off)
4754			global
4755			{not in Vi}
4756			{only available when compiled with the |+rightleft|
4757			feature}
4758	Inserting characters in Insert mode will work backwards.  See "typing
4759	backwards" |ins-reverse|.  This option can be toggled with the CTRL-_
4760	command in Insert mode, when 'allowrevins' is set.
4761	NOTE: This option is reset when 'compatible' or 'paste' is set.
4762
4763				 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4764'rightleft' 'rl'	boolean	(default off)
4765			local to window
4766			{not in Vi}
4767			{only available when compiled with the |+rightleft|
4768			feature}
4769	When on, display orientation becomes right-to-left, i.e., characters
4770	that are stored in the file appear from the right to the left.
4771	Using this option, it is possible to edit files for languages that
4772	are written from the right to the left such as Hebrew and Arabic.
4773	This option is per window, so it is possible to edit mixed files
4774	simultaneously, or to view the same file in both ways (this is
4775	useful whenever you have a mixed text file with both right-to-left
4776	and left-to-right strings so that both sets are displayed properly
4777	in different windows).  Also see |rileft.txt|.
4778
4779			*'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4780'rightleftcmd' 'rlc'	string	(default "search")
4781			local to window
4782			{not in Vi}
4783			{only available when compiled with the |+rightleft|
4784			feature}
4785	Each word in this option enables the command line editing to work in
4786	right-to-left mode for a group of commands:
4787
4788		search		"/" and "?" commands
4789
4790	This is useful for languages such as Hebrew, Arabic and Farsi.
4791	The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4792
4793					 *'ruler'* *'ru'* *'noruler'* *'noru'*
4794'ruler' 'ru'		boolean	(default off)
4795			global
4796			{not in Vi}
4797			{not available when compiled without the
4798			|+cmdline_info| feature}
4799	Show the line and column number of the cursor position, separated by a
4800	comma.  When there is room, the relative position of the displayed
4801	text in the file is shown on the far right:
4802		Top	first line is visible
4803		Bot	last line is visible
4804		All	first and last line are visible
4805		45%	relative position in the file
4806	If 'rulerformat' is set, it will determine the contents of the ruler.
4807	Each window has its own ruler.  If a window has a status line, the
4808	ruler is shown there.  Otherwise it is shown in the last line of the
4809	screen.  If the statusline is given by 'statusline' (ie. not empty),
4810	this option takes precedence over 'ruler' and 'rulerformat'
4811	If the number of characters displayed is different from the number of
4812	bytes in the text (e.g., for a TAB or a multi-byte character), both
4813	the text column (byte number) and the screen column are shown,
4814	separated with a dash.
4815	For an empty line "0-1" is shown.
4816	For an empty buffer the line number will also be zero: "0,0-1".
4817	This option is reset when the 'paste' option is set.
4818	If you don't want to see the ruler all the time but want to know where
4819	you are, use "g CTRL-G" |g_CTRL-G|.
4820	NOTE: This option is reset when 'compatible' is set.
4821
4822						*'rulerformat'* *'ruf'*
4823'rulerformat' 'ruf'	string	(default empty)
4824			global
4825			{not in Vi}
4826			{not available when compiled without the |+statusline|
4827			feature}
4828	When this option is not empty, it determines the content of the ruler
4829	string, as displayed for the 'ruler' option.
4830	The format of this option, is like that of 'statusline'.
4831	The default ruler width is 17 characters.  To make the ruler 15
4832	characters wide, put "%15(" at the start and "%)" at the end.
4833	Example: >
4834		:set rulerformat=%15(%c%V\ %p%%%)
4835<
4836				*'runtimepath'* *'rtp'* *vimfiles*
4837'runtimepath' 'rtp'	string	(default:
4838					Unix: "$HOME/.vim,
4839						$VIM/vimfiles,
4840						$VIMRUNTIME,
4841						$VIM/vimfiles/after,
4842						$HOME/.vim/after"
4843					Amiga: "home:vimfiles,
4844						$VIM/vimfiles,
4845						$VIMRUNTIME,
4846						$VIM/vimfiles/after,
4847						home:vimfiles/after"
4848					PC, OS/2: "$HOME/vimfiles,
4849						$VIM/vimfiles,
4850						$VIMRUNTIME,
4851						$VIM/vimfiles/after,
4852						$HOME/vimfiles/after"
4853					Macintosh: "$VIM:vimfiles,
4854						$VIMRUNTIME,
4855						$VIM:vimfiles:after"
4856					RISC-OS: "Choices:vimfiles,
4857						$VIMRUNTIME,
4858						Choices:vimfiles/after"
4859					VMS: "sys$login:vimfiles,
4860						$VIM/vimfiles,
4861						$VIMRUNTIME,
4862						$VIM/vimfiles/after,
4863						sys$login:vimfiles/after"
4864			global
4865			{not in Vi}
4866	This is a list of directories which will be searched for runtime
4867	files:
4868	  filetype.vim	filetypes by file name |new-filetype|
4869	  scripts.vim	filetypes by file contents |new-filetype-scripts|
4870	  colors/	color scheme files |:colorscheme|
4871	  compiler/	compiler files |:compiler|
4872	  doc/		documentation |write-local-help|
4873	  ftplugin/	filetype plugins |write-filetype-plugin|
4874	  indent/	indent scripts |indent-expression|
4875	  keymap/	key mapping files |mbyte-keymap|
4876	  lang/		menu translations |:menutrans|
4877	  menu.vim	GUI menus |menu.vim|
4878	  plugin/	plugin scripts |write-plugin|
4879	  print/	files for printing |postscript-print-encoding|
4880	  syntax/	syntax files |mysyntaxfile|
4881	  tutor/	files for vimtutor |tutor|
4882
4883	And any other file searched for with the |:runtime| command.
4884
4885	The defaults for most systems are setup to search five locations:
4886	1. In your home directory, for your personal preferences.
4887	2. In a system-wide Vim directory, for preferences from the system
4888	   administrator.
4889	3. In $VIMRUNTIME, for files distributed with Vim.
4890							*after-directory*
4891	4. In the "after" directory in the system-wide Vim directory.  This is
4892	   for the system administrator to overrule or add to the distributed
4893	   defaults (rarely needed)
4894	5. In the "after" directory in your home directory.  This is for
4895	   personal preferences to overrule or add to the distributed defaults
4896	   or system-wide settings (rarely needed).
4897
4898	Note that, unlike 'path', no wildcards like "**" are allowed.  Normal
4899	wildcards are allowed, but can significantly slow down searching for
4900	runtime files.  For speed, use as few items as possible and avoid
4901	wildcards.
4902	See |:runtime|.
4903	Example: >
4904		:set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
4905<	This will use the directory "~/vimruntime" first (containing your
4906	personal Vim runtime files), then "/mygroup/vim" (shared between a
4907	group of people) and finally "$VIMRUNTIME" (the distributed runtime
4908	files).
4909	You probably should always include $VIMRUNTIME somewhere, to use the
4910	distributed runtime files.  You can put a directory before $VIMRUNTIME
4911	to find files which replace a distributed runtime files.  You can put
4912	a directory after $VIMRUNTIME to find files which add to distributed
4913	runtime files.
4914	This option cannot be set from a |modeline| or in the |sandbox|, for
4915	security reasons.
4916
4917						*'scroll'* *'scr'*
4918'scroll' 'scr'		number	(default: half the window height)
4919			local to window
4920	Number of lines to scroll with CTRL-U and CTRL-D commands.  Will be
4921	set to half the number of lines in the window when the window size
4922	changes.  If you give a count to the CTRL-U or CTRL-D command it will
4923	be used as the new value for 'scroll'.  Reset to half the window
4924	height with ":set scroll=0".   {Vi is a bit different: 'scroll' gives
4925	the number of screen lines instead of file lines, makes a difference
4926	when lines wrap}
4927
4928			*'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
4929'scrollbind' 'scb'	boolean  (default off)
4930			local to window
4931			{not in Vi}
4932			{not available when compiled without the |+scrollbind|
4933			feature}
4934	See also |scroll-binding|.  When this option is set, the current
4935	window scrolls as other scrollbind windows (windows that also have
4936	this option set) scroll.  This option is useful for viewing the
4937	differences between two versions of a file, see 'diff'.
4938	See |'scrollopt'| for options that determine how this option should be
4939	interpreted.
4940	This option is mostly reset when splitting a window to edit another
4941	file.  This means that ":split | edit file" results in two windows
4942	with scroll-binding, but ":split file" does not.
4943
4944						*'scrolljump'* *'sj'*
4945'scrolljump' 'sj'	number	(default 1)
4946			global
4947			{not in Vi}
4948	Minimal number of lines to scroll when the cursor gets off the
4949	screen (e.g., with "j").  Not used for scroll commands (e.g., CTRL-E,
4950	CTRL-D).  Useful if your terminal scrolls very slowly.
4951	NOTE: This option is set to 1 when 'compatible' is set.
4952
4953						*'scrolloff'* *'so'*
4954'scrolloff' 'so'	number	(default 0)
4955			global
4956			{not in Vi}
4957	Minimal number of screen lines to keep above and below the cursor.
4958	This will make some context visible around where you are working.  If
4959	you set it to a very large value (999) the cursor line will always be
4960	in the middle of the window (except at the start or end of the file or
4961	when long lines wrap).
4962	For scrolling horizontally see 'sidescrolloff'.
4963	NOTE: This option is set to 0 when 'compatible' is set.
4964
4965						*'scrollopt'* *'sbo'*
4966'scrollopt' 'sbo'	string	(default "ver,jump")
4967			global
4968			{not available when compiled without the |+scrollbind|
4969			feature}
4970			{not in Vi}
4971	This is a comma-separated list of words that specifies how
4972	'scrollbind' windows should behave.
4973	The following words are available:
4974	    ver		Bind vertical scrolling for 'scrollbind' windows
4975	    hor		Bind horizontal scrolling for 'scrollbind' windows
4976	    jump	Applies to the offset between two windows for vertical
4977			scrolling.  This offset is the difference in the first
4978			displayed line of the bound windows.  When moving
4979			around in a window, another 'scrollbind' window may
4980			reach a position before the start or after the end of
4981			the buffer.  The offset is not changed though, when
4982			moving back the 'scrollbind' window will try to scroll
4983			to the desired position when possible.
4984			When now making that window the current one, two
4985			things can be done with the relative offset:
4986			1. When "jump" is not included, the relative offset is
4987			   adjusted for the scroll position in the new current
4988			   window.  When going back to the other window, the
4989			   the new relative offset will be used.
4990			2. When "jump" is included, the other windows are
4991			   scrolled to keep the same relative offset.  When
4992			   going back to the other window, it still uses the
4993			   same relative offset.
4994	Also see |scroll-binding|.
4995
4996						*'sections'* *'sect'*
4997'sections' 'sect'	string	(default "SHNHH HUnhsh")
4998			global
4999	Specifies the nroff macros that separate sections.  These are pairs of
5000	two letters (See |object-motions|).  The default makes a section start
5001	at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5002
5003						*'secure'* *'nosecure'* *E523*
5004'secure'		boolean	(default off)
5005			global
5006			{not in Vi}
5007	When on, ":autocmd", shell and write commands are not allowed in
5008	".vimrc" and ".exrc" in the current directory and map commands are
5009	displayed.  Switch it off only if you know that you will not run into
5010	problems, or when the 'exrc' option is off.  On Unix this option is
5011	only used if the ".vimrc" or ".exrc" is not owned by you.  This can be
5012	dangerous if the systems allows users to do a "chown".  You better set
5013	'secure' at the end of your ~/.vimrc then.
5014	This option cannot be set from a |modeline| or in the |sandbox|, for
5015	security reasons.
5016
5017						*'selection'* *'sel'*
5018'selection' 'sel'	string	(default "inclusive")
5019			global
5020			{not in Vi}
5021	This option defines the behavior of the selection.  It is only used
5022	in Visual and Select mode.
5023	Possible values:
5024	   value	past line     inclusive ~
5025	   old		   no		yes
5026	   inclusive	   yes		yes
5027	   exclusive	   yes		no
5028	"past line" means that the cursor is allowed to be positioned one
5029	character past the line.
5030	"inclusive" means that the last character of the selection is included
5031	in an operation.  For example, when "x" is used to delete the
5032	selection.
5033	Note that when "exclusive" is used and selecting from the end
5034	backwards, you cannot include the last character of a line, when
5035	starting in Normal mode and 'virtualedit' empty.
5036
5037	The 'selection' option is set by the |:behave| command.
5038
5039						*'selectmode'* *'slm'*
5040'selectmode' 'slm'	string	(default "")
5041			global
5042			{not in Vi}
5043	This is a comma separated list of words, which specifies when to start
5044	Select mode instead of Visual mode, when a selection is started.
5045	Possible values:
5046	   mouse	when using the mouse
5047	   key		when using shifted special keys
5048	   cmd		when using "v", "V" or CTRL-V
5049	See |Select-mode|.
5050	The 'selectmode' option is set by the |:behave| command.
5051
5052						*'sessionoptions'* *'ssop'*
5053'sessionoptions' 'ssop'	string	(default: "blank,buffers,curdir,folds,
5054							help,options,winsize")
5055			global
5056			{not in Vi}
5057			{not available when compiled without the +mksession
5058			feature}
5059	Changes the effect of the |:mksession| command.  It is a comma
5060	separated list of words.  Each word enables saving and restoring
5061	something:
5062	   word		save and restore ~
5063	   blank	empty windows
5064	   buffers	hidden and unloaded buffers, not just those in windows
5065	   curdir	the current directory
5066	   folds	manually created folds, opened/closed folds and local
5067			fold options
5068	   globals	global variables that start with an uppercase letter
5069			and contain at least one lowercase letter.
5070	   help		the help window
5071	   localoptions	options and mappings local to a window or buffer (not
5072			global values for local options)
5073	   options	all options and mappings (also global values for local
5074			options)
5075	   resize	size of the Vim window: 'lines' and 'columns'
5076	   sesdir	the directory in which the session file is located
5077			will become the current directory (useful with
5078			projects accessed over a network from different
5079			systems)
5080	   slash	backslashes in file names replaced with forward
5081			slashes
5082	   unix		with Unix end-of-line format (single <NL>), even when
5083			on Windows or DOS
5084	   winpos	position of the whole Vim window
5085	   winsize	window sizes
5086
5087	Don't include both "curdir" and "sesdir".
5088	When "curdir" nor "sesdir" is included, file names are stored with
5089	absolute paths.
5090	"slash" and "unix" are useful on Windows when sharing session files
5091	with Unix.  The Unix version of Vim cannot source dos format scripts,
5092	but the Windows version of Vim can source unix format scripts.
5093
5094						*'shell'* *'sh'* *E91*
5095'shell' 'sh'		string	(default $SHELL or "sh",
5096					MS-DOS and Win32: "command.com" or
5097					"cmd.exe", OS/2: "cmd")
5098			global
5099	Name of the shell to use for ! and :! commands.  When changing the
5100	value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5101	'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
5102	It is allowed to give an argument to the command, e.g.  "csh -f".
5103	See |option-backslash| about including spaces and backslashes.
5104	Environment variables are expanded |:set_env|.
5105	If the name of the shell contains a space, you might need to enclose
5106	it in quotes.  Example: >
5107		:set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5108<	Note the backslash before each quote (to avoid starting a comment) and
5109	each space (to avoid ending the option value).  Also note that the
5110	"-f" is not inside the quotes, because it is not part of the command
5111	name.  And Vim automagically recognizes the backslashes that are path
5112	separators.
5113	For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5114	variable to change the way external commands are executed.  See the
5115	libc.inf file of DJGPP.
5116	Under MS-Windows, when the executable ends in ".com" it must be
5117	included.  Thus setting the shell to "command.com" or "4dos.com"
5118	works, but "command" and "4dos" do not work for all commands (e.g.,
5119	filtering).
5120	For unknown reasons, when using "4dos.com" the current directory is
5121	changed to "C:\".  To avoid this set 'shell' like this: >
5122		:set shell=command.com\ /c\ 4dos
5123<	This option cannot be set from a |modeline| or in the |sandbox|, for
5124	security reasons.
5125
5126						*'shellcmdflag'* *'shcf'*
5127'shellcmdflag' 'shcf'	string	(default: "-c", MS-DOS and Win32, when 'shell'
5128					does not contain "sh" somewhere: "/c")
5129			global
5130			{not in Vi}
5131	Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5132	"bash.exe -c ls" or "command.com /c dir".  For the MS-DOS-like
5133	systems, the default is set according to the value of 'shell', to
5134	reduce the need to set this option by the user.  It's not used for
5135	OS/2 (EMX figures this out itself).  See |option-backslash| about
5136	including spaces and backslashes.  See |dos-shell|.
5137	This option cannot be set from a |modeline| or in the |sandbox|, for
5138	security reasons.
5139
5140						*'shellpipe'* *'sp'*
5141'shellpipe' 'sp'	string	(default ">", "| tee", "|& tee" or "2>&1| tee")
5142			global
5143			{not in Vi}
5144			{not available when compiled without the |+quickfix|
5145			feature}
5146	String to be used to put the output of the ":make" command in the
5147	error file.  See also |:make_makeprg|.  See |option-backslash| about
5148	including spaces and backslashes.
5149	The name of the temporary file can be represented by "%s" if necessary
5150	(the file name is appended automatically if no %s appears in the value
5151	of this option).
5152	For the Amiga and MS-DOS the default is ">".  The output is directly
5153	saved in a file and not echoed to the screen.
5154	For Unix the default it "| tee".  The stdout of the compiler is saved
5155	in a file and echoed to the screen.  If the 'shell' option is "csh" or
5156	"tcsh" after initializations, the default becomes "|& tee".  If the
5157	'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5158	"2>&1| tee".  This means that stderr is also included.
5159	The initialization of this option is done after reading the ".vimrc"
5160	and the other initializations, so that when the 'shell' option is set
5161	there, the 'shellpipe' option changes automatically, unless it was
5162	explicitly set before.
5163	When 'shellpipe' is set to an empty string, no redirection of the
5164	":make" output will be done.  This is useful if you use a 'makeprg'
5165	that writes to 'makeef' by itself.  If you want no piping, but do
5166	want to include the 'makeef', set 'shellpipe' to a single space.
5167	Don't forget to precede the space with a backslash: ":set sp=\ ".
5168	In the future pipes may be used for filtering and this option will
5169	become obsolete (at least for Unix).
5170	This option cannot be set from a |modeline| or in the |sandbox|, for
5171	security reasons.
5172
5173						*'shellquote'* *'shq'*
5174'shellquote' 'shq'	string	(default: ""; MS-DOS and Win32, when 'shell'
5175					contains "sh" somewhere: "\"")
5176			global
5177			{not in Vi}
5178	Quoting character(s), put around the command passed to the shell, for
5179	the "!" and ":!" commands.  The redirection is kept outside of the
5180	quoting.  See 'shellxquote' to include the redirection.  It's
5181	probably not useful to set both options.
5182	This is an empty string by default.  Only known to be useful for
5183	third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5184	or bash, where it should be "\"".  The default is adjusted according
5185	the value of 'shell', to reduce the need to set this option by the
5186	user.  See |dos-shell|.
5187	This option cannot be set from a |modeline| or in the |sandbox|, for
5188	security reasons.
5189
5190						*'shellredir'* *'srr'*
5191'shellredir' 'srr'	string	(default ">", ">&" or ">%s 2>&1")
5192			global
5193			{not in Vi}
5194	String to be used to put the output of a filter command in a temporary
5195	file.  See also |:!|.  See |option-backslash| about including spaces
5196	and backslashes.
5197	The name of the temporary file can be represented by "%s" if necessary
5198	(the file name is appended automatically if no %s appears in the value
5199	of this option).
5200	The default is ">".  For Unix, if the 'shell' option is "csh", "tcsh"
5201	or "zsh" during initializations, the default becomes ">&".  If the
5202	'shell' option is "sh", "ksh" or "bash" the default becomes
5203	">%s 2>&1".  This means that stderr is also included.
5204	For Win32, the Unix checks are done and additionally "cmd" is checked
5205	for, which makes the default ">%s 2>&1".  Also, the same names with
5206	".exe" appended are checked for.
5207	The initialization of this option is done after reading the ".vimrc"
5208	and the other initializations, so that when the 'shell' option is set
5209	there, the 'shellredir' option changes automatically unless it was
5210	explicitly set before.
5211	In the future pipes may be used for filtering and this option will
5212	become obsolete (at least for Unix).
5213	This option cannot be set from a |modeline| or in the |sandbox|, for
5214	security reasons.
5215
5216			*'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5217'shellslash' 'ssl'	boolean	(default off)
5218			global
5219			{not in Vi} {only for MSDOS, MS-Windows and OS/2}
5220	When set, a forward slash is used when expanding file names.  This is
5221	useful when a Unix-like shell is used instead of command.com or
5222	cmd.exe.  Backward slashes can still be typed, but they are changed to
5223	forward slashes by Vim.
5224	Note that setting or resetting this option has no effect for some
5225	existing file names, thus this option needs to be set before opening
5226	any file for best results.  This might change in the future.
5227	'shellslash' only works when a backslash can be used as a path
5228	separator.  To test if this is so use: >
5229		if exists('+shellslash')
5230<
5231						*'shelltype'* *'st'*
5232'shelltype' 'st'	number	(default 0)
5233			global
5234			{not in Vi} {only for the Amiga}
5235	On the Amiga this option influences the way how the commands work
5236	which use a shell.
5237	0 and 1: always use the shell
5238	2 and 3: use the shell only to filter lines
5239	4 and 5: use shell only for ':sh' command
5240	When not using the shell, the command is executed directly.
5241
5242	0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5243	1 and 3: use "shell cmd" to start external commands
5244
5245						*'shellxquote'* *'sxq'*
5246'shellxquote' 'sxq'	string	(default: "";
5247					for Win32, when 'shell' contains "sh"
5248					somewhere: "\""
5249					for Unix, when using system(): "\"")
5250			global
5251			{not in Vi}
5252	Quoting character(s), put around the command passed to the shell, for
5253	the "!" and ":!" commands.  Includes the redirection.  See
5254	'shellquote' to exclude the redirection.  It's probably not useful
5255	to set both options.
5256	This is an empty string by default.  Known to be useful for
5257	third-party shells when using the Win32 version, such as the MKS Korn
5258	Shell or bash, where it should be "\"".  The default is adjusted
5259	according the value of 'shell', to reduce the need to set this option
5260	by the user.  See |dos-shell|.
5261	This option cannot be set from a |modeline| or in the |sandbox|, for
5262	security reasons.
5263
5264			*'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5265'shiftround' 'sr'	boolean	(default off)
5266			global
5267			{not in Vi}
5268	Round indent to multiple of 'shiftwidth'.  Applies to > and <
5269	commands.  CTRL-T and CTRL-D in Insert mode always round the indent to
5270	a multiple of 'shiftwidth' (this is Vi compatible).
5271	NOTE: This option is reset when 'compatible' is set.
5272
5273						*'shiftwidth'* *'sw'*
5274'shiftwidth' 'sw'	number	(default 8)
5275			local to buffer
5276	Number of spaces to use for each step of (auto)indent.  Used for
5277	|'cindent'|, |>>|, |<<|, etc.
5278
5279						*'shortmess'* *'shm'*
5280'shortmess' 'shm'	string	(Vim default "filnxtToO", Vi default: "")
5281			global
5282			{not in Vi}
5283	This option helps to avoid all the |hit-enter| prompts caused by file
5284	messages, for example  with CTRL-G, and to avoid some other messages.
5285	It is a list of flags:
5286	 flag	meaning when present	~
5287	  f	use "(3 of 5)" instead of "(file 3 of 5)"
5288	  i	use "[noeol]" instead of "[Incomplete last line]"
5289	  l	use "999L, 888C" instead of "999 lines, 888 characters"
5290	  m	use "[+]" instead of "[Modified]"
5291	  n	use "[New]" instead of "[New File]"
5292	  r	use "[RO]" instead of "[readonly]"
5293	  w	use "[w]" instead of "written" for file write message
5294		and "[a]" instead of "appended" for ':w >> file' command
5295	  x	use "[dos]" instead of "[dos format]", "[unix]" instead of
5296		"[unix format]" and "[mac]" instead of "[mac format]".
5297	  a	all of the above abbreviations
5298
5299	  o	overwrite message for writing a file with subsequent message
5300		for reading a file (useful for ":wn" or when 'autowrite' on)
5301	  O	message for reading a file overwrites any previous message.
5302		Also for quickfix message (e.g., ":cn").
5303	  s	don't give "search hit BOTTOM, continuing at TOP" or "search
5304		hit TOP, continuing at BOTTOM" messages
5305	  t	truncate file message at the start if it is too long to fit
5306		on the command-line, "<" will appear in the left most column.
5307		Ignored in Ex mode.
5308	  T	truncate other messages in the middle if they are too long to
5309		fit on the command line. "..." will appear in the middle.
5310		Ignored in Ex mode.
5311	  W	don't give "written" or "[w]" when writing a file
5312	  A	don't give the "ATTENTION" message when an existing swap file
5313		is found.
5314	  I	don't give the intro message when starting Vim |:intro|.
5315
5316	This gives you the opportunity to avoid that a change between buffers
5317	requires you to hit <Enter>, but still gives as useful a message as
5318	possible for the space available.  To get the whole message that you
5319	would have got with 'shm' empty, use ":file!"
5320	Useful values:
5321	    shm=	No abbreviation of message.
5322	    shm=a	Abbreviation, but no loss of information.
5323	    shm=at	Abbreviation, and truncate message when necessary.
5324
5325	NOTE: This option is set to the Vi default value when 'compatible' is
5326	set and to the Vim default value when 'compatible' is reset.
5327
5328				 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5329'shortname' 'sn'	boolean	(default off)
5330			local to buffer
5331			{not in Vi, not in MS-DOS versions}
5332	Filenames are assumed to be 8 characters plus one extension of 3
5333	characters.  Multiple dots in file names are not allowed.  When this
5334	option is on, dots in file names are replaced with underscores when
5335	adding an extension (".~" or ".swp").  This option is not available
5336	for MS-DOS, because then it would always be on.  This option is useful
5337	when editing files on an MS-DOS compatible filesystem, e.g., messydos
5338	or crossdos.  When running the Win32 GUI version under Win32s, this
5339	option is always on by default.
5340
5341						*'showbreak'* *'sbr'* *E595*
5342'showbreak' 'sbr'	string	(default "")
5343			global
5344			{not in Vi}
5345			{not available when compiled without the  |+linebreak|
5346			feature}
5347	String to put at the start of lines that have been wrapped.  Useful
5348	values are "> " or "+++ ".
5349	Only printable single-cell characters are allowed, excluding <Tab> and
5350	comma (in a future version the comma might be used to separate the
5351	part that is shown at the end and at the start of a line).
5352	The characters are highlighted according to the '@' flag in
5353	'highlight'.
5354	Note that tabs after the showbreak will be displayed differently.
5355	If you want the 'showbreak' to appear in between line numbers, add the
5356	"n" flag to 'cpoptions'.
5357
5358				     *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5359'showcmd' 'sc'		boolean	(Vim default: on, off for Unix, Vi default:
5360				 off)
5361			global
5362			{not in Vi}
5363			{not available when compiled without the
5364			|+cmdline_info| feature}
5365	Show (partial) command in status line.  Set this option off if your
5366	terminal is slow.
5367	In Visual mode the size of the selected area is shown:
5368	- When selecting characters within a line, the number of characters.
5369	- When selecting more than one line, the number of lines.
5370	- When selecting a block, the size in screen characters: linesxcolumns.
5371	NOTE: This option is set to the Vi default value when 'compatible' is
5372	set and to the Vim default value when 'compatible' is reset.
5373
5374			*'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5375'showfulltag' 'sft'	boolean (default off)
5376			global
5377			{not in Vi}
5378	When completing a word in insert mode (see |ins-completion|) from the
5379	tags file, show both the tag name and a tidied-up form of the search
5380	pattern (if there is one) as possible matches.  Thus, if you have
5381	matched a C function, you can see a template for what arguments are
5382	required (coding style permitting).
5383
5384				 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5385'showmatch' 'sm'	boolean	(default off)
5386			global
5387	When a bracket is inserted, briefly jump to the matching one.  The
5388	jump is only done if the match can be seen on the screen.  The time to
5389	show the match can be set with 'matchtime'.
5390	A Beep is given if there is no match (no matter if the match can be
5391	seen or not).  This option is reset when the 'paste' option is set.
5392	When the 'm' flag is not included in 'cpoptions', typing a character
5393	will immediately move the cursor back to where it belongs.
5394	See the "sm" field in 'guicursor' for setting the cursor shape and
5395	blinking when showing the match.
5396	The 'matchpairs' option can be used to specify the characters to show
5397	matches for.  'rightleft' and 'revins' are used to look for opposite
5398	matches.
5399	Note: For the use of the short form parental guidance is advised.
5400
5401				 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5402'showmode' 'smd'	boolean	(Vim default: on, Vi default: off)
5403			global
5404	If in Insert, Replace or Visual mode put a message on the last line.
5405	Use the 'M' flag in 'highlight' to set the type of highlighting for
5406	this message.
5407	When |XIM| may be used the message will include "XIM".  But this
5408	doesn't mean XIM is really active, especially when 'imactivatekey' is
5409	not set.
5410	NOTE: This option is set to the Vi default value when 'compatible' is
5411	set and to the Vim default value when 'compatible' is reset.
5412
5413						*'sidescroll'* *'ss'*
5414'sidescroll' 'ss'	number	(default 0)
5415			global
5416			{not in Vi}
5417	The minimal number of columns to scroll horizontally.  Used only when
5418	the 'wrap' option is off and the cursor is moved off of the screen.
5419	When it is zero the cursor will be put in the middle of the screen.
5420	When using a slow terminal set it to a large number or 0.  When using
5421	a fast terminal use a small number or 1.  Not used for "zh" and "zl"
5422	commands.
5423
5424						*'sidescrolloff'* *'siso'*
5425'sidescrolloff' 'siso'	number (default 0)
5426			global
5427			{not in Vi}
5428	The minimal number of screen columns to keep to the left and to the
5429	right of the cursor if 'nowrap' is set. Setting this option to a value
5430	greater than 0 while having |'sidescroll'| also at a non-zero value
5431	makes some context visible in the line you are scrolling in
5432	horizontally (except at the end and beginning of the line).  Setting
5433	this option to a large value (like 999) has the effect of keeping the
5434	cursor horizontally centered in the window, as long as one does not
5435	come too close to the beginning or end of the line.
5436	NOTE: This option is set to 0 when 'compatible' is set.
5437
5438	Example: Try this together with 'sidescroll' and 'listchars' as
5439		 in the following example to never allow the cursor to move
5440		 onto the "extends" character:
5441
5442		 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5443		 :set sidescrolloff=1
5444
5445
5446			*'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5447'smartcase' 'scs'	boolean	(default off)
5448			global
5449			{not in Vi}
5450	Override the 'ignorecase' option if the search pattern contains upper
5451	case characters.  Only used when the search pattern is typed and
5452	'ignorecase' option is on.  Used for the commands "/", "?", "n", "N",
5453	":g" and ":s".  Not used for "*", "#", "gd", tag search, etc..  After
5454	"*" and "#" you can make 'smartcase' used by doing a "/" command,
5455	recalling the search pattern from history and hitting <Enter>.
5456	NOTE: This option is reset when 'compatible' is set.
5457
5458			     *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5459'smartindent' 'si'	boolean	(default off)
5460			local to buffer
5461			{not in Vi}
5462			{not available when compiled without the
5463			|+smartindent| feature}
5464	Do smart autoindenting when starting a new line.  Works for C-like
5465	programs, but can also be used for other languages.  'cindent' does
5466	something like this, works better in most cases, but is more strict,
5467	see |C-indenting|.  When 'cindent' is on, setting 'si' has no effect.
5468	'indentexpr' is a more advanced alternative.
5469	Normally 'autoindent' should also be on when using 'smartindent'.
5470	An indent is automatically inserted:
5471	- After a line ending in '{'.
5472	- After a line starting with a keyword from 'cinwords'.
5473	- Before a line starting with '}' (only with the "O" command).
5474	When typing '}' as the first character in a new line, that line is
5475	given the same indent as the matching '{'.
5476	When typing '#' as the first character in a new line, the indent for
5477	that line is removed, the '#' is put in the first column.  The indent
5478	is restored for the next line.  If you don't want this, use this
5479	mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5480	When using the ">>" command, lines starting with '#' are not shifted
5481	right.
5482	NOTE: 'smartindent' is reset when 'compatible' is set.  When 'paste'
5483	is set smart indenting is disabled.
5484
5485				 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5486'smarttab' 'sta'	boolean	(default off)
5487			global
5488			{not in Vi}
5489	When on, a <Tab> in front of a line inserts blanks according to
5490	'shiftwidth'.  'tabstop' is used in other places.  A <BS> will delete
5491	a 'shiftwidth' worth of space at the start of the line.
5492	When off a <Tab> always inserts blanks according to 'tabstop'.
5493	'shiftwidth' is only used for shifting text left or right
5494	|shift-left-right|.
5495	What gets inserted (a Tab or spaces) depends on the 'expandtab'
5496	option.  Also see |ins-expandtab|.  When 'expandtab' is not set, the
5497	number of spaces is minimized by using <Tab>s.
5498	NOTE: This option is reset when 'compatible' is set.
5499
5500					*'softtabstop'* *'sts'*
5501'softtabstop' 'sts'	number	(default 0)
5502			local to buffer
5503			{not in Vi}
5504	Number of spaces that a <Tab> counts for while performing editing
5505	operations, like inserting a <Tab> or using <BS>.  It "feels" like
5506	<Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5507	used.  This is useful to keep the 'ts' setting at its standard value
5508	of 8, while being able to edit like it is set to 'sts'.  However,
5509	commands like "x" still work on the actual characters.
5510	When 'sts' is zero, this feature is off.
5511	'softtabstop' is set to 0 when the 'paste' option is set.
5512	See also |ins-expandtab|.  When 'expandtab' is not set, the number of
5513	spaces is minimized by using <Tab>s.
5514	The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5515	set.
5516	NOTE: This option is set to 0 when 'compatible' is set.
5517
5518			*'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5519'splitbelow' 'sb'	boolean	(default off)
5520			global
5521			{not in Vi}
5522			{not available when compiled without the +windows
5523			feature}
5524	When on, splitting a window will put the new window below the current
5525	one. |:split|
5526
5527			*'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5528'splitright' 'spr'	boolean	(default off)
5529			global
5530			{not in Vi}
5531			{not available when compiled without the +vertsplit
5532			feature}
5533	When on, splitting a window will put the new window right of the
5534	current one. |:vsplit|
5535
5536			   *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5537'startofline' 'sol'	boolean	(default on)
5538			global
5539			{not in Vi}
5540	When "on" the commands listed below move the cursor to the first
5541	non-blank of the line.  When off the cursor is kept in the same column
5542	(if possible).  This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
5543	CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
5544	with a linewise operator, with "%" with a count and to buffer changing
5545	commands (CTRL-^, :bnext, :bNext, etc.).  Also for an Ex command that
5546	only has a line number, e.g., ":25" or ":+".
5547	In case of buffer changing commands the cursor is placed at the column
5548	where it was the last time the buffer was edited.
5549	NOTE: This option is set when 'compatible' is set.
5550
5551			   *'statusline'* *'stl'* *E540* *E541* *E542*
5552'statusline' 'stl'	string	(default empty)
5553			global
5554			{not in Vi}
5555			{not available when compiled without the |+statusline|
5556			feature}
5557	When nonempty, this option determines the content of the status line.
5558	Also see |status-line|.
5559
5560	The option consists of printf style '%' items interspersed with
5561	normal text.  Each status line item is of the form:
5562	  %-0{minwid}.{maxwid}{item}
5563	All fields except the {item} is optional.  A single percent sign can
5564	be given as "%%".  Up to 80 items can be specified.
5565
5566	Note that the only effect of 'ruler' when this option is set (and
5567	'laststatus' is 2) is controlling the output of |CTRL-G|.
5568
5569	field	    meaning ~
5570	-	    Left justify the item. The default is right justified
5571		    when minwid is larger than the length of the item.
5572	0	    Leading zeroes in numeric items. Overridden by '-'.
5573	minwid	    Minimum width of the item, padding as set by '-' & '0'.
5574		    Value must be 50 or less.
5575	maxwid	    Maximum width of the item.  Truncation occurs with a '<'
5576		    on the left for text items.  Numeric items will be
5577		    shifted down to maxwid-2 digits followed by '>'number
5578		    where number is the amount of missing digits, much like
5579		    an exponential notation.
5580	item	    A one letter code as described below.
5581
5582	Following is a description of the possible statusline items.  The
5583	second character in "item" is the type:
5584		N for number
5585		S for string
5586		F for flags as described below
5587		- not applicable
5588
5589	item  meaning ~
5590	f S   Path to the file in the buffer, relative to current directory.
5591	F S   Full path to the file in the buffer.
5592	t S   File name (tail) of file in the buffer.
5593	m F   Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5594	M F   Modified flag, text is ",+" or ",-".
5595	r F   Readonly flag, text is " [RO]".
5596	R F   Readonly flag, text is ",RO".
5597	h F   Help buffer flag, text is " [help]".
5598	H F   Help buffer flag, text is ",HLP".
5599	w F   Preview window flag, text is " [Preview]".
5600	W F   Preview window flag, text is ",PRV".
5601	y F   Type of file in the buffer, e.g., " [vim]".  See 'filetype'.
5602	Y F   Type of file in the buffer, e.g., ",VIM".  See 'filetype'.
5603	      {not available when compiled without |+autocmd| feature}
5604	k S   Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5605	      being used: "<keymap>"
5606	n N   Buffer number.
5607	b N   Value of byte under cursor.
5608	B N   As above, in hexadecimal.
5609	o N   Byte number in file of byte under cursor, first byte is 1.
5610	      Mnemonic: Offset from start of file (with one added)
5611	      {not available when compiled without |+byte_offset| feature}
5612	O N   As above, in hexadecimal.
5613	N N   Printer page number. (Only works in the 'printheader' option.)
5614	l N   Line number.
5615	L N   Number of lines in buffer.
5616	c N   Column number.
5617	v N   Virtual column number.
5618	V N   Virtual column number as -{num}.  Not displayed if equal to 'c'.
5619	p N   Percentage through file in lines as in |CTRL-G|.
5620	P S   Percentage through file of displayed window.  This is like the
5621	      percentage described for 'ruler'.  Always 3 in length.
5622	a S   Argument list status as in default title. ({current} of {max})
5623	      Empty if the argument file count is zero or one.
5624	{ NF  Evaluate expression between '{' and '}' and substitute result.
5625	( -   Start of item group.  Can be used for setting the width and
5626	      alignment of a section.  Must be followed by %) somewhere.
5627	) -   End of item group.  No width fields allowed.
5628	< -   Where to truncate line if too long.  Default is at the start.
5629	      No width fields allowed.
5630	= -   Separation point between left and right aligned items.
5631	      No width fields allowed.
5632	* -   Set highlight group to User{N}, where {N} is taken from the
5633	      minwid field. eg. %1*.  Restore normal highlight with %* or %0*.
5634	      The difference between User{N} and StatusLine  will be applied
5635	      to StatusLineNC for the statusline of non-current windows.
5636	      The number N must be between 1 and 9.  See |hl-User1..9|
5637
5638	Display of flags are controlled by the following heuristic:
5639	If a flag text starts with comma it is assumed that it wants to
5640	separate itself from anything but preceding plaintext.  If it starts
5641	with a space it is assumed that it wants to separate itself from
5642	anything but other flags.  That is: A leading comma is removed if the
5643	preceding character stems from plaintext.  A leading space is removed
5644	if the preceding character stems from another active flag. This will
5645	make a nice display when flags are used like in the examples below.
5646
5647	When all items in a group becomes an empty string (ie. flags that are
5648	not set) and a minwid is not set for the group, the whole group will
5649	become empty.  This will make a group like the following disappear
5650	completely from the statusline when none of the flags are set. >
5651		:set statusline=...%(\ [%M%R%H]%)...
5652<
5653	Beware that an expression is evaluated each and every time the status
5654	line is displayed.  The current buffer and current window will be set
5655	temporarily to that of the window (and buffer) whose statusline is
5656	currently being drawn. The expression will evaluate in this context.
5657	The variable "actual_curbuf" is set to the 'bufnr()' number of the
5658	real current buffer.  The expression is evaluated in the |sandbox|.
5659
5660	If the statusline is not updated when you want it (e.g., after setting
5661	a variable that's used in an expression), you can force an update by
5662	setting an option without changing its value.  Example: >
5663		:let &ro = &ro
5664
5665<	A result of all digits is regarded a number for display purposes.
5666	Otherwise the result is taken as flag text and applied to the rules
5667	described above.
5668
5669	Watch out for errors in expressions.  They may render Vim unusable !
5670	If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5671	edit your .vimrc or whatever with "vim -u NONE" to get it right.
5672
5673	Examples:
5674	Emulate standard status line with 'ruler' set >
5675	  :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5676<	Similar, but add ASCII value of char under the cursor (like "ga") >
5677	  :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5678<	Display byte count and byte value, modified flag in red. >
5679	  :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5680	  :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5681<	Display a ,GZ flag if a compressed file is loaded >
5682	  :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5683<	In the |:autocmd|'s: >
5684	  :let b:gzflag = 1
5685<	And: >
5686	  :unlet b:gzflag
5687<	And define this function: >
5688	  :function VarExists(var, val)
5689	  :    if exists(a:var) | return a:val | else | return '' | endif
5690	  :endfunction
5691<
5692						*'suffixes'* *'su'*
5693'suffixes' 'su'		string	(default ".bak,~,.o,.h,.info,.swp,.obj")
5694			global
5695			{not in Vi}
5696	Files with these suffixes get a lower priority when multiple files
5697	match a wildcard.  See |suffixes|.  Commas can be used to separate the
5698	suffixes.  Spaces after the comma are ignored.  A dot is also seen as
5699	the start of a suffix.  To avoid a dot or comma being recognized as a
5700	separator, precede it with a backslash (see |option-backslash| about
5701	including spaces and backslashes).
5702	See 'wildignore' for completely ignoring files.
5703	The use of |:set+=| and |:set-=| is preferred when adding or removing
5704	suffixes from the list.  This avoids problems when a future version
5705	uses another default.
5706
5707						*'suffixesadd'* *'sua'*
5708'suffixesadd' 'sua'	string	(default "")
5709			local to buffer
5710			{not in Vi}
5711			{not available when compiled without the
5712			|+file_in_path| feature}
5713	Comma separated list of suffixes, which are used when searching for a
5714	file for the "gf", "[I", etc. commands.  Example: >
5715		:set suffixesadd=.java
5716<
5717				*'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
5718'swapfile' 'swf'	boolean (default on)
5719			local to buffer
5720			{not in Vi}
5721	Use a swapfile for the buffer.  This option can be reset when a
5722	swapfile is not wanted for a specific buffer.  For example, with
5723	confidential information that even root must not be able to access.
5724	Careful: All text will be in memory:
5725		- Don't use this for big files.
5726		- Recovery will be impossible!
5727	A swapfile will only be present when |'updatecount'| is non-zero and
5728	'swapfile' is set.
5729	When 'swapfile' is reset, the swap file for the current buffer is
5730	immediately deleted.  When 'swapfile' is set, and 'updatecount' is
5731	non-zero, a swap file is immediately created.
5732	Also see |swap-file| and |'swapsync'|.
5733
5734	This option is used together with 'bufhidden' and 'buftype' to
5735	specify special kinds of buffers.   See |special-buffers|.
5736
5737						*'swapsync'* *'sws'*
5738'swapsync' 'sws'	string	(default "fsync")
5739			global
5740			{not in Vi}
5741	When this option is not empty a swap file is synced to disk after
5742	writing to it.  This takes some time, especially on busy unix systems.
5743	When this option is empty parts of the swap file may be in memory and
5744	not written to disk.  When the system crashes you may lose more work.
5745	On Unix the system does a sync now and then without Vim asking for it,
5746	so the disadvantage of setting this option off is small.  On some
5747	systems the swap file will not be written at all.  For a unix system
5748	setting it to "sync" will use the sync() call instead of the default
5749	fsync(), which may work better on some systems.
5750
5751						*'switchbuf'* *'swb'*
5752'switchbuf' 'swb'	string	(default "")
5753			global
5754			{not in Vi}
5755	This option controls the behavior when switching between buffers.
5756	Possible values (comma separated list):
5757	   useopen	If included, jump to the first open window that
5758			contains the specified buffer (if there is one).
5759			Otherwise: Do not examine other windows.
5760			This setting is checked with |quickfix| commands, when
5761			jumping to errors (":cc", ":cn", "cp", etc.).  It is
5762			also used in all buffer related split commands, for
5763			example ":sbuffer", ":sbnext", or ":sbrewind".
5764	   split	If included, split the current window before loading
5765			a buffer. Otherwise: do not split, use current window.
5766			Supported in |quickfix| commands that display errors.
5767
5768						*'syntax'* *'syn'*
5769'syntax' 'syn'		string	(default empty)
5770			local to buffer
5771			{not in Vi}
5772			{not available when compiled without the |+syntax|
5773			feature}
5774	When this option is set, the syntax with this name is loaded, unless
5775	syntax highlighting has been switched off with ":syntax off".
5776	Otherwise this option does not always reflect the current syntax (the
5777	b:current_syntax variable does).
5778	This option is most useful in a modeline, for a file which syntax is
5779	not automatically recognized.  Example, for in an IDL file: >
5780		/* vim: set syntax=idl : */
5781<	To switch off syntax highlighting for the current file, use: >
5782		:set syntax=OFF
5783<	To switch syntax highlighting on according to the current value of the
5784	'filetype' option: >
5785		:set syntax=ON
5786<	What actually happens when setting the 'syntax' option is that the
5787	Syntax autocommand event is triggered with the value as argument.
5788	This option is not copied to another buffer, independent of the 's' or
5789	'S' flag in 'cpoptions'.
5790
5791					*'tabstop'* *'ts'*
5792'tabstop' 'ts'		number	(default 8)
5793			local to buffer
5794	Number of spaces that a <Tab> in the file counts for.  Also see
5795	|:retab| command, and 'softtabstop' option.
5796
5797	Note: Setting 'tabstop' to any other value than 8 can make your file
5798	appear wrong in many places (e.g., when printing it).
5799
5800	There are four main ways to use tabs in Vim:
5801	1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
5802	   (or 3 or whatever you prefer) and use 'noexpandtab'.  Then Vim
5803	   will use a mix of tabs and spaces, but typing Tab and BS will
5804	   behave like a tab appears every 4 (or 3) characters.
5805	2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
5806	   'expandtab'.  This way you will always insert spaces.  The
5807	   formatting will never be messed up when 'tabstop' is changed.
5808	3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
5809	   |modeline| to set these values when editing the file again.  Only
5810	   works when using Vim to edit the file.
5811	4. Always set 'tabstop' and 'shiftwidth' to the same value, and
5812	   'noexpandtab'.  This should then work (for initial indents only)
5813	   for any tabstop setting that people use.  It might be nice to have
5814	   tabs after the first non-blank inserted as spaces if you do this
5815	   though.  Otherwise aligned comments will be wrong when 'tabstop' is
5816	   changed.
5817
5818			*'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
5819'tagbsearch' 'tbs'	boolean	(default on)
5820			global
5821			{not in Vi}
5822	When searching for a tag (e.g., for the |:ta| command), Vim can either
5823	use a binary search or a linear search in a tags file.  Binary
5824	searching makes searching for a tag a LOT faster, but a linear search
5825	will find more tags if the tags file wasn't properly sorted.
5826	Vim normally assumes that your tags files are sorted, or indicate that
5827	they are not sorted.  Only when this is not the case does the
5828	'tagbsearch' option need to be switched off.
5829
5830	When 'tagbsearch' is on, binary searching is first used in the tags
5831	files.  In certain situations, Vim will do a linear search instead for
5832	certain files, or retry all files with a linear search.  When
5833	'tagbsearch' is off, only a linear search is done.
5834
5835	Linear searching is done anyway, for one file, when Vim finds a line
5836	at the start of the file indicating that it's not sorted: >
5837   !_TAG_FILE_SORTED	0	/some command/
5838<	[The whitespace before and after the '0' must be a single <Tab>]
5839
5840	When a binary search was done and no match was found in any of the
5841	files listed in 'tags', and 'ignorecase' is set or a pattern is used
5842	instead of a normal tag name, a retry is done with a linear search.
5843	Tags in unsorted tags files, and matches with different case will only
5844	be found in the retry.
5845
5846	If a tag file indicates that is is case-fold sorted, the second,
5847	linear search can be avoided for the 'ignorecase' case.  Use a value
5848	of '2' in the "!_TAG_FILE_SORTED" line for this.  A tag file can be
5849	case-fold sorted with the -f switch to "sort" in most unices, as in
5850	the command: "sort -f -o tags tags".  For "Exuberant ctags" version
5851	5.3 or higher the -f or --fold-case-sort switch can be used for this
5852	as well.  Note that case must be folded to uppercase for this to work.
5853
5854	When 'tagbsearch' is off, tags searching is slower when a full match
5855	exists, but faster when no full match exists.  Tags in unsorted tags
5856	files may only be found with 'tagbsearch' off.
5857	When the tags file is not sorted, or sorted in a wrong way (not on
5858	ASCII byte value), 'tagbsearch' should be off, or the line given above
5859	must be included in the tags file.
5860	This option doesn't affect commands that find all matching tags (e.g.,
5861	command-line completion and ":help").
5862	{Vi: always uses binary search in some versions}
5863
5864						*'taglength'* *'tl'*
5865'taglength' 'tl'	number	(default 0)
5866			global
5867	If non-zero, tags are significant up to this number of characters.
5868
5869			*'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
5870'tagrelative' 'tr'	boolean	(Vim default: on, Vi default: off)
5871			global
5872			{not in Vi}
5873	If on and using a tag file in another directory, file names in that
5874	tag file are relative to the directory where the tag file is.
5875	NOTE: This option is set to the Vi default value when 'compatible' is
5876	set and to the Vim default value when 'compatible' is reset.
5877
5878						*'tags'* *'tag'* *E433*
5879'tags' 'tag'		string	(default "./tags,tags", when compiled with
5880				|+emacs_tags|: "./tags,./TAGS,tags,TAGS")
5881			global or local to buffer |global-local|
5882	Filenames for the tag command, separated by spaces or commas.  To
5883	include a space or comma in a file name, precede it with a backslash
5884	(see |option-backslash| about including spaces and backslashes).
5885	When a file name starts with "./", the '.' is replaced with the path
5886	of the current file.  But only when the 'd' flag is not included in
5887	'cpoptions'.  Environment variables are expanded |:set_env|.  Also see
5888	|tags-option|.
5889	"*", "**" and other wildcards can be used to search for tags files in
5890	a directory tree.  See |file-searching|.  {not available when compiled
5891	without the |+path_extra| feature}
5892	If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
5893	files are also supported.  They are automatically recognized.  The
5894	default value becomes "./tags,./TAGS,tags,TAGS", unless case
5895	differences are ignored (MS-Windows).  |emacs-tags|
5896	The use of |:set+=| and |:set-=| is preferred when adding or removing
5897	file names from the list.  This avoids problems when a future version
5898	uses another default.
5899	{Vi: default is "tags /usr/lib/tags"}
5900
5901				*'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
5902'tagstack' 'tgst'	boolean	(default on)
5903			global
5904			{not in all versions of Vi}
5905	When on, the |tagstack| is used normally.  When off, a ":tag" or
5906	":tselect" command with an argument will not push the tag onto the
5907	tagstack.  A following ":tag" without an argument, a ":pop" command or
5908	any other command that uses the tagstack will use the unmodified
5909	tagstack, but does change the pointer to the active entry.
5910	Resetting this option is useful when using a ":tag" command in a
5911	mapping which should not change the tagstack.
5912
5913						*'term'* *E529* *E530* *E531*
5914'term'			string	(default is $TERM, if that fails:
5915				      in the GUI: "builtin_gui"
5916					on Amiga: "amiga"
5917					 on BeOS: "beos-ansi"
5918					  on Mac: "mac-ansi"
5919					 on MiNT: "vt52"
5920				       on MS-DOS: "pcterm"
5921					 on OS/2: "os2ansi"
5922					 on Unix: "ansi"
5923					  on VMS: "ansi"
5924				       on Win 32: "win32")
5925			global
5926	Name of the terminal.  Used for choosing the terminal control
5927	characters.  Environment variables are expanded |:set_env|.
5928	For example: >
5929		:set term=$TERM
5930<	See |termcap|.
5931
5932						*'termbidi'* *'tbidi'*
5933						*'notermbidi'* *'notbidi'*
5934'termbidi' 'tbidi'	boolean (default off, on for "mlterm")
5935			global
5936			{not in Vi}
5937			{only available when compiled with the |+arabic|
5938			feature}
5939	The terminal is in charge of Bi-directionality of text (as specified
5940	by Unicode).  The terminal is also expected to do the required shaping
5941	that some languages (such as Arabic) require.
5942	Setting this option implies that 'rightleft' will not be set when
5943	'arabic' is set and the value of 'arabicshape' will be ignored.
5944	Note that setting 'termbidi' has the immediate effect that
5945	'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
5946	This option is reset when the GUI is started.
5947	For further details see |arabic.txt|.
5948
5949					*'termencoding'* *'tenc'*
5950'termencoding' 'tenc'	string	(default ""; with GTK+ 2 GUI: "utf-8"; with
5951						    Macintosh GUI: "macroman")
5952			global
5953			{only available when compiled with the |+multi_byte|
5954			feature}
5955			{not in Vi}
5956	Encoding used for the terminal.  This specifies what character
5957	encoding the keyboard produces and the display will understand.  For
5958	the GUI it only applies to the keyboard ('encoding' is used for the
5959	display).
5960	In the Win32 console version the default value is the console codepage
5961	when it differs from the ANSI codepage.
5962								*E617*
5963	Note: This does not apply to the GTK+ 2 GUI.  After the GUI has been
5964	successfully initialized, 'termencoding' is forcibly set to "utf-8".
5965	Any attempts to set a different value will be rejected, and an error
5966	message is shown.
5967	For the Win32 GUI 'termencoding' is not used for typed characters,
5968	because the Win32 system always passes Unicode characters.
5969	When empty, the same encoding is used as for the 'encoding' option.
5970	This is the normal value.
5971	Not all combinations for 'termencoding' and 'encoding' are valid.  See
5972	|encoding-table|.
5973	The value for this option must be supported by internal conversions or
5974	iconv().  When this is not possible no conversion will be done and you
5975	will probably experience problems with non-ASCII characters.
5976	Example: You are working with the locale set to euc-jp (Japanese) and
5977	want to edit a UTF-8 file: >
5978		:let &termencoding = &encoding
5979		:set encoding=utf-8
5980<	You need to do this when your system has no locale support for UTF-8.
5981
5982						*'terse'* *'noterse'*
5983'terse'			boolean	(default off)
5984			global
5985	When set: Add 's' flag to 'shortmess' option (this makes the message
5986	for a search that hits the start or end of the file not being
5987	displayed).  When reset: Remove 's' flag from 'shortmess' option.  {Vi
5988	shortens a lot of messages}
5989
5990				   *'textauto'* *'ta'* *'notextauto'* *'nota'*
5991'textauto' 'ta'		boolean	(Vim default: on, Vi default: off)
5992			global
5993			{not in Vi}
5994	This option is obsolete.  Use 'fileformats'.
5995	For backwards compatibility, when 'textauto' is set, 'fileformats' is
5996	set to the default value for the current system.  When 'textauto' is
5997	reset, 'fileformats' is made empty.
5998	NOTE: This option is set to the Vi default value when 'compatible' is
5999	set and to the Vim default value when 'compatible' is reset.
6000
6001				   *'textmode'* *'tx'* *'notextmode'* *'notx'*
6002'textmode' 'tx'		boolean	(MS-DOS, Win32 and OS/2: default on,
6003				 others: default off)
6004			local to buffer
6005			{not in Vi}
6006	This option is obsolete.  Use 'fileformat'.
6007	For backwards compatibility, when 'textmode' is set, 'fileformat' is
6008	set to "dos".  When 'textmode' is reset, 'fileformat' is set to
6009	"unix".
6010
6011						*'textwidth'* *'tw'*
6012'textwidth' 'tw'	number	(default 0)
6013			local to buffer
6014			{not in Vi}
6015	Maximum width of text that is being inserted.  A longer line will be
6016	broken after white space to get this width.  A zero value disables
6017	this.  'textwidth' is set to 0 when the 'paste' option is set.  When
6018	'textwidth' is zero, 'wrapmargin' may be used.  See also
6019	'formatoptions' and |ins-textwidth|.
6020	NOTE: This option is set to 0 when 'compatible' is set.
6021
6022						*'thesaurus'* *'tsr'*
6023'thesaurus' 'tsr'	string	(default "")
6024			global or local to buffer |global-local|
6025			{not in Vi}
6026	List of file names, separated by commas, that are used to lookup words
6027	for thesaurus completion commands |i_CTRL-X_CTRL-T|.  Each line in
6028	the file should contain words with similar meaning, separated by
6029	non-keyword characters (white space is preferred).  Maximum line
6030	length is 510 bytes.
6031	To obtain a file to be used here, check out the wordlist FAQ at
6032	http://www.hyphenologist.co.uk .
6033	To include a comma in a file name precede it with a backslash.  Spaces
6034	after a comma are ignored, otherwise spaces are included in the file
6035	name.  See |option-backslash| about using backslashes.
6036	The use of |:set+=| and |:set-=| is preferred when adding or removing
6037	directories from the list.  This avoids problems when a future version
6038	uses another default.
6039	Backticks cannot be used in this option for security reasons.
6040
6041			     *'tildeop'* *'top'* *'notildeop'* *'notop'*
6042'tildeop' 'top'		boolean	(default off)
6043			global
6044			{not in Vi}
6045	When on: The tilde command "~" behaves like an operator.
6046	NOTE: This option is reset when 'compatible' is set.
6047
6048				*'timeout'* *'to'* *'notimeout'* *'noto'*
6049'timeout' 'to'		boolean (default on)
6050			global
6051						*'ttimeout'* *'nottimeout'*
6052'ttimeout'		boolean (default off)
6053			global
6054			{not in Vi}
6055	These two options together determine the behavior when part of a
6056	mapped key sequence or keyboard code has been received:
6057
6058	'timeout'    'ttimeout'		action	~
6059	   off		off		do not time out
6060	   on		on or off	time out on :mappings and key codes
6061	   off		on		time out on key codes
6062
6063	If both options are off, Vim will wait until either the complete
6064	mapping or key sequence has been received, or it is clear that there
6065	is no mapping or key sequence for the received characters.  For
6066	example: if you have mapped "vl" and Vim has received 'v', the next
6067	character is needed to see if the 'v' is followed by an 'l'.
6068	When one of the options is on, Vim will wait for about 1 second for
6069	the next character to arrive.  After that the already received
6070	characters are interpreted as single characters.  The waiting time can
6071	be changed with the 'timeoutlen' option.
6072	On slow terminals or very busy systems timing out may cause
6073	malfunctioning cursor keys.  If both options are off, Vim waits
6074	forever after an entered <Esc> if there are key codes that start
6075	with <Esc>.  You will have to type <Esc> twice.  If you do not have
6076	problems with key codes, but would like to have :mapped key
6077	sequences not timing out in 1 second, set the 'ttimeout' option and
6078	reset the 'timeout' option.
6079
6080	NOTE: 'ttimeout' is reset when 'compatible' is set.
6081
6082						*'timeoutlen'* *'tm'*
6083'timeoutlen' 'tm'	number	(default 1000)
6084			global
6085			{not in all versions of Vi}
6086						*'ttimeoutlen'* *'ttm'*
6087'ttimeoutlen' 'ttm'	number	(default -1)
6088			global
6089			{not in Vi}
6090	The time in milliseconds that is waited for a key code or mapped key
6091	sequence to complete.  Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6092	when part of a command has been typed.
6093	Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1.  When a
6094	different timeout value for key codes is desired set 'ttimeoutlen' to
6095	a non-negative number.
6096
6097		ttimeoutlen	mapping delay	   key code delay	~
6098		   < 0		'timeoutlen'	   'timeoutlen'
6099		  >= 0		'timeoutlen'	   'ttimeoutlen'
6100
6101	The timeout only happens when the 'timeout' and 'ttimeout' options
6102	tell so.  A useful setting would be >
6103		:set timeout timeoutlen=3000 ttimeoutlen=100
6104<	(time out on mapping after three seconds, time out on key codes after
6105	a tenth of a second).
6106
6107						*'title'* *'notitle'*
6108'title'			boolean	(default off, on when title can be restored)
6109			global
6110			{not in Vi}
6111			{not available when compiled without the |+title|
6112			feature}
6113	When on, the title of the window will be set to the value of
6114	'titlestring' (if it is not empty), or to:
6115		filename [+=-] (path) - VIM
6116	Where:
6117		filename	the name of the file being edited
6118		-		indicates the file cannot be modified, 'ma' off
6119		+		indicates the file was modified
6120		=		indicates the file is read-only
6121		=+		indicates the file is read-only and modified
6122		(path)		is the path of the file being edited
6123		- VIM		the server name |v:servername| or "VIM"
6124	Only works if the terminal supports setting window titles
6125	(currently Amiga console, Win32 console, all GUI versions and
6126	terminals with a non- empty 't_ts' option - these are Unix xterm and
6127	iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6128								*X11*
6129	When Vim was compiled with HAVE_X11 defined, the original title will
6130	be restored if possible.  The output of ":version" will include "+X11"
6131	when HAVE_X11 was defined, otherwise it will be "-X11".  This also
6132	works for the icon name |'icon'|.
6133	But: When Vim was started with the |-X| argument, restoring the title
6134	will not work (except in the GUI).
6135	If the title cannot be restored, it is set to the value of 'titleold'.
6136	You might want to restore the title outside of Vim then.
6137	When using an xterm from a remote machine you can use this command:
6138	    rsh machine_name xterm -display $DISPLAY &
6139	then the WINDOWID environment variable should be inherited and the
6140	title of the window should change back to what it should be after
6141	exiting Vim.
6142
6143								*'titlelen'*
6144'titlelen'		number	(default 85)
6145			global
6146			{not in Vi}
6147			{not available when compiled without the |+title|
6148			feature}
6149	Gives the percentage of 'columns' to use for the length of the window
6150	title.  When the title is longer, only the end of the path name is
6151	shown.  A '<' character before the path name is used to indicate this.
6152	Using a percentage makes this adapt to the width of the window.  But
6153	it won't work perfectly, because the actual number of characters
6154	available also depends on the font used and other things in the title
6155	bar.  When 'titlelen' is zero the full path is used.  Otherwise,
6156	values from 1 to 30000 percent can be used.
6157	'titlelen' is also used for the 'titlestring' option.
6158
6159						*'titleold'*
6160'titleold'		string	(default "Thanks for flying Vim")
6161			global
6162			{not in Vi}
6163			{only available when compiled with the |+title|
6164			feature}
6165	This option will be used for the window title when exiting Vim if the
6166	original title cannot be restored.  Only happens if 'title' is on or
6167	'titlestring' is not empty.
6168						*'titlestring'*
6169'titlestring'		string	(default "")
6170			global
6171			{not in Vi}
6172			{not available when compiled without the |+title|
6173			feature}
6174	When this option is not empty, it will be used for the title of the
6175	window.  This happens only when the 'title' option is on.
6176	Only works if the terminal supports setting window titles (currently
6177	Amiga console, Win32 console, all GUI versions and terminals with a
6178	non-empty 't_ts' option).
6179	When Vim was compiled with HAVE_X11 defined, the original title will
6180	be restored if possible |X11|.
6181	When this option contains printf-style '%' items, they will be
6182	expanded according to the rules used for 'statusline'.
6183	Example: >
6184    :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6185    :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6186<	The value of 'titlelen' is used to align items in the middle or right
6187	of the available space.
6188	Some people prefer to have the file name first: >
6189    :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6190<	Note the use of "%{ }" and an expression to get the path of the file,
6191	without the file name.  The "%( %)" constructs are used to add a
6192	separating space only when needed.
6193	NOTE: Use of special characters in 'titlestring' may cause the display
6194	to be garbled (e.g., when it contains a CR or NL character).
6195	{not available when compiled without the |+statusline| feature}
6196
6197				*'toolbar'* *'tb'*
6198'toolbar' 'tb'		string	(default "icons,tooltips")
6199			global
6200			{only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6201			|+GUI_Photon|}
6202	The contents of this option controls various toolbar settings.  The
6203	possible values are:
6204		icons		Toolbar buttons are shown with icons.
6205		text		Toolbar buttons shown with text.
6206		horiz		Icon and text of a toolbar button are
6207				horizontally arranged.  {only in GTK+ 2 GUI}
6208		tooltips	Tooltips are active for toolbar buttons.
6209	Tooltips refer to the popup help text which appears after the mouse
6210	cursor is placed over a toolbar button for a brief moment.
6211
6212	If you want the toolbar to be shown with icons as well as text, do the
6213	following: >
6214		:set tb=icons,text
6215<	Motif and Athena cannot display icons and text at the same time.  They
6216	will show icons if both are requested.
6217
6218	If none of the strings specified in 'toolbar' are valid or if
6219	'toolbar' is empty, this option is ignored.  If you want to disable
6220	the toolbar, you need to set the 'guioptions' option.  For example: >
6221		:set guioptions-=T
6222<	Also see |gui-toolbar|.
6223
6224						*'toolbariconsize'* *'tbis'*
6225'toolbariconsize' 'tbis'	string	(default "small")
6226				global
6227				{not in Vi}
6228				{only in the GTK+ 2 GUI}
6229	Controls the size of toolbar icons.  The possible values are:
6230		tiny		Use tiny toolbar icons.
6231		small		Use small toolbar icons (default).
6232		medium		Use medium-sized toolbar icons.
6233		large		Use large toolbar icons.
6234	The exact dimensions in pixels of the various icon sizes depend on
6235	the current theme.  Common dimensions are large=32x32, medium=24x24,
6236	small=20x20 and tiny=16x16.
6237
6238	If 'toolbariconsize' is empty, the global default size as determined
6239	by user preferences or the current theme is used.
6240
6241			     *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6242'ttybuiltin' 'tbi'	boolean	(default on)
6243			global
6244			{not in Vi}
6245	When on, the builtin termcaps are searched before the external ones.
6246	When off the builtin termcaps are searched after the external ones.
6247	When this option is changed, you should set the 'term' option next for
6248	the change to take effect, for example: >
6249		:set notbi term=$TERM
6250<	See also |termcap|.
6251	Rationale: The default for this option is "on", because the builtin
6252	termcap entries are generally better (many systems contain faulty
6253	xterm entries...).
6254
6255				     *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6256'ttyfast' 'tf'		boolean	(default off, on when 'term' is xterm, hpterm,
6257					sun-cmd, screen, rxvt, dtterm or
6258					iris-ansi; also on when running Vim in
6259					a DOS console)
6260			global
6261			{not in Vi}
6262	Indicates a fast terminal connection.  More characters will be sent to
6263	the screen for redrawing, instead of using insert/delete line
6264	commands.  Improves smoothness of redrawing when there are multiple
6265	windows and the terminal does not support a scrolling region.
6266	Also enables the extra writing of characters at the end of each screen
6267	line for lines that wrap.  This helps when using copy/paste with the
6268	mouse in an xterm and other terminals.
6269
6270						*'ttymouse'* *'ttym'*
6271'ttymouse' 'ttym'	string	(default depends on 'term')
6272			global
6273			{not in Vi}
6274			{only in Unix and VMS, doesn't work in the GUI; not
6275			available when compiled without |+mouse|}
6276	Name of the terminal type for which mouse codes are to be recognized.
6277	Currently these three strings are valid:
6278							*xterm-mouse*
6279	   xterm	xterm-like mouse handling.  The mouse generates
6280			"<Esc>[Mscr", where "scr" is three bytes:
6281				"s"  = button state
6282				"c"  = column plus 33
6283				"r"  = row plus 33
6284	   xterm2	Works like "xterm", but with the xterm reporting the
6285			mouse position while the mouse is dragged.  This works
6286			much faster and more precise.  Your xterm must at
6287			least at patchlevel 88	/ XFree 3.3.3 for this to
6288			work.  See below for how Vim detects this
6289			automatically.
6290							*netterm-mouse*
6291	   netterm	NetTerm mouse handling.  The mouse generates
6292			"<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6293			for the row and column.
6294							*dec-mouse*
6295	   dec		DEC terminal mouse handling.  The mouse generates a
6296			rather complex sequence, starting with "<Esc>[".
6297							*jsbterm-mouse*
6298	   jsbterm	JSB term mouse handling.
6299							*pterm-mouse*
6300	   pterm	QNX pterm mouse handling.
6301
6302	The mouse handling must be enabled at compile time |+mouse_xterm|
6303	|+mouse_dec| |+mouse_netterm|.
6304	Only "xterm"(2) is really recognized.  NetTerm mouse codes are always
6305	recognized, if enabled at compile time.  DEC terminal mouse codes
6306	are recognized if enabled at compile time, and 'ttymouse' is not
6307	"xterm" (because the xterm and dec mouse codes conflict).
6308	This option is automatically set to "xterm", when the 'term' option is
6309	set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6310	or "xterm2" already.  The main use of this option is to set it to
6311	"xterm", when the terminal name doesn't start with "xterm", but it can
6312	handle xterm mouse codes.
6313	The "xterm2" value will be set if the xterm version is reported to be
6314	95 of higher.  This only works when compiled with the |+termresponse|
6315	feature and if |t_RV| is set to the escape sequence to request the
6316	xterm version number.  Otherwise "xterm2" must be set explicitly.
6317	If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6318	t_RV to an empty string: >
6319		:set t_RV=
6320<
6321						*'ttyscroll'* *'tsl'*
6322'ttyscroll' 'tsl'	number	(default 999)
6323			global
6324	Maximum number of lines to scroll the screen.  If there are more lines
6325	to scroll the window is redrawn.  For terminals where scrolling is
6326	very slow and redrawing is not slow this can be set to a small number,
6327	e.g., 3, to speed up displaying.
6328
6329						*'ttytype'* *'tty'*
6330'ttytype' 'tty'		string	(default from $TERM)
6331			global
6332	Alias for 'term', see above.
6333
6334						*'undolevels'* *'ul'*
6335'undolevels' 'ul'	number	(default 100, 1000 for Unix, VMS,
6336						Win32 and OS/2)
6337			global
6338			{not in Vi}
6339	Maximum number of changes that can be undone.  Since undo information
6340	is kept in memory, higher numbers will cause more memory to be used
6341	(nevertheless, a single change can use an unlimited amount of memory).
6342	Set to 0 for Vi compatibility: One level of undo and "u" undoes
6343	itself: >
6344		set ul=0
6345<	But you can also get Vi compatibility by including the 'u' flag in
6346	'cpoptions', and still be able to use CTRL-R to repeat undo.
6347	Set to a negative number for no undo at all: >
6348		set ul=-1
6349<	This helps when you run out of memory for a single change.
6350	Also see |undo-two-ways|.
6351
6352						*'updatecount'* *'uc'*
6353'updatecount' 'uc'	number	(default: 200)
6354			global
6355			{not in Vi}
6356	After typing this many characters the swap file will be written to
6357	disk.  When zero, no swap file will be created at all (see chapter on
6358	recovery |crash-recovery|).  'updatecount' is set to zero by starting
6359	Vim with the "-n" option, see |startup|.  When editing in readonly
6360	mode this option will be initialized to 10000.
6361	The swapfile can be disabled per buffer with |'swapfile'|.
6362	When 'updatecount' is set from zero to non-zero, swap files are
6363	created for all buffers that have 'swapfile' set.  When 'updatecount'
6364	is set to zero, existing swap files are not deleted.
6365	Also see |'swapsync'|.
6366	This option has no meaning in buffers where |'buftype'| is "nofile"
6367	or "nowrite".
6368
6369						*'updatetime'* *'ut'*
6370'updatetime' 'ut'	number	(default 4000)
6371			global
6372			{not in Vi}
6373	If this many milliseconds nothing is typed the swap file will be
6374	written to disk (see |crash-recovery|).  Also used for the
6375	|CursorHold| autocommand event.
6376
6377						*'verbose'* *'vbs'*
6378'verbose' 'vbs'		number	(default 0)
6379			global
6380			{not in Vi, although some versions have a boolean
6381			verbose option}
6382	When bigger than zero, Vim will give messages about what it is doing.
6383	Currently, these messages are given:
6384	>= 1	When the viminfo file is read or written.
6385	>= 2	When a file is ":source"'ed.
6386	>= 5	Every searched tags file.
6387	>= 8	Files for which a group of autocommands is executed.
6388	>= 9	Every executed autocommand.
6389	>= 12	Every executed function.
6390	>= 13	When an exception is thrown, caught, finished, or discarded.
6391	>= 14	Anything pending in a ":finally" clause.
6392	>= 15	Every executed Ex command (truncated at 200 characters).
6393
6394	This option can also be set with the "-V" argument.  See |-V|.
6395	This option is also set by the |:verbose| command.
6396
6397						*'viewdir'* *'vdir'*
6398'viewdir' 'vdir'	string	(default for Amiga, MS-DOS, OS/2 and Win32:
6399							 "$VIM/vimfiles/view",
6400				 for Unix: "~/.vim/view",
6401				 for Macintosh: "$VIM:vimfiles:view"
6402				 for VMS: "sys$login:vimfiles/view"
6403				 for RiscOS: "Choices:vimfiles/view")
6404			global
6405			{not in Vi}
6406			{not available when compiled without the +mksession
6407			feature}
6408	Name of the directory where to store files for |:mkview|.
6409	This option cannot be set from a |modeline| or in the |sandbox|, for
6410	security reasons.
6411
6412						*'viewoptions'* *'vop'*
6413'viewoptions' 'vop'	string	(default: "folds,options,cursor")
6414			global
6415			{not in Vi}
6416			{not available when compiled without the +mksession
6417			feature}
6418	Changes the effect of the |:mkview| command.  It is a comma separated
6419	list of words.  Each word enables saving and restoring something:
6420	   word		save and restore ~
6421	   cursor	cursor position in file and in window
6422	   folds	manually created folds, opened/closed folds and local
6423			fold options
6424	   options	options and mappings local to a window or buffer (not
6425			global values for local options)
6426	   slash	backslashes in file names replaced with forward
6427			slashes
6428	   unix		with Unix end-of-line format (single <NL>), even when
6429			on Windows or DOS
6430
6431	"slash" and "unix" are useful on Windows when sharing view files
6432	with Unix.  The Unix version of Vim cannot source dos format scripts,
6433	but the Windows version of Vim can source unix format scripts.
6434
6435				*'viminfo'* *'vi'* *E526* *E527* *E528*
6436'viminfo' 'vi'		string	(Vi default: "", Vim default for MS-DOS,
6437				   Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6438				   for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6439				   for others: '20,<50,s10,h)
6440			global
6441			{not in Vi}
6442			{not available when compiled without the  |+viminfo|
6443			feature}
6444	When non-empty, the viminfo file is read upon startup and written
6445	when exiting Vim (see |viminfo-file|).  The string should be a comma
6446	separated list of parameters, each consisting of a single character
6447	identifying the particular parameter, followed by a number or string
6448	which specifies the value of that parameter.  If a particular
6449	character is left out, then the default value is used for that
6450	parameter.  The following is a list of the identifying characters and
6451	the effect of their value.
6452	CHAR	VALUE	~
6453	!	When included, save and restore global variables that start
6454		with an uppercase letter, and don't contain a lowercase
6455		letter.  Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
6456		and "_K_L_M" are not.
6457	"	Maximum number of lines saved for each register.  Old name of
6458		the '<' item, with the disadvantage that you need to put a
6459		backslash before the ", otherwise it will be recognized as the
6460		start of a comment!
6461	%	When included, save and restore the buffer list.  If Vim is
6462		started with a file name argument, the buffer list is not
6463		restored.  If Vim is started without a file name argument, the
6464		buffer list is restored from the viminfo file.  Buffers
6465		without a file name and buffers for help files are not written
6466		to the viminfo file.
6467	'	Maximum number of previously edited files for which the marks
6468		are remembered.  This parameter must always be included when
6469		'viminfo' is non-empty.
6470		Including this item also means that the |jumplist| and the
6471		|changelist| are stored in the viminfo file.
6472	/	Maximum number of items in the search pattern history to be
6473		saved.  If non-zero, then the previous search and substitute
6474		patterns are also saved.  When not included, the value of
6475		'history' is used.
6476	:	Maximum number of items in the command-line history to be
6477		saved.  When not included, the value of 'history' is used.
6478	<	Maximum number of lines saved for each register.  If zero then
6479		registers are not saved.  When not included, all lines are
6480		saved.  '"' is the old name for this item.
6481		Also see the 's' item below: limit specified in Kbyte.
6482	@	Maximum number of items in the input-line history to be
6483		saved.  When not included, the value of 'history' is used.
6484	c	When included, convert the text in the viminfo file from the
6485		'encoding' used when writing the file to the current
6486		'encoding'. See |viminfo-encoding|.
6487	f	Whether file marks need to be stored.  If zero, file marks ('0
6488		to '9, 'A to 'Z) are not stored.  When not present or when
6489		non-zero, they are all stored.  '0 is used for the current
6490		cursor position (when exiting or when doing ":wviminfo").
6491	h	Disable the effect of 'hlsearch' when loading the viminfo
6492		file.  When not included, it depends on whether ":nohlsearch"
6493		has been used since the last search command.
6494	n	Name of the viminfo file.  The name must immediately follow
6495		the 'n'.  Must be the last one!  If the "-i" argument was
6496		given when starting Vim, that file name overrides the one
6497		given here with 'viminfo'.  Environment variables are expanded
6498		when opening the file, not when setting the option.
6499	r	Removable media.  The argument is a string (up to the next
6500		',').  This parameter can be given several times.  Each
6501		specifies the start of a path for which no marks will be
6502		stored.  This is to avoid removable media.  For MS-DOS you
6503		could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:".  You can
6504		also use it for temp files, e.g., for Unix: "r/tmp".  Case is
6505		ignored.  Maximum length of each 'r' argument is 50
6506		characters.
6507	s	Maximum size of an item in Kbyte.  If zero then registers are
6508		not saved.  Currently only applies to registers.  The default
6509		"s10" will exclude registers with more than 10 Kbyte of text.
6510		Also see the '<' item above: line count limit.
6511
6512	Example: >
6513	    :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6514<
6515	'50		Marks will be remembered for the last 50 files you
6516			edited.
6517	<1000		Contents of registers (up to 1000 lines each) will be
6518			remembered.
6519	s100		Registers with more than 100 Kbyte text are skipped.
6520	:0		Command-line history will not be saved.
6521	n~/vim/viminfo	The name of the file to use is "~/vim/viminfo".
6522	no /		Since '/' is not specified, the default will be used,
6523			that is, save all of the search history, and also the
6524			previous search and substitute patterns.
6525	no %		The buffer list will not be saved nor read back.
6526	no h		'hlsearch' highlighting will be restored.
6527
6528	When setting 'viminfo' from an empty value you can use |:rviminfo| to
6529	load the contents of the file, this is not done automatically.
6530
6531	This option cannot be set from a |modeline| or in the |sandbox|, for
6532	security reasons.
6533
6534					    *'virtualedit'* *'ve'*
6535'virtualedit' 've'	string	(default "")
6536			global
6537			{not in Vi}
6538			{not available when compiled without the
6539			|+virtualedit| feature}
6540	A comma separated list of these words:
6541	    block	Allow virtual editing in Visual block mode.
6542	    insert	Allow virtual editing in Insert mode.
6543	    all		Allow virtual editing in all modes.
6544	Virtual editing means that the cursor can be positioned where there is
6545	no actual character.  This can be halfway into a Tab or beyond the end
6546	of the line.  Useful for selecting a rectangle in Visual mode and
6547	editing a table.
6548
6549			*'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6550'visualbell' 'vb'	boolean	(default off)
6551			global
6552			{not in Vi}
6553	Use visual bell instead of beeping.  The terminal code to display the
6554	visual bell is given with 't_vb'.  When no beep or flash is wanted,
6555	use ":set vb t_vb=".
6556	Note: When the GUI starts, 't_vb' is reset to its default value.  You
6557	might want to set it again in your |gvimrc|.
6558	In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6559	for 20 msec.  If you want to use a different time, use "<Esc>|40f",
6560	where 40 is the time in msec.
6561	Does not work on the Amiga, you always get a screen flash.
6562	Also see 'errorbells'.
6563
6564						*'warn'* *'nowarn'*
6565'warn'			boolean	(default on)
6566			global
6567	Give a warning message when a shell command is used while the buffer
6568	has been changed.
6569
6570		     *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6571'weirdinvert' 'wiv'	boolean	(default off)
6572			global
6573			{not in Vi}
6574	This option has the same effect as the 't_xs' termcap option.
6575	It is provided for backwards compatibility with version 4.x.
6576	Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6577	vice versa.  Has no effect when the GUI is running.
6578
6579						*'whichwrap'* *'ww'*
6580'whichwrap' 'ww'	string	(Vim default: "b,s", Vi default: "")
6581			global
6582			{not in Vi}
6583	Allow specified keys that move the cursor left/right to move to the
6584	previous/next line when the cursor is on the first/last character in
6585	the line.  Concatenate characters to allow this for these keys:
6586		char   key	  mode	~
6587		 b    <BS>	 Normal and Visual
6588		 s    <Space>	 Normal and Visual
6589		 h    "h"	 Normal and Visual
6590		 l    "l"	 Normal and Visual
6591		 <    <Left>	 Normal and Visual
6592		 >    <Right>	 Normal and Visual
6593		 ~    "~"	 Normal
6594		 [    <Left>	 Insert and Replace
6595		 ]    <Right>	 Insert and Replace
6596	For example: >
6597		:set ww=<,>,[,]
6598<	allows wrap only when cursor keys are used.
6599	When the movement keys are used in combination with a delete or change
6600	operator, the <EOL> also counts for a character.  This makes "3h"
6601	different from "3dh" when the cursor crosses the end of a line.  This
6602	is also true for "x" and "X", because they do the same as "dl" and
6603	"dh".  If you use this, you may also want to use the mapping
6604	":map <BS> X" to make backspace delete the character in front of the
6605	cursor.
6606	When 'l' is included, you get a side effect: "yl" on an empty line
6607	will include the <EOL>, so that "p" will insert a new line.
6608	NOTE: This option is set to the Vi default value when 'compatible' is
6609	set and to the Vim default value when 'compatible' is reset.
6610
6611						*'wildchar'* *'wc'*
6612'wildchar' 'wc'		number	(Vim default: <Tab>, Vi default: CTRL-E)
6613			global
6614			{not in Vi}
6615	Character you have to type to start wildcard expansion in the
6616	command-line, as specified with 'wildmode'.
6617	The character is not recognized when used inside a macro.  See
6618	'wildcharm' for that.
6619	Although 'wc' is a number option, you can set it to a special key: >
6620		:set wc=<Esc>
6621<	NOTE: This option is set to the Vi default value when 'compatible' is
6622	set and to the Vim default value when 'compatible' is reset.
6623
6624						*'wildcharm'* *'wcm'*
6625'wildcharm' 'wcm'	number	(default: none (0))
6626			global
6627			{not in Vi}
6628	'wildcharm' works exactly like 'wildchar', except that it is
6629	recognized when used inside a macro. You can find "spare" command-line
6630	keys suitable for this option by looking at |ex-edit-index|. Normally
6631	you'll never actually type 'wildcharm', just use it in mappings that
6632	automatically invoke completion mode, e.g.: >
6633		:set wcm=<C-Z>
6634		:cmap ss so $vim/sessions/*.vim<C-Z>
6635<	Then after typing :ss you can use CTRL-P & CTRL-N.
6636
6637						*'wildignore'* *'wig'*
6638'wildignore' 'wig'	string	(default "")
6639			global
6640			{not in Vi}
6641			{not available when compiled without the |+wildignore|
6642			feature}
6643	A list of file patterns.  A file that matches with one of these
6644	patterns is ignored when completing file or directory names.
6645	The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6646	Also see 'suffixes'.
6647	Example: >
6648		:set wildignore=*.o,*.obj
6649<	The use of |:set+=| and |:set-=| is preferred when adding or removing
6650	a pattern from the list.  This avoids problems when a future version
6651	uses another default.
6652
6653				*'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6654'wildmenu' 'wmnu'	boolean	(default off)
6655			global
6656			{not in Vi}
6657			{not available if compiled without the |+wildmenu|
6658			feature}
6659	When 'wildmenu' is on, command-line completion operates in an enhanced
6660	mode.  On pressing 'wildchar' (usually <Tab>) to invoke completion,
6661	the possible matches are shown just above the command line, with the
6662	first match highlighted (overwriting the status line, if there is
6663	one).  Keys that show the previous/next match, such as <Tab> or
6664	CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
6665	When 'wildmode' is used, "wildmenu" mode is used where "full" is
6666	specified.  "longest" and "list" do not start "wildmenu" mode.
6667	If there are more matches than can fit in the line, a ">" is shown on
6668	the right and/or a "<" is shown on the left.  The status line scrolls
6669	as needed.
6670	The "wildmenu" mode is abandoned when a key is hit that is not used
6671	for selecting a completion.
6672	While the "wildmenu" is active the following keys have special
6673	meanings:
6674
6675	<Left> <Right>	- select previous/next match (like CTRL-P/CTRL-N)
6676	<Down>		- in filename/menu name completion: move into a
6677			  subdirectory or submenu.
6678	<CR>		- in menu completion, when the cursor is just after a
6679			  dot: move into a submenu.
6680	<Up>		- in filename/menu name completion: move up into
6681			  parent directory or parent menu.
6682
6683	This makes the menus accessible from the console |console-menus|.
6684
6685	If you prefer the <Left> and <Right> keys to move the cursor instead
6686	of selecting a different match, use this: >
6687		:cnoremap <Left> <Space><BS><Left>
6688		:cnoremap <Right> <Space><BS><Right>
6689<
6690	The "WildMenu" highlighting is used for displaying the current match
6691	|hl-WildMenu|.
6692
6693						*'wildmode'* *'wim'*
6694'wildmode' 'wim'	string	(Vim default: "full")
6695			global
6696			{not in Vi}
6697	Completion mode that is used for the character specified with
6698	'wildchar'.  It is a comma separated list of up to four parts.  Each
6699	part specifies what to do for each consecutive use of 'wildchar.  The
6700	first part specifies the behavior for the first use of 'wildchar',
6701	The second part for the second use, etc.
6702	These are the possible values for each part:
6703	""		Complete only the first match.
6704	"full"		Complete the next full match.  After the last match,
6705			the original string is used and then the first match
6706			again.
6707	"longest"	Complete till longest common string.  If this doesn't
6708			result in a longer string, use the next part.
6709	"longest:full"	Like "longest", but also start 'wildmenu' if it is
6710			enabled.
6711	"list"		When more than one match, list all matches.
6712	"list:full"	When more than one match, list all matches and
6713			complete first match.
6714	"list:longest"	When more than one match, list all matches and
6715			complete till longest common string.
6716	When there is only a single match, it is fully completed in all cases.
6717
6718	Examples: >
6719		:set wildmode=full
6720<	Complete first full match, next match, etc. (the default) >
6721		:set wildmode=longest,full
6722<	Complete longest common string, then each full match >
6723		:set wildmode=list:full
6724<	List all matches and complete each full match >
6725		:set wildmode=list,full
6726<	List all matches without completing, then each full match >
6727		:set wildmode=longest,list
6728<	Complete longest common string, then list alternatives.
6729
6730						*'winaltkeys'* *'wak'*
6731'winaltkeys' 'wak'	string	(default "menu")
6732			global
6733			{not in Vi}
6734			{only used in Win32, Motif, GTK and Photon GUI}
6735	Some GUI versions allow the access to menu entries by using the ALT
6736	key in combination with a character that appears underlined in the
6737	menu.  This conflicts with the use of the ALT key for mappings and
6738	entering special characters.  This option tells what to do:
6739	  no	Don't use ALT keys for menus.  ALT key combinations can be
6740		mapped, but there is no automatic handling.  This can then be
6741		done with the |:simalt| command.
6742	  yes	ALT key handling is done by the windowing system.  ALT key
6743		combinations cannot be mapped.
6744	  menu	Using ALT in combination with a character that is a menu
6745		shortcut key, will be handled by the windowing system.  Other
6746		keys can be mapped.
6747	If the menu is disabled by excluding 'm' from 'guioptions', the ALT
6748	key is never used for the menu.
6749	In the Win32 version, the <F10> key is handled like this too, since
6750	Windows uses it to select a menu.
6751
6752						*'winheight'* *'wh'* *E591*
6753'winheight' 'wh'	number	(default 1)
6754			global
6755			{not in Vi}
6756			{not available when compiled without the +windows
6757			feature}
6758	Minimal number of lines for the current window.  This is not a hard
6759	minimum, Vim will use fewer lines if there is not enough room.  If the
6760	current window is smaller, its size is increased, at the cost of the
6761	height of other windows.  Set it to 999 to make the current window
6762	always fill the screen (although this has the drawback that ":all"
6763	will create only two windows).  Set it to a small number for normal
6764	editing.
6765	Minimum value is 1.
6766	The height is not adjusted after one of the commands to change the
6767	height of the current window.
6768	'winheight' applies to the current window.  Use 'winminheight' to set
6769	the minimal height for other windows.
6770
6771			*'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
6772'winfixheight' 'wfh'	boolean	(default off)
6773			local to window
6774			{not in Vi}
6775			{not available when compiled without the +windows
6776			feature}
6777	Keep the window height when windows are opened or closed and
6778	'equalalways' is set.  Set by default for the |preview-window| and
6779	|quickfix-window|.
6780	The height may be changed anyway when running out of room.
6781
6782						*'winminheight'* *'wmh'*
6783'winminheight' 'wmh'	number	(default 1)
6784			global
6785			{not in Vi}
6786			{not available when compiled without the +windows
6787			feature}
6788	The minimal height of a window, when it's not the current window.
6789	This is a hard minimum, windows will never become smaller.
6790	When set to zero, windows may be "squashed" to zero lines (i.e. just a
6791	status bar) if necessary.  They will return to at least one line when
6792	they become active (since the cursor has to have somewhere to go.)
6793	Use 'winheight' to set the minimal height of the current window.
6794	This option is only checked when making a window smaller.  Don't use a
6795	large number, it will cause errors when opening more than a few
6796	windows.  A value of 0 to 3 is reasonable.
6797
6798						*'winminwidth'* *'wmw'*
6799'winminwidth' 'wmw'	number	(default 1)
6800			global
6801			{not in Vi}
6802			{not available when compiled without the +vertsplit
6803			feature}
6804	The minimal width of a window, when it's not the current window.
6805	This is a hard minimum, windows will never become smaller.
6806	When set to zero, windows may be "squashed" to zero columns (i.e. just
6807	a vertical separator) if necessary.  They will return to at least one
6808	line when they become active (since the cursor has to have somewhere
6809	to go.)
6810	Use 'winwidth' to set the minimal width of the current window.
6811	This option is only checked when making a window smaller.  Don't use a
6812	large number, it will cause errors when opening more than a few
6813	windows.  A value of 0 to 12 is reasonable.
6814
6815						*'winwidth'* *'wiw'* *E592*
6816'winwidth' 'wiw'	number	(default 20)
6817			global
6818			{not in Vi}
6819			{not available when compiled without the +vertsplit
6820			feature}
6821	Minimal number of columns for the current window.  This is not a hard
6822	minimum, Vim will use fewer columns if there is not enough room.  If
6823	the current window is smaller, its size is increased, at the cost of
6824	the width of other windows.  Set it to 999 to make the current window
6825	always fill the screen.  Set it to a small number for normal editing.
6826	The width is not adjusted after one of the commands to change the
6827	width of the current window.
6828	'winwidth' applies to the current window.  Use 'winminwidth' to set
6829	the minimal width for other windows.
6830
6831						*'wrap'* *'nowrap'*
6832'wrap'			boolean	(default on)
6833			local to window
6834			{not in Vi}
6835	This option changes how text is displayed.  It doesn't change the text
6836	in the buffer, see 'textwidth' for that.
6837	When on, lines longer than the width of the window will wrap and
6838	displaying continues on the next line.  When off lines will not wrap
6839	and only part of long lines will be displayed.  When the cursor is
6840	moved to a part that is not shown, the screen will scroll
6841	horizontally.
6842	The line will be broken in the middle of a word if necessary.  See
6843	'linebreak' to get the break at a word boundary.
6844	To make scrolling horizontally a bit more useful, try this: >
6845		:set sidescroll=5
6846		:set listchars+=precedes:<,extends:>
6847<	See 'sidescroll', 'listchars' and |wrap-off|.
6848
6849						*'wrapmargin'* *'wm'*
6850'wrapmargin' 'wm'	number	(default 0)
6851			local to buffer
6852	Number of characters from the right window border where wrapping
6853	starts.  When typing text beyond this limit, an <EOL> will be inserted
6854	and inserting continues on the next line.
6855	Options that add a margin, such as 'number' and 'foldcolumn', cause
6856	the text width to be further reduced.  This is Vi compatible.
6857	When 'textwidth' is non-zero, this option is not used.
6858	See also 'formatoptions' and |ins-textwidth|.  {Vi: works differently
6859	and less usefully}
6860
6861				   *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
6862'wrapscan' 'ws'		boolean	(default on)			*E384* *E385*
6863			global
6864	Searches wrap around the end of the file.
6865
6866						   *'write'* *'nowrite'*
6867'write'			boolean	(default on)
6868			global
6869			{not in Vi}
6870	Allows writing files.  When not set, writing a file is not allowed.
6871	Can be used for a view-only mode, where modifications to the text are
6872	still allowed.  Can be reset with the |-m| or |-M| command line
6873	argument.  Filtering text is still possible, even though this requires
6874	writing a temporary file.
6875
6876				   *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
6877'writeany' 'wa'		boolean	(default off)
6878			global
6879	Allows writing to any file with no need for "!" override.
6880
6881			     *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
6882'writebackup' 'wb'	boolean	(default on with |+writebackup| feature, off
6883					otherwise)
6884			global
6885			{not in Vi}
6886	Make a backup before overwriting a file.  The backup is removed after
6887	the file was successfully written, unless the 'backup' option is
6888	also on.  Reset this option if your file system is almost full.  See
6889	|backup-table| for another explanation.
6890	When the 'backupskip' pattern matches, a backup is not made anyway.
6891	NOTE: This option is set to the default value when 'compatible' is
6892	set.
6893
6894						*'writedelay'* *'wd'*
6895'writedelay' 'wd'	number	(default 0)
6896			global
6897			{not in Vi}
6898	The number of microseconds to wait for each character sent to the
6899	screen.  When non-zero, characters are sent to the terminal one by
6900	one.  For MS-DOS pcterm this does not work.  For debugging purposes.
6901
6902 vim:tw=78:ts=8:ft=help:norl:
6903