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