blob: 2592850211d5178ae3466ceffc55fcf536fb4dd8 [file] [log] [blame]
Bram Moolenaar98692072006-02-04 00:57:42 +00001*options.txt* For Vim version 7.0aa. Last change: 2006 Feb 02
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==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
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
Bram Moolenaara5792f52005-11-23 21:25:05 +000079 are removed. When adding a flag that was already
80 present the option value doesn't change.
Bram Moolenaar071d4272004-06-13 20:20:40 +000081< Also see |:set-args| above.
82 {not in Vi}
83
84:se[t] {option}^={value} *:set^=*
85 Multiply the {value} to a number option, or prepend
86 the {value} to a string option. When the option is a
87 comma separated list, a comma is added, unless the
88 value was empty.
89 Also see |:set-args| above.
90 {not in Vi}
91
92:se[t] {option}-={value} *:set-=*
93 Subtract the {value} from a number option, or remove
94 the {value} from a string option, if it is there.
95 If the {value} is not found in a string option, there
96 is no error or warning. When the option is a comma
97 separated list, a comma is deleted, unless the option
98 becomes empty.
99 When the option is a list of flags, {value} must be
100 exactly as they appear in the option. Remove flags
101 one by one to avoid problems.
102 Also see |:set-args| above.
103 {not in Vi}
104
105The {option} arguments to ":set" may be repeated. For example: >
106 :set ai nosi sw=3 ts=3
107If you make an error in one of the arguments, an error message will be given
108and the following arguments will be ignored.
109
110 *:set-verbose*
111When 'verbose' is non-zero, displaying an option value will also tell where it
112was last set. Example: >
113 :verbose set shiftwidth cindent?
114 shiftwidth=4
115 Last set from modeline
116 cindent
117 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
118This is only done when specific option values are requested, not for ":set
119all" or ":set" without an argument.
120When the option was set by hand there is no "Last set" message. There is only
121one value for all local options with the same name. Thus the message applies
122to the option name, not necessarily its value.
123When the option was set while executing a function, user command or
124autocommand, the script in which it was defined is reported.
125Note that an option may also have been set as a side effect of setting
126'compatible'.
127{not available when compiled without the +eval feature}
128
129 *:set-termcap* *E522*
130For {option} the form "t_xx" may be used to set a termcap option. This will
131override the value from the termcap. You can then use it in a mapping. If
132the "xx" part contains special characters, use the <t_xx> form: >
133 :set <t_#4>=^[Ot
134This can also be used to translate a special code for a normal key. For
135example, if Alt-b produces <Esc>b, use this: >
136 :set <M-b>=^[b
137(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
138The advantage over a mapping is that it works in all situations.
139
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000140The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
141security reasons.
142
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000144at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145"set all" probably does not fit on the screen, causing Vim to give the
146|more-prompt|.
147
148 *option-backslash*
149To include white space in a string option value it has to be preceded with a
150backslash. To include a backslash you have to use two. Effectively this
151means that the number of backslashes in an option value is halved (rounded
152down).
153A few examples: >
154 :set tags=tags\ /usr/tags results in "tags /usr/tags"
155 :set tags=tags\\,file results in "tags\,file"
156 :set tags=tags\\\ file results in "tags\ file"
157
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000158The "|" character separates a ":set" command from a following command. To
159include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160'titlestring' option to "hi|there": >
161 :set titlestring=hi\|there
162This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
163 :set titlestring=hi|set iconstring=there
164
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000165Similarly, the double quote character starts a comment. To include the '"' in
166the option value, use '\"' instead. This example sets the 'titlestring'
167option to 'hi "there"': >
168 :set titlestring=hi\ \"there\"
169
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000170For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171precise: For options that expect a file name (those where environment
172variables are expanded) a backslash before a normal file name character is not
173removed. But a backslash before a special character (space, backslash, comma,
174etc.) is used like explained above.
175There is one special situation, when the value starts with "\\": >
176 :set dir=\\machine\path results in "\\machine\path"
177 :set dir=\\\\machine\\path results in "\\machine\path"
178 :set dir=\\path\\file results in "\\path\file" (wrong!)
179For the first one the start is kept, but for the second one the backslashes
180are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182result which is probably not what you want. Avoid it.
183
184 *add-option-flags* *remove-option-flags*
185 *E539* *E550* *E551* *E552*
186Some options are a list of flags. When you want to add a flag to such an
187option, without changing the existing ones, you can do it like this: >
188 :set guioptions+=a
189Remove a flag from an option like this: >
190 :set guioptions-=a
191This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000192Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
194doesn't appear.
195
196 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000197Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198environment variable exists the '$' and the following environment variable
199name is replaced with its value. If it does not exist the '$' and the name
200are not modified. Any non-id character (not a letter, digit or '_') may
201follow the environment variable name. That character and what follows is
202appended to the value of the environment variable. Examples: >
203 :set term=$TERM.new
204 :set path=/usr/$INCLUDE,$HOME/include,.
205When adding or removing a string from an option with ":set opt-=val" or ":set
206opt+=val" the expansion is done before the adding or removing.
207
208
209Handling of local options *local-options*
210
211Some of the options only apply to a window or buffer. Each window or buffer
212has its own copy of this option, thus can each have their own value. This
213allows you to set 'list' in one window but not in another. And set
214'shiftwidth' to 3 in one buffer and 4 in another.
215
216The following explains what happens to these local options in specific
217situations. You don't really need to know all of this, since Vim mostly uses
218the option values you would expect. Unfortunately, doing what the user
219expects is a bit complicated...
220
221When splitting a window, the local options are copied to the new window. Thus
222right after the split the contents of the two windows look the same.
223
224When editing a new buffer, its local option values must be initialized. Since
225the local options of the current buffer might be specifically for that buffer,
226these are not used. Instead, for each buffer-local option there also is a
227global value, which is used for new buffers. With ":set" both the local and
228global value is changed. With "setlocal" only the local value is changed,
229thus this value is not used when editing a new buffer.
230
231When editing a buffer that has been edited before, the last used window
232options are used again. If this buffer has been edited in this window, the
233values from back then are used. Otherwise the values from the window where
234the buffer was edited last are used.
235
236It's possible to set a local window option specifically for a type of buffer.
237When you edit another buffer in the same window, you don't want to keep
238using these local window options. Therefore Vim keeps a global value of the
239local window options, which is used when editing another buffer. Each window
240has its own copy of these values. Thus these are local to the window, but
241global to all buffers in the window. With this you can do: >
242 :e one
243 :set list
244 :e two
245Now the 'list' option will also be set in "two", since with the ":set list"
246command you have also set the global value. >
247 :set nolist
248 :e one
249 :setlocal list
250 :e two
251Now the 'list' option is not set, because ":set nolist" resets the global
252value, ":setlocal list" only changes the local value and ":e two" gets the
253global value. Note that if you do this next: >
254 :e one
255You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000256"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257
258 *:setl* *:setlocal*
259:setl[ocal] ... Like ":set" but set only the value local to the
260 current buffer or window. Not all options have a
261 local value. If the option does not have a local
262 value the global value is set.
263 With the "all" argument: display all local option's
264 local values.
265 Without argument: Display all local option's local
266 values which are different from the default.
267 When displaying a specific local option, show the
268 local value. For a global option the global value is
269 shown (but that might change in the future).
270 {not in Vi}
271
272:setl[ocal] {option}< Set the local value of {option} to its global value.
273 {not in Vi}
274
275 *:setg* *:setglobal*
276:setg[lobal] ... Like ":set" but set only the global value for a local
277 option without changing the local value.
278 When displaying an option, the global value is shown.
279 With the "all" argument: display all local option's
280 global values.
281 Without argument: display all local option's global
282 values which are different from the default.
283 {not in Vi}
284
285For buffer-local and window-local options:
286 Command global value local value ~
287 :set option=value set set
288 :setlocal option=value - set
289:setglobal option=value set -
290 :set option? - display
291 :setlocal option? - display
292:setglobal option? display -
293
294
295Global options with a local value *global-local*
296
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000297Options are global when you mostly use one value for all buffers and windows.
298For some global options it's useful to sometimes have a different local value.
299You can set the local value with ":setlocal". That buffer or window will then
300use the local value, while other buffers and windows continue using the global
301value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302
303For example, you have two windows, both on C source code. They use the global
304'makeprg' option. If you do this in one of the two windows: >
305 :set makeprg=gmake
306then the other window will switch to the same value. There is no need to set
307the 'makeprg' option in the other C source window too.
308However, if you start editing a Perl file in a new window, you want to use
309another 'makeprog' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000310files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 :setlocal makeprg=perlmake
312You can switch back to using the global value by making the local value empty: >
313 :setlocal makeprg=
314This only works for a string option. For a boolean option you need to use the
315"<" flag, like this: >
316 :setlocal autoread<
317Note that for non-boolean options using "<" copies the global value to the
318local value, it doesn't switch back to using the global value (that matters
319when changing the global value later).
320Note: In the future more global options can be made global-local. Using
321":setlocal" on a global option might work differently then.
322
323
324Setting the filetype
325
326:setf[iletype] {filetype} *:setf* *:setfiletype*
327 Set the 'filetype' option to {filetype}, but only if
328 not done yet in a sequence of (nested) autocommands.
329 This is short for: >
330 :if !did_filetype()
331 : setlocal filetype={filetype}
332 :endif
333< This command is used in a filetype.vim file to avoid
334 setting the 'filetype' option twice, causing different
335 settings and syntax files to be loaded.
336 {not in Vi}
337
338:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
339:opt[ions] Open a window for viewing and setting all options.
340 Options are grouped by function.
341 Offers short help for each option. Hit <CR> on the
342 short help to open a help window with more help for
343 the option.
344 Modify the value of the option and hit <CR> on the
345 "set" line to set the new value. For window and
346 buffer specific options, the last accessed window is
347 used to set the option value in, unless this is a help
348 window, in which case the window below help window is
349 used (skipping the option-window).
350 {not available when compiled without the |+eval| or
351 |+autocmd| features}
352
353 *$HOME*
354Using "~" is like using "$HOME", but it is only recognized at the start of an
355option and after a space or comma.
356
357On Unix systems "~user" can be used too. It is replaced by the home directory
358of user "user". Example: >
359 :set path=~mool/include,/usr/include,.
360
361On Unix systems the form "${HOME}" can be used too. The name between {} can
362contain non-id characters then. Note that if you want to use this for the
363"gf" command, you need to add the '{' and '}' characters to 'isfname'.
364
365NOTE: expanding environment variables and "~/" is only done with the ":set"
366command, not when assigning a value to an option with ":let".
367
368
369Note the maximum length of an expanded option is limited. How much depends on
370the system, mostly it is something like 256 or 1024 characters.
371
372 *:fix* *:fixdel*
373:fix[del] Set the value of 't_kD':
374 't_kb' is 't_kD' becomes ~
375 CTRL-? CTRL-H
376 not CTRL-? CTRL-?
377
378 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
379
380 If your delete key terminal code is wrong, but the
381 code for backspace is alright, you can put this in
382 your .vimrc: >
383 :fixdel
384< This works no matter what the actual code for
385 backspace is.
386
387 If the backspace key terminal code is wrong you can
388 use this: >
389 :if &term == "termname"
390 : set t_kb=^V<BS>
391 : fixdel
392 :endif
393< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000394 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 with your terminal name.
396
397 If your <Delete> key sends a strange key sequence (not
398 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
399 :if &term == "termname"
400 : set t_kD=^V<Delete>
401 :endif
402< Where "^V" is CTRL-V and "<Delete>" is the delete key
403 (don't type eight characters!). Replace "termname"
404 with your terminal name.
405
406 *Linux-backspace*
407 Note about Linux: By default the backspace key
408 produces CTRL-?, which is wrong. You can fix it by
409 putting this line in your rc.local: >
410 echo "keycode 14 = BackSpace" | loadkeys
411<
412 *NetBSD-backspace*
413 Note about NetBSD: If your backspace doesn't produce
414 the right code, try this: >
415 xmodmap -e "keycode 22 = BackSpace"
416< If this works, add this in your .Xmodmap file: >
417 keysym 22 = BackSpace
418< You need to restart for this to take effect.
419
420==============================================================================
4212. Automatically setting options *auto-setting*
422
423Besides changing options with the ":set" command, there are three alternatives
424to set options automatically for one or more files:
425
4261. When starting Vim initializations are read from various places. See
427 |initialization|. Most of them are performed for all editing sessions,
428 and some of them depend on the directory where Vim is started.
429 You can create an initialization file with |:mkvimrc|, |:mkview| and
430 |:mksession|.
4312. If you start editing a new file, the automatic commands are executed.
432 This can be used to set options for files matching a particular pattern and
433 many other things. See |autocommand|.
4343. If you start editing a new file, and the 'modeline' option is on, a
435 number of lines at the beginning and end of the file are checked for
436 modelines. This is explained here.
437
438 *modeline* *vim:* *vi:* *ex:* *E520*
439There are two forms of modelines. The first form:
440 [text]{white}{vi:|vim:|ex:}[white]{options}
441
442[text] any text or empty
443{white} at least one blank character (<Space> or <Tab>)
444{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
445[white] optional white space
446{options} a list of option settings, separated with white space or ':',
447 where each part between ':' is the argument for a ":set"
448 command
449
450Example: >
451 vi:noai:sw=3 ts=6
452
453The second form (this is compatible with some versions of Vi):
454
455 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
456
457[text] any text or empty
458{white} at least one blank character (<Space> or <Tab>)
459{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
460[white] optional white space
461se[t] the string "set " or "se " (note the space)
462{options} a list of options, separated with white space, which is the
463 argument for a ":set" command
464: a colon
465[text] any text or empty
466
467Example: >
468 /* vim: set ai tw=75: */
469
470The white space before {vi:|vim:|ex:} is required. This minimizes the chance
471that a normal word like "lex:" is caught. There is one exception: "vi:" and
472"vim:" can also be at the start of the line (for compatibility with version
4733.0). Using "ex:" at the start of the line will be ignored (this could be
474short for "example:").
475
476 *modeline-local*
477The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000478buffer and window that contain the file. Although it's possible to set global
479options from a modeline, this is unusual. If you have two windows open and
480the files in it set the same global option to a different value, the result
481depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000482
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000483When editing a file that was already loaded, only the window-local options
484from the modeline are used. Thus if you manually changed a buffer-local
485option after opening the file, it won't be changed if you edit the same buffer
486in another window. But window-local options will be set.
487
Bram Moolenaar071d4272004-06-13 20:20:40 +0000488 *modeline-version*
489If the modeline is only to be used for some versions of Vim, the version
490number can be specified where "vim:" is used:
491 vim{vers}: version {vers} or later
492 vim<{vers}: version before {vers}
493 vim={vers}: version {vers}
494 vim>{vers}: version after {vers}
495{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
496For example, to use a modeline only for Vim 6.0 and later: >
497 /* vim600: set foldmethod=marker: */
498To use a modeline for Vim before version 5.7: >
499 /* vim<570: set sw=4: */
500There can be no blanks between "vim" and the ":".
501
502
503The number of lines that are checked can be set with the 'modelines' option.
504If 'modeline' is off or 'modelines' is 0 no lines are checked.
505
506Note that for the first form all of the rest of the line is used, thus a line
507like: >
508 /* vi:ts=4: */
509will give an error message for the trailing "*/". This line is OK: >
510 /* vi:set ts=4: */
511
512If an error is detected the rest of the line is skipped.
513
514If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000515backslash in front of the ':' will be removed. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516 /* vi:set dir=c\:\tmp: */
517This sets the 'dir' option to "c:\tmp". Only a single backslash before the
518':' is removed. Thus to include "\:" you have to specify "\\:".
519
520No other commands than "set" are supported, for security reasons (somebody
521might create a Trojan horse text file with modelines).
522
523Hint: If you would like to do something else than setting an option, you could
524define an autocommand that checks the file for a specific string. For
525example: >
526 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
527And define a function SetVar() that does something with the line containing
528"VAR".
529
530==============================================================================
5313. Options summary *option-summary*
532
533In the list below all the options are mentioned with their full name and with
534an abbreviation if there is one. Both forms may be used.
535
536In this document when a boolean option is "set" that means that ":set option"
537is entered. When an option is "reset", ":set nooption" is used.
538
539For some options there are two default values: The "Vim default", which is
540used when 'compatible' is not set, and the "Vi default", which is used when
541'compatible' is set.
542
543Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000544are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545different value in each window. For example the 'list' option can be set in
546one window and reset in another for the same text, giving both types of view
547at the same time. There are a few options that are specific to a certain
548file. These can have a different value for each file or buffer. For example
549the 'textwidth' option can be 78 for a normal text file and 0 for a C
550program.
551
552 global one option for all buffers and windows
553 local to window each window has its own copy of this option
554 local to buffer each buffer has its own copy of this option
555
556When creating a new window the option values from the currently active window
557are used as a default value for the window-specific options. For the
558buffer-specific options this depends on the 's' and 'S' flags in the
559'cpoptions' option. If 's' is included (which is the default) the values for
560buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000561first entered. If 'S' is present the options are copied each time the buffer
562is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563present, the options are copied from the currently active buffer when the
564buffer is created.
565
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000566Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000568Not all options are supported in all versions. This depends on the supported
569features and sometimes on the system. A remark about this is in curly braces
570below. When an option is not supported it may still be set without getting an
571error, this is called a hidden option. You can't get the value of a hidden
572option though, it is not stored.
573
574To test if option "foo" can be used with ":set" use something like this: >
575 if exists('&foo')
576This also returns true for a hidden option. To test if option "foo" is really
577supported use something like this: >
578 if exists('+foo')
579<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580 *E355*
581A jump table for the options with a short description can be found at |Q_op|.
582
583 *'aleph'* *'al'* *aleph* *Aleph*
584'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
585 global
586 {not in Vi}
587 {only available when compiled with the |+rightleft|
588 feature}
589 The ASCII code for the first letter of the Hebrew alphabet. The
590 routine that maps the keyboard in Hebrew mode, both in Insert mode
591 (when hkmap is set) and on the command-line (when hitting CTRL-_)
592 outputs the Hebrew characters in the range [aleph..aleph+26].
593 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
594 See |rileft.txt|.
595
596 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
597'allowrevins' 'ari' boolean (default off)
598 global
599 {not in Vi}
600 {only available when compiled with the |+rightleft|
601 feature}
602 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
603 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
604 into reverse Insert mode, and don't know how to get out. See
605 'revins'.
606 NOTE: This option is reset when 'compatible' is set.
607
608 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
609'altkeymap' 'akm' boolean (default off)
610 global
611 {not in Vi}
612 {only available when compiled with the |+farsi|
613 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000614 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 the keyboard map between Farsi and English, when 'allowrevins' set.
616
Bram Moolenaar582fd852005-03-28 20:58:01 +0000617 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618 is useful to start the Vim in native mode i.e. English (left-to-right
619 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621
622 *'ambiwidth'* *'ambw'*
623'ambiwidth' 'ambw' string (default: "single")
624 global
625 {not in Vi}
626 {only available when compiled with the |+multi_byte|
627 feature}
628 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
629 Tells Vim what to do with characters with East Asian Width Class
630 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
631 letters, Cyrillic letters).
632
633 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000634 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635 expected by most users.
636 "double": Use twice the width of ASCII characters.
637
638 There are a number of CJK fonts for which the width of glyphs for
639 those characters are solely based on how many octets they take in
640 legacy/traditional CJK encodings. In those encodings, Euro,
641 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000642 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000644 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 Vim is running inside a terminal (emulators) that uses a CJK font
646 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
647 this option should be set to "double" to match the width perceived
648 by Vim with the width of glyphs in the font. Perhaps it also has
649 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
650 when the system locale is set to one of CJK locales. See Unicode
651 Standard Annex #11 (http://www.unicode.org/reports/tr11).
652
653 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
654'antialias' 'anti' boolean (default: off)
655 global
656 {not in Vi}
657 {only available when compiled with GUI enabled
658 on Mac OS X}
659 This option only has an effect in the GUI version of Vim on Mac OS X
660 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
661 which can be easier to read at certain sizes on certain displays.
662 Setting this option can sometimes cause problems if 'guifont' is set
663 to its default (empty string).
664
665 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
666'autochdir' 'acd' boolean (default off)
667 global
668 {not in Vi}
669 {only available when compiled with the
670 |+netbeans_intg| or |+sun_workshop| feature}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000671 When on, Vim will change the current working directory whenever you
672 open a file, switch buffers, delete a buffer or open/close a window.
673 It will change to the directory containing the file which was opened
674 or selected.
675 This option is provided for backward compatibility with the Vim
676 released with Sun ONE Studio 4 Enterprise Edition.
677 Note: When this option is on some plugins may not work. The directory
678 browser sets if off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679
680 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
681'arabic' 'arab' boolean (default off)
682 local to window
683 {not in Vi}
684 {only available when compiled with the |+arabic|
685 feature}
686 This option can be set to start editing Arabic text.
687 Setting this option will:
688 - Set the 'rightleft' option, unless 'termbidi' is set.
689 - Set the 'arabicshape' option, unless 'termbidi' is set.
690 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
691 between typing English and Arabic key mapping.
692 - Set the 'delcombine' option
693 Note that 'encoding' must be "utf-8" for working with Arabic text.
694
695 Resetting this option will:
696 - Reset the 'rightleft' option.
697 - Disable the use of 'keymap' (without changing its value).
698 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
699 option.
700 Also see |arabic.txt|.
701
702 *'arabicshape'* *'arshape'*
703 *'noarabicshape'* *'noarshape'*
704'arabicshape' 'arshape' boolean (default on)
705 global
706 {not in Vi}
707 {only available when compiled with the |+arabic|
708 feature}
709 When on and 'termbidi' is off, the required visual character
710 corrections that need to take place for displaying the Arabic language
711 take affect. Shaping, in essence, gets enabled; the term is a broad
712 one which encompasses:
713 a) the changing/morphing of characters based on their location
714 within a word (initial, medial, final and stand-alone).
715 b) the enabling of the ability to compose characters
716 c) the enabling of the required combining of some characters
717 When disabled the character display reverts back to each character's
718 true stand-alone form.
719 Arabic is a complex language which requires other settings, for
720 further details see |arabic.txt|.
721
722 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
723'autoindent' 'ai' boolean (default off)
724 local to buffer
725 Copy indent from current line when starting a new line (typing <CR>
726 in Insert mode or when using the "o" or "O" command). If you do not
727 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000728 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
729 another line has the same effect, unless the 'I' flag is included in
730 'cpoptions'.
731 When autoindent is on, formatting (with the "gq" command or when you
732 reach 'textwidth' in Insert mode) uses the indentation of the first
733 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734 When 'smartindent' or 'cindent' is on the indent is changed in
735 a different way.
736 The 'autoindent' option is reset when the 'paste' option is set.
737 {small difference from Vi: After the indent is deleted when typing
738 <Esc> or <CR>, the cursor position when moving up or down is after the
739 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
740
741 *'autoread'* *'ar'* *'noautoread'* *'noar'*
742'autoread' 'ar' boolean (default off)
743 global or local to buffer |global-local|
744 {not in Vi}
745 When a file has been detected to have been changed outside of Vim and
746 it has not been changed inside of Vim, automatically read it again.
747 When the file has been deleted this is not done. |timestamp|
748 If this option has a local value, use this command to switch back to
749 using the global value: >
750 :set autoread<
751<
752 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
753'autowrite' 'aw' boolean (default off)
754 global
755 Write the contents of the file, if it has been modified, on each
756 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
757 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
758 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
759 Note that for some commands the 'autowrite' option is not used, see
760 'autowriteall' for that.
761
762 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
763'autowriteall' 'awa' boolean (default off)
764 global
765 {not in Vi}
766 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
767 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
768 Setting this option also implies that Vim behaves like 'autowrite' has
769 been set.
770
771 *'background'* *'bg'*
772'background' 'bg' string (default "dark" or "light")
773 global
774 {not in Vi}
775 When set to "dark", Vim will try to use colors that look good on a
776 dark background. When set to "light", Vim will try to use colors that
777 look good on a light background. Any other value is illegal.
778 Vim tries to set the default value according to the terminal used.
779 This will not always be correct.
780 Setting this option does not change the background color, it tells Vim
781 what the background color looks like. For changing the background
782 color, see |:hi-normal|.
783
784 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000785 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 change.
787 When a color scheme is loaded (the "colors_name" variable is set)
788 setting 'background' will cause the color scheme to be reloaded. If
789 the color scheme adjusts to the value of 'background' this will work.
790 However, if the color scheme sets 'background' itself the effect may
791 be undone. First delete the "colors_name" variable when needed.
792
793 When setting 'background' to the default value with: >
794 :set background&
795< Vim will guess the value. In the GUI this should work correctly,
796 in other cases Vim might not be able to guess the right value.
797
798 When starting the GUI, the default value for 'background' will be
799 "light". When the value is not set in the .gvimrc, and Vim detects
800 that the background is actually quite dark, 'background' is set to
801 "dark". But this happens only AFTER the .gvimrc file has been read
802 (because the window needs to be opened to find the actual background
803 color). To get around this, force the GUI window to be opened by
804 putting a ":gui" command in the .gvimrc file, before where the value
805 of 'background' is used (e.g., before ":syntax on").
806 Normally this option would be set in the .vimrc file. Possibly
807 depending on the terminal name. Example: >
808 :if &term == "pcterm"
809 : set background=dark
810 :endif
811< When this option is set, the default settings for the highlight groups
812 will change. To use other settings, place ":highlight" commands AFTER
813 the setting of the 'background' option.
814 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
815 to select the colors for syntax highlighting. After changing this
816 option, you must load syntax.vim again to see the result. This can be
817 done with ":syntax on".
818
819 *'backspace'* *'bs'*
820'backspace' 'bs' string (default "")
821 global
822 {not in Vi}
823 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
824 mode. This is a list of items, separated by commas. Each item allows
825 a way to backspace over something:
826 value effect ~
827 indent allow backspacing over autoindent
828 eol allow backspacing over line breaks (join lines)
829 start allow backspacing over the start of insert; CTRL-W and CTRL-U
830 stop once at the start of insert.
831
832 When the value is empty, Vi compatible backspacing is used.
833
834 For backwards compatibility with version 5.4 and earlier:
835 value effect ~
836 0 same as ":set backspace=" (Vi compatible)
837 1 same as ":set backspace=indent,eol"
838 2 same as ":set backspace=indent,eol,start"
839
840 See |:fixdel| if your <BS> or <Del> key does not do what you want.
841 NOTE: This option is set to "" when 'compatible' is set.
842
843 *'backup'* *'bk'* *'nobackup'* *'nobk'*
844'backup' 'bk' boolean (default off)
845 global
846 {not in Vi}
847 Make a backup before overwriting a file. Leave it around after the
848 file has been successfully written. If you do not want to keep the
849 backup file, but you do want a backup while the file is being
850 written, reset this option and set the 'writebackup' option (this is
851 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000852 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 |backup-table| for more explanations.
854 When the 'backupskip' pattern matches, a backup is not made anyway.
855 When 'patchmode' is set, the backup may be renamed to become the
856 oldest version of a file.
857 NOTE: This option is reset when 'compatible' is set.
858
859 *'backupcopy'* *'bkc'*
860'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
861 global
862 {not in Vi}
863 When writing a file and a backup is made, this option tells how it's
864 done. This is a comma separated list of words.
865
866 The main values are:
867 "yes" make a copy of the file and overwrite the original one
868 "no" rename the file and write a new one
869 "auto" one of the previous, what works best
870
871 Extra values that can be combined with the ones above are:
872 "breaksymlink" always break symlinks when writing
873 "breakhardlink" always break hardlinks when writing
874
875 Making a copy and overwriting the original file:
876 - Takes extra time to copy the file.
877 + When the file has special attributes, is a (hard/symbolic) link or
878 has a resource fork, all this is preserved.
879 - When the file is a link the backup will have the name of the link,
880 not of the real file.
881
882 Renaming the file and writing a new one:
883 + It's fast.
884 - Sometimes not all attributes of the file can be copied to the new
885 file.
886 - When the file is a link the new file will not be a link.
887
888 The "auto" value is the middle way: When Vim sees that renaming file
889 is possible without side effects (the attributes can be passed on and
890 and the file is not a link) that is used. When problems are expected,
891 a copy will be made.
892
893 The "breaksymlink" and "breakhardlink" values can be used in
894 combination with any of "yes", "no" and "auto". When included, they
895 force Vim to always break either symbolic or hard links by doing
896 exactly what the "no" option does, renaming the original file to
897 become the backup and writing a new file in its place. This can be
898 useful for example in source trees where all the files are symbolic or
899 hard links and any changes should stay in the local source tree, not
900 be propagated back to the original source.
901 *crontab*
902 One situation where "no" and "auto" will cause problems: A program
903 that opens a file, invokes Vim to edit that file, and then tests if
904 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000905 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906 example.
907
908 When a copy is made, the original file is truncated and then filled
909 with the new text. This means that protection bits, owner and
910 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000911 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 group of the backup is set to the group of the original file. If this
913 fails, the protection bits for the group are made the same as for
914 others.
915
916 When the file is renamed this is the other way around: The backup has
917 the same attributes of the original file, and the newly written file
918 is owned by the current user. When the file was a (hard/symbolic)
919 link, the new file will not! That's why the "auto" value doesn't
920 rename when the file is a link. The owner and group of the newly
921 written file will be set to the same ones as the original file, but
922 the system may refuse to do this. In that case the "auto" value will
923 again not rename the file.
924
925 *'backupdir'* *'bdir'*
926'backupdir' 'bdir' string (default for Amiga: ".,t:",
927 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
928 for Unix: ".,~/tmp,~/")
929 global
930 {not in Vi}
931 List of directories for the backup file, separated with commas.
932 - The backup file will be created in the first directory in the list
933 where this is possible.
934 - Empty means that no backup file will be created ('patchmode' is
935 impossible!). Writing may fail because of this.
936 - A directory "." means to put the backup file in the same directory
937 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000938 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 put the backup file relative to where the edited file is. The
940 leading "." is replaced with the path name of the edited file.
941 ("." inside a directory name has no special meaning).
942 - Spaces after the comma are ignored, other spaces are considered part
943 of the directory name. To have a space at the start of a directory
944 name, precede it with a backslash.
945 - To include a comma in a directory name precede it with a backslash.
946 - A directory name may end in an '/'.
947 - Environment variables are expanded |:set_env|.
948 - Careful with '\' characters, type one before a space, type two to
949 get one in the option (see |option-backslash|), for example: >
950 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
951< - For backwards compatibility with Vim version 3.0 a '>' at the start
952 of the option is removed.
953 See also 'backup' and 'writebackup' options.
954 If you want to hide your backup files on Unix, consider this value: >
955 :set backupdir=./.backup,~/.backup,.,/tmp
956< You must create a ".backup" directory in each directory and in your
957 home directory for this to work properly.
958 The use of |:set+=| and |:set-=| is preferred when adding or removing
959 directories from the list. This avoids problems when a future version
960 uses another default.
961 This option cannot be set from a |modeline| or in the |sandbox|, for
962 security reasons.
963
964 *'backupext'* *'bex'* *E589*
965'backupext' 'bex' string (default "~", for VMS: "_")
966 global
967 {not in Vi}
968 String which is appended to a file name to make the name of the
969 backup file. The default is quite unusual, because this avoids
970 accidentally overwriting existing files with a backup file. You might
971 prefer using ".bak", but make sure that you don't have files with
972 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000973 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000975 If you like to keep a lot of backups, you could use a BufWritePre
976 autocommand to change 'backupext' just before writing the file to
977 include a timestamp. >
978 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
979< Use 'backupdir' to put the backup in a different directory.
980
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981 *'backupskip'* *'bsk'*
982'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
983 global
984 {not in Vi}
985 {not available when compiled without the |+wildignore|
986 feature}
987 A list of file patterns. When one of the patterns matches with the
988 name of the file which is written, no backup file is created. Both
989 the specified file name and the full path name of the file are used.
990 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
991 Watch out for special characters, see |option-backslash|.
992 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +0000993 default value. "/tmp/*" is only used for Unix.
Bram Moolenaara5792f52005-11-23 21:25:05 +0000994 Note that the default also makes sure that "crontab -e" works (when a
995 backup would be made by renaming the original file crontab won't see
996 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997
998 *'balloondelay'* *'bdlay'*
999'balloondelay' 'bdlay' number (default: 600)
1000 global
1001 {not in Vi}
1002 {only available when compiled with the |+balloon_eval|
1003 feature}
1004 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1005
1006 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1007'ballooneval' 'beval' boolean (default off)
1008 global
1009 {not in Vi}
1010 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001011 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 Switch on the |balloon-eval| functionality.
1013
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001014 *'balloonexpr'* *'bexpr'*
1015'balloonexpr' 'bexpr' string (default "")
1016 global
1017 {not in Vi}
1018 {only available when compiled with the |+balloon_eval|
1019 feature}
1020 Expression to show in evaluation balloon. It is only used when
1021 'ballooneval' is on. These variables can be used:
1022
1023 v:beval_bufnr number of the buffer in which balloon is going to show
1024 v:beval_winnr number of the window
1025 v:beval_lnum line number
1026 v:beval_col column number (byte index)
1027 v:beval_text word under or after the mouse pointer
1028
1029 The evaluation of the expression must not have side effects!
1030 Example: >
1031 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001032 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001033 \', column ' . v:beval_col .
1034 \ ' of file ' . bufname(v:beval_bufnr) .
1035 \ ' on word "' . v:beval_text . '"'
1036 endfunction
1037 set bexpr=MyBalloonExpr()
1038 set ballooneval
1039<
1040 NOTE: The balloon is displayed only if the cursor is on a text
1041 character. If the result of evaluating 'balloonexpr' is not empty,
1042 Vim does not try to send a message to an external debugger (Netbeans
1043 or Sun Workshop).
1044
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001045 The expression may be evaluated in the |sandbox|, see
1046 |sandbox-option|.
1047
1048 It is not allowed to change text or jump to another window while
1049 evaluating 'balloonexpr' |textlock|.
1050
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001051 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001052 if has("balloon_multiline")
1053<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001054 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1055'binary' 'bin' boolean (default off)
1056 local to buffer
1057 {not in Vi}
1058 This option should be set before editing a binary file. You can also
1059 use the |-b| Vim argument. When this option is switched on a few
1060 options will be changed (also when it already was on):
1061 'textwidth' will be set to 0
1062 'wrapmargin' will be set to 0
1063 'modeline' will be off
1064 'expandtab' will be off
1065 Also, 'fileformat' and 'fileformats' options will not be used, the
1066 file is read and written like 'fileformat' was "unix" (a single <NL>
1067 separates lines).
1068 The 'fileencoding' and 'fileencodings' options will not be used, the
1069 file is read without conversion.
1070 NOTE: When you start editing a(nother) file while the 'bin' option is
1071 on, settings from autocommands may change the settings again (e.g.,
1072 'textwidth'), causing trouble when editing. You might want to set
1073 'bin' again when the file has been loaded.
1074 The previous values of these options are remembered and restored when
1075 'bin' is switched from on to off. Each buffer has its own set of
1076 saved option values.
1077 To edit a file with 'binary' set you can use the |++bin| argument.
1078 This avoids you have to do ":set bin", which would have effect for all
1079 files you edit.
1080 When writing a file the <EOL> for the last line is only written if
1081 there was one in the original file (normally Vim appends an <EOL> to
1082 the last line if there is none; this would make the file longer). See
1083 the 'endofline' option.
1084
1085 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1086'bioskey' 'biosk' boolean (default on)
1087 global
1088 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001089 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 better to detect CTRL-C, but only works for the console. When using a
1091 terminal over a serial port reset this option.
1092 Also see |'conskey'|.
1093
1094 *'bomb'* *'nobomb'*
1095'bomb' boolean (default off)
1096 local to buffer
1097 {not in Vi}
1098 {only available when compiled with the |+multi_byte|
1099 feature}
1100 When writing a file and the following conditions are met, a BOM (Byte
1101 Order Mark) is prepended to the file:
1102 - this option is on
1103 - the 'binary' option is off
1104 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1105 endian variants.
1106 Some applications use the BOM to recognize the encoding of the file.
1107 Often used for UCS-2 files on MS-Windows. For other applications it
1108 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1109 appear halfway the resulting file.
1110 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1111 check for the presence of the BOM is done and 'bomb' set accordingly.
1112 Unless 'binary' is set, it is removed from the first line, so that you
1113 don't see it when editing. When you don't change the options, the BOM
1114 will be restored when writing the file.
1115
1116 *'breakat'* *'brk'*
1117'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1118 global
1119 {not in Vi}
1120 {not available when compiled without the |+linebreak|
1121 feature}
1122 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001123 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1124 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125
1126 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001127'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 global
1129 {not in Vi} {only for Motif and Win32 GUI}
1130 Which directory to use for the file browser:
1131 last Use same directory as with last file browser.
1132 buffer Use the directory of the related buffer.
1133 current Use the current directory.
1134 {path} Use the specified directory
1135
1136 *'bufhidden'* *'bh'*
1137'bufhidden' 'bh' string (default: "")
1138 local to buffer
1139 {not in Vi}
1140 {not available when compiled without the |+quickfix|
1141 feature}
1142 This option specifies what happens when a buffer is no longer
1143 displayed in a window:
1144 <empty> follow the global 'hidden' option
1145 hide hide the buffer (don't unload it), also when 'hidden'
1146 is not set
1147 unload unload the buffer, also when 'hidden' is set or using
1148 |:hide|
1149 delete delete the buffer from the buffer list, also when
1150 'hidden' is set or using |:hide|, like using
1151 |:bdelete|
1152 wipe wipe out the buffer from the buffer list, also when
1153 'hidden' is set or using |:hide|, like using
1154 |:bwipeout|
1155
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001156 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1157 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 This option is used together with 'buftype' and 'swapfile' to specify
1159 special kinds of buffers. See |special-buffers|.
1160
1161 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1162'buflisted' 'bl' boolean (default: on)
1163 local to buffer
1164 {not in Vi}
1165 When this option is set, the buffer shows up in the buffer list. If
1166 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1167 This option is reset by Vim for buffers that are only used to remember
1168 a file name or marks. Vim sets it when starting to edit a buffer.
1169 But not when moving to a buffer with ":buffer".
1170
1171 *'buftype'* *'bt'* *E382*
1172'buftype' 'bt' string (default: "")
1173 local to buffer
1174 {not in Vi}
1175 {not available when compiled without the |+quickfix|
1176 feature}
1177 The value of this option specifies the type of a buffer:
1178 <empty> normal buffer
1179 nofile buffer which is not related to a file and will not be
1180 written
1181 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001182 acwrite buffer which will always be written with BufWriteCmd
1183 autocommands. {not available when compiled without the
1184 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001185 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001186 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 help help buffer (you are not supposed to set this
1188 manually)
1189
1190 This option is used together with 'bufhidden' and 'swapfile' to
1191 specify special kinds of buffers. See |special-buffers|.
1192
1193 Be careful with changing this option, it can have many side effects!
1194
Bram Moolenaar280f1262006-01-30 00:14:18 +00001195 A "quickfix" buffer is only used for the error list and the location
1196 list. This value is set by the |:cwindow| and |:lwindow| commands and
1197 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198
1199 "nofile" and "nowrite" buffers are similar:
1200 both: The buffer is not to be written to disk, ":w" doesn't
1201 work (":w filename" does work though).
1202 both: The buffer is never considered to be |'modified'|.
1203 There is no warning when the changes will be lost, for
1204 example when you quit Vim.
1205 both: A swap file is only created when using too much memory
1206 (when 'swapfile' has been reset there is never a swap
1207 file).
1208 nofile only: The buffer name is fixed, it is not handled like a
1209 file name. It is not modified in response to a |:cd|
1210 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001211 *E676*
1212 "acwrite" implies that the buffer name is not related to a file, like
1213 "nofile", but it will be written. Thus, in contrast to "nofile" and
1214 "nowrite", ":w" does work and a modified buffer can't be abandoned
1215 without saving. For writing there must be matching |BufWriteCmd|,
1216 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217
1218 *'casemap'* *'cmp'*
1219'casemap' 'cmp' string (default: "internal,keepascii")
1220 global
1221 {not in Vi}
1222 Specifies details about changing the case of letters. It may contain
1223 these words, separated by a comma:
1224 internal Use internal case mapping functions, the current
1225 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001226 matters when 'encoding' is a Unicode encoding,
1227 "latin1" or "iso-8859-15". When "internal" is
1228 omitted, the towupper() and towlower() system library
1229 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1231 case mapping, the current locale is not effective.
1232 This probably only matters for Turkish.
1233
1234 *'cdpath'* *'cd'* *E344* *E346*
1235'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1236 global
1237 {not in Vi}
1238 {not available when compiled without the
1239 |+file_in_path| feature}
1240 This is a list of directories which will be searched when using the
1241 |:cd| and |:lcd| commands, provided that the directory being searched
1242 for has a relative path (not starting with "/", "./" or "../").
1243 The 'cdpath' option's value has the same form and semantics as
1244 |'path'|. Also see |file-searching|.
1245 The default value is taken from $CDPATH, with a "," prepended to look
1246 in the current directory first.
1247 If the default value taken from $CDPATH is not what you want, include
1248 a modified version of the following command in your vimrc file to
1249 override it: >
1250 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1251< This option cannot be set from a |modeline| or in the |sandbox|, for
1252 security reasons.
1253 (parts of 'cdpath' can be passed to the shell to expand file names).
1254
1255 *'cedit'*
1256'cedit' string (Vi default: "", Vim default: CTRL-F)
1257 global
1258 {not in Vi}
1259 {not available when compiled without the |+vertsplit|
1260 feature}
1261 The key used in Command-line Mode to open the command-line window.
1262 The default is CTRL-F when 'compatible' is off.
1263 Only non-printable keys are allowed.
1264 The key can be specified as a single character, but it is difficult to
1265 type. The preferred way is to use the <> notation. Examples: >
1266 :set cedit=<C-Y>
1267 :set cedit=<Esc>
1268< |Nvi| also has this option, but it only uses the first character.
1269 See |cmdwin|.
1270
1271 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1272'charconvert' 'ccv' string (default "")
1273 global
1274 {only available when compiled with the |+multi_byte|
1275 feature and the |+eval| feature}
1276 {not in Vi}
1277 An expression that is used for character encoding conversion. It is
1278 evaluated when a file that is to be read or has been written has a
1279 different encoding from what is desired.
1280 'charconvert' is not used when the internal iconv() function is
1281 supported and is able to do the conversion. Using iconv() is
1282 preferred, because it is much faster.
1283 'charconvert' is not used when reading stdin |--|, because there is no
1284 file to convert from. You will have to save the text in a file first.
1285 The expression must return zero or an empty string for success,
1286 non-zero for failure.
1287 The possible encoding names encountered are in 'encoding'.
1288 Additionally, names given in 'fileencodings' and 'fileencoding' are
1289 used.
1290 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1291 is done internally by Vim, 'charconvert' is not used for this.
1292 'charconvert' is also used to convert the viminfo file, if the 'c'
1293 flag is present in 'viminfo'. Also used for Unicode conversion.
1294 Example: >
1295 set charconvert=CharConvert()
1296 fun CharConvert()
1297 system("recode "
1298 \ . v:charconvert_from . ".." . v:charconvert_to
1299 \ . " <" . v:fname_in . " >" v:fname_out)
1300 return v:shell_error
1301 endfun
1302< The related Vim variables are:
1303 v:charconvert_from name of the current encoding
1304 v:charconvert_to name of the desired encoding
1305 v:fname_in name of the input file
1306 v:fname_out name of the output file
1307 Note that v:fname_in and v:fname_out will never be the same.
1308 Note that v:charconvert_from and v:charconvert_to may be different
1309 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1310 Encryption is not done by Vim when using 'charconvert'. If you want
1311 to encrypt the file after conversion, 'charconvert' should take care
1312 of this.
1313 This option cannot be set from a |modeline| or in the |sandbox|, for
1314 security reasons.
1315
1316 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1317'cindent' 'cin' boolean (default off)
1318 local to buffer
1319 {not in Vi}
1320 {not available when compiled without the |+cindent|
1321 feature}
1322 Enables automatic C program indenting See 'cinkeys' to set the keys
1323 that trigger reindenting in insert mode and 'cinoptions' to set your
1324 preferred indent style.
1325 If 'indentexpr' is not empty, it overrules 'cindent'.
1326 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1327 the "=" operator indents using this algorithm rather than calling an
1328 external program.
1329 See |C-indenting|.
1330 When you don't like the way 'cindent' works, try the 'smartindent'
1331 option or 'indentexpr'.
1332 This option is not used when 'paste' is set.
1333 NOTE: This option is reset when 'compatible' is set.
1334
1335 *'cinkeys'* *'cink'*
1336'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1337 local to buffer
1338 {not in Vi}
1339 {not available when compiled without the |+cindent|
1340 feature}
1341 A list of keys that, when typed in Insert mode, cause reindenting of
1342 the current line. Only used if 'cindent' is on and 'indentexpr' is
1343 empty.
1344 For the format of this option see |cinkeys-format|.
1345 See |C-indenting|.
1346
1347 *'cinoptions'* *'cino'*
1348'cinoptions' 'cino' string (default "")
1349 local to buffer
1350 {not in Vi}
1351 {not available when compiled without the |+cindent|
1352 feature}
1353 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1354 program. See |cinoptions-values| for the values of this option, and
1355 |C-indenting| for info on C indenting in general.
1356
1357
1358 *'cinwords'* *'cinw'*
1359'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1360 local to buffer
1361 {not in Vi}
1362 {not available when compiled without both the
1363 |+cindent| and the |+smartindent| features}
1364 These keywords start an extra indent in the next line when
1365 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1366 an appropriate place (inside {}).
1367 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1368 matter, include the keyword both the uppercase and lowercase:
1369 "if,If,IF".
1370
1371 *'clipboard'* *'cb'*
1372'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1373 for X-windows, "" otherwise)
1374 global
1375 {not in Vi}
1376 {only in GUI versions or when the |+xterm_clipboard|
1377 feature is included}
1378 This option is a list of comma separated names.
1379 These names are recognized:
1380
1381 unnamed When included, Vim will use the clipboard register '*'
1382 for all yank, delete, change and put operations which
1383 would normally go to the unnamed register. When a
1384 register is explicitly specified, it will always be
1385 used regardless of whether "unnamed" is in 'clipboard'
1386 or not. The clipboard register can always be
1387 explicitly accessed using the "* notation. Also see
1388 |gui-clipboard|.
1389
1390 autoselect Works like the 'a' flag in 'guioptions': If present,
1391 then whenever Visual mode is started, or the Visual
1392 area extended, Vim tries to become the owner of the
1393 windowing system's global selection or put the
1394 selected text on the clipboard used by the selection
1395 register "*. See |guioptions_a| and |quotestar| for
1396 details. When the GUI is active, the 'a' flag in
1397 'guioptions' is used, when the GUI is not active, this
1398 "autoselect" flag is used.
1399 Also applies to the modeless selection.
1400
1401 autoselectml Like "autoselect", but for the modeless selection
1402 only. Compare to the 'A' flag in 'guioptions'.
1403
1404 exclude:{pattern}
1405 Defines a pattern that is matched against the name of
1406 the terminal 'term'. If there is a match, no
1407 connection will be made to the X server. This is
1408 useful in this situation:
1409 - Running Vim in a console.
1410 - $DISPLAY is set to start applications on another
1411 display.
1412 - You do not want to connect to the X server in the
1413 console, but do want this in a terminal emulator.
1414 To never connect to the X server use: >
1415 exclude:.*
1416< This has the same effect as using the |-X| argument.
1417 Note that when there is no connection to the X server
1418 the window title won't be restored and the clipboard
1419 cannot be accessed.
1420 The value of 'magic' is ignored, {pattern} is
1421 interpreted as if 'magic' was on.
1422 The rest of the option value will be used for
1423 {pattern}, this must be the last entry.
1424
1425 *'cmdheight'* *'ch'*
1426'cmdheight' 'ch' number (default 1)
1427 global
1428 {not in Vi}
1429 Number of screen lines to use for the command-line. Helps avoiding
1430 |hit-enter| prompts.
1431
1432 *'cmdwinheight'* *'cwh'*
1433'cmdwinheight' 'cwh' number (default 7)
1434 global
1435 {not in Vi}
1436 {not available when compiled without the |+vertsplit|
1437 feature}
1438 Number of screen lines to use for the command-line window. |cmdwin|
1439
1440 *'columns'* *'co'* *E594*
1441'columns' 'co' number (default 80 or terminal width)
1442 global
1443 {not in Vi}
1444 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001445 initialization and does not have to be set by hand. Also see
1446 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 When Vim is running in the GUI or in a resizable window, setting this
1448 option will cause the window size to be changed. When you only want
1449 to use the size for the GUI, put the command in your |gvimrc| file.
1450 When you set this option and Vim is unable to change the physical
1451 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001452 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453
1454 *'comments'* *'com'* *E524* *E525*
1455'comments' 'com' string (default
1456 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1457 local to buffer
1458 {not in Vi}
1459 {not available when compiled without the |+comments|
1460 feature}
1461 A comma separated list of strings that can start a comment line. See
1462 |format-comments|. See |option-backslash| about using backslashes to
1463 insert a space.
1464
1465 *'commentstring'* *'cms'* *E537*
1466'commentstring' 'cms' string (default "/*%s*/")
1467 local to buffer
1468 {not in Vi}
1469 {not available when compiled without the |+folding|
1470 feature}
1471 A template for a comment. The "%s" in the value is replaced with the
1472 comment text. Currently only used to add markers for folding, see
1473 |fold-marker|.
1474
1475 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001476'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1477 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478 global
1479 {not in Vi}
1480 This option has the effect of making Vim either more Vi-compatible, or
1481 make Vim behave in a more useful way.
1482 This is a special kind of option, because when it's set or reset,
1483 other options are also changed as a side effect. CAREFUL: Setting or
1484 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001485 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 set this option in your vimrc file, you should probably put it at the
1487 very start.
1488 By default this option is on and the Vi defaults are used for the
1489 options. This default was chosen for those people who want to use Vim
1490 just like Vi, and don't even (want to) know about the 'compatible'
1491 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001492 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1493 this option is switched off, and all options that have not been
1494 modified will be set to the Vim defaults. Effectively, this means
1495 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1496 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1497 happen for the system-wide vimrc or gvimrc file). Also see
1498 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 You can also set this option with the "-C" argument, and reset it with
1500 "-N". See |-C| and |-N|.
1501 Switching this option off makes the Vim defaults be used for options
1502 that have a different Vi and Vim default value. See the options
1503 marked with a '+' below. Other options are not modified.
1504 At the moment this option is set, several other options will be set
1505 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001506 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 editing.
1508 See also 'cpoptions'.
1509
1510 option + set value effect ~
1511
1512 'allowrevins' off no CTRL-_ command
1513 'backupcopy' Unix: "yes" backup file is a copy
1514 others: "auto" copy or rename backup file
1515 'backspace' "" normal backspace
1516 'backup' off no backup file
1517 'cindent' off no C code indentation
1518 'cedit' + "" no key to open the |cmdwin|
1519 'cpoptions' + (all flags) Vi-compatible flags
1520 'cscopetag' off don't use cscope for ":tag"
1521 'cscopetagorder' 0 see |cscopetagorder|
1522 'cscopeverbose' off see |cscopeverbose|
1523 'digraph' off no digraphs
1524 'esckeys' + off no <Esc>-keys in Insert mode
1525 'expandtab' off tabs not expanded to spaces
1526 'fileformats' + "" no automatic file format detection,
1527 "dos,unix" except for DOS, Windows and OS/2
1528 'formatoptions' + "vt" Vi compatible formatting
1529 'gdefault' off no default 'g' flag for ":s"
1530 'history' + 0 no commandline history
1531 'hkmap' off no Hebrew keyboard mapping
1532 'hkmapp' off no phonetic Hebrew keyboard mapping
1533 'hlsearch' off no highlighting of search matches
1534 'incsearch' off no incremental searching
1535 'indentexpr' "" no indenting by expression
1536 'insertmode' off do not start in Insert mode
1537 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1538 characters and '_'
1539 'joinspaces' on insert 2 spaces after period
1540 'modeline' + off no modelines
1541 'more' + off no pauses in listings
1542 'revins' off no reverse insert
1543 'ruler' off no ruler
1544 'scrolljump' 1 no jump scroll
1545 'scrolloff' 0 no scroll offset
1546 'shiftround' off indent not rounded to shiftwidth
1547 'shortmess' + "" no shortening of messages
1548 'showcmd' + off command characters not shown
1549 'showmode' + off current mode not shown
1550 'smartcase' off no automatic ignore case switch
1551 'smartindent' off no smart indentation
1552 'smarttab' off no smart tab size
1553 'softtabstop' 0 tabs are always 'tabstop' positions
1554 'startofline' on goto startofline with some commands
1555 'tagrelative' + off tag file names are not relative
1556 'textauto' + off no automatic textmode detection
1557 'textwidth' 0 no automatic line wrap
1558 'tildeop' off tilde is not an operator
1559 'ttimeout' off no terminal timeout
1560 'whichwrap' + "" left-right movements don't wrap
1561 'wildchar' + CTRL-E only when the current value is <Tab>
1562 use CTRL-E for cmdline completion
1563 'writebackup' on or off depends on +writebackup feature
1564
1565 *'complete'* *'cpt'* *E535*
1566'complete' 'cpt' string (default: ".,w,b,u,t,i")
1567 local to buffer
1568 {not in Vi}
1569 This option specifies how keyword completion |ins-completion| works
1570 when CTRL-P or CTRL-N are used. It is also used for whole-line
1571 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1572 and the places to scan. It is a comma separated list of flags:
1573 . scan the current buffer ('wrapscan' is ignored)
1574 w scan buffers from other windows
1575 b scan other loaded buffers that are in the buffer list
1576 u scan the unloaded buffers that are in the buffer list
1577 U scan the buffers that are not in the buffer list
1578 k scan the files given with the 'dictionary' option
1579 k{dict} scan the file {dict}. Several "k" flags can be given,
1580 patterns are valid too. For example: >
1581 :set cpt=k/usr/dict/*,k~/spanish
1582< s scan the files given with the 'thesaurus' option
1583 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1584 are valid too.
1585 i scan current and included files
1586 d scan current and included files for defined name or macro
1587 |i_CTRL-X_CTRL-D|
1588 ] tag completion
1589 t same as "]"
1590
1591 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1592 not executed, this may lead to unexpected completions from some files
1593 (gzipped files for example). Unloaded buffers are not scanned for
1594 whole-line completion.
1595
1596 The default is ".,w,b,u,t,i", which means to scan:
1597 1. the current buffer
1598 2. buffers in other windows
1599 3. other loaded buffers
1600 4. unloaded buffers
1601 5. tags
1602 6. included files
1603
1604 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001605 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1606 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001608 *'completefunc'* *'cfu'*
1609'completefunc' 'cfu' string (default: empty)
1610 local to buffer
1611 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001612 {not available when compiled without the +eval
1613 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001614 This option specifies a function to be used for Insert mode completion
1615 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001616 See |complete-functions| for an explanation of how the function is
1617 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001618
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001619
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001620 *'completeopt'* *'cot'*
1621'completeopt' 'cot' string (default: "menu")
1622 global
1623 {not in Vi}
1624 Options for Insert mode completion |ins-completion|.
1625 Currently the only supported value is:
1626
1627 menu Use a popup menu to show the possible completions. The
1628 menu is only shown when there is more than one match and
1629 sufficient colors are available. |ins-completion-menu|
1630
1631
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1633'confirm' 'cf' boolean (default off)
1634 global
1635 {not in Vi}
1636 When 'confirm' is on, certain operations that would normally
1637 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1638 instead raise a |dialog| asking if you wish to save the current
1639 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1640 If 'confirm' is off you can still activate confirmation for one
1641 command only (this is most useful in mappings) with the |:confirm|
1642 command.
1643 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1644
1645 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1646'conskey' 'consk' boolean (default off)
1647 global
1648 {not in Vi} {only for MS-DOS}
1649 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001650 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 three methods of console input are available:
1652 'conskey' 'bioskey' action ~
1653 on on or off direct console input
1654 off on BIOS
1655 off off STDIN
1656
1657 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1658'copyindent' 'ci' boolean (default off)
1659 local to buffer
1660 {not in Vi}
1661 Copy the structure of the existing lines indent when autoindenting a
1662 new line. Normally the new indent is reconstructed by a series of
1663 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1664 in which case only spaces are used). Enabling this option makes the
1665 new line copy whatever characters were used for indenting on the
1666 existing line. If the new indent is greater than on the existing
1667 line, the remaining space is filled in the normal manner.
1668 NOTE: 'copyindent' is reset when 'compatible' is set.
1669 Also see 'preserveindent'.
1670
1671 *'cpoptions'* *'cpo'*
1672'cpoptions' 'cpo' string (Vim default: "aABceFs",
1673 Vi default: all flags)
1674 global
1675 {not in Vi}
1676 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001677 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 not being vi-compatible is mostly or sometimes preferred.
1679 'cpoptions' stands for "compatible-options".
1680 Commas can be added for readability.
1681 To avoid problems with flags that are added in the future, use the
1682 "+=" and "-=" feature of ":set" |add-option-flags|.
1683 NOTE: This option is set to the Vi default value when 'compatible' is
1684 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001685 NOTE: This option is set to the POSIX default value at startup when
1686 the Vi default value would be used and the $VIM_POSIX environment
1687 variable exists |posix|. This means tries to behave like the POSIX
1688 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689
1690 contains behavior ~
1691 *cpo-a*
1692 a When included, a ":read" command with a file name
1693 argument will set the alternate file name for the
1694 current window.
1695 *cpo-A*
1696 A When included, a ":write" command with a file name
1697 argument will set the alternate file name for the
1698 current window.
1699 *cpo-b*
1700 b "\|" in a ":map" command is recognized as the end of
1701 the map command. The '\' is included in the mapping,
1702 the text after the '|' is interpreted as the next
1703 command. Use a CTRL-V instead of a backslash to
1704 include the '|' in the mapping. Applies to all
1705 mapping, abbreviation, menu and autocmd commands.
1706 See also |map_bar|.
1707 *cpo-B*
1708 B A backslash has no special meaning in mappings,
1709 abbreviations and the "to" part of the menu commands.
1710 Remove this flag to be able to use a backslash like a
1711 CTRL-V. For example, the command ":map X \<Esc>"
1712 results in X being mapped to:
1713 'B' included: "\^[" (^[ is a real <Esc>)
1714 'B' excluded: "<Esc>" (5 characters)
1715 ('<' excluded in both cases)
1716 *cpo-c*
1717 c Searching continues at the end of any match at the
1718 cursor position, but not further than the start of the
1719 next line. When not present searching continues
1720 one character from the cursor position. With 'c'
1721 "abababababab" only gets three matches when repeating
1722 "/abab", without 'c' there are five matches.
1723 *cpo-C*
1724 C Do not concatenate sourced lines that start with a
1725 backslash. See |line-continuation|.
1726 *cpo-d*
1727 d Using "./" in the 'tags' option doesn't mean to use
1728 the tags file relative to the current file, but the
1729 tags file in the current directory.
1730 *cpo-D*
1731 D Can't use CTRL-K to enter a digraph after Normal mode
1732 commands with a character argument, like |r|, |f| and
1733 |t|.
1734 *cpo-e*
1735 e When executing a register with ":@r", always add a
1736 <CR> to the last line, also when the register is not
1737 linewise. If this flag is not present, the register
1738 is not linewise and the last line does not end in a
1739 <CR>, then the last line is put on the command-line
1740 and can be edited before hitting <CR>.
1741 *cpo-E*
1742 E It is an error when using "y", "d", "c", "g~", "gu" or
1743 "gU" on an Empty region. The operators only work when
1744 at least one character is to be operate on. Example:
1745 This makes "y0" fail in the first column.
1746 *cpo-f*
1747 f When included, a ":read" command with a file name
1748 argument will set the file name for the current buffer,
1749 if the current buffer doesn't have a file name yet.
1750 *cpo-F*
1751 F When included, a ":write" command with a file name
1752 argument will set the file name for the current
1753 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001754 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 *cpo-g*
1756 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001757 *cpo-H*
1758 H When using "I" on a line with only blanks, insert
1759 before the last blank. Without this flag insert after
1760 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 *cpo-i*
1762 i When included, interrupting the reading of a file will
1763 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001764 *cpo-I*
1765 I When moving the cursor up or down just after inserting
1766 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 *cpo-j*
1768 j When joining lines, only add two spaces after a '.',
1769 not after '!' or '?'. Also see 'joinspaces'.
1770 *cpo-J*
1771 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001772 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 white space.
1774 *cpo-k*
1775 k Disable the recognition of raw key codes in
1776 mappings, abbreviations, and the "to" part of menu
1777 commands. For example, if <Key> sends ^[OA (where ^[
1778 is <Esc>), the command ":map X ^[OA" results in X
1779 being mapped to:
1780 'k' included: "^[OA" (3 characters)
1781 'k' excluded: "<Key>" (one key code)
1782 Also see the '<' flag below.
1783 *cpo-K*
1784 K Don't wait for a key code to complete when it is
1785 halfway a mapping. This breaks mapping <F1><F1> when
1786 only part of the second <F1> has been read. It
1787 enables cancelling the mapping by typing <F1><Esc>.
1788 *cpo-l*
1789 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001790 literally, only "\]", "\^", "\-" and "\\" are special.
1791 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1793 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001794 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 *cpo-L*
1796 L When the 'list' option is set, 'wrapmargin',
1797 'textwidth', 'softtabstop' and Virtual Replace mode
1798 (see |gR|) count a <Tab> as two characters, instead of
1799 the normal behavior of a <Tab>.
1800 *cpo-m*
1801 m When included, a showmatch will always wait half a
1802 second. When not included, a showmatch will wait half
1803 a second or until a character is typed. |'showmatch'|
1804 *cpo-M*
1805 M When excluded, "%" matching will take backslashes into
1806 account. Thus in "( \( )" and "\( ( \)" the outer
1807 parenthesis match. When included "%" ignores
1808 backslashes, which is Vi compatible.
1809 *cpo-n*
1810 n When included, the column used for 'number' will also
1811 be used for text of wrapped lines.
1812 *cpo-o*
1813 o Line offset to search command is not remembered for
1814 next search.
1815 *cpo-O*
1816 O Don't complain if a file is being overwritten, even
1817 when it didn't exist when editing it. This is a
1818 protection against a file unexpectedly created by
1819 someone else. Vi didn't complain about this.
1820 *cpo-p*
1821 p Vi compatible Lisp indenting. When not present, a
1822 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001823 *cpo-P*
1824 P When included, a ":write" command that appends to a
1825 file will set the file name for the current buffer, if
1826 the current buffer doesn't have a file name yet and
1827 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001828 *cpo-q*
1829 q When joining multiple lines leave the cursor at the
1830 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 *cpo-r*
1832 r Redo ("." command) uses "/" to repeat a search
1833 command, instead of the actually used search string.
1834 *cpo-R*
1835 R Remove marks from filtered lines. Without this flag
1836 marks are kept like |:keepmarks| was used.
1837 *cpo-s*
1838 s Set buffer options when entering the buffer for the
1839 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001840 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 set when the buffer is created.
1842 *cpo-S*
1843 S Set buffer options always when entering a buffer
1844 (except 'readonly', 'fileformat', 'filetype' and
1845 'syntax'). This is the (most) Vi compatible setting.
1846 The options are set to the values in the current
1847 buffer. When you change an option and go to another
1848 buffer, the value is copied. Effectively makes the
1849 buffer options global to all buffers.
1850
1851 's' 'S' copy buffer options
1852 no no when buffer created
1853 yes no when buffer first entered (default)
1854 X yes each time when buffer entered (vi comp.)
1855 *cpo-t*
1856 t Search pattern for the tag command is remembered for
1857 "n" command. Otherwise Vim only puts the pattern in
1858 the history for search pattern, but doesn't change the
1859 last used search pattern.
1860 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001861 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 *cpo-v*
1863 v Backspaced characters remain visible on the screen in
1864 Insert mode. Without this flag the characters are
1865 erased from the screen right away. With this flag the
1866 screen newly typed text overwrites backspaced
1867 characters.
1868 *cpo-w*
1869 w When using "cw" on a blank character, only change one
1870 character and not all blanks until the start of the
1871 next word.
1872 *cpo-W*
1873 W Don't overwrite a readonly file. When omitted, ":w!"
1874 overwrites a readonly file, if possible.
1875 *cpo-x*
1876 x <Esc> on the command-line executes the command-line.
1877 The default in Vim is to abandon the command-line,
1878 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001879 *cpo-X*
1880 X When using a count with "R" the replaced text is
1881 deleted only once. Also when repeating "R" with "."
1882 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 *cpo-y*
1884 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001885 *cpo-Z*
1886 Z When using "w!" while the 'readonly' option is set,
1887 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 *cpo-!*
1889 ! When redoing a filter command, use the last used
1890 external command, whatever it was. Otherwise the last
1891 used -filter- command is used.
1892 *cpo-$*
1893 $ When making a change to one line, don't redisplay the
1894 line, but put a '$' at the end of the changed text.
1895 The changed text will be overwritten when you type the
1896 new text. The line is redisplayed if you type any
1897 command that moves the cursor from the insertion
1898 point.
1899 *cpo-%*
1900 % Vi-compatible matching is done for the "%" command.
1901 Does not recognize "#if", "#endif", etc.
1902 Does not recognize "/*" and "*/".
1903 Parens inside single and double quotes are also
1904 counted, causing a string that contains a paren to
1905 disturb the matching. For example, in a line like
1906 "if (strcmp("foo(", s))" the first paren does not
1907 match the last one. When this flag is not included,
1908 parens inside single and double quotes are treated
1909 specially. When matching a paren outside of quotes,
1910 everything inside quotes is ignored. When matching a
1911 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001912 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001913 This flag is also used for other features, such as
1914 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001915 *cpo--*
1916 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001917 it would go above the first line or below the last
1918 line. Without it the cursor moves to the first or
1919 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001920 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001921 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001922 *cpo-+*
1923 + When included, a ":write file" command will reset the
1924 'modified' flag of the buffer, even though the buffer
1925 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001926 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 * Use ":*" in the same way as ":@". When not included,
1928 ":*" is an alias for ":'<,'>", select the Visual area.
1929 *cpo-<*
1930 < Disable the recognition of special key codes in |<>|
1931 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001932 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 ":map X <Tab>" results in X being mapped to:
1934 '<' included: "<Tab>" (5 characters)
1935 '<' excluded: "^I" (^I is a real <Tab>)
1936 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001937 *cpo->*
1938 > When appending to a register, put a line break before
1939 the appended text.
1940
1941 POSIX flags. These are not included in the Vi default value, except
1942 when $VIM_POSIX was set on startup. |posix|
1943
1944 contains behavior ~
1945 *cpo-#*
1946 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001947 *cpo-&*
1948 & When ":preserve" was used keep the swap file when
1949 exiting normally while this buffer is still loaded.
1950 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001951 *cpo-\*
1952 \ Backslash in a [] range in a search pattern is taken
1953 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001954 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1955 '\' excluded: "/[ \-]" finds <Space> and '-'
1956 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001957 *cpo-/*
1958 / When "%" is used as the replacement string in a |:s|
1959 command, use the previous replacement string. |:s%|
1960 *cpo-{*
1961 { The |{| and |}| commands also stop at a "{" character
1962 at the start of a line.
1963 *cpo-.*
1964 . The ":chdir" and ":cd" commands fail if the current
1965 buffer is modified, unless ! is used. Vim doesn't
1966 need this, since it remembers the full path of an
1967 opened file.
1968 *cpo-bar*
1969 | The value of the $LINES and $COLUMNS environment
1970 variables overrule the terminal size values obtained
1971 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001972
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973
1974 *'cscopepathcomp'* *'cspc'*
1975'cscopepathcomp' 'cspc' number (default 0)
1976 global
1977 {not available when compiled without the |+cscope|
1978 feature}
1979 {not in Vi}
1980 Determines how many components of the path to show in a list of tags.
1981 See |cscopepathcomp|.
1982
1983 *'cscopeprg'* *'csprg'*
1984'cscopeprg' 'csprg' string (default "cscope")
1985 global
1986 {not available when compiled without the |+cscope|
1987 feature}
1988 {not in Vi}
1989 Specifies the command to execute cscope. See |cscopeprg|.
1990 This option cannot be set from a |modeline| or in the |sandbox|, for
1991 security reasons.
1992
1993 *'cscopequickfix'* *'csqf'*
1994'cscopequickfix' 'csqf' string (default "")
1995 global
1996 {not available when compiled without the |+cscope|
1997 or |+quickfix| features}
1998 {not in Vi}
1999 Specifies whether to use quickfix window to show cscope results.
2000 See |cscopequickfix|.
2001
2002 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2003'cscopetag' 'cst' boolean (default off)
2004 global
2005 {not available when compiled without the |+cscope|
2006 feature}
2007 {not in Vi}
2008 Use cscope for tag commands. See |cscope-options|.
2009 NOTE: This option is reset when 'compatible' is set.
2010
2011 *'cscopetagorder'* *'csto'*
2012'cscopetagorder' 'csto' number (default 0)
2013 global
2014 {not available when compiled without the |+cscope|
2015 feature}
2016 {not in Vi}
2017 Determines the order in which ":cstag" performs a search. See
2018 |cscopetagorder|.
2019 NOTE: This option is set to 0 when 'compatible' is set.
2020
2021 *'cscopeverbose'* *'csverb'*
2022 *'nocscopeverbose'* *'nocsverb'*
2023'cscopeverbose' 'csverb' boolean (default off)
2024 global
2025 {not available when compiled without the |+cscope|
2026 feature}
2027 {not in Vi}
2028 Give messages when adding a cscope database. See |cscopeverbose|.
2029 NOTE: This option is reset when 'compatible' is set.
2030
2031 *'debug'*
2032'debug' string (default "")
2033 global
2034 {not in Vi}
2035 When set to "msg", error messages that would otherwise be omitted will
2036 be given anyway. This is useful when debugging 'foldexpr' or
2037 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002038 When set to "beep", a message will be given when otherwise only a beep
2039 would be produced.
2040 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041
2042 *'define'* *'def'*
2043'define' 'def' string (default "^\s*#\s*define")
2044 global or local to buffer |global-local|
2045 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002046 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 pattern, just like for the "/" command. This option is used for the
2048 commands like "[i" and "[d" |include-search|. The 'isident' option is
2049 used to recognize the defined name after the match:
2050 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2051 See |option-backslash| about inserting backslashes to include a space
2052 or backslash.
2053 The default value is for C programs. For C++ this value would be
2054 useful, to include const type declarations: >
2055 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2056< When using the ":set" command, you need to double the backslashes!
2057
2058 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2059'delcombine' 'deco' boolean (default off)
2060 global
2061 {not in Vi}
2062 {only available when compiled with the |+multi_byte|
2063 feature}
2064 If editing Unicode and this option is set, backspace and Normal mode
2065 "x" delete each combining character on its own. When it is off (the
2066 default) the character along with its combining characters are
2067 deleted.
2068 Note: When 'delcombine' is set "xx" may work different from "2x"!
2069
2070 This is useful for Arabic, Hebrew and many other languages where one
2071 may have combining characters overtop of base characters, and want
2072 to remove only the combining ones.
2073
2074 *'dictionary'* *'dict'*
2075'dictionary' 'dict' string (default "")
2076 global or local to buffer |global-local|
2077 {not in Vi}
2078 List of file names, separated by commas, that are used to lookup words
2079 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2080 contain a list of words. This can be one word per line, or several
2081 words per line, separated by non-keyword characters (white space is
2082 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002083 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 after a comma are ignored, otherwise spaces are included in the file
2085 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002086 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 Where to find a list of words?
2088 - On FreeBSD, there is the file "/usr/share/dict/words".
2089 - In the Simtel archive, look in the "msdos/linguist" directory.
2090 - In "miscfiles" of the GNU collection.
2091 The use of |:set+=| and |:set-=| is preferred when adding or removing
2092 directories from the list. This avoids problems when a future version
2093 uses another default.
2094 Backticks cannot be used in this option for security reasons.
2095
2096 *'diff'* *'nodiff'*
2097'diff' boolean (default off)
2098 local to window
2099 {not in Vi}
2100 {not available when compiled without the |+diff|
2101 feature}
2102 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002103 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104
2105 *'dex'* *'diffexpr'*
2106'diffexpr' 'dex' string (default "")
2107 global
2108 {not in Vi}
2109 {not available when compiled without the |+diff|
2110 feature}
2111 Expression which is evaluated to obtain an ed-style diff file from two
2112 versions of a file. See |diff-diffexpr|.
2113 This option cannot be set from a |modeline| or in the |sandbox|, for
2114 security reasons.
2115
2116 *'dip'* *'diffopt'*
2117'diffopt' 'dip' string (default "filler")
2118 global
2119 {not in Vi}
2120 {not available when compiled without the |+diff|
2121 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002122 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 All are optional. Items must be separated by a comma.
2124
2125 filler Show filler lines, to keep the text
2126 synchronized with a window that has inserted
2127 lines at the same position. Mostly useful
2128 when windows are side-by-side and 'scrollbind'
2129 is set.
2130
2131 context:{n} Use a context of {n} lines between a change
2132 and a fold that contains unchanged lines.
2133 When omitted a context of six lines is used.
2134 See |fold-diff|.
2135
2136 icase Ignore changes in case of text. "a" and "A"
2137 are considered the same. Adds the "-i" flag
2138 to the "diff" command if 'diffexpr' is empty.
2139
2140 iwhite Ignore changes in amount of white space. Adds
2141 the "-b" flag to the "diff" command if
2142 'diffexpr' is empty. Check the documentation
2143 of the "diff" command for what this does
2144 exactly. It should ignore adding trailing
2145 white space, but not leading white space.
2146
2147 Examples: >
2148
2149 :set diffopt=filler,context:4
2150 :set diffopt=
2151 :set diffopt=filler
2152<
2153 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2154'digraph' 'dg' boolean (default off)
2155 global
2156 {not in Vi}
2157 {not available when compiled without the |+digraphs|
2158 feature}
2159 Enable the entering of digraphs in Insert mode with {char1} <BS>
2160 {char2}. See |digraphs|.
2161 NOTE: This option is reset when 'compatible' is set.
2162
2163 *'directory'* *'dir'*
2164'directory' 'dir' string (default for Amiga: ".,t:",
2165 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2166 for Unix: ".,~/tmp,/var/tmp,/tmp")
2167 global
2168 List of directory names for the swap file, separated with commas.
2169 - The swap file will be created in the first directory where this is
2170 possible.
2171 - Empty means that no swap file will be used (recovery is
2172 impossible!).
2173 - A directory "." means to put the swap file in the same directory as
2174 the edited file. On Unix, a dot is prepended to the file name, so
2175 it doesn't show in a directory listing. On MS-Windows the "hidden"
2176 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002177 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 put the swap file relative to where the edited file is. The leading
2179 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002180 - For Unix and Win32, if a directory ends in two path separators "//"
2181 or "\\", the swap file name will be built from the complete path to
2182 the file with all path separators substituted to percent '%' signs.
2183 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 - Spaces after the comma are ignored, other spaces are considered part
2185 of the directory name. To have a space at the start of a directory
2186 name, precede it with a backslash.
2187 - To include a comma in a directory name precede it with a backslash.
2188 - A directory name may end in an ':' or '/'.
2189 - Environment variables are expanded |:set_env|.
2190 - Careful with '\' characters, type one before a space, type two to
2191 get one in the option (see |option-backslash|), for example: >
2192 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2193< - For backwards compatibility with Vim version 3.0 a '>' at the start
2194 of the option is removed.
2195 Using "." first in the list is recommended. This means that editing
2196 the same file twice will result in a warning. Using "/tmp" on Unix is
2197 discouraged: When the system crashes you lose the swap file.
2198 "/var/tmp" is often not cleared when rebooting, thus is a better
2199 choice than "/tmp". But it can contain a lot of files, your swap
2200 files get lost in the crowd. That is why a "tmp" directory in your
2201 home directory is tried first.
2202 The use of |:set+=| and |:set-=| is preferred when adding or removing
2203 directories from the list. This avoids problems when a future version
2204 uses another default.
2205 This option cannot be set from a |modeline| or in the |sandbox|, for
2206 security reasons.
2207 {Vi: directory to put temp file in, defaults to "/tmp"}
2208
2209 *'display'* *'dy'*
2210'display' 'dy' string (default "")
2211 global
2212 {not in Vi}
2213 Change the way text is displayed. This is comma separated list of
2214 flags:
2215 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002216 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 last line that doesn't fit is replaced with "@" lines.
2218 uhex Show unprintable characters hexadecimal as <xx>
2219 instead of using ^C and ~C.
2220
2221 *'eadirection'* *'ead'*
2222'eadirection' 'ead' string (default "both")
2223 global
2224 {not in Vi}
2225 {not available when compiled without the +vertsplit
2226 feature}
2227 Tells when the 'equalalways' option applies:
2228 ver vertically, width of windows is not affected
2229 hor horizontally, height of windows is not affected
2230 both width and height of windows is affected
2231
2232 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2233'edcompatible' 'ed' boolean (default off)
2234 global
2235 Makes the 'g' and 'c' flags of the ":substitute" command to be
2236 toggled each time the flag is given. See |complex-change|. See
2237 also 'gdefault' option.
2238 Switching this option on is discouraged!
2239
2240 *'encoding'* *'enc'* *E543*
2241'encoding' 'enc' string (default: "latin1" or value from $LANG)
2242 global
2243 {only available when compiled with the |+multi_byte|
2244 feature}
2245 {not in Vi}
2246 Sets the character encoding used inside Vim. It applies to text in
2247 the buffers, registers, Strings in expressions, text stored in the
2248 viminfo file, etc. It sets the kind of characters which Vim can work
2249 with. See |encoding-names| for the possible values.
2250
2251 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002252 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 It should normally be kept at its default value, or set when Vim
2254 starts up. See |multibyte|.
2255
2256 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2257 "utf-8". Although care has been taken to allow different values of
2258 'encoding', "utf-8" is the natural choice for the environment and
2259 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002260 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 versions, and to avoid changing the encoding of newly created files
2262 without your knowledge (in case 'fileencodings' is empty).
2263
2264 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002265 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 iconv() or as specified with 'charconvert'.
2267
2268 Normally 'encoding' will be equal to your current locale. This will
2269 be the default if Vim recognizes your environment settings. If
2270 'encoding' is not set to the current locale, 'termencoding' must be
2271 set to convert typed and displayed text. See |encoding-table|.
2272
2273 When you set this option, it fires the |EncodingChanged| autocommand
2274 event so that you can set up fonts if necessary.
2275
2276 When the option is set, the value is converted to lowercase. Thus
2277 you can set it with uppercase values too. Underscores are translated
2278 to '-' signs.
2279 When the encoding is recognized, it is changed to the standard name.
2280 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2281 "iso-8859-2" and "utf8" becomes "utf-8".
2282
2283 Note: "latin1" is also used when the encoding could not be detected.
2284 This only works when editing files in the same encoding! When the
2285 actual character set is not latin1, make sure 'fileencoding' and
2286 'fileencodings' are empty. When conversion is needed, switch to using
2287 utf-8.
2288
2289 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2290 You don't notice this while editing, but it does matter for the
2291 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2292 setting 'encoding' to one of these values instead of utf-8 only has
2293 effect for encoding used for files when 'fileencoding' is empty.
2294
Bram Moolenaar661b1822005-07-28 22:36:45 +00002295 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2296 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297
2298 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2299'endofline' 'eol' boolean (default on)
2300 local to buffer
2301 {not in Vi}
2302 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002303 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 option is automatically set when starting to edit a new file, unless
2305 the file does not have an <EOL> for the last line in the file, in
2306 which case it is reset. Normally you don't have to set or reset this
2307 option. When 'binary' is off the value is not used when writing the
2308 file. When 'binary' is on it is used to remember the presence of a
2309 <EOL> for the last line in the file, so that when you write the file
2310 the situation from the original file can be kept. But you can change
2311 it if you want to.
2312
2313 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2314'equalalways' 'ea' boolean (default on)
2315 global
2316 {not in Vi}
2317 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002318 splitting or closing a window. This also happens the moment the
2319 option is switched on. When off, splitting a window will reduce the
2320 size of the current window and leave the other windows the same. When
2321 closing a window the extra lines are given to the window next to it
2322 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 When mixing vertically and horizontally split windows, a minimal size
2324 is computed and some windows may be larger if there is room. The
2325 'eadirection' option tells in which direction the size is affected.
2326 Changing the height of a window can be avoided by setting
2327 'winfixheight'.
2328
2329 *'equalprg'* *'ep'*
2330'equalprg' 'ep' string (default "")
2331 global or local to buffer |global-local|
2332 {not in Vi}
2333 External program to use for "=" command. When this option is empty
2334 the internal formatting functions are used ('lisp', 'cindent' or
2335 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002336 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 about including spaces and backslashes.
2338 This option cannot be set from a |modeline| or in the |sandbox|, for
2339 security reasons.
2340
2341 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2342'errorbells' 'eb' boolean (default off)
2343 global
2344 Ring the bell (beep or screen flash) for error messages. This only
2345 makes a difference for error messages, the bell will be used always
2346 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002347 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348 screen flash or do nothing.
2349
2350 *'errorfile'* *'ef'*
2351'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2352 others: "errors.err")
2353 global
2354 {not in Vi}
2355 {not available when compiled without the |+quickfix|
2356 feature}
2357 Name of the errorfile for the QuickFix mode (see |:cf|).
2358 When the "-q" command-line argument is used, 'errorfile' is set to the
2359 following argument. See |-q|.
2360 NOT used for the ":make" command. See 'makeef' for that.
2361 Environment variables are expanded |:set_env|.
2362 See |option-backslash| about including spaces and backslashes.
2363 This option cannot be set from a |modeline| or in the |sandbox|, for
2364 security reasons.
2365
2366 *'errorformat'* *'efm'*
2367'errorformat' 'efm' string (default is very long)
2368 global or local to buffer |global-local|
2369 {not in Vi}
2370 {not available when compiled without the |+quickfix|
2371 feature}
2372 Scanf-like description of the format for the lines in the error file
2373 (see |errorformat|).
2374
2375 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2376'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2377 global
2378 {not in Vi}
2379 Function keys that start with an <Esc> are recognized in Insert
2380 mode. When this option is off, the cursor and function keys cannot be
2381 used in Insert mode if they start with an <Esc>. The advantage of
2382 this is that the single <Esc> is recognized immediately, instead of
2383 after one second. Instead of resetting this option, you might want to
2384 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2385 when 'esckeys' is off, you can still map anything, but the cursor keys
2386 won't work by default.
2387 NOTE: This option is set to the Vi default value when 'compatible' is
2388 set and to the Vim default value when 'compatible' is reset.
2389
2390 *'eventignore'* *'ei'*
2391'eventignore' 'ei' string (default "")
2392 global
2393 {not in Vi}
2394 {not available when compiled without the |+autocmd|
2395 feature}
2396 A list of autocommand event names, which are to be ignored.
2397 When set to "all", all autocommand events are ignored, autocommands
2398 will not be executed.
2399 Otherwise this is a comma separated list of event names. Example: >
2400 :set ei=WinEnter,WinLeave
2401<
2402 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2403'expandtab' 'et' boolean (default off)
2404 local to buffer
2405 {not in Vi}
2406 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002407 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2409 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2410 NOTE: This option is reset when 'compatible' is set.
2411
2412 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2413'exrc' 'ex' boolean (default off)
2414 global
2415 {not in Vi}
2416 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2417 directory. If you switch this option on you should also consider
2418 setting the 'secure' option (see |initialization|). Using a local
2419 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2420 also see |.vimrc| and |gui-init|.
2421 This option cannot be set from a |modeline| or in the |sandbox|, for
2422 security reasons.
2423
2424 *'fileencoding'* *'fenc'* *E213*
2425'fileencoding' 'fenc' string (default: "")
2426 local to buffer
2427 {only available when compiled with the |+multi_byte|
2428 feature}
2429 {not in Vi}
2430 Sets the character encoding for the file of this buffer.
2431 When 'fileencoding' is different from 'encoding', conversion will be
2432 done when reading and writing the file.
2433 When 'fileencoding' is empty, the same value as 'encoding' will be
2434 used (no conversion when reading or writing a file).
2435 WARNING: Conversion can cause loss of information! When
2436 'encoding' is "utf-8" conversion is most likely done in a way
2437 that the reverse conversion results in the same text. When
2438 'encoding' is not "utf-8" some characters may be lost!
2439 See 'encoding' for the possible values. Additionally, values may be
2440 specified that can be handled by the converter, see
2441 |mbyte-conversion|.
2442 When reading a file 'fileencoding' will be set from 'fileencodings'.
2443 To read a file in a certain encoding it won't work by setting
2444 'fileencoding', use the |++enc| argument.
2445 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2446 When the option is set, the value is converted to lowercase. Thus
2447 you can set it with uppercase values too. '_' characters are
2448 replaced with '-'. If a name is recognized from the list for
2449 'encoding', it is replaced by the standard name. For example
2450 "ISO8859-2" becomes "iso-8859-2".
2451 When this option is set, after starting to edit a file, the 'modified'
2452 option is set, because the file would be different when written.
2453 If you do this in a modeline, you might want to set 'nomodified' to
2454 avoid this.
2455 This option can not be changed when 'modifiable' is off.
2456
2457 *'fe'*
2458 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002459 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 old short name was 'fe', which is no longer used.
2461
2462 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002463'fileencodings' 'fencs' string (default: "ucs-bom",
2464 "ucs-bom,utf-8,default,latin1" when
2465 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466 global
2467 {only available when compiled with the |+multi_byte|
2468 feature}
2469 {not in Vi}
2470 This is a list of character encodings considered when starting to edit
2471 an existing file. When a file is read, Vim tries to use the first
2472 mentioned character encoding. If an error is detected, the next one
2473 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002474 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475 an empty string, which means the value of 'encoding' is used.
2476 WARNING: Conversion can cause loss of information! When
2477 'encoding' is "utf-8" (or one of the other Unicode variants)
2478 conversion is most likely done in a way that the reverse
2479 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002480 "utf-8" some non-ASCII characters may be lost! You can use
2481 the |++bad| argument to specify what is done with characters
2482 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 For an empty file or a file with only ASCII characters most encodings
2484 will work and the first entry of 'fileencodings' will be used (except
2485 "ucs-bom", which requires the BOM to be present). If you prefer
2486 another encoding use an BufReadPost autocommand event to test if your
2487 preferred encoding is to be used. Example: >
2488 au BufReadPost * if search('\S', 'w') == 0 |
2489 \ set fenc=iso-2022-jp | endif
2490< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2491 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002492 When the |++enc| argument is used then the value of 'fileencodings' is
2493 not used.
2494 Note that 'fileencodings' is not used for a new file, 'fileencoding'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 is always empty then. This means that a non-existing file may get a
2496 different encoding than an empty file.
2497 The special value "ucs-bom" can be used to check for a Unicode BOM
2498 (Byte Order Mark) at the start of the file. It must not be preceded
2499 by "utf-8" or another Unicode encoding for this to work properly.
2500 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2501 because Vim cannot detect an error, thus the encoding is always
2502 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002503 The special value "default" can be used for the encoding from the
2504 environment. This is the default value for 'encoding'. It is useful
2505 when 'encoding' is set to "utf-8" and your environment uses a
2506 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 WRONG VALUES: WHAT'S WRONG:
2508 latin1,utf-8 "latin1" will always be used
2509 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2510 file
2511 cp1250,latin1 "cp1250" will always be used
2512 If 'fileencodings' is empty, 'fileencoding' is not modified.
2513 See 'fileencoding' for the possible values.
2514 Setting this option does not have an effect until the next time a file
2515 is read.
2516
2517 *'fileformat'* *'ff'*
2518'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2519 Unix default: "unix",
2520 Macintosh default: "mac")
2521 local to buffer
2522 {not in Vi}
2523 This gives the <EOL> of the current buffer, which is used for
2524 reading/writing the buffer from/to a file:
2525 dos <CR> <NL>
2526 unix <NL>
2527 mac <CR>
2528 When "dos" is used, CTRL-Z at the end of a file is ignored.
2529 See |file-formats| and |file-read|.
2530 For the character encoding of the file see 'fileencoding'.
2531 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2532 works like it was set to "unix'.
2533 This option is set automatically when starting to edit a file and
2534 'fileformats' is not empty and 'binary' is off.
2535 When this option is set, after starting to edit a file, the 'modified'
2536 option is set, because the file would be different when written.
2537 This option can not be changed when 'modifiable' is off.
2538 For backwards compatibility: When this option is set to "dos",
2539 'textmode' is set, otherwise 'textmode' is reset.
2540
2541 *'fileformats'* *'ffs'*
2542'fileformats' 'ffs' string (default:
2543 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2544 Vim Unix: "unix,dos",
2545 Vim Mac: "mac,unix,dos",
2546 Vi Cygwin: "unix,dos",
2547 Vi others: "")
2548 global
2549 {not in Vi}
2550 This gives the end-of-line (<EOL>) formats that will be tried when
2551 starting to edit a new buffer and when reading a file into an existing
2552 buffer:
2553 - When empty, the format defined with 'fileformat' will be used
2554 always. It is not set automatically.
2555 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002556 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 'fileformats' name will be used when a file is read into an existing
2558 buffer, no matter what 'fileformat' for that buffer is set to.
2559 - When more than one name is present, separated by commas, automatic
2560 <EOL> detection will be done when reading a file. When starting to
2561 edit a file, a check is done for the <EOL>:
2562 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2563 'fileformat' is set to "dos".
2564 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002565 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 preceding <CR>, "unix" is preferred over "dos".
2567 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2568 This means that "mac" is only chosen when "unix" is not present,
2569 or when no <NL> is found in the file, and when "dos" is not
2570 present, or no <CR><NL> is present in the file.
2571 Also if "unix" was first chosen, but the first <CR> is before
2572 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2573 the file, then 'fileformat' is set to "mac".
2574 4. If 'fileformat' is still not set, the first name from
2575 'fileformats' is used.
2576 When reading a file into an existing buffer, the same is done, but
2577 this happens like 'fileformat' has been set appropriately for that
2578 file only, the option is not changed.
2579 When 'binary' is set, the value of 'fileformats' is not used.
2580
2581 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2582 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2583 done:
2584 - When 'fileformats' is empty, there is no automatic detection. Dos
2585 format will be used.
2586 - When 'fileformats' is set to one or more names, automatic detection
2587 is done. This is based on the first <NL> in the file: If there is a
2588 <CR> in front of it, Dos format is used, otherwise Unix format is
2589 used.
2590 Also see |file-formats|.
2591 For backwards compatibility: When this option is set to an empty
2592 string or one format (no comma is included), 'textauto' is reset,
2593 otherwise 'textauto' is set.
2594 NOTE: This option is set to the Vi default value when 'compatible' is
2595 set and to the Vim default value when 'compatible' is reset.
2596
2597 *'filetype'* *'ft'*
2598'filetype' 'ft' string (default: "")
2599 local to buffer
2600 {not in Vi}
2601 {not available when compiled without the |+autocmd|
2602 feature}
2603 When this option is set, the FileType autocommand event is triggered.
2604 All autocommands that match with the value of this option will be
2605 executed. Thus the value of 'filetype' is used in place of the file
2606 name.
2607 Otherwise this option does not always reflect the current file type.
2608 This option is normally set when the file type is detected. To enable
2609 this use the ":filetype on" command. |:filetype|
2610 Setting this option to a different value is most useful in a modeline,
2611 for a file for which the file type is not automatically recognized.
2612 Example, for in an IDL file: >
2613 /* vim: set filetype=idl : */
2614< |FileType| |filetypes|
2615 Do not confuse this option with 'osfiletype', which is for the file
2616 type that is actually stored with the file.
2617 This option is not copied to another buffer, independent of the 's' or
2618 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002619 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620
2621 *'fillchars'* *'fcs'*
2622'fillchars' 'fcs' string (default "vert:|,fold:-")
2623 global
2624 {not in Vi}
2625 {not available when compiled without the |+windows|
2626 and |+folding| features}
2627 Characters to fill the statuslines and vertical separators.
2628 It is a comma separated list of items:
2629
2630 item default Used for ~
2631 stl:c ' ' or '^' statusline of the current window
2632 stlnc:c ' ' or '-' statusline of the non-current windows
2633 vert:c '|' vertical separators |:vsplit|
2634 fold:c '-' filling 'foldtext'
2635 diff:c '-' deleted lines of the 'diff' option
2636
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002637 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 "stlnc" the space will be used when there is highlighting, '^' or '-'
2639 otherwise.
2640
2641 Example: >
2642 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2643< This is similar to the default, except that these characters will also
2644 be used when there is highlighting.
2645
2646 The highlighting used for these items:
2647 item highlight group ~
2648 stl:c StatusLine |hl-StatusLine|
2649 stlnc:c StatusLineNC |hl-StatusLineNC|
2650 vert:c VertSplit |hl-VertSplit|
2651 fold:c Folded |hl-Folded|
2652 diff:c DiffDelete |hl-DiffDelete|
2653
2654 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2655'fkmap' 'fk' boolean (default off) *E198*
2656 global
2657 {not in Vi}
2658 {only available when compiled with the |+rightleft|
2659 feature}
2660 When on, the keyboard is mapped for the Farsi character set.
2661 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002662 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663
2664 *'foldclose'* *'fcl'*
2665'foldclose' 'fcl' string (default "")
2666 global
2667 {not in Vi}
2668 {not available when compiled without the |+folding|
2669 feature}
2670 When set to "all", a fold is closed when the cursor isn't in it and
2671 its level is higher than 'foldlevel'. Useful if you want folds to
2672 automatically close when moving out of them.
2673
2674 *'foldcolumn'* *'fdc'*
2675'foldcolumn' 'fdc' number (default 0)
2676 local to window
2677 {not in Vi}
2678 {not available when compiled without the |+folding|
2679 feature}
2680 When non-zero, a column with the specified width is shown at the side
2681 of the window which indicates open and closed folds. The maximum
2682 value is 12.
2683 See |folding|.
2684
2685 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2686'foldenable' 'fen' boolean (default on)
2687 local to window
2688 {not in Vi}
2689 {not available when compiled without the |+folding|
2690 feature}
2691 When off, all folds are open. This option can be used to quickly
2692 switch between showing all text unfolded and viewing the text with
2693 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002694 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 'foldenable' is off.
2696 This option is set by commands that create a new fold or close a fold.
2697 See |folding|.
2698
2699 *'foldexpr'* *'fde'*
2700'foldexpr' 'fde' string (default: "0")
2701 local to window
2702 {not in Vi}
2703 {not available when compiled without the |+folding|
2704 or |+eval| feature}
2705 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002706 for each line to obtain its fold level. See |fold-expr|.
2707
2708 The expression may be evaluated in the |sandbox|, see
2709 |sandbox-option|.
2710
2711 It is not allowed to change text or jump to another window while
2712 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713
2714 *'foldignore'* *'fdi'*
2715'foldignore' 'fdi' string (default: "#")
2716 local to window
2717 {not in Vi}
2718 {not available when compiled without the |+folding|
2719 feature}
2720 Used only when 'foldmethod' is "indent". Lines starting with
2721 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002722 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 The default "#" works well for C programs. See |fold-indent|.
2724
2725 *'foldlevel'* *'fdl'*
2726'foldlevel' 'fdl' number (default: 0)
2727 local to window
2728 {not in Vi}
2729 {not available when compiled without the |+folding|
2730 feature}
2731 Sets the fold level: Folds with a higher level will be closed.
2732 Setting this option to zero will close all folds. Higher numbers will
2733 close fewer folds.
2734 This option is set by commands like |zm|, |zM| and |zR|.
2735 See |fold-foldlevel|.
2736
2737 *'foldlevelstart'* *'fdls'*
2738'foldlevelstart' 'fdls' number (default: -1)
2739 global
2740 {not in Vi}
2741 {not available when compiled without the |+folding|
2742 feature}
2743 Sets 'foldlevel' when starting to edit another buffer in a window.
2744 Useful to always start editing with all folds closed (value zero),
2745 some folds closed (one) or no folds closed (99).
2746 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002747 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 ignores this option and closes all folds.
2749 It is also done before BufReadPre autocommands, to allow an autocmd to
2750 overrule the 'foldlevel' value for specific files.
2751 When the value is negative, it is not used.
2752
2753 *'foldmarker'* *'fmr'* *E536*
2754'foldmarker' 'fmr' string (default: "{{{,}}}")
2755 local to window
2756 {not in Vi}
2757 {not available when compiled without the |+folding|
2758 feature}
2759 The start and end marker used when 'foldmethod' is "marker". There
2760 must be one comma, which separates the start and end marker. The
2761 marker is a literal string (a regular expression would be too slow).
2762 See |fold-marker|.
2763
2764 *'foldmethod'* *'fdm'*
2765'foldmethod' 'fdm' string (default: "manual")
2766 local to window
2767 {not in Vi}
2768 {not available when compiled without the |+folding|
2769 feature}
2770 The kind of folding used for the current window. Possible values:
2771 |fold-manual| manual Folds are created manually.
2772 |fold-indent| indent Lines with equal indent form a fold.
2773 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2774 |fold-marker| marker Markers are used to specify folds.
2775 |fold-syntax| syntax Syntax highlighting items specify folds.
2776 |fold-diff| diff Fold text that is not changed.
2777
2778 *'foldminlines'* *'fml'*
2779'foldminlines' 'fml' number (default: 1)
2780 local to window
2781 {not in Vi}
2782 {not available when compiled without the |+folding|
2783 feature}
2784 Sets the minimum number of screen lines for a fold to be displayed
2785 closed. Also for manually closed folds.
2786 Note that this only has an effect of what is displayed. After using
2787 "zc" to close a fold, which is displayed open because it's smaller
2788 than 'foldminlines', a following "zc" may close a containing fold.
2789
2790 *'foldnestmax'* *'fdn'*
2791'foldnestmax' 'fdn' number (default: 20)
2792 local to window
2793 {not in Vi}
2794 {not available when compiled without the |+folding|
2795 feature}
2796 Sets the maximum nesting of folds for the "indent" and "syntax"
2797 methods. This avoids that too many folds will be created. Using more
2798 than 20 doesn't work, because the internal limit is 20.
2799
2800 *'foldopen'* *'fdo'*
2801'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2802 search,tag,undo")
2803 global
2804 {not in Vi}
2805 {not available when compiled without the |+folding|
2806 feature}
2807 Specifies for which type of commands folds will be opened, if the
2808 command moves the cursor into a closed fold. It is a comma separated
2809 list of items.
2810 item commands ~
2811 all any
2812 block "(", "{", "[[", "[{", etc.
2813 hor horizontal movements: "l", "w", "fx", etc.
2814 insert any command in Insert mode
2815 jump far jumps: "G", "gg", etc.
2816 mark jumping to a mark: "'m", CTRL-O, etc.
2817 percent "%"
2818 quickfix ":cn", ":crew", ":make", etc.
2819 search search for a pattern: "/", "n", "*", "gd", etc.
2820 (not for a search pattern in a ":" command)
2821 tag jumping to a tag: ":ta", CTRL-T, etc.
2822 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002823 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 the |zv| command to the mapping to get the same effect.
2825 When a movement command is used for an operator (e.g., "dl" or "y%")
2826 this option is not used. This means the operator will include the
2827 whole closed fold.
2828 Note that vertical movements are not here, because it would make it
2829 very difficult to move onto a closed fold.
2830 In insert mode the folds containing the cursor will always be open
2831 when text is inserted.
2832 To close folds you can re-apply 'foldlevel' with the |zx| command or
2833 set the 'foldclose' option to "all".
2834
2835 *'foldtext'* *'fdt'*
2836'foldtext' 'fdt' string (default: "foldtext()")
2837 local to window
2838 {not in Vi}
2839 {not available when compiled without the |+folding|
2840 feature}
2841 An expression which is used to specify the text displayed for a closed
2842 fold. See |fold-foldtext|.
2843
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002844 The expression may be evaluated in the |sandbox|, see
2845 |sandbox-option|.
2846
2847 It is not allowed to change text or jump to another window while
2848 evaluating 'foldtext' |textlock|.
2849
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 *'formatoptions'* *'fo'*
2851'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2852 local to buffer
2853 {not in Vi}
2854 This is a sequence of letters which describes how automatic
2855 formatting is to be done. See |fo-table|. When the 'paste' option is
2856 on, no formatting is done (like 'formatoptions' is empty). Commas can
2857 be inserted for readability.
2858 To avoid problems with flags that are added in the future, use the
2859 "+=" and "-=" feature of ":set" |add-option-flags|.
2860 NOTE: This option is set to the Vi default value when 'compatible' is
2861 set and to the Vim default value when 'compatible' is reset.
2862
Bram Moolenaar86b68352004-12-27 21:59:20 +00002863 *'formatlistpat'* *'flp'*
2864'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2865 local to buffer
2866 {not in Vi}
2867 A pattern that is used to recognize a list header. This is used for
2868 the "n" flag in 'formatoptions'.
2869 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002870 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002871 while still checking more characters. There must be a character
2872 following the pattern, when it matches the whole line it is handled
2873 like there is no match.
2874 The default recognizes a number, followed by an optional punctuation
2875 character and white space.
2876
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 *'formatprg'* *'fp'*
2878'formatprg' 'fp' string (default "")
2879 global
2880 {not in Vi}
2881 The name of an external program that will be used to format the lines
2882 selected with the "gq" command. The program must take the input on
2883 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002884 such a program.
2885 If this option is an empty string, the internal format function will
2886 be used |C-indenting|.
2887 Environment variables are expanded |:set_env|. See |option-backslash|
2888 about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 This option cannot be set from a |modeline| or in the |sandbox|, for
2890 security reasons.
2891
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002892 *'fsync'* *'fs'*
2893'fsync' 'fs' boolean (default on)
2894 global
2895 {not in Vi}
2896 When on, the library function fsync() will be called after writing a
2897 file. This will flush a file to disk, ensuring that it is safely
2898 written even on filesystems which do metadata-only journaling. This
2899 will force the harddrive to spin up on Linux systems running in laptop
2900 mode, so it may be undesirable in some situations. Be warned that
2901 turning this off increases the chances of data loss after a crash. On
2902 systems without an fsync() implementation, this variable is always
2903 off.
2904 Also see 'swapsync' for controlling fsync() on swap files.
2905
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2907'gdefault' 'gd' boolean (default off)
2908 global
2909 {not in Vi}
2910 When on, the ":substitute" flag 'g' is default on. This means that
2911 all matches in a line are substituted instead of one. When a 'g' flag
2912 is given to a ":substitute" command, this will toggle the substitution
2913 of all or one match. See |complex-change|.
2914
2915 command 'gdefault' on 'gdefault' off ~
2916 :s/// subst. all subst. one
2917 :s///g subst. one subst. all
2918 :s///gg subst. all subst. one
2919
2920 NOTE: This option is reset when 'compatible' is set.
2921
2922 *'grepformat'* *'gfm'*
2923'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2924 global
2925 {not in Vi}
2926 Format to recognize for the ":grep" command output.
2927 This is a scanf-like string that uses the same format as the
2928 'errorformat' option: see |errorformat|.
2929
2930 *'grepprg'* *'gp'*
2931'grepprg' 'gp' string (default "grep -n ",
2932 Unix: "grep -n $* /dev/null",
2933 Win32: "findstr /n" or "grep -n",
2934 VMS: "SEARCH/NUMBERS ")
2935 global or local to buffer |global-local|
2936 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002937 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 and '#' characters, which are expanded like when used in a command-
2939 line. The placeholder "$*" is allowed to specify where the arguments
2940 will be included. Environment variables are expanded |:set_env|. See
2941 |option-backslash| about including spaces and backslashes.
2942 When your "grep" accepts the "-H" argument, use this to make ":grep"
2943 also work well with a single file: >
2944 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002945< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00002946 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
2947 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002948 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 apply equally to 'grepprg'.
2950 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2951 otherwise it's "grep -n".
2952 This option cannot be set from a |modeline| or in the |sandbox|, for
2953 security reasons.
2954
2955 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2956'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2957 ve:ver35-Cursor,
2958 o:hor50-Cursor,
2959 i-ci:ver25-Cursor/lCursor,
2960 r-cr:hor20-Cursor/lCursor,
2961 sm:block-Cursor
2962 -blinkwait175-blinkoff150-blinkon175",
2963 for MS-DOS and Win32 console:
2964 "n-v-c:block,o:hor50,i-ci:hor15,
2965 r-cr:hor30,sm:block")
2966 global
2967 {not in Vi}
2968 {only available when compiled with GUI enabled, and
2969 for MS-DOS and Win32 console}
2970 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002971 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 the height of the cursor can be changed. This can be done by
2973 specifying a block cursor, or a percentage for a vertical or
2974 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002975 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002977 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 mode-list and an argument-list:
2979 mode-list:argument-list,mode-list:argument-list,..
2980 The mode-list is a dash separated list of these modes:
2981 n Normal mode
2982 v Visual mode
2983 ve Visual mode with 'selection' "exclusive" (same as 'v',
2984 if not specified)
2985 o Operator-pending mode
2986 i Insert mode
2987 r Replace mode
2988 c Command-line Normal (append) mode
2989 ci Command-line Insert mode
2990 cr Command-line Replace mode
2991 sm showmatch in Insert mode
2992 a all modes
2993 The argument-list is a dash separated list of these arguments:
2994 hor{N} horizontal bar, {N} percent of the character height
2995 ver{N} vertical bar, {N} percent of the character width
2996 block block cursor, fills the whole character
2997 [only one of the above three should be present]
2998 blinkwait{N} *cursor-blinking*
2999 blinkon{N}
3000 blinkoff{N}
3001 blink times for cursor: blinkwait is the delay before
3002 the cursor starts blinking, blinkon is the time that
3003 the cursor is shown and blinkoff is the time that the
3004 cursor is not shown. The times are in msec. When one
3005 of the numbers is zero, there is no blinking. The
3006 default is: "blinkwait700-blinkon400-blinkoff250".
3007 These numbers are used for a missing entry. This
3008 means that blinking is enabled by default. To switch
3009 blinking off you can use "blinkon0". The cursor only
3010 blinks when Vim is waiting for input, not while
3011 executing a command.
3012 To make the cursor blink in an xterm, see
3013 |xterm-blink|.
3014 {group-name}
3015 a highlight group name, that sets the color and font
3016 for the cursor
3017 {group-name}/{group-name}
3018 Two highlight group names, the first is used when
3019 no language mappings are used, the other when they
3020 are. |language-mapping|
3021
3022 Examples of parts:
3023 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3024 block cursor with colors from the "nCursor"
3025 highlight group
3026 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3027 In Insert and Command-line Insert mode, use a
3028 30% vertical bar cursor with colors from the
3029 "iCursor" highlight group. Blink a bit
3030 faster.
3031
3032 The 'a' mode is different. It will set the given argument-list for
3033 all modes. It does not reset anything to defaults. This can be used
3034 to do a common setting for all modes. For example, to switch off
3035 blinking: "a:blinkon0"
3036
3037 Examples of cursor highlighting: >
3038 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3039 :highlight Cursor gui=NONE guifg=bg guibg=fg
3040<
3041 *'guifont'* *'gfn'*
3042 *E235* *E596* *E610* *E611*
3043'guifont' 'gfn' string (default "")
3044 global
3045 {not in Vi}
3046 {only available when compiled with GUI enabled}
3047 This is a list of fonts which will be used for the GUI version of Vim.
3048 In its simplest form the value is just one font name. When
3049 the font cannot be found you will get an error message. To try other
3050 font names a list can be specified, font names separated with commas.
3051 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003052
Bram Moolenaar05159a02005-02-26 23:04:13 +00003053 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3054 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003055
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 Spaces after a comma are ignored. To include a comma in a font name
3057 precede it with a backslash. Setting an option requires an extra
3058 backslash before a space and a backslash. See also
3059 |option-backslash|. For example: >
3060 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003061< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003063
3064 If none of the fonts can be loaded, Vim will keep the current setting.
3065 If an empty font list is given, Vim will try using other resource
3066 settings (for X, it will use the Vim.font resource), and finally it
3067 will try some builtin default which should always be there ("7x13" in
3068 the case of X). The font names given should be "normal" fonts. Vim
3069 will try to find the related bold and italic fonts.
3070
Bram Moolenaar05159a02005-02-26 23:04:13 +00003071 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003072 :set guifont=*
3073< will bring up a font requester, where you can pick the font you want.
3074
3075 The font name depends on the GUI used. See |setting-guifont| for a
3076 way to set 'guifont' for various systems.
3077
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 For the GTK+ 2 GUI the font name looks like this: >
3079 :set guifont=Andale\ Mono\ 11
3080< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003081
3082 For Mac OSX you can use something like this: >
3083 :set guifont=Monaco:h10
3084< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003086 width). An exception is GTK 2: all fonts are accepted, but
3087 mono-spaced fonts look best.
3088
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 To preview a font on X11, you might be able to use the "xfontsel"
3090 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003091
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 For the Win32 GUI *E244* *E245*
3093 - takes these options in the font name:
3094 hXX - height is XX (points, can be floating-point)
3095 wXX - width is XX (points, can be floating-point)
3096 b - bold
3097 i - italic
3098 u - underline
3099 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003100 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3102 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3103 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003104 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105
3106 Use a ':' to separate the options.
3107 - A '_' can be used in the place of a space, so you don't need to use
3108 backslashes to escape the spaces.
3109 - Examples: >
3110 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3111 :set guifont=Andale_Mono:h7.5:w4.5
3112< See also |font-sizes|.
3113
3114 *'guifontset'* *'gfs'*
3115 *E250* *E252* *E234* *E597* *E598*
3116'guifontset' 'gfs' string (default "")
3117 global
3118 {not in Vi}
3119 {only available when compiled with GUI enabled and
3120 with the |+xfontset| feature}
3121 {not available in the GTK+ 2 GUI}
3122 When not empty, specifies two (or more) fonts to be used. The first
3123 one for normal English, the second one for your special language. See
3124 |xfontset|.
3125 Setting this option also means that all font names will be handled as
3126 a fontset name. Also the ones used for the "font" argument of the
3127 |:highlight| command.
3128 The fonts must match with the current locale. If fonts for the
3129 character sets that the current locale uses are not included, setting
3130 'guifontset' will fail.
3131 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3132 the comma-separated names are alternative names, one of which will be
3133 used. In 'guifontset' the whole string is one fontset name,
3134 including the commas. It is not possible to specify alternative
3135 fontset names.
3136 This example works on many X11 systems: >
3137 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3138<
3139 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3140'guifontwide' 'gfw' string (default "")
3141 global
3142 {not in Vi}
3143 {only available when compiled with GUI enabled}
3144 When not empty, specifies a comma-separated list of fonts to be used
3145 for double-width characters. The first font that can be loaded is
3146 used.
3147 Note: The size of these fonts must be exactly twice as wide as the one
3148 specified with 'guifont' and the same height.
3149
3150 All GUI versions but GTK+ 2:
3151
3152 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3153 'guifontset' is empty or invalid.
3154 When 'guifont' is set and a valid font is found in it and
3155 'guifontwide' is empty Vim will attempt to find a matching
3156 double-width font and set 'guifontwide' to it.
3157
3158 GTK+ 2 GUI only: *guifontwide_gtk2*
3159
3160 If set and valid, 'guifontwide' is always used for double width
3161 characters, even if 'encoding' is not set to "utf-8".
3162 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003163 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 font for characters not available in 'guifont'. Thus you do not need
3165 to set 'guifontwide' at all unless you want to override the choice
3166 made by Pango/Xft.
3167
3168 *'guiheadroom'* *'ghr'*
3169'guiheadroom' 'ghr' number (default 50)
3170 global
3171 {not in Vi} {only for GTK and X11 GUI}
3172 The number of pixels subtracted from the screen height when fitting
3173 the GUI window on the screen. Set this before the GUI is started,
3174 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003175 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 lines will be left for window decorations and other items on the
3177 screen. Set it to a negative value to allow windows taller than the
3178 screen.
3179
3180 *'guioptions'* *'go'*
3181'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003182 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 global
3184 {not in Vi}
3185 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003186 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 sequence of letters which describes what components and options of the
3188 GUI should be used.
3189 To avoid problems with flags that are added in the future, use the
3190 "+=" and "-=" feature of ":set" |add-option-flags|.
3191
3192 Valid letters are as follows:
3193 *guioptions_a*
3194 'a' Autoselect: If present, then whenever VISUAL mode is started,
3195 or the Visual area extended, Vim tries to become the owner of
3196 the windowing system's global selection. This means that the
3197 Visually highlighted text is available for pasting into other
3198 applications as well as into Vim itself. When the Visual mode
3199 ends, possibly due to an operation on the text, or when an
3200 application wants to paste the selection, the highlighted text
3201 is automatically yanked into the "* selection register.
3202 Thus the selection is still available for pasting into other
3203 applications after the VISUAL mode has ended.
3204 If not present, then Vim won't become the owner of the
3205 windowing system's global selection unless explicitly told to
3206 by a yank or delete operation for the "* register.
3207 The same applies to the modeless selection.
3208
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003209 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 applies to the modeless selection.
3211
3212 'guioptions' autoselect Visual autoselect modeless ~
3213 "" - -
3214 "a" yes yes
3215 "A" - yes
3216 "aA" yes yes
3217
3218 'c' Use console dialogs instead of popup dialogs for simple
3219 choices.
3220
3221 'f' Foreground: Don't use fork() to detach the GUI from the shell
3222 where it was started. Use this for programs that wait for the
3223 editor to finish (e.g., an e-mail program). Alternatively you
3224 can use "gvim -f" or ":gui -f" to start the GUI in the
3225 foreground. |gui-fork|
3226 Note: Set this option in the vimrc file. The forking may have
3227 happened already when the gvimrc file is read.
3228
3229 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3230 corner of the window. It's black&white on non-GTK, because of
3231 limitations of X11. For a color icon, see |X11-icon|.
3232
3233 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003234 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 that this flag must be added in the .vimrc file, before
3236 switching on syntax or filetype recognition (when the .gvimrc
3237 file is sourced the system menu has already been loaded; the
3238 ":syntax on" and ":filetype on" commands load the menu too).
3239 'g' Grey menu items: Make menu items that are not active grey. If
3240 'g' is not included inactive menu items are not shown at all.
3241 Exception: Athena will always use grey menu items.
3242
3243 't' Include tearoff menu items. Currently only works for Win32,
3244 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003245 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3246 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247
3248 'r' Right-hand scrollbar is always present.
3249 'R' Right-hand scrollbar is present when there is a vertically
3250 split window.
3251 'l' Left-hand scrollbar is always present.
3252 'L' Left-hand scrollbar is present when there is a vertically
3253 split window.
3254 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3255 the longest visible line, or on the cursor line if the 'h'
3256 flag is included. |gui-horiz-scroll|
3257 'h' Limit horizontal scrollbar size to the length of the cursor
3258 line. Reduces computations. |gui-horiz-scroll|
3259
3260 And yes, you may even have scrollbars on the left AND the right if
3261 you really want to :-). See |gui-scrollbars| for more information.
3262
3263 'v' Use a vertical button layout for dialogs. When not included,
3264 a horizontal layout is preferred, but when it doesn't fit a
3265 vertical layout is used anyway.
3266 'p' Use Pointer callbacks for X11 GUI. This is required for some
3267 window managers. If the cursor is not blinking or hollow at
3268 the right moment, try adding this flag. This must be done
3269 before starting the GUI. Set it in your gvimrc. Adding or
3270 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003271 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272
3273 *'guipty'* *'noguipty'*
3274'guipty' boolean (default on)
3275 global
3276 {not in Vi}
3277 {only available when compiled with GUI enabled}
3278 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3279 I/O to/from shell commands. See |gui-pty|.
3280
3281 *'helpfile'* *'hf'*
3282'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3283 (others) "$VIMRUNTIME/doc/help.txt")
3284 global
3285 {not in Vi}
3286 Name of the main help file. All distributed help files should be
3287 placed together in one directory. Additionally, all "doc" directories
3288 in 'runtimepath' will be used.
3289 Environment variables are expanded |:set_env|. For example:
3290 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003291 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 spaces and backslashes.
3293 This option cannot be set from a |modeline| or in the |sandbox|, for
3294 security reasons.
3295
3296 *'helpheight'* *'hh'*
3297'helpheight' 'hh' number (default 20)
3298 global
3299 {not in Vi}
3300 {not available when compiled without the +windows
3301 feature}
3302 Minimal initial height of the help window when it is opened with the
3303 ":help" command. The initial height of the help window is half of the
3304 current window, or (when the 'ea' option is on) the same as other
3305 windows. When the height is less than 'helpheight', the height is
3306 set to 'helpheight'. Set to zero to disable.
3307
3308 *'helplang'* *'hlg'*
3309'helplang' 'hlg' string (default: messages language or empty)
3310 global
3311 {only available when compiled with the |+multi_lang|
3312 feature}
3313 {not in Vi}
3314 Comma separated list of languages. Vim will use the first language
3315 for which the desired help can be found. The English help will always
3316 be used as a last resort. You can add "en" to prefer English over
3317 another language, but that will only find tags that exist in that
3318 language and not in the English help.
3319 Example: >
3320 :set helplang=de,it
3321< This will first search German, then Italian and finally English help
3322 files.
3323 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3324 try to find the tag in the current language before using this option.
3325 See |help-translated|.
3326
3327 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3328'hidden' 'hid' boolean (default off)
3329 global
3330 {not in Vi}
3331 When off a buffer is unloaded when it is |abandon|ed. When on a
3332 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3333 displayed in another window, it does not become hidden, of course.
3334 The commands that move through the buffer list sometimes make a buffer
3335 hidden although the 'hidden' option is off: When the buffer is
3336 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003337 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003338 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 This option is set for one command with ":hide {command}" |:hide|.
3340 WARNING: It's easy to forget that you have changes in hidden buffers.
3341 Think twice when using ":q!" or ":qa!".
3342
3343 *'highlight'* *'hl'*
3344'highlight' 'hl' string (default (as a single string):
3345 "8:SpecialKey,@:NonText,d:Directory,
3346 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3347 M:ModeMsg,n:LineNr,r:Question,
3348 s:StatusLine,S:StatusLineNC,c:VertSplit
3349 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3350 f:Folded,F:FoldColumn,A:DiffAdd,
3351 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003352 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003353 R:SpellRare,L:SpellLocal,
3354 +:Pmenu,=:PmenuSel,
3355 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 global
3357 {not in Vi}
3358 This option can be used to set highlighting mode for various
3359 occasions. It is a comma separated list of character pairs. The
3360 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003361 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3363 |hl-NonText| @ '~' and '@' at the end of the window and
3364 characters from 'showbreak'
3365 |hl-Directory| d directories in CTRL-D listing and other special
3366 things in listings
3367 |hl-ErrorMsg| e error messages
3368 h (obsolete, ignored)
3369 |hl-IncSearch| i 'incsearch' highlighting
3370 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3371 |hl-MoreMsg| m |more-prompt|
3372 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3373 |hl-LineNr| n line number for ":number" and ":#" commands
3374 |hl-Question| r |hit-enter| prompt and yes/no questions
3375 |hl-StatusLine| s status line of current window |status-line|
3376 |hl-StatusLineNC| S status lines of not-current windows
3377 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3378 |hl-VertSplit| c column used to separate vertically split windows
3379 |hl-Visual| v Visual mode
3380 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3381 Selection" Only X11 Gui's |gui-x11| and
3382 |xterm-clipboard|.
3383 |hl-WarningMsg| w warning messages
3384 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3385 |hl-Folded| f line used for closed folds
3386 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003387 |hl-DiffAdd| A added line in diff mode
3388 |hl-DiffChange| C changed line in diff mode
3389 |hl-DiffDelete| D deleted line in diff mode
3390 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003392 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003393 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003394 |hl-SpellRare| R rare word |spell|
3395 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003396 |hl-Pmenu| + popup menu normal line
3397 |hl-PmenuSel| = popup menu normal line
3398 |hl-PmenuSbar| x popup menu scrollbar
3399 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400
3401 The display modes are:
3402 r reverse (termcap entry "mr" and "me")
3403 i italic (termcap entry "ZH" and "ZR")
3404 b bold (termcap entry "md" and "me")
3405 s standout (termcap entry "so" and "se")
3406 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003407 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 n no highlighting
3409 - no highlighting
3410 : use a highlight group
3411 The default is used for occasions that are not included.
3412 If you want to change what the display modes do, see |dos-colors|
3413 for an example.
3414 When using the ':' display mode, this must be followed by the name of
3415 a highlight group. A highlight group can be used to define any type
3416 of highlighting, including using color. See |:highlight| on how to
3417 define one. The default uses a different group for each occasion.
3418 See |highlight-default| for the default highlight groups.
3419
3420 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3421'hlsearch' 'hls' boolean (default off)
3422 global
3423 {not in Vi}
3424 {not available when compiled without the
3425 |+extra_search| feature}
3426 When there is a previous search pattern, highlight all its matches.
3427 The type of highlighting used can be set with the 'l' occasion in the
3428 'highlight' option. This uses the "Search" highlight group by
3429 default. Note that only the matching text is highlighted, any offsets
3430 are not applied.
3431 See also: 'incsearch' and |:match|.
3432 When you get bored looking at the highlighted matches, you can turn it
3433 off with |:nohlsearch|. As soon as you use a search command, the
3434 highlighting comes back.
3435 When the search pattern can match an end-of-line, Vim will try to
3436 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003437 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 line below a closed fold. A match in a previous line which is not
3439 drawn may not continue in an newly drawn line.
3440 NOTE: This option is reset when 'compatible' is set.
3441
3442 *'history'* *'hi'*
3443'history' 'hi' number (Vim default: 20, Vi default: 0)
3444 global
3445 {not in Vi}
3446 A history of ":" commands, and a history of previous search patterns
3447 are remembered. This option decides how many entries may be stored in
3448 each of these histories (see |cmdline-editing|).
3449 NOTE: This option is set to the Vi default value when 'compatible' is
3450 set and to the Vim default value when 'compatible' is reset.
3451
3452 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3453'hkmap' 'hk' boolean (default off)
3454 global
3455 {not in Vi}
3456 {only available when compiled with the |+rightleft|
3457 feature}
3458 When on, the keyboard is mapped for the Hebrew character set.
3459 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3460 toggle this option. See |rileft.txt|.
3461 NOTE: This option is reset when 'compatible' is set.
3462
3463 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3464'hkmapp' 'hkp' boolean (default off)
3465 global
3466 {not in Vi}
3467 {only available when compiled with the |+rightleft|
3468 feature}
3469 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3470 This is useful if you have a non-Hebrew keyboard.
3471 See |rileft.txt|.
3472 NOTE: This option is reset when 'compatible' is set.
3473
3474 *'icon'* *'noicon'*
3475'icon' boolean (default off, on when title can be restored)
3476 global
3477 {not in Vi}
3478 {not available when compiled without the |+title|
3479 feature}
3480 When on, the icon text of the window will be set to the value of
3481 'iconstring' (if it is not empty), or to the name of the file
3482 currently being edited. Only the last part of the name is used.
3483 Overridden by the 'iconstring' option.
3484 Only works if the terminal supports setting window icons (currently
3485 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3486 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3487 builtin termcap).
3488 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003489 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 X11.
3491
3492 *'iconstring'*
3493'iconstring' string (default "")
3494 global
3495 {not in Vi}
3496 {not available when compiled without the |+title|
3497 feature}
3498 When this option is not empty, it will be used for the icon text of
3499 the window. This happens only when the 'icon' option is on.
3500 Only works if the terminal supports setting window icon text
3501 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3502 Does not work for MS Windows.
3503 When Vim was compiled with HAVE_X11 defined, the original icon will be
3504 restored if possible |X11|.
3505 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003506 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 'titlestring' for example settings.
3508 {not available when compiled without the |+statusline| feature}
3509
3510 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3511'ignorecase' 'ic' boolean (default off)
3512 global
3513 Ignore case in search patterns. Also used when searching in the tags
3514 file.
3515 Also see 'smartcase'.
3516 Can be overruled by using "\c" or "\C" in the pattern, see
3517 |/ignorecase|.
3518
3519 *'imactivatekey'* *'imak'*
3520'imactivatekey' 'imak' string (default "")
3521 global
3522 {not in Vi}
3523 {only available when compiled with |+xim| and
3524 |+GUI_GTK|}
3525 Specifies the key that your Input Method in X-Windows uses for
3526 activation. When this is specified correctly, vim can fully control
3527 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3528 You can't use this option to change the activation key, the option
3529 tells Vim what the key is.
3530 Format:
3531 [MODIFIER_FLAG-]KEY_STRING
3532
3533 These characters can be used for MODIFIER_FLAG (case is ignored):
3534 S Shift key
3535 L Lock key
3536 C Control key
3537 1 Mod1 key
3538 2 Mod2 key
3539 3 Mod3 key
3540 4 Mod4 key
3541 5 Mod5 key
3542 Combinations are allowed, for example "S-C-space" or "SC-space" are
3543 both shift+ctrl+space.
3544 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3545
3546 Example: >
3547 :set imactivatekey=S-space
3548< "S-space" means shift+space. This is the activation key for kinput2 +
3549 canna (Japanese), and ami (Korean).
3550
3551 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3552'imcmdline' 'imc' boolean (default off)
3553 global
3554 {not in Vi}
3555 {only available when compiled with the |+xim|
3556 |+multi_byte_ime| or |global-ime| feature}
3557 When set the Input Method is always on when starting to edit a command
3558 line, unless entering a search pattern (see 'imsearch' for that).
3559 Setting this option is useful when your input method allows entering
3560 English characters directly, e.g., when it's used to type accented
3561 characters with dead keys.
3562
3563 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3564'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3565 global
3566 {not in Vi}
3567 {only available when compiled with the |+xim|
3568 |+multi_byte_ime| or |global-ime| feature}
3569 When set the Input Method is never used. This is useful to disable
3570 the IM when it doesn't work properly.
3571 Currently this option is on by default for SGI/IRIX machines. This
3572 may change in later releases.
3573
3574 *'iminsert'* *'imi'*
3575'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3576 local to buffer
3577 {not in Vi}
3578 Specifies whether :lmap or an Input Method (IM) is to be used in
3579 Insert mode. Valid values:
3580 0 :lmap is off and IM is off
3581 1 :lmap is ON and IM is off
3582 2 :lmap is off and IM is ON
3583 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3584 or |global-ime|.
3585 To always reset the option to zero when leaving Insert mode with <Esc>
3586 this can be used: >
3587 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3588< This makes :lmap and IM turn off automatically when leaving Insert
3589 mode.
3590 Note that this option changes when using CTRL-^ in Insert mode
3591 |i_CTRL-^|.
3592 The value is set to 1 when setting 'keymap' to a valid keymap name.
3593 It is also used for the argument of commands like "r" and "f".
3594 The value 0 may not work correctly with Athena and Motif with some XIM
3595 methods. Use 'imdisable' to disable XIM then.
3596
3597 *'imsearch'* *'ims'*
3598'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3599 local to buffer
3600 {not in Vi}
3601 Specifies whether :lmap or an Input Method (IM) is to be used when
3602 entering a search pattern. Valid values:
3603 -1 the value of 'iminsert' is used, makes it look like
3604 'iminsert' is also used when typing a search pattern
3605 0 :lmap is off and IM is off
3606 1 :lmap is ON and IM is off
3607 2 :lmap is off and IM is ON
3608 Note that this option changes when using CTRL-^ in Command-line mode
3609 |c_CTRL-^|.
3610 The value is set to 1 when it is not -1 and setting the 'keymap'
3611 option to a valid keymap name.
3612 The value 0 may not work correctly with Athena and Motif with some XIM
3613 methods. Use 'imdisable' to disable XIM then.
3614
3615 *'include'* *'inc'*
3616'include' 'inc' string (default "^\s*#\s*include")
3617 global or local to buffer |global-local|
3618 {not in Vi}
3619 {not available when compiled without the
3620 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003621 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 pattern, just like for the "/" command (See |pattern|). The default
3623 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003624 "]I", "[d", etc.
3625 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003626 comes after the matched pattern. But if "\zs" appears in the pattern
3627 then the text matched from "\zs" to the end, or until "\ze" if it
3628 appears, is used as the file name. Use this to include characters
3629 that are not in 'isfname', such as a space. You can then use
3630 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003631 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632
3633 *'includeexpr'* *'inex'*
3634'includeexpr' 'inex' string (default "")
3635 local to buffer
3636 {not in Vi}
3637 {not available when compiled without the
3638 |+find_in_path| or |+eval| feature}
3639 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003640 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 :set includeexpr=substitute(v:fname,'\\.','/','g')
3642< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003643
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003645 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 Also used for |<cfile>|.
3647
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003648 The expression may be evaluated in the |sandbox|, see
3649 |sandbox-option|.
3650
3651 It is not allowed to change text or jump to another window while
3652 evaluating 'includeexpr' |textlock|.
3653
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3655'incsearch' 'is' boolean (default off)
3656 global
3657 {not in Vi}
3658 {not available when compiled without the
3659 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003660 While typing a search command, show where the pattern, as it was typed
3661 so far, matches. The matched string is highlighted. If the pattern
3662 is invalid or not found, nothing is shown. The screen will be updated
3663 often, this is only useful on fast terminals.
3664 Note that the match will be shown, but the cursor will return to its
3665 original position when no match is found and when pressing <Esc>. You
3666 still need to finish the search command with <Enter> to move the
3667 cursor to the match.
3668 The highlighting can be set with the 'i' flag in 'highlight'.
3669 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 NOTE: This option is reset when 'compatible' is set.
3671
3672 *'indentexpr'* *'inde'*
3673'indentexpr' 'inde' string (default "")
3674 local to buffer
3675 {not in Vi}
3676 {not available when compiled without the |+cindent|
3677 or |+eval| features}
3678 Expression which is evaluated to obtain the proper indent for a line.
3679 It is used when a new line is created, for the |=| operator and
3680 in Insert mode as specified with the 'indentkeys' option.
3681 When this option is not empty, it overrules the 'cindent' and
3682 'smartindent' indenting.
3683 When 'paste' is set this option is not used for indenting.
3684 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003685 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 when the expression is evaluated (but it may be moved around).
3687 The expression must return the number of spaces worth of indent. It
3688 can return "-1" to keep the current indent (this means 'autoindent' is
3689 used for the indent).
3690 Functions useful for computing the indent are |indent()|, |cindent()|
3691 and |lispindent()|.
3692 The evaluation of the expression must not have side effects! It must
3693 not change the text, jump to another window, etc. Afterwards the
3694 cursor position is always restored, thus the cursor may be moved.
3695 Normally this option would be set to call a function: >
3696 :set indentexpr=GetMyIndent()
3697< Error messages will be suppressed, unless the 'debug' option contains
3698 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003699 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 NOTE: This option is made empty when 'compatible' is set.
3701
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003702 The expression may be evaluated in the |sandbox|, see
3703 |sandbox-option|.
3704
3705 It is not allowed to change text or jump to another window while
3706 evaluating 'indentexpr' |textlock|.
3707
3708
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 *'indentkeys'* *'indk'*
3710'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3711 local to buffer
3712 {not in Vi}
3713 {not available when compiled without the |+cindent|
3714 feature}
3715 A list of keys that, when typed in Insert mode, cause reindenting of
3716 the current line. Only happens if 'indentexpr' isn't empty.
3717 The format is identical to 'cinkeys', see |indentkeys-format|.
3718 See |C-indenting| and |indent-expression|.
3719
3720 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3721'infercase' 'inf' boolean (default off)
3722 local to buffer
3723 {not in Vi}
3724 When doing keyword completion in insert mode |ins-completion|, and
3725 'ignorecase' is also on, the case of the match is adjusted. If the
3726 typed text contains a lowercase letter where the match has an upper
3727 case letter, the completed part is made lowercase. If the typed text
3728 has no lowercase letters and the match has a lowercase letter where
3729 the typed text has an uppercase letter, and there is a letter before
3730 it, the completed part is made uppercase.
3731
3732 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3733'insertmode' 'im' boolean (default off)
3734 global
3735 {not in Vi}
3736 Makes Vim work in a way that Insert mode is the default mode. Useful
3737 if you want to use Vim as a modeless editor. Used for |evim|.
3738 These Insert mode commands will be useful:
3739 - Use the cursor keys to move around.
3740 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3741 this is a mapping, it is executed as if 'insertmode' was off.
3742 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003744 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3745 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746
3747 These items change when 'insertmode' is set:
3748 - when starting to edit of a file, Vim goes to Insert mode.
3749 - <Esc> in Insert mode is a no-op and beeps.
3750 - <Esc> in Normal mode makes Vim go to Insert mode.
3751 - CTRL-L in Insert mode is a command, it is not inserted.
3752 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3753 However, when <Esc> is used inside a mapping, it behaves like
3754 'insertmode' was not set. This was done to be able to use the same
3755 mappings with 'insertmode' set or not set.
3756 When executing commands with |:normal| 'insertmode' is not used.
3757
3758 NOTE: This option is reset when 'compatible' is set.
3759
3760 *'isfname'* *'isf'*
3761'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3762 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3763 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3764 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3765 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3766 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3767 global
3768 {not in Vi}
3769 The characters specified by this option are included in file names and
3770 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003771 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 Multi-byte characters 256 and above are always included, only the
3773 characters up to 255 are specified with this option.
3774 For UTF-8 the characters 0xa0 to 0xff are included as well.
3775
3776 Note that on systems using a backslash as path separator, Vim tries to
3777 do its best to make it work as you would expect. That is a bit
3778 tricky, since Vi originally used the backslash to escape special
3779 characters. Vim will not remove a backslash in front of a normal file
3780 name character on these systems, but it will on Unix and alikes. The
3781 '&' and '^' are not included by default, because these are special for
3782 cmd.exe.
3783
3784 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003785 Each part can be a single character number or a range. A range is two
3786 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 decimal number between 0 and 255 or the ASCII character itself (does
3788 not work for digits). Example:
3789 "_,-,128-140,#-43" (include '_' and '-' and the range
3790 128 to 140 and '#' to 43)
3791 If a part starts with '^', the following character number or range
3792 will be excluded from the option. The option is interpreted from left
3793 to right. Put the excluded character after the range where it is
3794 included. To include '^' itself use it as the last character of the
3795 option or the end of a range. Example:
3796 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3797 If the character is '@', all characters where isalpha() returns TRUE
3798 are included. Normally these are the characters a to z and A to Z,
3799 plus accented characters. To include '@' itself use "@-@". Examples:
3800 "@,^a-z" All alphabetic characters, excluding lower
3801 case letters.
3802 "a-z,A-Z,@-@" All letters plus the '@' character.
3803 A comma can be included by using it where a character number is
3804 expected. Example:
3805 "48-57,,,_" Digits, comma and underscore.
3806 A comma can be excluded by prepending a '^'. Example:
3807 " -~,^,,9" All characters from space to '~', excluding
3808 comma, plus <Tab>.
3809 See |option-backslash| about including spaces and backslashes.
3810
3811 *'isident'* *'isi'*
3812'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3813 "@,48-57,_,128-167,224-235"
3814 otherwise: "@,48-57,_,192-255")
3815 global
3816 {not in Vi}
3817 The characters given by this option are included in identifiers.
3818 Identifiers are used in recognizing environment variables and after a
3819 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003820 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 option.
3822 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003823 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3825
3826 *'iskeyword'* *'isk'*
3827'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3828 "@,48-57,_,128-167,224-235"
3829 otherwise: "@,48-57,_,192-255"
3830 Vi default: "@,48-57,_")
3831 local to buffer
3832 {not in Vi}
3833 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003834 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 'isfname' for a description of the format of this option. For C
3836 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3837 For a help file it is set to all non-blank printable characters except
3838 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3839 command).
3840 When the 'lisp' option is on the '-' character is always included.
3841 NOTE: This option is set to the Vi default value when 'compatible' is
3842 set and to the Vim default value when 'compatible' is reset.
3843
3844 *'isprint'* *'isp'*
3845'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3846 "@,~-255"; otherwise: "@,161-255")
3847 global
3848 {not in Vi}
3849 The characters given by this option are displayed directly on the
3850 screen. It is also used for "\p" in a |pattern|. The characters from
3851 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3852 even when they are not included in 'isprint' or excluded. See
3853 'isfname' for a description of the format of this option.
3854
3855 Non-printable characters are displayed with two characters:
3856 0 - 31 "^@" - "^_"
3857 32 - 126 always single characters
3858 127 "^?"
3859 128 - 159 "~@" - "~_"
3860 160 - 254 "| " - "|~"
3861 255 "~?"
3862 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3863 displayed as <xx>, with the hexadecimal value of the byte.
3864 When 'display' contains "uhex" all unprintable characters are
3865 displayed as <xx>.
3866 The NonText highlighting will be used for unprintable characters.
3867 |hl-NonText|
3868
3869 Multi-byte characters 256 and above are always included, only the
3870 characters up to 255 are specified with this option. When a character
3871 is printable but it is not available in the current font, a
3872 replacement character will be shown.
3873 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3874 There is no option to specify these characters.
3875
3876 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3877'joinspaces' 'js' boolean (default on)
3878 global
3879 {not in Vi}
3880 Insert two spaces after a '.', '?' and '!' with a join command.
3881 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3882 Otherwise only one space is inserted.
3883 NOTE: This option is set when 'compatible' is set.
3884
3885 *'key'*
3886'key' string (default "")
3887 local to buffer
3888 {not in Vi}
3889 The key that is used for encrypting and decrypting the current buffer.
3890 See |encryption|.
3891 Careful: Do not set the key value by hand, someone might see the typed
3892 key. Use the |:X| command. But you can make 'key' empty: >
3893 :set key=
3894< It is not possible to get the value of this option with ":set key" or
3895 "echo &key". This is to avoid showing it to someone who shouldn't
3896 know. It also means you cannot see it yourself once you have set it,
3897 be careful not to make a typing error!
3898
3899 *'keymap'* *'kmp'* *E544*
3900'keymap' 'kmp' string (default "")
3901 local to buffer
3902 {not in Vi}
3903 {only available when compiled with the |+keymap|
3904 feature}
3905 Name of a keyboard mapping. See |mbyte-keymap|.
3906 Setting this option to a valid keymap name has the side effect of
3907 setting 'iminsert' to one, so that the keymap becomes effective.
3908 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003909 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910
3911 *'keymodel'* *'km'*
3912'keymodel' 'km' string (default "")
3913 global
3914 {not in Vi}
3915 List of comma separated words, which enable special things that keys
3916 can do. These values can be used:
3917 startsel Using a shifted special key starts selection (either
3918 Select mode or Visual mode, depending on "key" being
3919 present in 'selectmode').
3920 stopsel Using a not-shifted special key stops selection.
3921 Special keys in this context are the cursor keys, <End>, <Home>,
3922 <PageUp> and <PageDown>.
3923 The 'keymodel' option is set by the |:behave| command.
3924
3925 *'keywordprg'* *'kp'*
3926'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3927 OS/2: "view /", VMS: "help")
3928 global or local to buffer |global-local|
3929 {not in Vi}
3930 Program to use for the |K| command. Environment variables are
3931 expanded |:set_env|. ":help" may be used to access the Vim internal
3932 help. (Note that previously setting the global option to the empty
3933 value did this, which is now deprecated.)
3934 When "man" is used, Vim will automatically translate a count for the
3935 "K" command to a section number. Also for "man -s", in which case the
3936 "-s" is removed when there is no count.
3937 See |option-backslash| about including spaces and backslashes.
3938 Example: >
3939 :set keywordprg=man\ -s
3940< This option cannot be set from a |modeline| or in the |sandbox|, for
3941 security reasons.
3942
3943 *'langmap'* *'lmap'* *E357* *E358*
3944'langmap' 'lmap' string (default "")
3945 global
3946 {not in Vi}
3947 {only available when compiled with the |+langmap|
3948 feature}
3949 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003950 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 inserted directly. When in command mode the 'langmap' option takes
3952 care of translating these special characters to the original meaning
3953 of the key. This means you don't have to change the keyboard mode to
3954 be able to execute Normal mode commands.
3955 This is the opposite of the 'keymap' option, where characters are
3956 mapped in Insert mode.
3957 This only works for 8-bit characters. The value of 'langmap' may be
3958 specified with multi-byte characters (e.g., UTF-8), but only the lower
3959 8 bits of each character will be used.
3960
3961 Example (for Greek): *greek* >
3962 :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
3963< Example (exchanges meaning of z and y for commands): >
3964 :set langmap=zy,yz,ZY,YZ
3965<
3966 The 'langmap' option is a list of parts, separated with commas. Each
3967 part can be in one of two forms:
3968 1. A list of pairs. Each pair is a "from" character immediately
3969 followed by the "to" character. Examples: "aA", "aAbBcC".
3970 2. A list of "from" characters, a semi-colon and a list of "to"
3971 characters. Example: "abc;ABC"
3972 Example: "aA,fgh;FGH,cCdDeE"
3973 Special characters need to be preceded with a backslash. These are
3974 ";", ',' and backslash itself.
3975
3976 This will allow you to activate vim actions without having to switch
3977 back and forth between the languages. Your language characters will
3978 be understood as normal vim English characters (according to the
3979 langmap mappings) in the following cases:
3980 o Normal/Visual mode (commands, buffer/register names, user mappings)
3981 o Insert/Replace Mode: Register names after CTRL-R
3982 o Insert/Replace Mode: Mappings
3983 Characters entered in Command-line mode will NOT be affected by
3984 this option. Note that this option can be changed at any time
3985 allowing to switch between mappings for different languages/encodings.
3986 Use a mapping to avoid having to type it each time!
3987
3988 *'langmenu'* *'lm'*
3989'langmenu' 'lm' string (default "")
3990 global
3991 {not in Vi}
3992 {only available when compiled with the |+menu| and
3993 |+multi_lang| features}
3994 Language to use for menu translation. Tells which file is loaded
3995 from the "lang" directory in 'runtimepath': >
3996 "lang/menu_" . &langmenu . ".vim"
3997< (without the spaces). For example, to always use the Dutch menus, no
3998 matter what $LANG is set to: >
3999 :set langmenu=nl_NL.ISO_8859-1
4000< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004001 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 If your $LANG is set to a non-English language but you do want to use
4003 the English menus: >
4004 :set langmenu=none
4005< This option must be set before loading menus, switching on filetype
4006 detection or syntax highlighting. Once the menus are defined setting
4007 this option has no effect. But you could do this: >
4008 :source $VIMRUNTIME/delmenu.vim
4009 :set langmenu=de_DE.ISO_8859-1
4010 :source $VIMRUNTIME/menu.vim
4011< Warning: This deletes all menus that you defined yourself!
4012
4013 *'laststatus'* *'ls'*
4014'laststatus' 'ls' number (default 1)
4015 global
4016 {not in Vi}
4017 The value of this option influences when the last window will have a
4018 status line:
4019 0: never
4020 1: only if there are at least two windows
4021 2: always
4022 The screen looks nicer with a status line if you have several
4023 windows, but it takes another screen line. |status-line|
4024
4025 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4026'lazyredraw' 'lz' boolean (default off)
4027 global
4028 {not in Vi}
4029 When this option is set, the screen will not be redrawn while
4030 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004031 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 update use |:redraw|.
4033
4034 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4035'linebreak' 'lbr' boolean (default off)
4036 local to window
4037 {not in Vi}
4038 {not available when compiled without the |+linebreak|
4039 feature}
4040 If on Vim will wrap long lines at a character in 'breakat' rather
4041 than at the last character that fits on the screen. Unlike
4042 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4043 it only affects the way the file is displayed, not its contents. The
4044 value of 'showbreak' is used to put in front of wrapped lines.
4045 This option is not used when the 'wrap' option is off or 'list' is on.
4046 Note that <Tab> characters after an <EOL> are mostly not displayed
4047 with the right amount of white space.
4048
4049 *'lines'* *E593*
4050'lines' number (default 24 or terminal height)
4051 global
4052 Number of lines of the Vim window.
4053 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004054 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 When Vim is running in the GUI or in a resizable window, setting this
4056 option will cause the window size to be changed. When you only want
4057 to use the size for the GUI, put the command in your |gvimrc| file.
4058 Vim limits the number of lines to what fits on the screen. You can
4059 use this command to get the tallest window possible: >
4060 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004061< Minimum value is 2, maximum value is 1000.
4062 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 When you set this option and Vim is unable to change the physical
4064 number of lines of the display, the display may be messed up.
4065
4066 *'linespace'* *'lsp'*
4067'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4068 global
4069 {not in Vi}
4070 {only in the GUI}
4071 Number of pixel lines inserted between characters. Useful if the font
4072 uses the full character cell height, making lines touch each other.
4073 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004074 With some fonts there can be too much room between lines (to have
4075 space for ascents and descents). Then it makes sense to set
4076 'linespace' to a negative value. This may cause display problems
4077 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078
4079 *'lisp'* *'nolisp'*
4080'lisp' boolean (default off)
4081 local to buffer
4082 {not available when compiled without the |+lispindent|
4083 feature}
4084 Lisp mode: When <Enter> is typed in insert mode set the indent for
4085 the next line to Lisp standards (well, sort of). Also happens with
4086 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4087 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4088 better. Also see 'lispwords'.
4089 The '-' character is included in keyword characters. Redefines the
4090 "=" operator to use this same indentation algorithm rather than
4091 calling an external program if 'equalprg' is empty.
4092 This option is not used when 'paste' is set.
4093 {Vi: Does it a little bit differently}
4094
4095 *'lispwords'* *'lw'*
4096'lispwords' 'lw' string (default is very long)
4097 global
4098 {not in Vi}
4099 {not available when compiled without the |+lispindent|
4100 feature}
4101 Comma separated list of words that influence the Lisp indenting.
4102 |'lisp'|
4103
4104 *'list'* *'nolist'*
4105'list' boolean (default off)
4106 local to window
4107 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4108 see the difference between tabs and spaces and for trailing blanks.
4109 Note that this will also affect formatting (set with 'textwidth' or
4110 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4111 changing the way tabs are displayed.
4112
4113 *'listchars'* *'lcs'*
4114'listchars' 'lcs' string (default "eol:$")
4115 global
4116 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004117 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 settings.
4119 eol:c Character to show at the end of each line. When
4120 omitted, there is no extra character at the end of the
4121 line.
4122 tab:xy Two characters to be used to show a Tab. The first
4123 char is used once. The second char is repeated to
4124 fill the space that the Tab normally occupies.
4125 "tab:>-" will show a Tab that takes four spaces as
4126 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004127 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 trailing spaces are blank.
4129 extends:c Character to show in the last column, when 'wrap' is
4130 off and the line continues beyond the right of the
4131 screen.
4132 precedes:c Character to show in the first column, when 'wrap'
4133 is off and there is text preceding the character
4134 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004135 nbsp:c Character to show for a non-breakable space (character
4136 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004138 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 be used when 'encoding' is "utf-8", otherwise only printable
4140 characters are allowed.
4141
4142 Examples: >
4143 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004144 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 :set lcs=extends:>,precedes:<
4146< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004147 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148
4149 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4150'loadplugins' 'lpl' boolean (default on)
4151 global
4152 {not in Vi}
4153 When on the plugin scripts are loaded when starting up |load-plugins|.
4154 This option can be reset in your |vimrc| file to disable the loading
4155 of plugins.
4156 Note that using the "-u NONE" and "--noplugin" command line arguments
4157 reset this option. |-u| |--noplugin|
4158
4159 *'magic'* *'nomagic'*
4160'magic' boolean (default on)
4161 global
4162 Changes the special characters that can be used in search patterns.
4163 See |pattern|.
4164 NOTE: To avoid portability problems with using patterns, always keep
4165 this option at the default "on". Only switch it off when working with
4166 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004167 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168
4169 *'makeef'* *'mef'*
4170'makeef' 'mef' string (default: "")
4171 global
4172 {not in Vi}
4173 {not available when compiled without the |+quickfix|
4174 feature}
4175 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4176 and the |:grep| command.
4177 When it is empty, an internally generated temp file will be used.
4178 When "##" is included, it is replaced by a number to make the name
4179 unique. This makes sure that the ":make" command doesn't overwrite an
4180 existing file.
4181 NOT used for the ":cf" command. See 'errorfile' for that.
4182 Environment variables are expanded |:set_env|.
4183 See |option-backslash| about including spaces and backslashes.
4184 This option cannot be set from a |modeline| or in the |sandbox|, for
4185 security reasons.
4186
4187 *'makeprg'* *'mp'*
4188'makeprg' 'mp' string (default "make", VMS: "MMS")
4189 global or local to buffer |global-local|
4190 {not in Vi}
4191 Program to use for the ":make" command. See |:make_makeprg|. This
4192 option may contain '%' and '#' characters, which are expanded like
4193 when used in a command-line. Environment variables are expanded
4194 |:set_env|. See |option-backslash| about including spaces and
4195 backslashes. Note that a '|' must be escaped twice: once for ":set"
4196 and once for the interpretation of a command. When you use a filter
4197 called "myfilter" do it like this: >
4198 :set makeprg=gmake\ \\\|\ myfilter
4199< The placeholder "$*" can be given (even multiple times) to specify
4200 where the arguments will be included, for example: >
4201 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4202< This option cannot be set from a |modeline| or in the |sandbox|, for
4203 security reasons.
4204
4205 *'matchpairs'* *'mps'*
4206'matchpairs' 'mps' string (default "(:),{:},[:]")
4207 local to buffer
4208 {not in Vi}
4209 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004210 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 must be different. The characters must be separated by a colon. The
4212 pairs must be separated by a comma. Example for including '<' and '>'
4213 (HTML): >
4214 :set mps+=<:>
4215
4216< A more exotic example, to jump between the '=' and ';' in an
4217 assignment, useful for languages like C and Java: >
4218 :au FileType c,cpp,java set mps+==:;
4219
4220< For a more advanced way of using "%", see the matchit.vim plugin in
4221 the $VIMRUNTIME/macros directory. |add-local-help|
4222
4223 *'matchtime'* *'mat'*
4224'matchtime' 'mat' number (default 5)
4225 global
4226 {not in Vi}{in Nvi}
4227 Tenths of a second to show the matching paren, when 'showmatch' is
4228 set. Note that this is not in milliseconds, like other options that
4229 set a time. This is to be compatible with Nvi.
4230
4231 *'maxfuncdepth'* *'mfd'*
4232'maxfuncdepth' 'mfd' number (default 100)
4233 global
4234 {not in Vi}
4235 Maximum depth of function calls for user functions. This normally
4236 catches endless recursion. When using a recursive function with
4237 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4238 more memory, there is the danger of failing when memory is exhausted.
4239 See also |:function|.
4240
4241 *'maxmapdepth'* *'mmd'* *E223*
4242'maxmapdepth' 'mmd' number (default 1000)
4243 global
4244 {not in Vi}
4245 Maximum number of times a mapping is done without resulting in a
4246 character to be used. This normally catches endless mappings, like
4247 ":map x y" with ":map y x". It still does not catch ":map g wg",
4248 because the 'w' is used before the next mapping is done. See also
4249 |key-mapping|.
4250
4251 *'maxmem'* *'mm'*
4252'maxmem' 'mm' number (default between 256 to 5120 (system
4253 dependent) or half the amount of memory
4254 available)
4255 global
4256 {not in Vi}
4257 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4258 limit is reached allocating extra memory for a buffer will cause
4259 other memory to be freed. Maximum value 2000000. Use this to work
4260 without a limit. Also see 'maxmemtot'.
4261
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004262 *'maxmempattern'* *'mmp'*
4263'maxmempattern' 'mmp' number (default 1000)
4264 global
4265 {not in Vi}
4266 Maximum amount of memory (in Kbyte) to use for pattern matching.
4267 Maximum value 2000000. Use this to work without a limit.
4268 *E363*
4269 When Vim runs into the limit it gives an error message mostly behaves
4270 like CTRL-C was typed.
4271 Running into the limit often means that the pattern is very
4272 inefficient or too complex. This may already happen with the pattern
4273 "\(.\)*" on a very long line. ".*" works much better.
4274 Vim may run out of memory before hitting the 'maxmempattern' limit.
4275
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 *'maxmemtot'* *'mmt'*
4277'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4278 dependent) or half the amount of memory
4279 available)
4280 global
4281 {not in Vi}
4282 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004283 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 'maxmem'.
4285
4286 *'menuitems'* *'mis'*
4287'menuitems' 'mis' number (default 25)
4288 global
4289 {not in Vi}
4290 {not available when compiled without the |+menu|
4291 feature}
4292 Maximum number of items to use in a menu. Used for menus that are
4293 generated from a list of items, e.g., the Buffers menu. Changing this
4294 option has no direct effect, the menu must be refreshed first.
4295
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004296 *'mkspellmem'* *'msm'*
4297'mkspellmem' 'msm' string (default "460000,2000,500")
4298 global
4299 {not in Vi}
4300 {not available when compiled without the |+syntax|
4301 feature}
4302 Parameters for |:mkspell|. This tunes when to start compressing the
4303 word tree. Compression can be slow when there are many words, but
4304 it's needed to avoid running out of memory. The amount of memory used
4305 per word depends very much on how similar the words are, that's why
4306 this tuning is complicated.
4307
4308 There are three numbers, separated by commas:
4309 {start},{inc},{added}
4310
4311 For most languages the uncompressed word tree fits in memory. {start}
4312 gives the amount of memory in Kbyte that can be used before any
4313 compression is done. It should be a bit smaller than the amount of
4314 memory that is available to Vim.
4315
4316 When going over the {start} limit the {inc} number specifies the
4317 amount of memory in Kbyte that can be allocated before another
4318 compression is done. A low number means compression is done after
4319 less words are added, which is slow. A high number means more memory
4320 will be allocated.
4321
4322 After doing compression, {added} times 1024 words can be added before
4323 the {inc} limit is ignored and compression is done when any extra
4324 amount of memory is needed. A low number means there is a smaller
4325 chance of hitting the {inc} limit, less memory is used but it's
4326 slower.
4327
4328 The languages for which these numbers are important are Italian and
4329 Hungarian. The default works for when you have about 512 Mbyte. If
4330 you have 1 Gbyte you could use: >
4331 :set mkspellmem=900000,3000,800
4332< If you have less than 512 Mbyte |:mkspell| may fail for some
4333 languages, no matter what you set 'mkspellmem' to.
4334
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4336'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4337 local to buffer
4338 *'modelines'* *'mls'*
4339'modelines' 'mls' number (default 5)
4340 global
4341 {not in Vi}
4342 If 'modeline' is on 'modelines' gives the number of lines that is
4343 checked for set commands. If 'modeline' is off or 'modelines' is zero
4344 no lines are checked. See |modeline|.
4345 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4346 set and to the Vim default value when 'compatible' is reset.
4347
4348 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4349'modifiable' 'ma' boolean (default on)
4350 local to buffer
4351 {not in Vi} *E21*
4352 When off the buffer contents cannot be changed. The 'fileformat' and
4353 'fileencoding' options also can't be changed.
4354 Can be reset with the |-M| command line argument.
4355
4356 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4357'modified' 'mod' boolean (default off)
4358 local to buffer
4359 {not in Vi}
4360 When on, the buffer is considered to be modified. This option is set
4361 when:
4362 1. A change was made to the text since it was last written. Using the
4363 |undo| command to go back to the original text will reset the
4364 option. But undoing changes that were made before writing the
4365 buffer will set the option again, since the text is different from
4366 when it was written.
4367 2. 'fileformat' or 'fileencoding' is different from its original
4368 value. The original value is set when the buffer is read or
4369 written. A ":set nomodified" command also resets the original
4370 values to the current values and the 'modified' option will be
4371 reset.
4372 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4373 will be ignored.
4374
4375 *'more'* *'nomore'*
4376'more' boolean (Vim default: on, Vi default: off)
4377 global
4378 {not in Vi}
4379 When on, listings pause when the whole screen is filled. You will get
4380 the |more-prompt|. When this option is off there are no pauses, the
4381 listing continues until finished.
4382 NOTE: This option is set to the Vi default value when 'compatible' is
4383 set and to the Vim default value when 'compatible' is reset.
4384
4385 *'mouse'* *E538*
4386'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4387 global
4388 {not in Vi}
4389 Enable the use of the mouse. Only works for certain terminals
4390 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4391 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4392 The mouse can be enabled for different modes:
4393 n Normal mode
4394 v Visual mode
4395 i Insert mode
4396 c Command-line mode
4397 h all previous modes when editing a help file
4398 a all previous modes
4399 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 Normally you would enable the mouse in all four modes with: >
4401 :set mouse=a
4402< When the mouse is not enabled, the GUI will still use the mouse for
4403 modeless selection. This doesn't move the text cursor.
4404
4405 See |mouse-using|. Also see |'clipboard'|.
4406
4407 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004408 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 the mouse buttons can still be used by keeping the shift key pressed.
4410 Also see the 'clipboard' option.
4411
4412 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4413'mousefocus' 'mousef' boolean (default off)
4414 global
4415 {not in Vi}
4416 {only works in the GUI}
4417 The window that the mouse pointer is on is automatically activated.
4418 When changing the window layout or window focus in another way, the
4419 mouse pointer is moved to the window with keyboard focus. Off is the
4420 default because it makes using the pull down menus a little goofy, as
4421 a pointer transit may activate a window unintentionally.
4422
4423 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4424'mousehide' 'mh' boolean (default on)
4425 global
4426 {not in Vi}
4427 {only works in the GUI}
4428 When on, the mouse pointer is hidden when characters are typed.
4429 The mouse pointer is restored when the mouse is moved.
4430
4431 *'mousemodel'* *'mousem'*
4432'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4433 global
4434 {not in Vi}
4435 Sets the model to use for the mouse. The name mostly specifies what
4436 the right mouse button is used for:
4437 extend Right mouse button extends a selection. This works
4438 like in an xterm.
4439 popup Right mouse button pops up a menu. The shifted left
4440 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004441 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 popup_setpos Like "popup", but the cursor will be moved to the
4443 position where the mouse was clicked, and thus the
4444 selected operation will act upon the clicked object.
4445 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004446 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 course, that right clicking outside a selection will
4448 end Visual mode.
4449 Overview of what button does what for each model:
4450 mouse extend popup(_setpos) ~
4451 left click place cursor place cursor
4452 left drag start selection start selection
4453 shift-left search word extend selection
4454 right click extend selection popup menu (place cursor)
4455 right drag extend selection -
4456 middle click paste paste
4457
4458 In the "popup" model the right mouse button produces a pop-up menu.
4459 You need to define this first, see |popup-menu|.
4460
4461 Note that you can further refine the meaning of buttons with mappings.
4462 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4463 selection (because that's handled in the GUI code directly).
4464
4465 The 'mousemodel' option is set by the |:behave| command.
4466
4467 *'mouseshape'* *'mouses'* *E547*
4468'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004469 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 global
4471 {not in Vi}
4472 {only available when compiled with the |+mouseshape|
4473 feature}
4474 This option tells Vim what the mouse pointer should look like in
4475 different modes. The option is a comma separated list of parts, much
4476 like used for 'guicursor'. Each part consist of a mode/location-list
4477 and an argument-list:
4478 mode-list:shape,mode-list:shape,..
4479 The mode-list is a dash separated list of these modes/locations:
4480 In a normal window: ~
4481 n Normal mode
4482 v Visual mode
4483 ve Visual mode with 'selection' "exclusive" (same as 'v',
4484 if not specified)
4485 o Operator-pending mode
4486 i Insert mode
4487 r Replace mode
4488
4489 Others: ~
4490 c appending to the command-line
4491 ci inserting in the command-line
4492 cr replacing in the command-line
4493 m at the 'Hit ENTER' or 'More' prompts
4494 ml idem, but cursor in the last line
4495 e any mode, pointer below last window
4496 s any mode, pointer on a status line
4497 sd any mode, while dragging a status line
4498 vs any mode, pointer on a vertical separator line
4499 vd any mode, while dragging a vertical separator line
4500 a everywhere
4501
4502 The shape is one of the following:
4503 avail name looks like ~
4504 w x arrow Normal mouse pointer
4505 w x blank no pointer at all (use with care!)
4506 w x beam I-beam
4507 w x updown up-down sizing arrows
4508 w x leftright left-right sizing arrows
4509 w x busy The system's usual busy pointer
4510 w x no The system's usual 'no input' pointer
4511 x udsizing indicates up-down resizing
4512 x lrsizing indicates left-right resizing
4513 x crosshair like a big thin +
4514 x hand1 black hand
4515 x hand2 white hand
4516 x pencil what you write with
4517 x question big ?
4518 x rightup-arrow arrow pointing right-up
4519 w x up-arrow arrow pointing up
4520 x <number> any X11 pointer number (see X11/cursorfont.h)
4521
4522 The "avail" column contains a 'w' if the shape is available for Win32,
4523 x for X11.
4524 Any modes not specified or shapes not available use the normal mouse
4525 pointer.
4526
4527 Example: >
4528 :set mouseshape=s:udsizing,m:no
4529< will make the mouse turn to a sizing arrow over the status lines and
4530 indicate no input when the hit-enter prompt is displayed (since
4531 clicking the mouse has no effect in this state.)
4532
4533 *'mousetime'* *'mouset'*
4534'mousetime' 'mouset' number (default 500)
4535 global
4536 {not in Vi}
4537 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4538 time in msec between two mouse clicks for the second click to be
4539 recognized as a multi click.
4540
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004541 *'mzquantum'* *'mzq'*
4542'mzquantum' 'mzq' number (default 100)
4543 global
4544 {not in Vi}
4545 {not available when compiled without the |+mzscheme|
4546 feature}
4547 The number of milliseconds between polls for MzScheme threads.
4548 Negative or zero value means no thread scheduling.
4549
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 *'nrformats'* *'nf'*
4551'nrformats' 'nf' string (default "octal,hex")
4552 local to buffer
4553 {not in Vi}
4554 This defines what bases Vim will consider for numbers when using the
4555 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4556 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004557 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 incremented or decremented. This is useful for a list with a
4559 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004560 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004562 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563 considered to be hexadecimal. Example: Using CTRL-X on
4564 "0x100" results in "0x0ff".
4565 Numbers which simply begin with a digit in the range 1-9 are always
4566 considered decimal. This also happens for numbers that are not
4567 recognized as octal or hex.
4568
4569 *'number'* *'nu'* *'nonumber'* *'nonu'*
4570'number' 'nu' boolean (default off)
4571 local to window
4572 Print the line number in front of each line. When the 'n' option is
4573 excluded from 'cpoptions' a wrapped line will not use the column of
4574 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004575 The 'numberwidth' option can be used to set the room used for the line
4576 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 When a long, wrapped line doesn't start with the first character, '-'
4578 characters are put before the number.
4579 See |hl-LineNr| for the highlighting used for the number.
4580
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004581 *'numberwidth'* *'nuw'*
4582'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4583 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004584 {not in Vi}
4585 {only available when compiled with the |+linebreak|
4586 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004587 Minimal number of columns to use for the line number. Only relevant
4588 when the 'number' option is set.
4589 Since one space is always between the number and the text, there is
4590 one less character for the number itself.
4591 The value is the minimum width. A bigger width is used when needed to
4592 fit the highest line number in the buffer. Thus with the Vim default
4593 of 4 there is room for a line number up to 999. When the buffer has
4594 1000 lines five columns will be used.
4595 The minimum value is 1, the maximum value is 10.
4596 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4597
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004598 *'omnifunc'* *'ofu'*
4599'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004600 local to buffer
4601 {not in Vi}
4602 {not available when compiled without the +eval
4603 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004604 This option specifies a function to be used for Insert mode omni
4605 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004606 See |complete-functions| for an explanation of how the function is
4607 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004608
4609
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004610 *'operatorfunc'* *'opfunc'*
4611'operatorfunc' 'opfunc' string (default: empty)
4612 global
4613 {not in Vi}
4614 This option specifies a function to be called by the |g@| operator.
4615 See |:map-operator| for more info and an example.
4616
4617 This option cannot be set from a |modeline| or in the |sandbox|, for
4618 security reasons.
4619
4620
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 *'osfiletype'* *'oft'* *E366*
4622'osfiletype' 'oft' string (RISC-OS default: "Text",
4623 others default: "")
4624 local to buffer
4625 {not in Vi}
4626 {only available when compiled with the |+osfiletype|
4627 feature}
4628 Some operating systems store extra information about files besides
4629 name, datestamp and permissions. This option contains the extra
4630 information, the nature of which will vary between systems.
4631 The value of this option is usually set when the file is loaded, and
4632 use to set the file type when file is written.
4633 It can affect the pattern matching of the automatic commands.
4634 |autocmd-osfiletypes|
4635
4636 *'paragraphs'* *'para'*
4637'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4638 global
4639 Specifies the nroff macros that separate paragraphs. These are pairs
4640 of two letters (see |object-motions|).
4641
4642 *'paste'* *'nopaste'*
4643'paste' boolean (default off)
4644 global
4645 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004646 Put Vim in Paste mode. This is useful if you want to cut or copy
4647 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 unexpected effects.
4649 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004650 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651 knows about pasting and will mostly do the right thing without 'paste'
4652 being set. The same is true for a terminal where Vim handles the
4653 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004654 This option is reset when starting the GUI. Thus if you set it in
4655 your .vimrc it will work in a terminal, but not in the GUI. Setting
4656 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4657 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 When the 'paste' option is switched on (also when it was already on):
4659 - mapping in Insert mode and Command-line mode is disabled
4660 - abbreviations are disabled
4661 - 'textwidth' is set to 0
4662 - 'wrapmargin' is set to 0
4663 - 'autoindent' is reset
4664 - 'smartindent' is reset
4665 - 'softtabstop' is set to 0
4666 - 'revins' is reset
4667 - 'ruler' is reset
4668 - 'showmatch' is reset
4669 - 'formatoptions' is used like it is empty
4670 These options keep their value, but their effect is disabled:
4671 - 'lisp'
4672 - 'indentexpr'
4673 - 'cindent'
4674 NOTE: When you start editing another file while the 'paste' option is
4675 on, settings from the modelines or autocommands may change the
4676 settings again, causing trouble when pasting text. You might want to
4677 set the 'paste' option again.
4678 When the 'paste' option is reset the mentioned options are restored to
4679 the value before the moment 'paste' was switched from off to on.
4680 Resetting 'paste' before ever setting it does not have any effect.
4681 Since mapping doesn't work while 'paste' is active, you need to use
4682 the 'pastetoggle' option to toggle the 'paste' option with some key.
4683
4684 *'pastetoggle'* *'pt'*
4685'pastetoggle' 'pt' string (default "")
4686 global
4687 {not in Vi}
4688 When non-empty, specifies the key sequence that toggles the 'paste'
4689 option. This is like specifying a mapping: >
4690 :map {keys} :set invpaste<CR>
4691< Where {keys} is the value of 'pastetoggle'.
4692 The difference is that it will work even when 'paste' is set.
4693 'pastetoggle' works in Insert mode and Normal mode, but not in
4694 Command-line mode.
4695 Mappings are checked first, thus overrule 'pastetoggle'. However,
4696 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4697 this: >
4698 :map <F10> :set paste<CR>
4699 :map <F11> :set nopaste<CR>
4700 :imap <F10> <C-O>:set paste<CR>
4701 :imap <F11> <nop>
4702 :set pastetoggle=<F11>
4703< This will make <F10> start paste mode and <F11> stop paste mode.
4704 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4705 mode everything is inserted literally, except the 'pastetoggle' key
4706 sequence.
4707
4708 *'pex'* *'patchexpr'*
4709'patchexpr' 'pex' string (default "")
4710 global
4711 {not in Vi}
4712 {not available when compiled without the |+diff|
4713 feature}
4714 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004715 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716
4717 *'patchmode'* *'pm'* *E206*
4718'patchmode' 'pm' string (default "")
4719 global
4720 {not in Vi}
4721 When non-empty the oldest version of a file is kept. This can be used
4722 to keep the original version of a file if you are changing files in a
4723 source distribution. Only the first time that a file is written a
4724 copy of the original file will be kept. The name of the copy is the
4725 name of the original file with the string in the 'patchmode' option
4726 appended. This option should start with a dot. Use a string like
4727 ".org". 'backupdir' must not be empty for this to work (Detail: The
4728 backup file is renamed to the patchmode file after the new file has
4729 been successfully written, that's why it must be possible to write a
4730 backup file). If there was no file to be backed up, an empty file is
4731 created.
4732 When the 'backupskip' pattern matches, a patchmode file is not made.
4733 Using 'patchmode' for compressed files appends the extension at the
4734 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4735 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004736 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737
4738 *'path'* *'pa'* *E343* *E345* *E347*
4739'path' 'pa' string (default on Unix: ".,/usr/include,,"
4740 on OS/2: ".,/emx/include,,"
4741 other systems: ".,,")
4742 global or local to buffer |global-local|
4743 {not in Vi}
4744 This is a list of directories which will be searched when using the
4745 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4746 being searched for has a relative path (not starting with '/'). The
4747 directories in the 'path' option may be relative or absolute.
4748 - Use commas to separate directory names: >
4749 :set path=.,/usr/local/include,/usr/include
4750< - Spaces can also be used to separate directory names (for backwards
4751 compatibility with version 3.0). To have a space in a directory
4752 name, precede it with an extra backslash, and escape the space: >
4753 :set path=.,/dir/with\\\ space
4754< - To include a comma in a directory name precede it with an extra
4755 backslash: >
4756 :set path=.,/dir/with\\,comma
4757< - To search relative to the directory of the current file, use: >
4758 :set path=.
4759< - To search in the current directory use an empty string between two
4760 commas: >
4761 :set path=,,
4762< - A directory name may end in a ':' or '/'.
4763 - Environment variables are expanded |:set_env|.
4764 - When using |netrw.vim| URLs can be used. For example, adding
4765 "http://www.vim.org" will make ":find index.html" work.
4766 - Search upwards and downwards in a directory tree:
4767 1) "*" matches a sequence of characters, e.g.: >
4768 :set path=/usr/include/*
4769< means all subdirectories in /usr/include (but not /usr/include
4770 itself). >
4771 :set path=/usr/*c
4772< matches /usr/doc and /usr/src.
4773 2) "**" matches a subtree, up to 100 directories deep. Example: >
4774 :set path=/home/user_x/src/**
4775< means search in the whole subtree under "/home/usr_x/src".
4776 3) If the path ends with a ';', this path is the startpoint
4777 for upward search.
4778 See |file-searching| for more info and exact syntax.
4779 {not available when compiled without the |+path_extra| feature}
4780 - Careful with '\' characters, type two to get one in the option: >
4781 :set path=.,c:\\include
4782< Or just use '/' instead: >
4783 :set path=.,c:/include
4784< Don't forget "." or files won't even be found in the same directory as
4785 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004786 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787 it is something like 256 or 1024 characters.
4788 You can check if all the include files are found, using the value of
4789 'path', see |:checkpath|.
4790 The use of |:set+=| and |:set-=| is preferred when adding or removing
4791 directories from the list. This avoids problems when a future version
4792 uses another default. To remove the current directory use: >
4793 :set path-=
4794< To add the current directory use: >
4795 :set path+=
4796< To use an environment variable, you probably need to replace the
4797 separator. Here is an example to append $INCL, in which directory
4798 names are separated with a semi-colon: >
4799 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4800< Replace the ';' with a ':' or whatever separator is used. Note that
4801 this doesn't work when $INCL contains a comma or white space.
4802
4803 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4804'preserveindent' 'pi' boolean (default off)
4805 local to buffer
4806 {not in Vi}
4807 When changing the indent of the current line, preserve as much of the
4808 indent structure as possible. Normally the indent is replaced by a
4809 series of tabs followed by spaces as required (unless |'expandtab'| is
4810 enabled, in which case only spaces are used). Enabling this option
4811 means the indent will preserve as many existing characters as possible
4812 for indenting, and only add additional tabs or spaces as required.
4813 NOTE: When using ">>" multiple times the resulting indent is a mix of
4814 tabs and spaces. You might not like this.
4815 NOTE: 'preserveindent' is reset when 'compatible' is set.
4816 Also see 'copyindent'.
4817 Use |:retab| to clean up white space.
4818
4819 *'previewheight'* *'pvh'*
4820'previewheight' 'pvh' number (default 12)
4821 global
4822 {not in Vi}
4823 {not available when compiled without the |+windows| or
4824 |+quickfix| feature}
4825 Default height for a preview window. Used for |:ptag| and associated
4826 commands. Used for |CTRL-W_}| when no count is given.
4827
4828 *'previewwindow'* *'nopreviewwindow'*
4829 *'pvw'* *'nopvw'* *E590*
4830'previewwindow' 'pvw' boolean (default off)
4831 local to window
4832 {not in Vi}
4833 {not available when compiled without the |+windows| or
4834 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004835 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 set. It's normally not set directly, but by using one of the commands
4837 |:ptag|, |:pedit|, etc.
4838
4839 *'printdevice'* *'pdev'*
4840'printdevice' 'pdev' string (default empty)
4841 global
4842 {not in Vi}
4843 {only available when compiled with the |+printer|
4844 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004845 The name of the printer to be used for |:hardcopy|.
4846 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004847 This option cannot be set from a |modeline| or in the |sandbox|, for
4848 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849
Bram Moolenaar8299df92004-07-10 09:47:34 +00004850 *'printencoding'* *'penc'*
4851'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 global
4853 {not in Vi}
4854 {only available when compiled with the |+printer|
4855 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004856 Sets the character encoding used when printing.
4857 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858
4859 *'printexpr'* *'pexpr'*
4860'printexpr' 'pexpr' String (default: see below)
4861 global
4862 {not in Vi}
4863 {only available when compiled with the |+printer|
4864 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004865 Expression used to print the PostScript produced with |:hardcopy|.
4866 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867
Bram Moolenaar8299df92004-07-10 09:47:34 +00004868 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869'printfont' 'pfn' string (default "courier")
4870 global
4871 {not in Vi}
4872 {only available when compiled with the |+printer|
4873 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004874 The name of the font that will be used for |:hardcopy|.
4875 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876
4877 *'printheader'* *'pheader'*
4878'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4879 global
4880 {not in Vi}
4881 {only available when compiled with the |+printer|
4882 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004883 The format of the header produced in |:hardcopy| output.
4884 See |pheader-option|.
4885
4886 *'printmbcharset'* *'pmbcs'*
4887'printmbcharset' 'pmbcs' string (default "")
4888 global
4889 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004890 {only available when compiled with the |+printer|,
4891 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004892 The CJK character set to be used for CJK output from |:hardcopy|.
4893 See |pmbcs-option|.
4894
4895 *'printmbfont'* *'pmbfn'*
4896'printmbfont' 'pmbfn' string (default "")
4897 global
4898 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004899 {only available when compiled with the |+printer|,
4900 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004901 List of font names to be used for CJK output from |:hardcopy|.
4902 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903
4904 *'printoptions'* *'popt'*
4905'printoptions' 'popt' string (default "")
4906 global
4907 {not in Vi}
4908 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004909 List of items that control the format of the output of |:hardcopy|.
4910 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004912 *'prompt'* *'noprompt'*
4913'prompt' boolean (default on)
4914 global
4915 When on a ":" prompt is used in Ex mode.
4916
Bram Moolenaar677ee682005-01-27 14:41:15 +00004917 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004918'quoteescape' 'qe' string (default "\")
4919 local to buffer
4920 {not in Vi}
4921 The characters that are used to escape quotes in a string. Used for
4922 objects like a', a" and a` |a'|.
4923 When one of the characters in this option is found inside a string,
4924 the following character will be skipped. The default value makes the
4925 text "foo\"bar\\" considered to be one string.
4926
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4928'readonly' 'ro' boolean (default off)
4929 local to buffer
4930 If on, writes fail unless you use a '!'. Protects you from
4931 accidentally overwriting a file. Default on when Vim is started
4932 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004933 When using ":w!" the 'readonly' option is reset for the current
4934 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004936 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937
4938 *'remap'* *'noremap'*
4939'remap' boolean (default on)
4940 global
4941 Allows for mappings to work recursively. If you do not want this for
4942 a single entry, use the :noremap[!] command.
4943
4944 *'report'*
4945'report' number (default 2)
4946 global
4947 Threshold for reporting number of lines changed. When the number of
4948 changed lines is more than 'report' a message will be given for most
4949 ":" commands. If you want it always, set 'report' to 0.
4950 For the ":substitute" command the number of substitutions is used
4951 instead of the number of lines.
4952
4953 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4954'restorescreen' 'rs' boolean (default on)
4955 global
4956 {not in Vi} {only in Windows 95/NT console version}
4957 When set, the screen contents is restored when exiting Vim. This also
4958 happens when executing external commands.
4959
4960 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4961 options in your .vimrc. To disable restoring:
4962 set t_ti= t_te=
4963 To enable restoring (for an xterm):
4964 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4965 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4966
4967 *'revins'* *'ri'* *'norevins'* *'nori'*
4968'revins' 'ri' boolean (default off)
4969 global
4970 {not in Vi}
4971 {only available when compiled with the |+rightleft|
4972 feature}
4973 Inserting characters in Insert mode will work backwards. See "typing
4974 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4975 command in Insert mode, when 'allowrevins' is set.
4976 NOTE: This option is reset when 'compatible' or 'paste' is set.
4977
4978 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4979'rightleft' 'rl' boolean (default off)
4980 local to window
4981 {not in Vi}
4982 {only available when compiled with the |+rightleft|
4983 feature}
4984 When on, display orientation becomes right-to-left, i.e., characters
4985 that are stored in the file appear from the right to the left.
4986 Using this option, it is possible to edit files for languages that
4987 are written from the right to the left such as Hebrew and Arabic.
4988 This option is per window, so it is possible to edit mixed files
4989 simultaneously, or to view the same file in both ways (this is
4990 useful whenever you have a mixed text file with both right-to-left
4991 and left-to-right strings so that both sets are displayed properly
4992 in different windows). Also see |rileft.txt|.
4993
4994 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4995'rightleftcmd' 'rlc' string (default "search")
4996 local to window
4997 {not in Vi}
4998 {only available when compiled with the |+rightleft|
4999 feature}
5000 Each word in this option enables the command line editing to work in
5001 right-to-left mode for a group of commands:
5002
5003 search "/" and "?" commands
5004
5005 This is useful for languages such as Hebrew, Arabic and Farsi.
5006 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5007
5008 *'ruler'* *'ru'* *'noruler'* *'noru'*
5009'ruler' 'ru' boolean (default off)
5010 global
5011 {not in Vi}
5012 {not available when compiled without the
5013 |+cmdline_info| feature}
5014 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005015 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 text in the file is shown on the far right:
5017 Top first line is visible
5018 Bot last line is visible
5019 All first and last line are visible
5020 45% relative position in the file
5021 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005022 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005024 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 this option takes precedence over 'ruler' and 'rulerformat'
5026 If the number of characters displayed is different from the number of
5027 bytes in the text (e.g., for a TAB or a multi-byte character), both
5028 the text column (byte number) and the screen column are shown,
5029 separated with a dash.
5030 For an empty line "0-1" is shown.
5031 For an empty buffer the line number will also be zero: "0,0-1".
5032 This option is reset when the 'paste' option is set.
5033 If you don't want to see the ruler all the time but want to know where
5034 you are, use "g CTRL-G" |g_CTRL-G|.
5035 NOTE: This option is reset when 'compatible' is set.
5036
5037 *'rulerformat'* *'ruf'*
5038'rulerformat' 'ruf' string (default empty)
5039 global
5040 {not in Vi}
5041 {not available when compiled without the |+statusline|
5042 feature}
5043 When this option is not empty, it determines the content of the ruler
5044 string, as displayed for the 'ruler' option.
5045 The format of this option, is like that of 'statusline'.
5046 The default ruler width is 17 characters. To make the ruler 15
5047 characters wide, put "%15(" at the start and "%)" at the end.
5048 Example: >
5049 :set rulerformat=%15(%c%V\ %p%%%)
5050<
5051 *'runtimepath'* *'rtp'* *vimfiles*
5052'runtimepath' 'rtp' string (default:
5053 Unix: "$HOME/.vim,
5054 $VIM/vimfiles,
5055 $VIMRUNTIME,
5056 $VIM/vimfiles/after,
5057 $HOME/.vim/after"
5058 Amiga: "home:vimfiles,
5059 $VIM/vimfiles,
5060 $VIMRUNTIME,
5061 $VIM/vimfiles/after,
5062 home:vimfiles/after"
5063 PC, OS/2: "$HOME/vimfiles,
5064 $VIM/vimfiles,
5065 $VIMRUNTIME,
5066 $VIM/vimfiles/after,
5067 $HOME/vimfiles/after"
5068 Macintosh: "$VIM:vimfiles,
5069 $VIMRUNTIME,
5070 $VIM:vimfiles:after"
5071 RISC-OS: "Choices:vimfiles,
5072 $VIMRUNTIME,
5073 Choices:vimfiles/after"
5074 VMS: "sys$login:vimfiles,
5075 $VIM/vimfiles,
5076 $VIMRUNTIME,
5077 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005078 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 global
5080 {not in Vi}
5081 This is a list of directories which will be searched for runtime
5082 files:
5083 filetype.vim filetypes by file name |new-filetype|
5084 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005085 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 colors/ color scheme files |:colorscheme|
5087 compiler/ compiler files |:compiler|
5088 doc/ documentation |write-local-help|
5089 ftplugin/ filetype plugins |write-filetype-plugin|
5090 indent/ indent scripts |indent-expression|
5091 keymap/ key mapping files |mbyte-keymap|
5092 lang/ menu translations |:menutrans|
5093 menu.vim GUI menus |menu.vim|
5094 plugin/ plugin scripts |write-plugin|
5095 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005096 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 syntax/ syntax files |mysyntaxfile|
5098 tutor/ files for vimtutor |tutor|
5099
5100 And any other file searched for with the |:runtime| command.
5101
5102 The defaults for most systems are setup to search five locations:
5103 1. In your home directory, for your personal preferences.
5104 2. In a system-wide Vim directory, for preferences from the system
5105 administrator.
5106 3. In $VIMRUNTIME, for files distributed with Vim.
5107 *after-directory*
5108 4. In the "after" directory in the system-wide Vim directory. This is
5109 for the system administrator to overrule or add to the distributed
5110 defaults (rarely needed)
5111 5. In the "after" directory in your home directory. This is for
5112 personal preferences to overrule or add to the distributed defaults
5113 or system-wide settings (rarely needed).
5114
5115 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5116 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005117 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 wildcards.
5119 See |:runtime|.
5120 Example: >
5121 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5122< This will use the directory "~/vimruntime" first (containing your
5123 personal Vim runtime files), then "/mygroup/vim" (shared between a
5124 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5125 files).
5126 You probably should always include $VIMRUNTIME somewhere, to use the
5127 distributed runtime files. You can put a directory before $VIMRUNTIME
5128 to find files which replace a distributed runtime files. You can put
5129 a directory after $VIMRUNTIME to find files which add to distributed
5130 runtime files.
5131 This option cannot be set from a |modeline| or in the |sandbox|, for
5132 security reasons.
5133
5134 *'scroll'* *'scr'*
5135'scroll' 'scr' number (default: half the window height)
5136 local to window
5137 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5138 set to half the number of lines in the window when the window size
5139 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005140 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5142 the number of screen lines instead of file lines, makes a difference
5143 when lines wrap}
5144
5145 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5146'scrollbind' 'scb' boolean (default off)
5147 local to window
5148 {not in Vi}
5149 {not available when compiled without the |+scrollbind|
5150 feature}
5151 See also |scroll-binding|. When this option is set, the current
5152 window scrolls as other scrollbind windows (windows that also have
5153 this option set) scroll. This option is useful for viewing the
5154 differences between two versions of a file, see 'diff'.
5155 See |'scrollopt'| for options that determine how this option should be
5156 interpreted.
5157 This option is mostly reset when splitting a window to edit another
5158 file. This means that ":split | edit file" results in two windows
5159 with scroll-binding, but ":split file" does not.
5160
5161 *'scrolljump'* *'sj'*
5162'scrolljump' 'sj' number (default 1)
5163 global
5164 {not in Vi}
5165 Minimal number of lines to scroll when the cursor gets off the
5166 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5167 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005168 When set to a negative number from -1 to -100 this is used as the
5169 percentage of the window height. Thus -50 scrolls half the window
5170 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 NOTE: This option is set to 1 when 'compatible' is set.
5172
5173 *'scrolloff'* *'so'*
5174'scrolloff' 'so' number (default 0)
5175 global
5176 {not in Vi}
5177 Minimal number of screen lines to keep above and below the cursor.
5178 This will make some context visible around where you are working. If
5179 you set it to a very large value (999) the cursor line will always be
5180 in the middle of the window (except at the start or end of the file or
5181 when long lines wrap).
5182 For scrolling horizontally see 'sidescrolloff'.
5183 NOTE: This option is set to 0 when 'compatible' is set.
5184
5185 *'scrollopt'* *'sbo'*
5186'scrollopt' 'sbo' string (default "ver,jump")
5187 global
5188 {not available when compiled without the |+scrollbind|
5189 feature}
5190 {not in Vi}
5191 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005192 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5193 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 The following words are available:
5195 ver Bind vertical scrolling for 'scrollbind' windows
5196 hor Bind horizontal scrolling for 'scrollbind' windows
5197 jump Applies to the offset between two windows for vertical
5198 scrolling. This offset is the difference in the first
5199 displayed line of the bound windows. When moving
5200 around in a window, another 'scrollbind' window may
5201 reach a position before the start or after the end of
5202 the buffer. The offset is not changed though, when
5203 moving back the 'scrollbind' window will try to scroll
5204 to the desired position when possible.
5205 When now making that window the current one, two
5206 things can be done with the relative offset:
5207 1. When "jump" is not included, the relative offset is
5208 adjusted for the scroll position in the new current
5209 window. When going back to the other window, the
5210 the new relative offset will be used.
5211 2. When "jump" is included, the other windows are
5212 scrolled to keep the same relative offset. When
5213 going back to the other window, it still uses the
5214 same relative offset.
5215 Also see |scroll-binding|.
5216
5217 *'sections'* *'sect'*
5218'sections' 'sect' string (default "SHNHH HUnhsh")
5219 global
5220 Specifies the nroff macros that separate sections. These are pairs of
5221 two letters (See |object-motions|). The default makes a section start
5222 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5223
5224 *'secure'* *'nosecure'* *E523*
5225'secure' boolean (default off)
5226 global
5227 {not in Vi}
5228 When on, ":autocmd", shell and write commands are not allowed in
5229 ".vimrc" and ".exrc" in the current directory and map commands are
5230 displayed. Switch it off only if you know that you will not run into
5231 problems, or when the 'exrc' option is off. On Unix this option is
5232 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005233 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234 'secure' at the end of your ~/.vimrc then.
5235 This option cannot be set from a |modeline| or in the |sandbox|, for
5236 security reasons.
5237
5238 *'selection'* *'sel'*
5239'selection' 'sel' string (default "inclusive")
5240 global
5241 {not in Vi}
5242 This option defines the behavior of the selection. It is only used
5243 in Visual and Select mode.
5244 Possible values:
5245 value past line inclusive ~
5246 old no yes
5247 inclusive yes yes
5248 exclusive yes no
5249 "past line" means that the cursor is allowed to be positioned one
5250 character past the line.
5251 "inclusive" means that the last character of the selection is included
5252 in an operation. For example, when "x" is used to delete the
5253 selection.
5254 Note that when "exclusive" is used and selecting from the end
5255 backwards, you cannot include the last character of a line, when
5256 starting in Normal mode and 'virtualedit' empty.
5257
5258 The 'selection' option is set by the |:behave| command.
5259
5260 *'selectmode'* *'slm'*
5261'selectmode' 'slm' string (default "")
5262 global
5263 {not in Vi}
5264 This is a comma separated list of words, which specifies when to start
5265 Select mode instead of Visual mode, when a selection is started.
5266 Possible values:
5267 mouse when using the mouse
5268 key when using shifted special keys
5269 cmd when using "v", "V" or CTRL-V
5270 See |Select-mode|.
5271 The 'selectmode' option is set by the |:behave| command.
5272
5273 *'sessionoptions'* *'ssop'*
5274'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5275 help,options,winsize")
5276 global
5277 {not in Vi}
5278 {not available when compiled without the +mksession
5279 feature}
5280 Changes the effect of the |:mksession| command. It is a comma
5281 separated list of words. Each word enables saving and restoring
5282 something:
5283 word save and restore ~
5284 blank empty windows
5285 buffers hidden and unloaded buffers, not just those in windows
5286 curdir the current directory
5287 folds manually created folds, opened/closed folds and local
5288 fold options
5289 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005290 and contain at least one lowercase letter. Only
5291 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 help the help window
5293 localoptions options and mappings local to a window or buffer (not
5294 global values for local options)
5295 options all options and mappings (also global values for local
5296 options)
5297 resize size of the Vim window: 'lines' and 'columns'
5298 sesdir the directory in which the session file is located
5299 will become the current directory (useful with
5300 projects accessed over a network from different
5301 systems)
5302 slash backslashes in file names replaced with forward
5303 slashes
5304 unix with Unix end-of-line format (single <NL>), even when
5305 on Windows or DOS
5306 winpos position of the whole Vim window
5307 winsize window sizes
5308
5309 Don't include both "curdir" and "sesdir".
5310 When "curdir" nor "sesdir" is included, file names are stored with
5311 absolute paths.
5312 "slash" and "unix" are useful on Windows when sharing session files
5313 with Unix. The Unix version of Vim cannot source dos format scripts,
5314 but the Windows version of Vim can source unix format scripts.
5315
5316 *'shell'* *'sh'* *E91*
5317'shell' 'sh' string (default $SHELL or "sh",
5318 MS-DOS and Win32: "command.com" or
5319 "cmd.exe", OS/2: "cmd")
5320 global
5321 Name of the shell to use for ! and :! commands. When changing the
5322 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5323 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005324 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 See |option-backslash| about including spaces and backslashes.
5326 Environment variables are expanded |:set_env|.
5327 If the name of the shell contains a space, you might need to enclose
5328 it in quotes. Example: >
5329 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5330< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005331 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 "-f" is not inside the quotes, because it is not part of the command
5333 name. And Vim automagically recognizes the backslashes that are path
5334 separators.
5335 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5336 variable to change the way external commands are executed. See the
5337 libc.inf file of DJGPP.
5338 Under MS-Windows, when the executable ends in ".com" it must be
5339 included. Thus setting the shell to "command.com" or "4dos.com"
5340 works, but "command" and "4dos" do not work for all commands (e.g.,
5341 filtering).
5342 For unknown reasons, when using "4dos.com" the current directory is
5343 changed to "C:\". To avoid this set 'shell' like this: >
5344 :set shell=command.com\ /c\ 4dos
5345< This option cannot be set from a |modeline| or in the |sandbox|, for
5346 security reasons.
5347
5348 *'shellcmdflag'* *'shcf'*
5349'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5350 does not contain "sh" somewhere: "/c")
5351 global
5352 {not in Vi}
5353 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5354 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5355 systems, the default is set according to the value of 'shell', to
5356 reduce the need to set this option by the user. It's not used for
5357 OS/2 (EMX figures this out itself). See |option-backslash| about
5358 including spaces and backslashes. See |dos-shell|.
5359 This option cannot be set from a |modeline| or in the |sandbox|, for
5360 security reasons.
5361
5362 *'shellpipe'* *'sp'*
5363'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5364 global
5365 {not in Vi}
5366 {not available when compiled without the |+quickfix|
5367 feature}
5368 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005369 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 including spaces and backslashes.
5371 The name of the temporary file can be represented by "%s" if necessary
5372 (the file name is appended automatically if no %s appears in the value
5373 of this option).
5374 For the Amiga and MS-DOS the default is ">". The output is directly
5375 saved in a file and not echoed to the screen.
5376 For Unix the default it "| tee". The stdout of the compiler is saved
5377 in a file and echoed to the screen. If the 'shell' option is "csh" or
5378 "tcsh" after initializations, the default becomes "|& tee". If the
5379 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5380 "2>&1| tee". This means that stderr is also included.
5381 The initialization of this option is done after reading the ".vimrc"
5382 and the other initializations, so that when the 'shell' option is set
5383 there, the 'shellpipe' option changes automatically, unless it was
5384 explicitly set before.
5385 When 'shellpipe' is set to an empty string, no redirection of the
5386 ":make" output will be done. This is useful if you use a 'makeprg'
5387 that writes to 'makeef' by itself. If you want no piping, but do
5388 want to include the 'makeef', set 'shellpipe' to a single space.
5389 Don't forget to precede the space with a backslash: ":set sp=\ ".
5390 In the future pipes may be used for filtering and this option will
5391 become obsolete (at least for Unix).
5392 This option cannot be set from a |modeline| or in the |sandbox|, for
5393 security reasons.
5394
5395 *'shellquote'* *'shq'*
5396'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5397 contains "sh" somewhere: "\"")
5398 global
5399 {not in Vi}
5400 Quoting character(s), put around the command passed to the shell, for
5401 the "!" and ":!" commands. The redirection is kept outside of the
5402 quoting. See 'shellxquote' to include the redirection. It's
5403 probably not useful to set both options.
5404 This is an empty string by default. Only known to be useful for
5405 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5406 or bash, where it should be "\"". The default is adjusted according
5407 the value of 'shell', to reduce the need to set this option by the
5408 user. See |dos-shell|.
5409 This option cannot be set from a |modeline| or in the |sandbox|, for
5410 security reasons.
5411
5412 *'shellredir'* *'srr'*
5413'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5414 global
5415 {not in Vi}
5416 String to be used to put the output of a filter command in a temporary
5417 file. See also |:!|. See |option-backslash| about including spaces
5418 and backslashes.
5419 The name of the temporary file can be represented by "%s" if necessary
5420 (the file name is appended automatically if no %s appears in the value
5421 of this option).
5422 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5423 or "zsh" during initializations, the default becomes ">&". If the
5424 'shell' option is "sh", "ksh" or "bash" the default becomes
5425 ">%s 2>&1". This means that stderr is also included.
5426 For Win32, the Unix checks are done and additionally "cmd" is checked
5427 for, which makes the default ">%s 2>&1". Also, the same names with
5428 ".exe" appended are checked for.
5429 The initialization of this option is done after reading the ".vimrc"
5430 and the other initializations, so that when the 'shell' option is set
5431 there, the 'shellredir' option changes automatically unless it was
5432 explicitly set before.
5433 In the future pipes may be used for filtering and this option will
5434 become obsolete (at least for Unix).
5435 This option cannot be set from a |modeline| or in the |sandbox|, for
5436 security reasons.
5437
5438 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5439'shellslash' 'ssl' boolean (default off)
5440 global
5441 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5442 When set, a forward slash is used when expanding file names. This is
5443 useful when a Unix-like shell is used instead of command.com or
5444 cmd.exe. Backward slashes can still be typed, but they are changed to
5445 forward slashes by Vim.
5446 Note that setting or resetting this option has no effect for some
5447 existing file names, thus this option needs to be set before opening
5448 any file for best results. This might change in the future.
5449 'shellslash' only works when a backslash can be used as a path
5450 separator. To test if this is so use: >
5451 if exists('+shellslash')
5452<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005453 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5454'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5455 global
5456 {not in Vi}
5457 When on, use temp files for shell commands. When off use a pipe.
5458 When using a pipe is not possible temp files are used anyway.
5459 Currently a pipe is only supported on Unix. You can check it with: >
5460 :if has("filterpipe")
5461< The advantage of using a pipe is that nobody can read the temp file
5462 and the 'shell' command does not need to support redirection.
5463 The advantage of using a temp file is that the file type and encoding
5464 can be detected.
5465 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5466 |FilterWritePost| autocommands event are not triggered when
5467 'shelltemp' is off.
5468
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 *'shelltype'* *'st'*
5470'shelltype' 'st' number (default 0)
5471 global
5472 {not in Vi} {only for the Amiga}
5473 On the Amiga this option influences the way how the commands work
5474 which use a shell.
5475 0 and 1: always use the shell
5476 2 and 3: use the shell only to filter lines
5477 4 and 5: use shell only for ':sh' command
5478 When not using the shell, the command is executed directly.
5479
5480 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5481 1 and 3: use "shell cmd" to start external commands
5482
5483 *'shellxquote'* *'sxq'*
5484'shellxquote' 'sxq' string (default: "";
5485 for Win32, when 'shell' contains "sh"
5486 somewhere: "\""
5487 for Unix, when using system(): "\"")
5488 global
5489 {not in Vi}
5490 Quoting character(s), put around the command passed to the shell, for
5491 the "!" and ":!" commands. Includes the redirection. See
5492 'shellquote' to exclude the redirection. It's probably not useful
5493 to set both options.
5494 This is an empty string by default. Known to be useful for
5495 third-party shells when using the Win32 version, such as the MKS Korn
5496 Shell or bash, where it should be "\"". The default is adjusted
5497 according the value of 'shell', to reduce the need to set this option
5498 by the user. See |dos-shell|.
5499 This option cannot be set from a |modeline| or in the |sandbox|, for
5500 security reasons.
5501
5502 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5503'shiftround' 'sr' boolean (default off)
5504 global
5505 {not in Vi}
5506 Round indent to multiple of 'shiftwidth'. Applies to > and <
5507 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5508 a multiple of 'shiftwidth' (this is Vi compatible).
5509 NOTE: This option is reset when 'compatible' is set.
5510
5511 *'shiftwidth'* *'sw'*
5512'shiftwidth' 'sw' number (default 8)
5513 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005514 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 |'cindent'|, |>>|, |<<|, etc.
5516
5517 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005518'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5519 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 global
5521 {not in Vi}
5522 This option helps to avoid all the |hit-enter| prompts caused by file
5523 messages, for example with CTRL-G, and to avoid some other messages.
5524 It is a list of flags:
5525 flag meaning when present ~
5526 f use "(3 of 5)" instead of "(file 3 of 5)"
5527 i use "[noeol]" instead of "[Incomplete last line]"
5528 l use "999L, 888C" instead of "999 lines, 888 characters"
5529 m use "[+]" instead of "[Modified]"
5530 n use "[New]" instead of "[New File]"
5531 r use "[RO]" instead of "[readonly]"
5532 w use "[w]" instead of "written" for file write message
5533 and "[a]" instead of "appended" for ':w >> file' command
5534 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5535 "[unix format]" and "[mac]" instead of "[mac format]".
5536 a all of the above abbreviations
5537
5538 o overwrite message for writing a file with subsequent message
5539 for reading a file (useful for ":wn" or when 'autowrite' on)
5540 O message for reading a file overwrites any previous message.
5541 Also for quickfix message (e.g., ":cn").
5542 s don't give "search hit BOTTOM, continuing at TOP" or "search
5543 hit TOP, continuing at BOTTOM" messages
5544 t truncate file message at the start if it is too long to fit
5545 on the command-line, "<" will appear in the left most column.
5546 Ignored in Ex mode.
5547 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005548 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 Ignored in Ex mode.
5550 W don't give "written" or "[w]" when writing a file
5551 A don't give the "ATTENTION" message when an existing swap file
5552 is found.
5553 I don't give the intro message when starting Vim |:intro|.
5554
5555 This gives you the opportunity to avoid that a change between buffers
5556 requires you to hit <Enter>, but still gives as useful a message as
5557 possible for the space available. To get the whole message that you
5558 would have got with 'shm' empty, use ":file!"
5559 Useful values:
5560 shm= No abbreviation of message.
5561 shm=a Abbreviation, but no loss of information.
5562 shm=at Abbreviation, and truncate message when necessary.
5563
5564 NOTE: This option is set to the Vi default value when 'compatible' is
5565 set and to the Vim default value when 'compatible' is reset.
5566
5567 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5568'shortname' 'sn' boolean (default off)
5569 local to buffer
5570 {not in Vi, not in MS-DOS versions}
5571 Filenames are assumed to be 8 characters plus one extension of 3
5572 characters. Multiple dots in file names are not allowed. When this
5573 option is on, dots in file names are replaced with underscores when
5574 adding an extension (".~" or ".swp"). This option is not available
5575 for MS-DOS, because then it would always be on. This option is useful
5576 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5577 or crossdos. When running the Win32 GUI version under Win32s, this
5578 option is always on by default.
5579
5580 *'showbreak'* *'sbr'* *E595*
5581'showbreak' 'sbr' string (default "")
5582 global
5583 {not in Vi}
5584 {not available when compiled without the |+linebreak|
5585 feature}
5586 String to put at the start of lines that have been wrapped. Useful
5587 values are "> " or "+++ ".
5588 Only printable single-cell characters are allowed, excluding <Tab> and
5589 comma (in a future version the comma might be used to separate the
5590 part that is shown at the end and at the start of a line).
5591 The characters are highlighted according to the '@' flag in
5592 'highlight'.
5593 Note that tabs after the showbreak will be displayed differently.
5594 If you want the 'showbreak' to appear in between line numbers, add the
5595 "n" flag to 'cpoptions'.
5596
5597 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5598'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5599 off)
5600 global
5601 {not in Vi}
5602 {not available when compiled without the
5603 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005604 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 terminal is slow.
5606 In Visual mode the size of the selected area is shown:
5607 - When selecting characters within a line, the number of characters.
5608 - When selecting more than one line, the number of lines.
5609 - When selecting a block, the size in screen characters: linesxcolumns.
5610 NOTE: This option is set to the Vi default value when 'compatible' is
5611 set and to the Vim default value when 'compatible' is reset.
5612
5613 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5614'showfulltag' 'sft' boolean (default off)
5615 global
5616 {not in Vi}
5617 When completing a word in insert mode (see |ins-completion|) from the
5618 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005619 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 matched a C function, you can see a template for what arguments are
5621 required (coding style permitting).
5622
5623 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5624'showmatch' 'sm' boolean (default off)
5625 global
5626 When a bracket is inserted, briefly jump to the matching one. The
5627 jump is only done if the match can be seen on the screen. The time to
5628 show the match can be set with 'matchtime'.
5629 A Beep is given if there is no match (no matter if the match can be
5630 seen or not). This option is reset when the 'paste' option is set.
5631 When the 'm' flag is not included in 'cpoptions', typing a character
5632 will immediately move the cursor back to where it belongs.
5633 See the "sm" field in 'guicursor' for setting the cursor shape and
5634 blinking when showing the match.
5635 The 'matchpairs' option can be used to specify the characters to show
5636 matches for. 'rightleft' and 'revins' are used to look for opposite
5637 matches.
5638 Note: For the use of the short form parental guidance is advised.
5639
5640 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5641'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5642 global
5643 If in Insert, Replace or Visual mode put a message on the last line.
5644 Use the 'M' flag in 'highlight' to set the type of highlighting for
5645 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005646 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 doesn't mean XIM is really active, especially when 'imactivatekey' is
5648 not set.
5649 NOTE: This option is set to the Vi default value when 'compatible' is
5650 set and to the Vim default value when 'compatible' is reset.
5651
5652 *'sidescroll'* *'ss'*
5653'sidescroll' 'ss' number (default 0)
5654 global
5655 {not in Vi}
5656 The minimal number of columns to scroll horizontally. Used only when
5657 the 'wrap' option is off and the cursor is moved off of the screen.
5658 When it is zero the cursor will be put in the middle of the screen.
5659 When using a slow terminal set it to a large number or 0. When using
5660 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5661 commands.
5662
5663 *'sidescrolloff'* *'siso'*
5664'sidescrolloff' 'siso' number (default 0)
5665 global
5666 {not in Vi}
5667 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005668 right of the cursor if 'nowrap' is set. Setting this option to a
5669 value greater than 0 while having |'sidescroll'| also at a non-zero
5670 value makes some context visible in the line you are scrolling in
5671 horizontally (except at beginning of the line). Setting this option
5672 to a large value (like 999) has the effect of keeping the cursor
5673 horizontally centered in the window, as long as one does not come too
5674 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 NOTE: This option is set to 0 when 'compatible' is set.
5676
5677 Example: Try this together with 'sidescroll' and 'listchars' as
5678 in the following example to never allow the cursor to move
5679 onto the "extends" character:
5680
5681 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5682 :set sidescrolloff=1
5683
5684
5685 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5686'smartcase' 'scs' boolean (default off)
5687 global
5688 {not in Vi}
5689 Override the 'ignorecase' option if the search pattern contains upper
5690 case characters. Only used when the search pattern is typed and
5691 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005692 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5694 recalling the search pattern from history and hitting <Enter>.
5695 NOTE: This option is reset when 'compatible' is set.
5696
5697 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5698'smartindent' 'si' boolean (default off)
5699 local to buffer
5700 {not in Vi}
5701 {not available when compiled without the
5702 |+smartindent| feature}
5703 Do smart autoindenting when starting a new line. Works for C-like
5704 programs, but can also be used for other languages. 'cindent' does
5705 something like this, works better in most cases, but is more strict,
5706 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5707 'indentexpr' is a more advanced alternative.
5708 Normally 'autoindent' should also be on when using 'smartindent'.
5709 An indent is automatically inserted:
5710 - After a line ending in '{'.
5711 - After a line starting with a keyword from 'cinwords'.
5712 - Before a line starting with '}' (only with the "O" command).
5713 When typing '}' as the first character in a new line, that line is
5714 given the same indent as the matching '{'.
5715 When typing '#' as the first character in a new line, the indent for
5716 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005717 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5719 When using the ">>" command, lines starting with '#' are not shifted
5720 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005721 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 is set smart indenting is disabled.
5723
5724 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5725'smarttab' 'sta' boolean (default off)
5726 global
5727 {not in Vi}
5728 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005729 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5730 <BS> will delete a 'shiftwidth' worth of space at the start of the
5731 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005732 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005733 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5734 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5736 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005737 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 NOTE: This option is reset when 'compatible' is set.
5739
5740 *'softtabstop'* *'sts'*
5741'softtabstop' 'sts' number (default 0)
5742 local to buffer
5743 {not in Vi}
5744 Number of spaces that a <Tab> counts for while performing editing
5745 operations, like inserting a <Tab> or using <BS>. It "feels" like
5746 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5747 used. This is useful to keep the 'ts' setting at its standard value
5748 of 8, while being able to edit like it is set to 'sts'. However,
5749 commands like "x" still work on the actual characters.
5750 When 'sts' is zero, this feature is off.
5751 'softtabstop' is set to 0 when the 'paste' option is set.
5752 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5753 spaces is minimized by using <Tab>s.
5754 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5755 set.
5756 NOTE: This option is set to 0 when 'compatible' is set.
5757
Bram Moolenaar217ad922005-03-20 22:37:15 +00005758 *'spell'* *'nospell'*
5759'spell' boolean (default off)
5760 local to window
5761 {not in Vi}
5762 {not available when compiled without the |+syntax|
5763 feature}
5764 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005765 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005766
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005767 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005768'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005769 local to buffer
5770 {not in Vi}
5771 {not available when compiled without the |+syntax|
5772 feature}
5773 Pattern to locate the end of a sentence. The following word will be
5774 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005775 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005776 When this check is not wanted make this option empty.
5777 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005778 Be careful with special characters, see |option-backslash| about
5779 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005780 To set this option automatically depending on the language, see
5781 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005782
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005783 *'spellfile'* *'spf'*
5784'spellfile' 'spf' string (default empty)
5785 local to buffer
5786 {not in Vi}
5787 {not available when compiled without the |+syntax|
5788 feature}
5789 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005790 commands. It must end in ".{encoding}.add". You need to include the
5791 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005792 *E765*
5793 It may also be a comma separated list of names. A count before the
5794 |zg| and |zw| commands can be used to access each. This allows using
5795 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005796 When a word is added while this option is empty Vim will set it for
5797 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005798 writable and the first language name that appears in 'spelllang',
5799 ignoring the region.
5800 The resulting ".spl" file will be used for spell checking, it does not
5801 have to appear in 'spelllang'.
5802 Normally one file is used for all regions, but you can add the region
5803 name if you want to. However, it will then only be used when
5804 'spellfile' is set to it, for entries in 'spelllang' only files
5805 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005806 This option cannot be set from a |modeline| or in the |sandbox|, for
5807 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005808
Bram Moolenaar217ad922005-03-20 22:37:15 +00005809 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005810'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005811 local to buffer
5812 {not in Vi}
5813 {not available when compiled without the |+syntax|
5814 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005815 A comma separated list of word list names. When the 'spell' option is
5816 on spellchecking will be done for these languages. Example: >
5817 set spelllang=en_us,nl,medical
5818< This means US English, Dutch and medical words are recognized. Words
5819 that are not recognized will be highlighted.
5820 The word list name must not include a comma or dot. Using a dash is
5821 recommended to separate the two letter language name from a
5822 specification. Thus "en-rare" is used for rare English words.
5823 A region name must come last and have the form "_xx", where "xx" is
5824 the two-letter, lower case region name. You can use more than one
5825 region by listing them: "en_us,en_ca" supports both US and Canadian
5826 English, but not words specific for Australia, New Zealand or Great
5827 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005828 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005829 As a special case the name of a .spl file can be given as-is. The
5830 first "_xx" in the name is removed and used as the region name
5831 (_xx is an underscore, two letters and followed by a non-letter).
5832 This is mainly for testing purposes. You must make sure the correct
5833 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005834 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005835 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5836 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005837 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005838
Bram Moolenaar98692072006-02-04 00:57:42 +00005839 If the |spellfile.vim| plugin is active and you use a language name
5840 for which Vim cannot find the .spl file in 'runtimepath' the plugin
5841 will ask you if you want to download the file.
5842
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005843 After this option has been set successfully, Vim will source the files
5844 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005845 up to the first comma, dot or underscore.
5846 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005847
5848
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005849 *'spellsuggest'* *'sps'*
5850'spellsuggest' 'sps' string (default "best")
5851 global
5852 {not in Vi}
5853 {not available when compiled without the |+syntax|
5854 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005855 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005856 the |spellsuggest()| function. This is a comma-separated list of
5857 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005858
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005859 best Internal method that works best for English. Finds
5860 changes like "fast" and uses a bit of sound-a-like
5861 scoring to improve the ordering.
5862
5863 double Internal method that uses two methods and mixes the
5864 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005865 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005866 word. That only works when the language specifies
5867 sound folding. Can be slow and doesn't always give
5868 better results.
5869
5870 fast Internal method that only checks for simple changes:
5871 character inserts/deletes/swaps. Works well for
5872 simple typing mistakes.
5873
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005874 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005875 Not used for |spellsuggest()|. The number of
5876 suggestions is never more than the value of 'lines'
5877 minus two.
5878
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005879 file:{filename} Read file {filename}, which must have two columns,
5880 separated by a slash. The first column contains the
5881 bad word, the second column the suggested good word.
5882 Example:
5883 theribal/terrible ~
5884 Use this for common mistakes that do not appear at the
5885 top of the suggestion list with the internal methods.
5886 Lines without a slash are ignored, use this for
5887 comments.
5888 The file is used for all languages.
5889
5890 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5891 trouble with spaces. |v:val| holds the badly spelled
5892 word. The expression must evaluate to a List of
5893 Lists, each with a suggestion and a score.
5894 Example:
5895 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005896 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005897 internal methods use. A lower score is better.
5898 This may invoke |spellsuggest()| if you temporarily
5899 set 'spellsuggest' to exclude the "expr:" part.
5900 Errors are silently ignored, unless you set the
5901 'verbose' option to a non-zero value.
5902
5903 Only one of "best", "double" or "fast" may be used. The others may
5904 appear several times in any order. Example: >
5905 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5906<
5907 This option cannot be set from a |modeline| or in the |sandbox|, for
5908 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005909
5910
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5912'splitbelow' 'sb' boolean (default off)
5913 global
5914 {not in Vi}
5915 {not available when compiled without the +windows
5916 feature}
5917 When on, splitting a window will put the new window below the current
5918 one. |:split|
5919
5920 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5921'splitright' 'spr' boolean (default off)
5922 global
5923 {not in Vi}
5924 {not available when compiled without the +vertsplit
5925 feature}
5926 When on, splitting a window will put the new window right of the
5927 current one. |:vsplit|
5928
5929 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5930'startofline' 'sol' boolean (default on)
5931 global
5932 {not in Vi}
5933 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005934 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005935 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005936 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937 with a linewise operator, with "%" with a count and to buffer changing
5938 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5939 only has a line number, e.g., ":25" or ":+".
5940 In case of buffer changing commands the cursor is placed at the column
5941 where it was the last time the buffer was edited.
5942 NOTE: This option is set when 'compatible' is set.
5943
5944 *'statusline'* *'stl'* *E540* *E541* *E542*
5945'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005946 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 {not in Vi}
5948 {not available when compiled without the |+statusline|
5949 feature}
5950 When nonempty, this option determines the content of the status line.
5951 Also see |status-line|.
5952
5953 The option consists of printf style '%' items interspersed with
5954 normal text. Each status line item is of the form:
5955 %-0{minwid}.{maxwid}{item}
5956 All fields except the {item} is optional. A single percent sign can
5957 be given as "%%". Up to 80 items can be specified.
5958
5959 Note that the only effect of 'ruler' when this option is set (and
5960 'laststatus' is 2) is controlling the output of |CTRL-G|.
5961
5962 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005963 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005964 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005965 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 minwid Minimum width of the item, padding as set by '-' & '0'.
5967 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005968 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 on the left for text items. Numeric items will be
5970 shifted down to maxwid-2 digits followed by '>'number
5971 where number is the amount of missing digits, much like
5972 an exponential notation.
5973 item A one letter code as described below.
5974
5975 Following is a description of the possible statusline items. The
5976 second character in "item" is the type:
5977 N for number
5978 S for string
5979 F for flags as described below
5980 - not applicable
5981
5982 item meaning ~
5983 f S Path to the file in the buffer, relative to current directory.
5984 F S Full path to the file in the buffer.
5985 t S File name (tail) of file in the buffer.
5986 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5987 M F Modified flag, text is ",+" or ",-".
5988 r F Readonly flag, text is " [RO]".
5989 R F Readonly flag, text is ",RO".
5990 h F Help buffer flag, text is " [help]".
5991 H F Help buffer flag, text is ",HLP".
5992 w F Preview window flag, text is " [Preview]".
5993 W F Preview window flag, text is ",PRV".
5994 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5995 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5996 {not available when compiled without |+autocmd| feature}
5997 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5998 being used: "<keymap>"
5999 n N Buffer number.
6000 b N Value of byte under cursor.
6001 B N As above, in hexadecimal.
6002 o N Byte number in file of byte under cursor, first byte is 1.
6003 Mnemonic: Offset from start of file (with one added)
6004 {not available when compiled without |+byte_offset| feature}
6005 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006006 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 l N Line number.
6008 L N Number of lines in buffer.
6009 c N Column number.
6010 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006011 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 p N Percentage through file in lines as in |CTRL-G|.
6013 P S Percentage through file of displayed window. This is like the
6014 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006015 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016 Empty if the argument file count is zero or one.
6017 { NF Evaluate expression between '{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006018 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019 ( - Start of item group. Can be used for setting the width and
6020 alignment of a section. Must be followed by %) somewhere.
6021 ) - End of item group. No width fields allowed.
6022 < - Where to truncate line if too long. Default is at the start.
6023 No width fields allowed.
6024 = - Separation point between left and right aligned items.
6025 No width fields allowed.
6026 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006027 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 The difference between User{N} and StatusLine will be applied
6029 to StatusLineNC for the statusline of non-current windows.
6030 The number N must be between 1 and 9. See |hl-User1..9|
6031
6032 Display of flags are controlled by the following heuristic:
6033 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006034 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035 with a space it is assumed that it wants to separate itself from
6036 anything but other flags. That is: A leading comma is removed if the
6037 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006038 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 make a nice display when flags are used like in the examples below.
6040
Bram Moolenaar582fd852005-03-28 20:58:01 +00006041 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 not set) and a minwid is not set for the group, the whole group will
6043 become empty. This will make a group like the following disappear
6044 completely from the statusline when none of the flags are set. >
6045 :set statusline=...%(\ [%M%R%H]%)...
6046<
6047 Beware that an expression is evaluated each and every time the status
6048 line is displayed. The current buffer and current window will be set
6049 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006050 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006052 real current buffer.
6053
6054 The 'statusline' option may be evaluated in the |sandbox|, see
6055 |sandbox-option|.
6056
6057 It is not allowed to change text or jump to another window while
6058 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059
6060 If the statusline is not updated when you want it (e.g., after setting
6061 a variable that's used in an expression), you can force an update by
6062 setting an option without changing its value. Example: >
6063 :let &ro = &ro
6064
6065< A result of all digits is regarded a number for display purposes.
6066 Otherwise the result is taken as flag text and applied to the rules
6067 described above.
6068
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006069 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6071 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6072
6073 Examples:
6074 Emulate standard status line with 'ruler' set >
6075 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6076< Similar, but add ASCII value of char under the cursor (like "ga") >
6077 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6078< Display byte count and byte value, modified flag in red. >
6079 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6080 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6081< Display a ,GZ flag if a compressed file is loaded >
6082 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6083< In the |:autocmd|'s: >
6084 :let b:gzflag = 1
6085< And: >
6086 :unlet b:gzflag
6087< And define this function: >
6088 :function VarExists(var, val)
6089 : if exists(a:var) | return a:val | else | return '' | endif
6090 :endfunction
6091<
6092 *'suffixes'* *'su'*
6093'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6094 global
6095 {not in Vi}
6096 Files with these suffixes get a lower priority when multiple files
6097 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006098 suffixes. Spaces after the comma are ignored. A dot is also seen as
6099 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 separator, precede it with a backslash (see |option-backslash| about
6101 including spaces and backslashes).
6102 See 'wildignore' for completely ignoring files.
6103 The use of |:set+=| and |:set-=| is preferred when adding or removing
6104 suffixes from the list. This avoids problems when a future version
6105 uses another default.
6106
6107 *'suffixesadd'* *'sua'*
6108'suffixesadd' 'sua' string (default "")
6109 local to buffer
6110 {not in Vi}
6111 {not available when compiled without the
6112 |+file_in_path| feature}
6113 Comma separated list of suffixes, which are used when searching for a
6114 file for the "gf", "[I", etc. commands. Example: >
6115 :set suffixesadd=.java
6116<
6117 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6118'swapfile' 'swf' boolean (default on)
6119 local to buffer
6120 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006121 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 swapfile is not wanted for a specific buffer. For example, with
6123 confidential information that even root must not be able to access.
6124 Careful: All text will be in memory:
6125 - Don't use this for big files.
6126 - Recovery will be impossible!
6127 A swapfile will only be present when |'updatecount'| is non-zero and
6128 'swapfile' is set.
6129 When 'swapfile' is reset, the swap file for the current buffer is
6130 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6131 non-zero, a swap file is immediately created.
6132 Also see |swap-file| and |'swapsync'|.
6133
6134 This option is used together with 'bufhidden' and 'buftype' to
6135 specify special kinds of buffers. See |special-buffers|.
6136
6137 *'swapsync'* *'sws'*
6138'swapsync' 'sws' string (default "fsync")
6139 global
6140 {not in Vi}
6141 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006142 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 When this option is empty parts of the swap file may be in memory and
6144 not written to disk. When the system crashes you may lose more work.
6145 On Unix the system does a sync now and then without Vim asking for it,
6146 so the disadvantage of setting this option off is small. On some
6147 systems the swap file will not be written at all. For a unix system
6148 setting it to "sync" will use the sync() call instead of the default
6149 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006150 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151
6152 *'switchbuf'* *'swb'*
6153'switchbuf' 'swb' string (default "")
6154 global
6155 {not in Vi}
6156 This option controls the behavior when switching between buffers.
6157 Possible values (comma separated list):
6158 useopen If included, jump to the first open window that
6159 contains the specified buffer (if there is one).
6160 Otherwise: Do not examine other windows.
6161 This setting is checked with |quickfix| commands, when
6162 jumping to errors (":cc", ":cn", "cp", etc.). It is
6163 also used in all buffer related split commands, for
6164 example ":sbuffer", ":sbnext", or ":sbrewind".
6165 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006166 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 Supported in |quickfix| commands that display errors.
6168
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006169 *'synmaxcol'* *'smc'*
6170'synmaxcol' 'smc' number (default 3000)
6171 local to buffer
6172 {not in Vi}
6173 {not available when compiled without the |+syntax|
6174 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006175 Maximum column in which to search for syntax items. In long lines the
6176 text after this column is not highlighted and following lines may not
6177 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006178 This helps to avoid very slow redrawing for an XML file that is one
6179 long line.
6180 Set to zero to remove the limit.
6181
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 *'syntax'* *'syn'*
6183'syntax' 'syn' string (default empty)
6184 local to buffer
6185 {not in Vi}
6186 {not available when compiled without the |+syntax|
6187 feature}
6188 When this option is set, the syntax with this name is loaded, unless
6189 syntax highlighting has been switched off with ":syntax off".
6190 Otherwise this option does not always reflect the current syntax (the
6191 b:current_syntax variable does).
6192 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006193 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 /* vim: set syntax=idl : */
6195< To switch off syntax highlighting for the current file, use: >
6196 :set syntax=OFF
6197< To switch syntax highlighting on according to the current value of the
6198 'filetype' option: >
6199 :set syntax=ON
6200< What actually happens when setting the 'syntax' option is that the
6201 Syntax autocommand event is triggered with the value as argument.
6202 This option is not copied to another buffer, independent of the 's' or
6203 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006204 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205
6206 *'tabstop'* *'ts'*
6207'tabstop' 'ts' number (default 8)
6208 local to buffer
6209 Number of spaces that a <Tab> in the file counts for. Also see
6210 |:retab| command, and 'softtabstop' option.
6211
6212 Note: Setting 'tabstop' to any other value than 8 can make your file
6213 appear wrong in many places (e.g., when printing it).
6214
6215 There are four main ways to use tabs in Vim:
6216 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6217 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6218 will use a mix of tabs and spaces, but typing Tab and BS will
6219 behave like a tab appears every 4 (or 3) characters.
6220 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6221 'expandtab'. This way you will always insert spaces. The
6222 formatting will never be messed up when 'tabstop' is changed.
6223 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006224 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 works when using Vim to edit the file.
6226 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6227 'noexpandtab'. This should then work (for initial indents only)
6228 for any tabstop setting that people use. It might be nice to have
6229 tabs after the first non-blank inserted as spaces if you do this
6230 though. Otherwise aligned comments will be wrong when 'tabstop' is
6231 changed.
6232
6233 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6234'tagbsearch' 'tbs' boolean (default on)
6235 global
6236 {not in Vi}
6237 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006238 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 searching makes searching for a tag a LOT faster, but a linear search
6240 will find more tags if the tags file wasn't properly sorted.
6241 Vim normally assumes that your tags files are sorted, or indicate that
6242 they are not sorted. Only when this is not the case does the
6243 'tagbsearch' option need to be switched off.
6244
6245 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006246 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 certain files, or retry all files with a linear search. When
6248 'tagbsearch' is off, only a linear search is done.
6249
6250 Linear searching is done anyway, for one file, when Vim finds a line
6251 at the start of the file indicating that it's not sorted: >
6252 !_TAG_FILE_SORTED 0 /some command/
6253< [The whitespace before and after the '0' must be a single <Tab>]
6254
6255 When a binary search was done and no match was found in any of the
6256 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6257 instead of a normal tag name, a retry is done with a linear search.
6258 Tags in unsorted tags files, and matches with different case will only
6259 be found in the retry.
6260
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006261 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 linear search can be avoided for the 'ignorecase' case. Use a value
6263 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6264 case-fold sorted with the -f switch to "sort" in most unices, as in
6265 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6266 5.3 or higher the -f or --fold-case-sort switch can be used for this
6267 as well. Note that case must be folded to uppercase for this to work.
6268
6269 When 'tagbsearch' is off, tags searching is slower when a full match
6270 exists, but faster when no full match exists. Tags in unsorted tags
6271 files may only be found with 'tagbsearch' off.
6272 When the tags file is not sorted, or sorted in a wrong way (not on
6273 ASCII byte value), 'tagbsearch' should be off, or the line given above
6274 must be included in the tags file.
6275 This option doesn't affect commands that find all matching tags (e.g.,
6276 command-line completion and ":help").
6277 {Vi: always uses binary search in some versions}
6278
6279 *'taglength'* *'tl'*
6280'taglength' 'tl' number (default 0)
6281 global
6282 If non-zero, tags are significant up to this number of characters.
6283
6284 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6285'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6286 global
6287 {not in Vi}
6288 If on and using a tag file in another directory, file names in that
6289 tag file are relative to the directory where the tag file is.
6290 NOTE: This option is set to the Vi default value when 'compatible' is
6291 set and to the Vim default value when 'compatible' is reset.
6292
6293 *'tags'* *'tag'* *E433*
6294'tags' 'tag' string (default "./tags,tags", when compiled with
6295 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6296 global or local to buffer |global-local|
6297 Filenames for the tag command, separated by spaces or commas. To
6298 include a space or comma in a file name, precede it with a backslash
6299 (see |option-backslash| about including spaces and backslashes).
6300 When a file name starts with "./", the '.' is replaced with the path
6301 of the current file. But only when the 'd' flag is not included in
6302 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6303 |tags-option|.
6304 "*", "**" and other wildcards can be used to search for tags files in
6305 a directory tree. See |file-searching|. {not available when compiled
6306 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006307 The |tagfiles()| function can be used to get a list of the file names
6308 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6310 files are also supported. They are automatically recognized. The
6311 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6312 differences are ignored (MS-Windows). |emacs-tags|
6313 The use of |:set+=| and |:set-=| is preferred when adding or removing
6314 file names from the list. This avoids problems when a future version
6315 uses another default.
6316 {Vi: default is "tags /usr/lib/tags"}
6317
6318 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6319'tagstack' 'tgst' boolean (default on)
6320 global
6321 {not in all versions of Vi}
6322 When on, the |tagstack| is used normally. When off, a ":tag" or
6323 ":tselect" command with an argument will not push the tag onto the
6324 tagstack. A following ":tag" without an argument, a ":pop" command or
6325 any other command that uses the tagstack will use the unmodified
6326 tagstack, but does change the pointer to the active entry.
6327 Resetting this option is useful when using a ":tag" command in a
6328 mapping which should not change the tagstack.
6329
6330 *'term'* *E529* *E530* *E531*
6331'term' string (default is $TERM, if that fails:
6332 in the GUI: "builtin_gui"
6333 on Amiga: "amiga"
6334 on BeOS: "beos-ansi"
6335 on Mac: "mac-ansi"
6336 on MiNT: "vt52"
6337 on MS-DOS: "pcterm"
6338 on OS/2: "os2ansi"
6339 on Unix: "ansi"
6340 on VMS: "ansi"
6341 on Win 32: "win32")
6342 global
6343 Name of the terminal. Used for choosing the terminal control
6344 characters. Environment variables are expanded |:set_env|.
6345 For example: >
6346 :set term=$TERM
6347< See |termcap|.
6348
6349 *'termbidi'* *'tbidi'*
6350 *'notermbidi'* *'notbidi'*
6351'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6352 global
6353 {not in Vi}
6354 {only available when compiled with the |+arabic|
6355 feature}
6356 The terminal is in charge of Bi-directionality of text (as specified
6357 by Unicode). The terminal is also expected to do the required shaping
6358 that some languages (such as Arabic) require.
6359 Setting this option implies that 'rightleft' will not be set when
6360 'arabic' is set and the value of 'arabicshape' will be ignored.
6361 Note that setting 'termbidi' has the immediate effect that
6362 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6363 This option is reset when the GUI is started.
6364 For further details see |arabic.txt|.
6365
6366 *'termencoding'* *'tenc'*
6367'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6368 Macintosh GUI: "macroman")
6369 global
6370 {only available when compiled with the |+multi_byte|
6371 feature}
6372 {not in Vi}
6373 Encoding used for the terminal. This specifies what character
6374 encoding the keyboard produces and the display will understand. For
6375 the GUI it only applies to the keyboard ('encoding' is used for the
6376 display).
6377 In the Win32 console version the default value is the console codepage
6378 when it differs from the ANSI codepage.
6379 *E617*
6380 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6381 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6382 Any attempts to set a different value will be rejected, and an error
6383 message is shown.
6384 For the Win32 GUI 'termencoding' is not used for typed characters,
6385 because the Win32 system always passes Unicode characters.
6386 When empty, the same encoding is used as for the 'encoding' option.
6387 This is the normal value.
6388 Not all combinations for 'termencoding' and 'encoding' are valid. See
6389 |encoding-table|.
6390 The value for this option must be supported by internal conversions or
6391 iconv(). When this is not possible no conversion will be done and you
6392 will probably experience problems with non-ASCII characters.
6393 Example: You are working with the locale set to euc-jp (Japanese) and
6394 want to edit a UTF-8 file: >
6395 :let &termencoding = &encoding
6396 :set encoding=utf-8
6397< You need to do this when your system has no locale support for UTF-8.
6398
6399 *'terse'* *'noterse'*
6400'terse' boolean (default off)
6401 global
6402 When set: Add 's' flag to 'shortmess' option (this makes the message
6403 for a search that hits the start or end of the file not being
6404 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6405 shortens a lot of messages}
6406
6407 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6408'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6409 global
6410 {not in Vi}
6411 This option is obsolete. Use 'fileformats'.
6412 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6413 set to the default value for the current system. When 'textauto' is
6414 reset, 'fileformats' is made empty.
6415 NOTE: This option is set to the Vi default value when 'compatible' is
6416 set and to the Vim default value when 'compatible' is reset.
6417
6418 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6419'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6420 others: default off)
6421 local to buffer
6422 {not in Vi}
6423 This option is obsolete. Use 'fileformat'.
6424 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6425 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6426 "unix".
6427
6428 *'textwidth'* *'tw'*
6429'textwidth' 'tw' number (default 0)
6430 local to buffer
6431 {not in Vi}
6432 Maximum width of text that is being inserted. A longer line will be
6433 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006434 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6435 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 'formatoptions' and |ins-textwidth|.
6437 NOTE: This option is set to 0 when 'compatible' is set.
6438
6439 *'thesaurus'* *'tsr'*
6440'thesaurus' 'tsr' string (default "")
6441 global or local to buffer |global-local|
6442 {not in Vi}
6443 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006444 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 the file should contain words with similar meaning, separated by
6446 non-keyword characters (white space is preferred). Maximum line
6447 length is 510 bytes.
6448 To obtain a file to be used here, check out the wordlist FAQ at
6449 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006450 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 after a comma are ignored, otherwise spaces are included in the file
6452 name. See |option-backslash| about using backslashes.
6453 The use of |:set+=| and |:set-=| is preferred when adding or removing
6454 directories from the list. This avoids problems when a future version
6455 uses another default.
6456 Backticks cannot be used in this option for security reasons.
6457
6458 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6459'tildeop' 'top' boolean (default off)
6460 global
6461 {not in Vi}
6462 When on: The tilde command "~" behaves like an operator.
6463 NOTE: This option is reset when 'compatible' is set.
6464
6465 *'timeout'* *'to'* *'notimeout'* *'noto'*
6466'timeout' 'to' boolean (default on)
6467 global
6468 *'ttimeout'* *'nottimeout'*
6469'ttimeout' boolean (default off)
6470 global
6471 {not in Vi}
6472 These two options together determine the behavior when part of a
6473 mapped key sequence or keyboard code has been received:
6474
6475 'timeout' 'ttimeout' action ~
6476 off off do not time out
6477 on on or off time out on :mappings and key codes
6478 off on time out on key codes
6479
6480 If both options are off, Vim will wait until either the complete
6481 mapping or key sequence has been received, or it is clear that there
6482 is no mapping or key sequence for the received characters. For
6483 example: if you have mapped "vl" and Vim has received 'v', the next
6484 character is needed to see if the 'v' is followed by an 'l'.
6485 When one of the options is on, Vim will wait for about 1 second for
6486 the next character to arrive. After that the already received
6487 characters are interpreted as single characters. The waiting time can
6488 be changed with the 'timeoutlen' option.
6489 On slow terminals or very busy systems timing out may cause
6490 malfunctioning cursor keys. If both options are off, Vim waits
6491 forever after an entered <Esc> if there are key codes that start
6492 with <Esc>. You will have to type <Esc> twice. If you do not have
6493 problems with key codes, but would like to have :mapped key
6494 sequences not timing out in 1 second, set the 'ttimeout' option and
6495 reset the 'timeout' option.
6496
6497 NOTE: 'ttimeout' is reset when 'compatible' is set.
6498
6499 *'timeoutlen'* *'tm'*
6500'timeoutlen' 'tm' number (default 1000)
6501 global
6502 {not in all versions of Vi}
6503 *'ttimeoutlen'* *'ttm'*
6504'ttimeoutlen' 'ttm' number (default -1)
6505 global
6506 {not in Vi}
6507 The time in milliseconds that is waited for a key code or mapped key
6508 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6509 when part of a command has been typed.
6510 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6511 different timeout value for key codes is desired set 'ttimeoutlen' to
6512 a non-negative number.
6513
6514 ttimeoutlen mapping delay key code delay ~
6515 < 0 'timeoutlen' 'timeoutlen'
6516 >= 0 'timeoutlen' 'ttimeoutlen'
6517
6518 The timeout only happens when the 'timeout' and 'ttimeout' options
6519 tell so. A useful setting would be >
6520 :set timeout timeoutlen=3000 ttimeoutlen=100
6521< (time out on mapping after three seconds, time out on key codes after
6522 a tenth of a second).
6523
6524 *'title'* *'notitle'*
6525'title' boolean (default off, on when title can be restored)
6526 global
6527 {not in Vi}
6528 {not available when compiled without the |+title|
6529 feature}
6530 When on, the title of the window will be set to the value of
6531 'titlestring' (if it is not empty), or to:
6532 filename [+=-] (path) - VIM
6533 Where:
6534 filename the name of the file being edited
6535 - indicates the file cannot be modified, 'ma' off
6536 + indicates the file was modified
6537 = indicates the file is read-only
6538 =+ indicates the file is read-only and modified
6539 (path) is the path of the file being edited
6540 - VIM the server name |v:servername| or "VIM"
6541 Only works if the terminal supports setting window titles
6542 (currently Amiga console, Win32 console, all GUI versions and
6543 terminals with a non- empty 't_ts' option - these are Unix xterm and
6544 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6545 *X11*
6546 When Vim was compiled with HAVE_X11 defined, the original title will
6547 be restored if possible. The output of ":version" will include "+X11"
6548 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6549 works for the icon name |'icon'|.
6550 But: When Vim was started with the |-X| argument, restoring the title
6551 will not work (except in the GUI).
6552 If the title cannot be restored, it is set to the value of 'titleold'.
6553 You might want to restore the title outside of Vim then.
6554 When using an xterm from a remote machine you can use this command:
6555 rsh machine_name xterm -display $DISPLAY &
6556 then the WINDOWID environment variable should be inherited and the
6557 title of the window should change back to what it should be after
6558 exiting Vim.
6559
6560 *'titlelen'*
6561'titlelen' number (default 85)
6562 global
6563 {not in Vi}
6564 {not available when compiled without the |+title|
6565 feature}
6566 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006567 title. When the title is longer, only the end of the path name is
6568 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 Using a percentage makes this adapt to the width of the window. But
6570 it won't work perfectly, because the actual number of characters
6571 available also depends on the font used and other things in the title
6572 bar. When 'titlelen' is zero the full path is used. Otherwise,
6573 values from 1 to 30000 percent can be used.
6574 'titlelen' is also used for the 'titlestring' option.
6575
6576 *'titleold'*
6577'titleold' string (default "Thanks for flying Vim")
6578 global
6579 {not in Vi}
6580 {only available when compiled with the |+title|
6581 feature}
6582 This option will be used for the window title when exiting Vim if the
6583 original title cannot be restored. Only happens if 'title' is on or
6584 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006585 This option cannot be set from a |modeline| or in the |sandbox|, for
6586 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 *'titlestring'*
6588'titlestring' string (default "")
6589 global
6590 {not in Vi}
6591 {not available when compiled without the |+title|
6592 feature}
6593 When this option is not empty, it will be used for the title of the
6594 window. This happens only when the 'title' option is on.
6595 Only works if the terminal supports setting window titles (currently
6596 Amiga console, Win32 console, all GUI versions and terminals with a
6597 non-empty 't_ts' option).
6598 When Vim was compiled with HAVE_X11 defined, the original title will
6599 be restored if possible |X11|.
6600 When this option contains printf-style '%' items, they will be
6601 expanded according to the rules used for 'statusline'.
6602 Example: >
6603 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6604 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6605< The value of 'titlelen' is used to align items in the middle or right
6606 of the available space.
6607 Some people prefer to have the file name first: >
6608 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6609< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006610 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 separating space only when needed.
6612 NOTE: Use of special characters in 'titlestring' may cause the display
6613 to be garbled (e.g., when it contains a CR or NL character).
6614 {not available when compiled without the |+statusline| feature}
6615
6616 *'toolbar'* *'tb'*
6617'toolbar' 'tb' string (default "icons,tooltips")
6618 global
6619 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6620 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006621 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 possible values are:
6623 icons Toolbar buttons are shown with icons.
6624 text Toolbar buttons shown with text.
6625 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006626 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 tooltips Tooltips are active for toolbar buttons.
6628 Tooltips refer to the popup help text which appears after the mouse
6629 cursor is placed over a toolbar button for a brief moment.
6630
6631 If you want the toolbar to be shown with icons as well as text, do the
6632 following: >
6633 :set tb=icons,text
6634< Motif and Athena cannot display icons and text at the same time. They
6635 will show icons if both are requested.
6636
6637 If none of the strings specified in 'toolbar' are valid or if
6638 'toolbar' is empty, this option is ignored. If you want to disable
6639 the toolbar, you need to set the 'guioptions' option. For example: >
6640 :set guioptions-=T
6641< Also see |gui-toolbar|.
6642
6643 *'toolbariconsize'* *'tbis'*
6644'toolbariconsize' 'tbis' string (default "small")
6645 global
6646 {not in Vi}
6647 {only in the GTK+ 2 GUI}
6648 Controls the size of toolbar icons. The possible values are:
6649 tiny Use tiny toolbar icons.
6650 small Use small toolbar icons (default).
6651 medium Use medium-sized toolbar icons.
6652 large Use large toolbar icons.
6653 The exact dimensions in pixels of the various icon sizes depend on
6654 the current theme. Common dimensions are large=32x32, medium=24x24,
6655 small=20x20 and tiny=16x16.
6656
6657 If 'toolbariconsize' is empty, the global default size as determined
6658 by user preferences or the current theme is used.
6659
6660 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6661'ttybuiltin' 'tbi' boolean (default on)
6662 global
6663 {not in Vi}
6664 When on, the builtin termcaps are searched before the external ones.
6665 When off the builtin termcaps are searched after the external ones.
6666 When this option is changed, you should set the 'term' option next for
6667 the change to take effect, for example: >
6668 :set notbi term=$TERM
6669< See also |termcap|.
6670 Rationale: The default for this option is "on", because the builtin
6671 termcap entries are generally better (many systems contain faulty
6672 xterm entries...).
6673
6674 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6675'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6676 sun-cmd, screen, rxvt, dtterm or
6677 iris-ansi; also on when running Vim in
6678 a DOS console)
6679 global
6680 {not in Vi}
6681 Indicates a fast terminal connection. More characters will be sent to
6682 the screen for redrawing, instead of using insert/delete line
6683 commands. Improves smoothness of redrawing when there are multiple
6684 windows and the terminal does not support a scrolling region.
6685 Also enables the extra writing of characters at the end of each screen
6686 line for lines that wrap. This helps when using copy/paste with the
6687 mouse in an xterm and other terminals.
6688
6689 *'ttymouse'* *'ttym'*
6690'ttymouse' 'ttym' string (default depends on 'term')
6691 global
6692 {not in Vi}
6693 {only in Unix and VMS, doesn't work in the GUI; not
6694 available when compiled without |+mouse|}
6695 Name of the terminal type for which mouse codes are to be recognized.
6696 Currently these three strings are valid:
6697 *xterm-mouse*
6698 xterm xterm-like mouse handling. The mouse generates
6699 "<Esc>[Mscr", where "scr" is three bytes:
6700 "s" = button state
6701 "c" = column plus 33
6702 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006703 This only works up to 223 columns! See "dec" for a
6704 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 xterm2 Works like "xterm", but with the xterm reporting the
6706 mouse position while the mouse is dragged. This works
6707 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006708 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 work. See below for how Vim detects this
6710 automatically.
6711 *netterm-mouse*
6712 netterm NetTerm mouse handling. The mouse generates
6713 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6714 for the row and column.
6715 *dec-mouse*
6716 dec DEC terminal mouse handling. The mouse generates a
6717 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006718 This is also available for an Xterm, if it was
6719 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 *jsbterm-mouse*
6721 jsbterm JSB term mouse handling.
6722 *pterm-mouse*
6723 pterm QNX pterm mouse handling.
6724
6725 The mouse handling must be enabled at compile time |+mouse_xterm|
6726 |+mouse_dec| |+mouse_netterm|.
6727 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6728 recognized, if enabled at compile time. DEC terminal mouse codes
6729 are recognized if enabled at compile time, and 'ttymouse' is not
6730 "xterm" (because the xterm and dec mouse codes conflict).
6731 This option is automatically set to "xterm", when the 'term' option is
6732 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6733 or "xterm2" already. The main use of this option is to set it to
6734 "xterm", when the terminal name doesn't start with "xterm", but it can
6735 handle xterm mouse codes.
6736 The "xterm2" value will be set if the xterm version is reported to be
6737 95 of higher. This only works when compiled with the |+termresponse|
6738 feature and if |t_RV| is set to the escape sequence to request the
6739 xterm version number. Otherwise "xterm2" must be set explicitly.
6740 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6741 t_RV to an empty string: >
6742 :set t_RV=
6743<
6744 *'ttyscroll'* *'tsl'*
6745'ttyscroll' 'tsl' number (default 999)
6746 global
6747 Maximum number of lines to scroll the screen. If there are more lines
6748 to scroll the window is redrawn. For terminals where scrolling is
6749 very slow and redrawing is not slow this can be set to a small number,
6750 e.g., 3, to speed up displaying.
6751
6752 *'ttytype'* *'tty'*
6753'ttytype' 'tty' string (default from $TERM)
6754 global
6755 Alias for 'term', see above.
6756
6757 *'undolevels'* *'ul'*
6758'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6759 Win32 and OS/2)
6760 global
6761 {not in Vi}
6762 Maximum number of changes that can be undone. Since undo information
6763 is kept in memory, higher numbers will cause more memory to be used
6764 (nevertheless, a single change can use an unlimited amount of memory).
6765 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6766 itself: >
6767 set ul=0
6768< But you can also get Vi compatibility by including the 'u' flag in
6769 'cpoptions', and still be able to use CTRL-R to repeat undo.
6770 Set to a negative number for no undo at all: >
6771 set ul=-1
6772< This helps when you run out of memory for a single change.
6773 Also see |undo-two-ways|.
6774
6775 *'updatecount'* *'uc'*
6776'updatecount' 'uc' number (default: 200)
6777 global
6778 {not in Vi}
6779 After typing this many characters the swap file will be written to
6780 disk. When zero, no swap file will be created at all (see chapter on
6781 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6782 Vim with the "-n" option, see |startup|. When editing in readonly
6783 mode this option will be initialized to 10000.
6784 The swapfile can be disabled per buffer with |'swapfile'|.
6785 When 'updatecount' is set from zero to non-zero, swap files are
6786 created for all buffers that have 'swapfile' set. When 'updatecount'
6787 is set to zero, existing swap files are not deleted.
6788 Also see |'swapsync'|.
6789 This option has no meaning in buffers where |'buftype'| is "nofile"
6790 or "nowrite".
6791
6792 *'updatetime'* *'ut'*
6793'updatetime' 'ut' number (default 4000)
6794 global
6795 {not in Vi}
6796 If this many milliseconds nothing is typed the swap file will be
6797 written to disk (see |crash-recovery|). Also used for the
6798 |CursorHold| autocommand event.
6799
6800 *'verbose'* *'vbs'*
6801'verbose' 'vbs' number (default 0)
6802 global
6803 {not in Vi, although some versions have a boolean
6804 verbose option}
6805 When bigger than zero, Vim will give messages about what it is doing.
6806 Currently, these messages are given:
6807 >= 1 When the viminfo file is read or written.
6808 >= 2 When a file is ":source"'ed.
6809 >= 5 Every searched tags file.
6810 >= 8 Files for which a group of autocommands is executed.
6811 >= 9 Every executed autocommand.
6812 >= 12 Every executed function.
6813 >= 13 When an exception is thrown, caught, finished, or discarded.
6814 >= 14 Anything pending in a ":finally" clause.
6815 >= 15 Every executed Ex command (truncated at 200 characters).
6816
6817 This option can also be set with the "-V" argument. See |-V|.
6818 This option is also set by the |:verbose| command.
6819
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006820 When the 'verbosefile' option is set then the verbose messages are not
6821 displayed.
6822
6823 *'verbosefile'* *'vfile'*
6824'verbosefile' 'vfile' string (default empty)
6825 global
6826 {not in Vi}
6827 When not empty all messages are written in a file with this name.
6828 When the file exists messages are appended.
6829 Writing to the file ends when Vim exits or when 'verbosefile' is made
6830 empty.
6831 Setting 'verbosefile' to a new value is like making it empty first.
6832 The difference with |:redir| is that verbose messages are not
6833 displayed when 'verbosefile' is set.
6834
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 *'viewdir'* *'vdir'*
6836'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6837 "$VIM/vimfiles/view",
6838 for Unix: "~/.vim/view",
6839 for Macintosh: "$VIM:vimfiles:view"
6840 for VMS: "sys$login:vimfiles/view"
6841 for RiscOS: "Choices:vimfiles/view")
6842 global
6843 {not in Vi}
6844 {not available when compiled without the +mksession
6845 feature}
6846 Name of the directory where to store files for |:mkview|.
6847 This option cannot be set from a |modeline| or in the |sandbox|, for
6848 security reasons.
6849
6850 *'viewoptions'* *'vop'*
6851'viewoptions' 'vop' string (default: "folds,options,cursor")
6852 global
6853 {not in Vi}
6854 {not available when compiled without the +mksession
6855 feature}
6856 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006857 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 word save and restore ~
6859 cursor cursor position in file and in window
6860 folds manually created folds, opened/closed folds and local
6861 fold options
6862 options options and mappings local to a window or buffer (not
6863 global values for local options)
6864 slash backslashes in file names replaced with forward
6865 slashes
6866 unix with Unix end-of-line format (single <NL>), even when
6867 on Windows or DOS
6868
6869 "slash" and "unix" are useful on Windows when sharing view files
6870 with Unix. The Unix version of Vim cannot source dos format scripts,
6871 but the Windows version of Vim can source unix format scripts.
6872
6873 *'viminfo'* *'vi'* *E526* *E527* *E528*
6874'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6875 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6876 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6877 for others: '20,<50,s10,h)
6878 global
6879 {not in Vi}
6880 {not available when compiled without the |+viminfo|
6881 feature}
6882 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006883 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 separated list of parameters, each consisting of a single character
6885 identifying the particular parameter, followed by a number or string
6886 which specifies the value of that parameter. If a particular
6887 character is left out, then the default value is used for that
6888 parameter. The following is a list of the identifying characters and
6889 the effect of their value.
6890 CHAR VALUE ~
6891 ! When included, save and restore global variables that start
6892 with an uppercase letter, and don't contain a lowercase
6893 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006894 and "_K_L_M" are not. Only String and Number types are
6895 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 " Maximum number of lines saved for each register. Old name of
6897 the '<' item, with the disadvantage that you need to put a
6898 backslash before the ", otherwise it will be recognized as the
6899 start of a comment!
6900 % When included, save and restore the buffer list. If Vim is
6901 started with a file name argument, the buffer list is not
6902 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006903 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 without a file name and buffers for help files are not written
6905 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006906 When followed by a number, the number specifies the maximum
6907 number of buffers that are stored. Without a number all
6908 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 ' Maximum number of previously edited files for which the marks
6910 are remembered. This parameter must always be included when
6911 'viminfo' is non-empty.
6912 Including this item also means that the |jumplist| and the
6913 |changelist| are stored in the viminfo file.
6914 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006915 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916 patterns are also saved. When not included, the value of
6917 'history' is used.
6918 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006919 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 < Maximum number of lines saved for each register. If zero then
6921 registers are not saved. When not included, all lines are
6922 saved. '"' is the old name for this item.
6923 Also see the 's' item below: limit specified in Kbyte.
6924 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006925 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 c When included, convert the text in the viminfo file from the
6927 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006928 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 f Whether file marks need to be stored. If zero, file marks ('0
6930 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006931 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 cursor position (when exiting or when doing ":wviminfo").
6933 h Disable the effect of 'hlsearch' when loading the viminfo
6934 file. When not included, it depends on whether ":nohlsearch"
6935 has been used since the last search command.
6936 n Name of the viminfo file. The name must immediately follow
6937 the 'n'. Must be the last one! If the "-i" argument was
6938 given when starting Vim, that file name overrides the one
6939 given here with 'viminfo'. Environment variables are expanded
6940 when opening the file, not when setting the option.
6941 r Removable media. The argument is a string (up to the next
6942 ','). This parameter can be given several times. Each
6943 specifies the start of a path for which no marks will be
6944 stored. This is to avoid removable media. For MS-DOS you
6945 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6946 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6947 ignored. Maximum length of each 'r' argument is 50
6948 characters.
6949 s Maximum size of an item in Kbyte. If zero then registers are
6950 not saved. Currently only applies to registers. The default
6951 "s10" will exclude registers with more than 10 Kbyte of text.
6952 Also see the '<' item above: line count limit.
6953
6954 Example: >
6955 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6956<
6957 '50 Marks will be remembered for the last 50 files you
6958 edited.
6959 <1000 Contents of registers (up to 1000 lines each) will be
6960 remembered.
6961 s100 Registers with more than 100 Kbyte text are skipped.
6962 :0 Command-line history will not be saved.
6963 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6964 no / Since '/' is not specified, the default will be used,
6965 that is, save all of the search history, and also the
6966 previous search and substitute patterns.
6967 no % The buffer list will not be saved nor read back.
6968 no h 'hlsearch' highlighting will be restored.
6969
6970 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6971 load the contents of the file, this is not done automatically.
6972
6973 This option cannot be set from a |modeline| or in the |sandbox|, for
6974 security reasons.
6975
6976 *'virtualedit'* *'ve'*
6977'virtualedit' 've' string (default "")
6978 global
6979 {not in Vi}
6980 {not available when compiled without the
6981 |+virtualedit| feature}
6982 A comma separated list of these words:
6983 block Allow virtual editing in Visual block mode.
6984 insert Allow virtual editing in Insert mode.
6985 all Allow virtual editing in all modes.
6986 Virtual editing means that the cursor can be positioned where there is
6987 no actual character. This can be halfway into a Tab or beyond the end
6988 of the line. Useful for selecting a rectangle in Visual mode and
6989 editing a table.
6990
6991 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6992'visualbell' 'vb' boolean (default off)
6993 global
6994 {not in Vi}
6995 Use visual bell instead of beeping. The terminal code to display the
6996 visual bell is given with 't_vb'. When no beep or flash is wanted,
6997 use ":set vb t_vb=".
6998 Note: When the GUI starts, 't_vb' is reset to its default value. You
6999 might want to set it again in your |gvimrc|.
7000 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7001 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7002 where 40 is the time in msec.
7003 Does not work on the Amiga, you always get a screen flash.
7004 Also see 'errorbells'.
7005
7006 *'warn'* *'nowarn'*
7007'warn' boolean (default on)
7008 global
7009 Give a warning message when a shell command is used while the buffer
7010 has been changed.
7011
7012 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7013'weirdinvert' 'wiv' boolean (default off)
7014 global
7015 {not in Vi}
7016 This option has the same effect as the 't_xs' termcap option.
7017 It is provided for backwards compatibility with version 4.x.
7018 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7019 vice versa. Has no effect when the GUI is running.
7020
7021 *'whichwrap'* *'ww'*
7022'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7023 global
7024 {not in Vi}
7025 Allow specified keys that move the cursor left/right to move to the
7026 previous/next line when the cursor is on the first/last character in
7027 the line. Concatenate characters to allow this for these keys:
7028 char key mode ~
7029 b <BS> Normal and Visual
7030 s <Space> Normal and Visual
7031 h "h" Normal and Visual
7032 l "l" Normal and Visual
7033 < <Left> Normal and Visual
7034 > <Right> Normal and Visual
7035 ~ "~" Normal
7036 [ <Left> Insert and Replace
7037 ] <Right> Insert and Replace
7038 For example: >
7039 :set ww=<,>,[,]
7040< allows wrap only when cursor keys are used.
7041 When the movement keys are used in combination with a delete or change
7042 operator, the <EOL> also counts for a character. This makes "3h"
7043 different from "3dh" when the cursor crosses the end of a line. This
7044 is also true for "x" and "X", because they do the same as "dl" and
7045 "dh". If you use this, you may also want to use the mapping
7046 ":map <BS> X" to make backspace delete the character in front of the
7047 cursor.
7048 When 'l' is included, you get a side effect: "yl" on an empty line
7049 will include the <EOL>, so that "p" will insert a new line.
7050 NOTE: This option is set to the Vi default value when 'compatible' is
7051 set and to the Vim default value when 'compatible' is reset.
7052
7053 *'wildchar'* *'wc'*
7054'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7055 global
7056 {not in Vi}
7057 Character you have to type to start wildcard expansion in the
7058 command-line, as specified with 'wildmode'.
7059 The character is not recognized when used inside a macro. See
7060 'wildcharm' for that.
7061 Although 'wc' is a number option, you can set it to a special key: >
7062 :set wc=<Esc>
7063< NOTE: This option is set to the Vi default value when 'compatible' is
7064 set and to the Vim default value when 'compatible' is reset.
7065
7066 *'wildcharm'* *'wcm'*
7067'wildcharm' 'wcm' number (default: none (0))
7068 global
7069 {not in Vi}
7070 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007071 recognized when used inside a macro. You can find "spare" command-line
7072 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 you'll never actually type 'wildcharm', just use it in mappings that
7074 automatically invoke completion mode, e.g.: >
7075 :set wcm=<C-Z>
7076 :cmap ss so $vim/sessions/*.vim<C-Z>
7077< Then after typing :ss you can use CTRL-P & CTRL-N.
7078
7079 *'wildignore'* *'wig'*
7080'wildignore' 'wig' string (default "")
7081 global
7082 {not in Vi}
7083 {not available when compiled without the |+wildignore|
7084 feature}
7085 A list of file patterns. A file that matches with one of these
7086 patterns is ignored when completing file or directory names.
7087 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7088 Also see 'suffixes'.
7089 Example: >
7090 :set wildignore=*.o,*.obj
7091< The use of |:set+=| and |:set-=| is preferred when adding or removing
7092 a pattern from the list. This avoids problems when a future version
7093 uses another default.
7094
7095 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7096'wildmenu' 'wmnu' boolean (default off)
7097 global
7098 {not in Vi}
7099 {not available if compiled without the |+wildmenu|
7100 feature}
7101 When 'wildmenu' is on, command-line completion operates in an enhanced
7102 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7103 the possible matches are shown just above the command line, with the
7104 first match highlighted (overwriting the status line, if there is
7105 one). Keys that show the previous/next match, such as <Tab> or
7106 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7107 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7108 specified. "longest" and "list" do not start "wildmenu" mode.
7109 If there are more matches than can fit in the line, a ">" is shown on
7110 the right and/or a "<" is shown on the left. The status line scrolls
7111 as needed.
7112 The "wildmenu" mode is abandoned when a key is hit that is not used
7113 for selecting a completion.
7114 While the "wildmenu" is active the following keys have special
7115 meanings:
7116
7117 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7118 <Down> - in filename/menu name completion: move into a
7119 subdirectory or submenu.
7120 <CR> - in menu completion, when the cursor is just after a
7121 dot: move into a submenu.
7122 <Up> - in filename/menu name completion: move up into
7123 parent directory or parent menu.
7124
7125 This makes the menus accessible from the console |console-menus|.
7126
7127 If you prefer the <Left> and <Right> keys to move the cursor instead
7128 of selecting a different match, use this: >
7129 :cnoremap <Left> <Space><BS><Left>
7130 :cnoremap <Right> <Space><BS><Right>
7131<
7132 The "WildMenu" highlighting is used for displaying the current match
7133 |hl-WildMenu|.
7134
7135 *'wildmode'* *'wim'*
7136'wildmode' 'wim' string (Vim default: "full")
7137 global
7138 {not in Vi}
7139 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007140 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 part specifies what to do for each consecutive use of 'wildchar. The
7142 first part specifies the behavior for the first use of 'wildchar',
7143 The second part for the second use, etc.
7144 These are the possible values for each part:
7145 "" Complete only the first match.
7146 "full" Complete the next full match. After the last match,
7147 the original string is used and then the first match
7148 again.
7149 "longest" Complete till longest common string. If this doesn't
7150 result in a longer string, use the next part.
7151 "longest:full" Like "longest", but also start 'wildmenu' if it is
7152 enabled.
7153 "list" When more than one match, list all matches.
7154 "list:full" When more than one match, list all matches and
7155 complete first match.
7156 "list:longest" When more than one match, list all matches and
7157 complete till longest common string.
7158 When there is only a single match, it is fully completed in all cases.
7159
7160 Examples: >
7161 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007162< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 :set wildmode=longest,full
7164< Complete longest common string, then each full match >
7165 :set wildmode=list:full
7166< List all matches and complete each full match >
7167 :set wildmode=list,full
7168< List all matches without completing, then each full match >
7169 :set wildmode=longest,list
7170< Complete longest common string, then list alternatives.
7171
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007172 *'wildoptions'* *'wop'*
7173'wildoptions' 'wop' string (default "")
7174 global
7175 {not in Vi}
7176 {not available when compiled without the |+wildignore|
7177 feature}
7178 A list of words that change how command line completion is done.
7179 Currently only one word is allowed:
7180 tagfile When using CTRL-D to list matching tags, the kind of
7181 tag and the file of the tag is listed. Only one match
7182 is displayed per line. Often used tag kinds are:
7183 d #define
7184 f function
7185 Also see |cmdline-completion|.
7186
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 *'winaltkeys'* *'wak'*
7188'winaltkeys' 'wak' string (default "menu")
7189 global
7190 {not in Vi}
7191 {only used in Win32, Motif, GTK and Photon GUI}
7192 Some GUI versions allow the access to menu entries by using the ALT
7193 key in combination with a character that appears underlined in the
7194 menu. This conflicts with the use of the ALT key for mappings and
7195 entering special characters. This option tells what to do:
7196 no Don't use ALT keys for menus. ALT key combinations can be
7197 mapped, but there is no automatic handling. This can then be
7198 done with the |:simalt| command.
7199 yes ALT key handling is done by the windowing system. ALT key
7200 combinations cannot be mapped.
7201 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007202 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 keys can be mapped.
7204 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7205 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007206 This option is not used for <F10>; on Win32 and with GTK <F10> will
7207 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007209 *'window'* *'wi'*
7210'window' 'wi' number (default screen height - 1)
7211 global
7212 Window height. Do not confuse this with the height of the Vim window,
7213 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007214 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7215 value is smaller than 'lines' minus one. The screen will scroll
7216 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007217 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7218 in a much smarter way, taking care of wrapping lines.
7219 When resizing the Vim window, the value is smaller than 1 or more than
7220 or equal to 'lines' it will be set to 'lines' minus 1.
7221 {Vi also uses the option to specify the number of displayed lines}
7222
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 *'winheight'* *'wh'* *E591*
7224'winheight' 'wh' number (default 1)
7225 global
7226 {not in Vi}
7227 {not available when compiled without the +windows
7228 feature}
7229 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007230 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 current window is smaller, its size is increased, at the cost of the
7232 height of other windows. Set it to 999 to make the current window
7233 always fill the screen (although this has the drawback that ":all"
7234 will create only two windows). Set it to a small number for normal
7235 editing.
7236 Minimum value is 1.
7237 The height is not adjusted after one of the commands to change the
7238 height of the current window.
7239 'winheight' applies to the current window. Use 'winminheight' to set
7240 the minimal height for other windows.
7241
7242 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7243'winfixheight' 'wfh' boolean (default off)
7244 local to window
7245 {not in Vi}
7246 {not available when compiled without the +windows
7247 feature}
7248 Keep the window height when windows are opened or closed and
7249 'equalalways' is set. Set by default for the |preview-window| and
7250 |quickfix-window|.
7251 The height may be changed anyway when running out of room.
7252
7253 *'winminheight'* *'wmh'*
7254'winminheight' 'wmh' number (default 1)
7255 global
7256 {not in Vi}
7257 {not available when compiled without the +windows
7258 feature}
7259 The minimal height of a window, when it's not the current window.
7260 This is a hard minimum, windows will never become smaller.
7261 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7262 status bar) if necessary. They will return to at least one line when
7263 they become active (since the cursor has to have somewhere to go.)
7264 Use 'winheight' to set the minimal height of the current window.
7265 This option is only checked when making a window smaller. Don't use a
7266 large number, it will cause errors when opening more than a few
7267 windows. A value of 0 to 3 is reasonable.
7268
7269 *'winminwidth'* *'wmw'*
7270'winminwidth' 'wmw' number (default 1)
7271 global
7272 {not in Vi}
7273 {not available when compiled without the +vertsplit
7274 feature}
7275 The minimal width of a window, when it's not the current window.
7276 This is a hard minimum, windows will never become smaller.
7277 When set to zero, windows may be "squashed" to zero columns (i.e. just
7278 a vertical separator) if necessary. They will return to at least one
7279 line when they become active (since the cursor has to have somewhere
7280 to go.)
7281 Use 'winwidth' to set the minimal width of the current window.
7282 This option is only checked when making a window smaller. Don't use a
7283 large number, it will cause errors when opening more than a few
7284 windows. A value of 0 to 12 is reasonable.
7285
7286 *'winwidth'* *'wiw'* *E592*
7287'winwidth' 'wiw' number (default 20)
7288 global
7289 {not in Vi}
7290 {not available when compiled without the +vertsplit
7291 feature}
7292 Minimal number of columns for the current window. This is not a hard
7293 minimum, Vim will use fewer columns if there is not enough room. If
7294 the current window is smaller, its size is increased, at the cost of
7295 the width of other windows. Set it to 999 to make the current window
7296 always fill the screen. Set it to a small number for normal editing.
7297 The width is not adjusted after one of the commands to change the
7298 width of the current window.
7299 'winwidth' applies to the current window. Use 'winminwidth' to set
7300 the minimal width for other windows.
7301
7302 *'wrap'* *'nowrap'*
7303'wrap' boolean (default on)
7304 local to window
7305 {not in Vi}
7306 This option changes how text is displayed. It doesn't change the text
7307 in the buffer, see 'textwidth' for that.
7308 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007309 displaying continues on the next line. When off lines will not wrap
7310 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 moved to a part that is not shown, the screen will scroll
7312 horizontally.
7313 The line will be broken in the middle of a word if necessary. See
7314 'linebreak' to get the break at a word boundary.
7315 To make scrolling horizontally a bit more useful, try this: >
7316 :set sidescroll=5
7317 :set listchars+=precedes:<,extends:>
7318< See 'sidescroll', 'listchars' and |wrap-off|.
7319
7320 *'wrapmargin'* *'wm'*
7321'wrapmargin' 'wm' number (default 0)
7322 local to buffer
7323 Number of characters from the right window border where wrapping
7324 starts. When typing text beyond this limit, an <EOL> will be inserted
7325 and inserting continues on the next line.
7326 Options that add a margin, such as 'number' and 'foldcolumn', cause
7327 the text width to be further reduced. This is Vi compatible.
7328 When 'textwidth' is non-zero, this option is not used.
7329 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7330 and less usefully}
7331
7332 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7333'wrapscan' 'ws' boolean (default on) *E384* *E385*
7334 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007335 Searches wrap around the end of the file. Also applies to |]s| and
7336 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337
7338 *'write'* *'nowrite'*
7339'write' boolean (default on)
7340 global
7341 {not in Vi}
7342 Allows writing files. When not set, writing a file is not allowed.
7343 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007344 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 argument. Filtering text is still possible, even though this requires
7346 writing a temporary file.
7347
7348 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7349'writeany' 'wa' boolean (default off)
7350 global
7351 Allows writing to any file with no need for "!" override.
7352
7353 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7354'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7355 otherwise)
7356 global
7357 {not in Vi}
7358 Make a backup before overwriting a file. The backup is removed after
7359 the file was successfully written, unless the 'backup' option is
7360 also on. Reset this option if your file system is almost full. See
7361 |backup-table| for another explanation.
7362 When the 'backupskip' pattern matches, a backup is not made anyway.
7363 NOTE: This option is set to the default value when 'compatible' is
7364 set.
7365
7366 *'writedelay'* *'wd'*
7367'writedelay' 'wd' number (default 0)
7368 global
7369 {not in Vi}
7370 The number of microseconds to wait for each character sent to the
7371 screen. When non-zero, characters are sent to the terminal one by
7372 one. For MS-DOS pcterm this does not work. For debugging purposes.
7373
7374 vim:tw=78:ts=8:ft=help:norl: