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