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