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