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