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