blob: 9bd366026228ea1d795f9d7f5a50372349a0fa4d [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
2946 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002947 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 apply equally to 'grepprg'.
2949 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2950 otherwise it's "grep -n".
2951 This option cannot be set from a |modeline| or in the |sandbox|, for
2952 security reasons.
2953
2954 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2955'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2956 ve:ver35-Cursor,
2957 o:hor50-Cursor,
2958 i-ci:ver25-Cursor/lCursor,
2959 r-cr:hor20-Cursor/lCursor,
2960 sm:block-Cursor
2961 -blinkwait175-blinkoff150-blinkon175",
2962 for MS-DOS and Win32 console:
2963 "n-v-c:block,o:hor50,i-ci:hor15,
2964 r-cr:hor30,sm:block")
2965 global
2966 {not in Vi}
2967 {only available when compiled with GUI enabled, and
2968 for MS-DOS and Win32 console}
2969 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002970 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 the height of the cursor can be changed. This can be done by
2972 specifying a block cursor, or a percentage for a vertical or
2973 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002974 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002976 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 mode-list and an argument-list:
2978 mode-list:argument-list,mode-list:argument-list,..
2979 The mode-list is a dash separated list of these modes:
2980 n Normal mode
2981 v Visual mode
2982 ve Visual mode with 'selection' "exclusive" (same as 'v',
2983 if not specified)
2984 o Operator-pending mode
2985 i Insert mode
2986 r Replace mode
2987 c Command-line Normal (append) mode
2988 ci Command-line Insert mode
2989 cr Command-line Replace mode
2990 sm showmatch in Insert mode
2991 a all modes
2992 The argument-list is a dash separated list of these arguments:
2993 hor{N} horizontal bar, {N} percent of the character height
2994 ver{N} vertical bar, {N} percent of the character width
2995 block block cursor, fills the whole character
2996 [only one of the above three should be present]
2997 blinkwait{N} *cursor-blinking*
2998 blinkon{N}
2999 blinkoff{N}
3000 blink times for cursor: blinkwait is the delay before
3001 the cursor starts blinking, blinkon is the time that
3002 the cursor is shown and blinkoff is the time that the
3003 cursor is not shown. The times are in msec. When one
3004 of the numbers is zero, there is no blinking. The
3005 default is: "blinkwait700-blinkon400-blinkoff250".
3006 These numbers are used for a missing entry. This
3007 means that blinking is enabled by default. To switch
3008 blinking off you can use "blinkon0". The cursor only
3009 blinks when Vim is waiting for input, not while
3010 executing a command.
3011 To make the cursor blink in an xterm, see
3012 |xterm-blink|.
3013 {group-name}
3014 a highlight group name, that sets the color and font
3015 for the cursor
3016 {group-name}/{group-name}
3017 Two highlight group names, the first is used when
3018 no language mappings are used, the other when they
3019 are. |language-mapping|
3020
3021 Examples of parts:
3022 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3023 block cursor with colors from the "nCursor"
3024 highlight group
3025 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3026 In Insert and Command-line Insert mode, use a
3027 30% vertical bar cursor with colors from the
3028 "iCursor" highlight group. Blink a bit
3029 faster.
3030
3031 The 'a' mode is different. It will set the given argument-list for
3032 all modes. It does not reset anything to defaults. This can be used
3033 to do a common setting for all modes. For example, to switch off
3034 blinking: "a:blinkon0"
3035
3036 Examples of cursor highlighting: >
3037 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3038 :highlight Cursor gui=NONE guifg=bg guibg=fg
3039<
3040 *'guifont'* *'gfn'*
3041 *E235* *E596* *E610* *E611*
3042'guifont' 'gfn' string (default "")
3043 global
3044 {not in Vi}
3045 {only available when compiled with GUI enabled}
3046 This is a list of fonts which will be used for the GUI version of Vim.
3047 In its simplest form the value is just one font name. When
3048 the font cannot be found you will get an error message. To try other
3049 font names a list can be specified, font names separated with commas.
3050 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003051
Bram Moolenaar05159a02005-02-26 23:04:13 +00003052 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3053 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003054
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 Spaces after a comma are ignored. To include a comma in a font name
3056 precede it with a backslash. Setting an option requires an extra
3057 backslash before a space and a backslash. See also
3058 |option-backslash|. For example: >
3059 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003060< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003062
3063 If none of the fonts can be loaded, Vim will keep the current setting.
3064 If an empty font list is given, Vim will try using other resource
3065 settings (for X, it will use the Vim.font resource), and finally it
3066 will try some builtin default which should always be there ("7x13" in
3067 the case of X). The font names given should be "normal" fonts. Vim
3068 will try to find the related bold and italic fonts.
3069
Bram Moolenaar05159a02005-02-26 23:04:13 +00003070 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003071 :set guifont=*
3072< will bring up a font requester, where you can pick the font you want.
3073
3074 The font name depends on the GUI used. See |setting-guifont| for a
3075 way to set 'guifont' for various systems.
3076
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 For the GTK+ 2 GUI the font name looks like this: >
3078 :set guifont=Andale\ Mono\ 11
3079< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003080
3081 For Mac OSX you can use something like this: >
3082 :set guifont=Monaco:h10
3083< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003085 width). An exception is GTK 2: all fonts are accepted, but
3086 mono-spaced fonts look best.
3087
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 To preview a font on X11, you might be able to use the "xfontsel"
3089 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003090
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 For the Win32 GUI *E244* *E245*
3092 - takes these options in the font name:
3093 hXX - height is XX (points, can be floating-point)
3094 wXX - width is XX (points, can be floating-point)
3095 b - bold
3096 i - italic
3097 u - underline
3098 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003099 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3101 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3102 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003103 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104
3105 Use a ':' to separate the options.
3106 - A '_' can be used in the place of a space, so you don't need to use
3107 backslashes to escape the spaces.
3108 - Examples: >
3109 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3110 :set guifont=Andale_Mono:h7.5:w4.5
3111< See also |font-sizes|.
3112
3113 *'guifontset'* *'gfs'*
3114 *E250* *E252* *E234* *E597* *E598*
3115'guifontset' 'gfs' string (default "")
3116 global
3117 {not in Vi}
3118 {only available when compiled with GUI enabled and
3119 with the |+xfontset| feature}
3120 {not available in the GTK+ 2 GUI}
3121 When not empty, specifies two (or more) fonts to be used. The first
3122 one for normal English, the second one for your special language. See
3123 |xfontset|.
3124 Setting this option also means that all font names will be handled as
3125 a fontset name. Also the ones used for the "font" argument of the
3126 |:highlight| command.
3127 The fonts must match with the current locale. If fonts for the
3128 character sets that the current locale uses are not included, setting
3129 'guifontset' will fail.
3130 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3131 the comma-separated names are alternative names, one of which will be
3132 used. In 'guifontset' the whole string is one fontset name,
3133 including the commas. It is not possible to specify alternative
3134 fontset names.
3135 This example works on many X11 systems: >
3136 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3137<
3138 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3139'guifontwide' 'gfw' string (default "")
3140 global
3141 {not in Vi}
3142 {only available when compiled with GUI enabled}
3143 When not empty, specifies a comma-separated list of fonts to be used
3144 for double-width characters. The first font that can be loaded is
3145 used.
3146 Note: The size of these fonts must be exactly twice as wide as the one
3147 specified with 'guifont' and the same height.
3148
3149 All GUI versions but GTK+ 2:
3150
3151 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3152 'guifontset' is empty or invalid.
3153 When 'guifont' is set and a valid font is found in it and
3154 'guifontwide' is empty Vim will attempt to find a matching
3155 double-width font and set 'guifontwide' to it.
3156
3157 GTK+ 2 GUI only: *guifontwide_gtk2*
3158
3159 If set and valid, 'guifontwide' is always used for double width
3160 characters, even if 'encoding' is not set to "utf-8".
3161 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003162 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 font for characters not available in 'guifont'. Thus you do not need
3164 to set 'guifontwide' at all unless you want to override the choice
3165 made by Pango/Xft.
3166
3167 *'guiheadroom'* *'ghr'*
3168'guiheadroom' 'ghr' number (default 50)
3169 global
3170 {not in Vi} {only for GTK and X11 GUI}
3171 The number of pixels subtracted from the screen height when fitting
3172 the GUI window on the screen. Set this before the GUI is started,
3173 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003174 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 lines will be left for window decorations and other items on the
3176 screen. Set it to a negative value to allow windows taller than the
3177 screen.
3178
3179 *'guioptions'* *'go'*
3180'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003181 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 global
3183 {not in Vi}
3184 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003185 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 sequence of letters which describes what components and options of the
3187 GUI should be used.
3188 To avoid problems with flags that are added in the future, use the
3189 "+=" and "-=" feature of ":set" |add-option-flags|.
3190
3191 Valid letters are as follows:
3192 *guioptions_a*
3193 'a' Autoselect: If present, then whenever VISUAL mode is started,
3194 or the Visual area extended, Vim tries to become the owner of
3195 the windowing system's global selection. This means that the
3196 Visually highlighted text is available for pasting into other
3197 applications as well as into Vim itself. When the Visual mode
3198 ends, possibly due to an operation on the text, or when an
3199 application wants to paste the selection, the highlighted text
3200 is automatically yanked into the "* selection register.
3201 Thus the selection is still available for pasting into other
3202 applications after the VISUAL mode has ended.
3203 If not present, then Vim won't become the owner of the
3204 windowing system's global selection unless explicitly told to
3205 by a yank or delete operation for the "* register.
3206 The same applies to the modeless selection.
3207
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003208 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 applies to the modeless selection.
3210
3211 'guioptions' autoselect Visual autoselect modeless ~
3212 "" - -
3213 "a" yes yes
3214 "A" - yes
3215 "aA" yes yes
3216
3217 'c' Use console dialogs instead of popup dialogs for simple
3218 choices.
3219
3220 'f' Foreground: Don't use fork() to detach the GUI from the shell
3221 where it was started. Use this for programs that wait for the
3222 editor to finish (e.g., an e-mail program). Alternatively you
3223 can use "gvim -f" or ":gui -f" to start the GUI in the
3224 foreground. |gui-fork|
3225 Note: Set this option in the vimrc file. The forking may have
3226 happened already when the gvimrc file is read.
3227
3228 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3229 corner of the window. It's black&white on non-GTK, because of
3230 limitations of X11. For a color icon, see |X11-icon|.
3231
3232 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003233 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 that this flag must be added in the .vimrc file, before
3235 switching on syntax or filetype recognition (when the .gvimrc
3236 file is sourced the system menu has already been loaded; the
3237 ":syntax on" and ":filetype on" commands load the menu too).
3238 'g' Grey menu items: Make menu items that are not active grey. If
3239 'g' is not included inactive menu items are not shown at all.
3240 Exception: Athena will always use grey menu items.
3241
3242 't' Include tearoff menu items. Currently only works for Win32,
3243 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003244 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3245 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246
3247 'r' Right-hand scrollbar is always present.
3248 'R' Right-hand scrollbar is present when there is a vertically
3249 split window.
3250 'l' Left-hand scrollbar is always present.
3251 'L' Left-hand scrollbar is present when there is a vertically
3252 split window.
3253 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3254 the longest visible line, or on the cursor line if the 'h'
3255 flag is included. |gui-horiz-scroll|
3256 'h' Limit horizontal scrollbar size to the length of the cursor
3257 line. Reduces computations. |gui-horiz-scroll|
3258
3259 And yes, you may even have scrollbars on the left AND the right if
3260 you really want to :-). See |gui-scrollbars| for more information.
3261
3262 'v' Use a vertical button layout for dialogs. When not included,
3263 a horizontal layout is preferred, but when it doesn't fit a
3264 vertical layout is used anyway.
3265 'p' Use Pointer callbacks for X11 GUI. This is required for some
3266 window managers. If the cursor is not blinking or hollow at
3267 the right moment, try adding this flag. This must be done
3268 before starting the GUI. Set it in your gvimrc. Adding or
3269 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003270 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271
3272 *'guipty'* *'noguipty'*
3273'guipty' boolean (default on)
3274 global
3275 {not in Vi}
3276 {only available when compiled with GUI enabled}
3277 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3278 I/O to/from shell commands. See |gui-pty|.
3279
3280 *'helpfile'* *'hf'*
3281'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3282 (others) "$VIMRUNTIME/doc/help.txt")
3283 global
3284 {not in Vi}
3285 Name of the main help file. All distributed help files should be
3286 placed together in one directory. Additionally, all "doc" directories
3287 in 'runtimepath' will be used.
3288 Environment variables are expanded |:set_env|. For example:
3289 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003290 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 spaces and backslashes.
3292 This option cannot be set from a |modeline| or in the |sandbox|, for
3293 security reasons.
3294
3295 *'helpheight'* *'hh'*
3296'helpheight' 'hh' number (default 20)
3297 global
3298 {not in Vi}
3299 {not available when compiled without the +windows
3300 feature}
3301 Minimal initial height of the help window when it is opened with the
3302 ":help" command. The initial height of the help window is half of the
3303 current window, or (when the 'ea' option is on) the same as other
3304 windows. When the height is less than 'helpheight', the height is
3305 set to 'helpheight'. Set to zero to disable.
3306
3307 *'helplang'* *'hlg'*
3308'helplang' 'hlg' string (default: messages language or empty)
3309 global
3310 {only available when compiled with the |+multi_lang|
3311 feature}
3312 {not in Vi}
3313 Comma separated list of languages. Vim will use the first language
3314 for which the desired help can be found. The English help will always
3315 be used as a last resort. You can add "en" to prefer English over
3316 another language, but that will only find tags that exist in that
3317 language and not in the English help.
3318 Example: >
3319 :set helplang=de,it
3320< This will first search German, then Italian and finally English help
3321 files.
3322 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3323 try to find the tag in the current language before using this option.
3324 See |help-translated|.
3325
3326 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3327'hidden' 'hid' boolean (default off)
3328 global
3329 {not in Vi}
3330 When off a buffer is unloaded when it is |abandon|ed. When on a
3331 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3332 displayed in another window, it does not become hidden, of course.
3333 The commands that move through the buffer list sometimes make a buffer
3334 hidden although the 'hidden' option is off: When the buffer is
3335 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003336 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003337 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 This option is set for one command with ":hide {command}" |:hide|.
3339 WARNING: It's easy to forget that you have changes in hidden buffers.
3340 Think twice when using ":q!" or ":qa!".
3341
3342 *'highlight'* *'hl'*
3343'highlight' 'hl' string (default (as a single string):
3344 "8:SpecialKey,@:NonText,d:Directory,
3345 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3346 M:ModeMsg,n:LineNr,r:Question,
3347 s:StatusLine,S:StatusLineNC,c:VertSplit
3348 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3349 f:Folded,F:FoldColumn,A:DiffAdd,
3350 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003351 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003352 R:SpellRare,L:SpellLocal,
3353 +:Pmenu,=:PmenuSel,
3354 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 global
3356 {not in Vi}
3357 This option can be used to set highlighting mode for various
3358 occasions. It is a comma separated list of character pairs. The
3359 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003360 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3362 |hl-NonText| @ '~' and '@' at the end of the window and
3363 characters from 'showbreak'
3364 |hl-Directory| d directories in CTRL-D listing and other special
3365 things in listings
3366 |hl-ErrorMsg| e error messages
3367 h (obsolete, ignored)
3368 |hl-IncSearch| i 'incsearch' highlighting
3369 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3370 |hl-MoreMsg| m |more-prompt|
3371 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3372 |hl-LineNr| n line number for ":number" and ":#" commands
3373 |hl-Question| r |hit-enter| prompt and yes/no questions
3374 |hl-StatusLine| s status line of current window |status-line|
3375 |hl-StatusLineNC| S status lines of not-current windows
3376 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3377 |hl-VertSplit| c column used to separate vertically split windows
3378 |hl-Visual| v Visual mode
3379 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3380 Selection" Only X11 Gui's |gui-x11| and
3381 |xterm-clipboard|.
3382 |hl-WarningMsg| w warning messages
3383 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3384 |hl-Folded| f line used for closed folds
3385 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003386 |hl-DiffAdd| A added line in diff mode
3387 |hl-DiffChange| C changed line in diff mode
3388 |hl-DiffDelete| D deleted line in diff mode
3389 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003391 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003392 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003393 |hl-SpellRare| R rare word |spell|
3394 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003395 |hl-Pmenu| + popup menu normal line
3396 |hl-PmenuSel| = popup menu normal line
3397 |hl-PmenuSbar| x popup menu scrollbar
3398 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399
3400 The display modes are:
3401 r reverse (termcap entry "mr" and "me")
3402 i italic (termcap entry "ZH" and "ZR")
3403 b bold (termcap entry "md" and "me")
3404 s standout (termcap entry "so" and "se")
3405 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003406 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 n no highlighting
3408 - no highlighting
3409 : use a highlight group
3410 The default is used for occasions that are not included.
3411 If you want to change what the display modes do, see |dos-colors|
3412 for an example.
3413 When using the ':' display mode, this must be followed by the name of
3414 a highlight group. A highlight group can be used to define any type
3415 of highlighting, including using color. See |:highlight| on how to
3416 define one. The default uses a different group for each occasion.
3417 See |highlight-default| for the default highlight groups.
3418
3419 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3420'hlsearch' 'hls' boolean (default off)
3421 global
3422 {not in Vi}
3423 {not available when compiled without the
3424 |+extra_search| feature}
3425 When there is a previous search pattern, highlight all its matches.
3426 The type of highlighting used can be set with the 'l' occasion in the
3427 'highlight' option. This uses the "Search" highlight group by
3428 default. Note that only the matching text is highlighted, any offsets
3429 are not applied.
3430 See also: 'incsearch' and |:match|.
3431 When you get bored looking at the highlighted matches, you can turn it
3432 off with |:nohlsearch|. As soon as you use a search command, the
3433 highlighting comes back.
3434 When the search pattern can match an end-of-line, Vim will try to
3435 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003436 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 line below a closed fold. A match in a previous line which is not
3438 drawn may not continue in an newly drawn line.
3439 NOTE: This option is reset when 'compatible' is set.
3440
3441 *'history'* *'hi'*
3442'history' 'hi' number (Vim default: 20, Vi default: 0)
3443 global
3444 {not in Vi}
3445 A history of ":" commands, and a history of previous search patterns
3446 are remembered. This option decides how many entries may be stored in
3447 each of these histories (see |cmdline-editing|).
3448 NOTE: This option is set to the Vi default value when 'compatible' is
3449 set and to the Vim default value when 'compatible' is reset.
3450
3451 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3452'hkmap' 'hk' boolean (default off)
3453 global
3454 {not in Vi}
3455 {only available when compiled with the |+rightleft|
3456 feature}
3457 When on, the keyboard is mapped for the Hebrew character set.
3458 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3459 toggle this option. See |rileft.txt|.
3460 NOTE: This option is reset when 'compatible' is set.
3461
3462 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3463'hkmapp' 'hkp' boolean (default off)
3464 global
3465 {not in Vi}
3466 {only available when compiled with the |+rightleft|
3467 feature}
3468 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3469 This is useful if you have a non-Hebrew keyboard.
3470 See |rileft.txt|.
3471 NOTE: This option is reset when 'compatible' is set.
3472
3473 *'icon'* *'noicon'*
3474'icon' boolean (default off, on when title can be restored)
3475 global
3476 {not in Vi}
3477 {not available when compiled without the |+title|
3478 feature}
3479 When on, the icon text of the window will be set to the value of
3480 'iconstring' (if it is not empty), or to the name of the file
3481 currently being edited. Only the last part of the name is used.
3482 Overridden by the 'iconstring' option.
3483 Only works if the terminal supports setting window icons (currently
3484 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3485 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3486 builtin termcap).
3487 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003488 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 X11.
3490
3491 *'iconstring'*
3492'iconstring' string (default "")
3493 global
3494 {not in Vi}
3495 {not available when compiled without the |+title|
3496 feature}
3497 When this option is not empty, it will be used for the icon text of
3498 the window. This happens only when the 'icon' option is on.
3499 Only works if the terminal supports setting window icon text
3500 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3501 Does not work for MS Windows.
3502 When Vim was compiled with HAVE_X11 defined, the original icon will be
3503 restored if possible |X11|.
3504 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003505 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 'titlestring' for example settings.
3507 {not available when compiled without the |+statusline| feature}
3508
3509 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3510'ignorecase' 'ic' boolean (default off)
3511 global
3512 Ignore case in search patterns. Also used when searching in the tags
3513 file.
3514 Also see 'smartcase'.
3515 Can be overruled by using "\c" or "\C" in the pattern, see
3516 |/ignorecase|.
3517
3518 *'imactivatekey'* *'imak'*
3519'imactivatekey' 'imak' string (default "")
3520 global
3521 {not in Vi}
3522 {only available when compiled with |+xim| and
3523 |+GUI_GTK|}
3524 Specifies the key that your Input Method in X-Windows uses for
3525 activation. When this is specified correctly, vim can fully control
3526 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3527 You can't use this option to change the activation key, the option
3528 tells Vim what the key is.
3529 Format:
3530 [MODIFIER_FLAG-]KEY_STRING
3531
3532 These characters can be used for MODIFIER_FLAG (case is ignored):
3533 S Shift key
3534 L Lock key
3535 C Control key
3536 1 Mod1 key
3537 2 Mod2 key
3538 3 Mod3 key
3539 4 Mod4 key
3540 5 Mod5 key
3541 Combinations are allowed, for example "S-C-space" or "SC-space" are
3542 both shift+ctrl+space.
3543 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3544
3545 Example: >
3546 :set imactivatekey=S-space
3547< "S-space" means shift+space. This is the activation key for kinput2 +
3548 canna (Japanese), and ami (Korean).
3549
3550 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3551'imcmdline' 'imc' boolean (default off)
3552 global
3553 {not in Vi}
3554 {only available when compiled with the |+xim|
3555 |+multi_byte_ime| or |global-ime| feature}
3556 When set the Input Method is always on when starting to edit a command
3557 line, unless entering a search pattern (see 'imsearch' for that).
3558 Setting this option is useful when your input method allows entering
3559 English characters directly, e.g., when it's used to type accented
3560 characters with dead keys.
3561
3562 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3563'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3564 global
3565 {not in Vi}
3566 {only available when compiled with the |+xim|
3567 |+multi_byte_ime| or |global-ime| feature}
3568 When set the Input Method is never used. This is useful to disable
3569 the IM when it doesn't work properly.
3570 Currently this option is on by default for SGI/IRIX machines. This
3571 may change in later releases.
3572
3573 *'iminsert'* *'imi'*
3574'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3575 local to buffer
3576 {not in Vi}
3577 Specifies whether :lmap or an Input Method (IM) is to be used in
3578 Insert mode. Valid values:
3579 0 :lmap is off and IM is off
3580 1 :lmap is ON and IM is off
3581 2 :lmap is off and IM is ON
3582 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3583 or |global-ime|.
3584 To always reset the option to zero when leaving Insert mode with <Esc>
3585 this can be used: >
3586 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3587< This makes :lmap and IM turn off automatically when leaving Insert
3588 mode.
3589 Note that this option changes when using CTRL-^ in Insert mode
3590 |i_CTRL-^|.
3591 The value is set to 1 when setting 'keymap' to a valid keymap name.
3592 It is also used for the argument of commands like "r" and "f".
3593 The value 0 may not work correctly with Athena and Motif with some XIM
3594 methods. Use 'imdisable' to disable XIM then.
3595
3596 *'imsearch'* *'ims'*
3597'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3598 local to buffer
3599 {not in Vi}
3600 Specifies whether :lmap or an Input Method (IM) is to be used when
3601 entering a search pattern. Valid values:
3602 -1 the value of 'iminsert' is used, makes it look like
3603 'iminsert' is also used when typing a search pattern
3604 0 :lmap is off and IM is off
3605 1 :lmap is ON and IM is off
3606 2 :lmap is off and IM is ON
3607 Note that this option changes when using CTRL-^ in Command-line mode
3608 |c_CTRL-^|.
3609 The value is set to 1 when it is not -1 and setting the 'keymap'
3610 option to a valid keymap name.
3611 The value 0 may not work correctly with Athena and Motif with some XIM
3612 methods. Use 'imdisable' to disable XIM then.
3613
3614 *'include'* *'inc'*
3615'include' 'inc' string (default "^\s*#\s*include")
3616 global or local to buffer |global-local|
3617 {not in Vi}
3618 {not available when compiled without the
3619 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003620 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 pattern, just like for the "/" command (See |pattern|). The default
3622 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003623 "]I", "[d", etc.
3624 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003625 comes after the matched pattern. But if "\zs" appears in the pattern
3626 then the text matched from "\zs" to the end, or until "\ze" if it
3627 appears, is used as the file name. Use this to include characters
3628 that are not in 'isfname', such as a space. You can then use
3629 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003630 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631
3632 *'includeexpr'* *'inex'*
3633'includeexpr' 'inex' string (default "")
3634 local to buffer
3635 {not in Vi}
3636 {not available when compiled without the
3637 |+find_in_path| or |+eval| feature}
3638 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003639 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 :set includeexpr=substitute(v:fname,'\\.','/','g')
3641< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003642
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003644 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 Also used for |<cfile>|.
3646
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003647 The expression may be evaluated in the |sandbox|, see
3648 |sandbox-option|.
3649
3650 It is not allowed to change text or jump to another window while
3651 evaluating 'includeexpr' |textlock|.
3652
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3654'incsearch' 'is' boolean (default off)
3655 global
3656 {not in Vi}
3657 {not available when compiled without the
3658 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003659 While typing a search command, show where the pattern, as it was typed
3660 so far, matches. The matched string is highlighted. If the pattern
3661 is invalid or not found, nothing is shown. The screen will be updated
3662 often, this is only useful on fast terminals.
3663 Note that the match will be shown, but the cursor will return to its
3664 original position when no match is found and when pressing <Esc>. You
3665 still need to finish the search command with <Enter> to move the
3666 cursor to the match.
3667 The highlighting can be set with the 'i' flag in 'highlight'.
3668 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 NOTE: This option is reset when 'compatible' is set.
3670
3671 *'indentexpr'* *'inde'*
3672'indentexpr' 'inde' string (default "")
3673 local to buffer
3674 {not in Vi}
3675 {not available when compiled without the |+cindent|
3676 or |+eval| features}
3677 Expression which is evaluated to obtain the proper indent for a line.
3678 It is used when a new line is created, for the |=| operator and
3679 in Insert mode as specified with the 'indentkeys' option.
3680 When this option is not empty, it overrules the 'cindent' and
3681 'smartindent' indenting.
3682 When 'paste' is set this option is not used for indenting.
3683 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003684 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 when the expression is evaluated (but it may be moved around).
3686 The expression must return the number of spaces worth of indent. It
3687 can return "-1" to keep the current indent (this means 'autoindent' is
3688 used for the indent).
3689 Functions useful for computing the indent are |indent()|, |cindent()|
3690 and |lispindent()|.
3691 The evaluation of the expression must not have side effects! It must
3692 not change the text, jump to another window, etc. Afterwards the
3693 cursor position is always restored, thus the cursor may be moved.
3694 Normally this option would be set to call a function: >
3695 :set indentexpr=GetMyIndent()
3696< Error messages will be suppressed, unless the 'debug' option contains
3697 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003698 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 NOTE: This option is made empty when 'compatible' is set.
3700
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003701 The expression may be evaluated in the |sandbox|, see
3702 |sandbox-option|.
3703
3704 It is not allowed to change text or jump to another window while
3705 evaluating 'indentexpr' |textlock|.
3706
3707
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 *'indentkeys'* *'indk'*
3709'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3710 local to buffer
3711 {not in Vi}
3712 {not available when compiled without the |+cindent|
3713 feature}
3714 A list of keys that, when typed in Insert mode, cause reindenting of
3715 the current line. Only happens if 'indentexpr' isn't empty.
3716 The format is identical to 'cinkeys', see |indentkeys-format|.
3717 See |C-indenting| and |indent-expression|.
3718
3719 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3720'infercase' 'inf' boolean (default off)
3721 local to buffer
3722 {not in Vi}
3723 When doing keyword completion in insert mode |ins-completion|, and
3724 'ignorecase' is also on, the case of the match is adjusted. If the
3725 typed text contains a lowercase letter where the match has an upper
3726 case letter, the completed part is made lowercase. If the typed text
3727 has no lowercase letters and the match has a lowercase letter where
3728 the typed text has an uppercase letter, and there is a letter before
3729 it, the completed part is made uppercase.
3730
3731 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3732'insertmode' 'im' boolean (default off)
3733 global
3734 {not in Vi}
3735 Makes Vim work in a way that Insert mode is the default mode. Useful
3736 if you want to use Vim as a modeless editor. Used for |evim|.
3737 These Insert mode commands will be useful:
3738 - Use the cursor keys to move around.
3739 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3740 this is a mapping, it is executed as if 'insertmode' was off.
3741 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003743 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3744 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745
3746 These items change when 'insertmode' is set:
3747 - when starting to edit of a file, Vim goes to Insert mode.
3748 - <Esc> in Insert mode is a no-op and beeps.
3749 - <Esc> in Normal mode makes Vim go to Insert mode.
3750 - CTRL-L in Insert mode is a command, it is not inserted.
3751 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3752 However, when <Esc> is used inside a mapping, it behaves like
3753 'insertmode' was not set. This was done to be able to use the same
3754 mappings with 'insertmode' set or not set.
3755 When executing commands with |:normal| 'insertmode' is not used.
3756
3757 NOTE: This option is reset when 'compatible' is set.
3758
3759 *'isfname'* *'isf'*
3760'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3761 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3762 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3763 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3764 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3765 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3766 global
3767 {not in Vi}
3768 The characters specified by this option are included in file names and
3769 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003770 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 Multi-byte characters 256 and above are always included, only the
3772 characters up to 255 are specified with this option.
3773 For UTF-8 the characters 0xa0 to 0xff are included as well.
3774
3775 Note that on systems using a backslash as path separator, Vim tries to
3776 do its best to make it work as you would expect. That is a bit
3777 tricky, since Vi originally used the backslash to escape special
3778 characters. Vim will not remove a backslash in front of a normal file
3779 name character on these systems, but it will on Unix and alikes. The
3780 '&' and '^' are not included by default, because these are special for
3781 cmd.exe.
3782
3783 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003784 Each part can be a single character number or a range. A range is two
3785 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 decimal number between 0 and 255 or the ASCII character itself (does
3787 not work for digits). Example:
3788 "_,-,128-140,#-43" (include '_' and '-' and the range
3789 128 to 140 and '#' to 43)
3790 If a part starts with '^', the following character number or range
3791 will be excluded from the option. The option is interpreted from left
3792 to right. Put the excluded character after the range where it is
3793 included. To include '^' itself use it as the last character of the
3794 option or the end of a range. Example:
3795 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3796 If the character is '@', all characters where isalpha() returns TRUE
3797 are included. Normally these are the characters a to z and A to Z,
3798 plus accented characters. To include '@' itself use "@-@". Examples:
3799 "@,^a-z" All alphabetic characters, excluding lower
3800 case letters.
3801 "a-z,A-Z,@-@" All letters plus the '@' character.
3802 A comma can be included by using it where a character number is
3803 expected. Example:
3804 "48-57,,,_" Digits, comma and underscore.
3805 A comma can be excluded by prepending a '^'. Example:
3806 " -~,^,,9" All characters from space to '~', excluding
3807 comma, plus <Tab>.
3808 See |option-backslash| about including spaces and backslashes.
3809
3810 *'isident'* *'isi'*
3811'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3812 "@,48-57,_,128-167,224-235"
3813 otherwise: "@,48-57,_,192-255")
3814 global
3815 {not in Vi}
3816 The characters given by this option are included in identifiers.
3817 Identifiers are used in recognizing environment variables and after a
3818 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003819 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 option.
3821 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003822 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3824
3825 *'iskeyword'* *'isk'*
3826'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3827 "@,48-57,_,128-167,224-235"
3828 otherwise: "@,48-57,_,192-255"
3829 Vi default: "@,48-57,_")
3830 local to buffer
3831 {not in Vi}
3832 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003833 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 'isfname' for a description of the format of this option. For C
3835 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3836 For a help file it is set to all non-blank printable characters except
3837 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3838 command).
3839 When the 'lisp' option is on the '-' character is always included.
3840 NOTE: This option is set to the Vi default value when 'compatible' is
3841 set and to the Vim default value when 'compatible' is reset.
3842
3843 *'isprint'* *'isp'*
3844'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3845 "@,~-255"; otherwise: "@,161-255")
3846 global
3847 {not in Vi}
3848 The characters given by this option are displayed directly on the
3849 screen. It is also used for "\p" in a |pattern|. The characters from
3850 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3851 even when they are not included in 'isprint' or excluded. See
3852 'isfname' for a description of the format of this option.
3853
3854 Non-printable characters are displayed with two characters:
3855 0 - 31 "^@" - "^_"
3856 32 - 126 always single characters
3857 127 "^?"
3858 128 - 159 "~@" - "~_"
3859 160 - 254 "| " - "|~"
3860 255 "~?"
3861 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3862 displayed as <xx>, with the hexadecimal value of the byte.
3863 When 'display' contains "uhex" all unprintable characters are
3864 displayed as <xx>.
3865 The NonText highlighting will be used for unprintable characters.
3866 |hl-NonText|
3867
3868 Multi-byte characters 256 and above are always included, only the
3869 characters up to 255 are specified with this option. When a character
3870 is printable but it is not available in the current font, a
3871 replacement character will be shown.
3872 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3873 There is no option to specify these characters.
3874
3875 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3876'joinspaces' 'js' boolean (default on)
3877 global
3878 {not in Vi}
3879 Insert two spaces after a '.', '?' and '!' with a join command.
3880 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3881 Otherwise only one space is inserted.
3882 NOTE: This option is set when 'compatible' is set.
3883
3884 *'key'*
3885'key' string (default "")
3886 local to buffer
3887 {not in Vi}
3888 The key that is used for encrypting and decrypting the current buffer.
3889 See |encryption|.
3890 Careful: Do not set the key value by hand, someone might see the typed
3891 key. Use the |:X| command. But you can make 'key' empty: >
3892 :set key=
3893< It is not possible to get the value of this option with ":set key" or
3894 "echo &key". This is to avoid showing it to someone who shouldn't
3895 know. It also means you cannot see it yourself once you have set it,
3896 be careful not to make a typing error!
3897
3898 *'keymap'* *'kmp'* *E544*
3899'keymap' 'kmp' string (default "")
3900 local to buffer
3901 {not in Vi}
3902 {only available when compiled with the |+keymap|
3903 feature}
3904 Name of a keyboard mapping. See |mbyte-keymap|.
3905 Setting this option to a valid keymap name has the side effect of
3906 setting 'iminsert' to one, so that the keymap becomes effective.
3907 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003908 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909
3910 *'keymodel'* *'km'*
3911'keymodel' 'km' string (default "")
3912 global
3913 {not in Vi}
3914 List of comma separated words, which enable special things that keys
3915 can do. These values can be used:
3916 startsel Using a shifted special key starts selection (either
3917 Select mode or Visual mode, depending on "key" being
3918 present in 'selectmode').
3919 stopsel Using a not-shifted special key stops selection.
3920 Special keys in this context are the cursor keys, <End>, <Home>,
3921 <PageUp> and <PageDown>.
3922 The 'keymodel' option is set by the |:behave| command.
3923
3924 *'keywordprg'* *'kp'*
3925'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3926 OS/2: "view /", VMS: "help")
3927 global or local to buffer |global-local|
3928 {not in Vi}
3929 Program to use for the |K| command. Environment variables are
3930 expanded |:set_env|. ":help" may be used to access the Vim internal
3931 help. (Note that previously setting the global option to the empty
3932 value did this, which is now deprecated.)
3933 When "man" is used, Vim will automatically translate a count for the
3934 "K" command to a section number. Also for "man -s", in which case the
3935 "-s" is removed when there is no count.
3936 See |option-backslash| about including spaces and backslashes.
3937 Example: >
3938 :set keywordprg=man\ -s
3939< This option cannot be set from a |modeline| or in the |sandbox|, for
3940 security reasons.
3941
3942 *'langmap'* *'lmap'* *E357* *E358*
3943'langmap' 'lmap' string (default "")
3944 global
3945 {not in Vi}
3946 {only available when compiled with the |+langmap|
3947 feature}
3948 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003949 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 inserted directly. When in command mode the 'langmap' option takes
3951 care of translating these special characters to the original meaning
3952 of the key. This means you don't have to change the keyboard mode to
3953 be able to execute Normal mode commands.
3954 This is the opposite of the 'keymap' option, where characters are
3955 mapped in Insert mode.
3956 This only works for 8-bit characters. The value of 'langmap' may be
3957 specified with multi-byte characters (e.g., UTF-8), but only the lower
3958 8 bits of each character will be used.
3959
3960 Example (for Greek): *greek* >
3961 :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
3962< Example (exchanges meaning of z and y for commands): >
3963 :set langmap=zy,yz,ZY,YZ
3964<
3965 The 'langmap' option is a list of parts, separated with commas. Each
3966 part can be in one of two forms:
3967 1. A list of pairs. Each pair is a "from" character immediately
3968 followed by the "to" character. Examples: "aA", "aAbBcC".
3969 2. A list of "from" characters, a semi-colon and a list of "to"
3970 characters. Example: "abc;ABC"
3971 Example: "aA,fgh;FGH,cCdDeE"
3972 Special characters need to be preceded with a backslash. These are
3973 ";", ',' and backslash itself.
3974
3975 This will allow you to activate vim actions without having to switch
3976 back and forth between the languages. Your language characters will
3977 be understood as normal vim English characters (according to the
3978 langmap mappings) in the following cases:
3979 o Normal/Visual mode (commands, buffer/register names, user mappings)
3980 o Insert/Replace Mode: Register names after CTRL-R
3981 o Insert/Replace Mode: Mappings
3982 Characters entered in Command-line mode will NOT be affected by
3983 this option. Note that this option can be changed at any time
3984 allowing to switch between mappings for different languages/encodings.
3985 Use a mapping to avoid having to type it each time!
3986
3987 *'langmenu'* *'lm'*
3988'langmenu' 'lm' string (default "")
3989 global
3990 {not in Vi}
3991 {only available when compiled with the |+menu| and
3992 |+multi_lang| features}
3993 Language to use for menu translation. Tells which file is loaded
3994 from the "lang" directory in 'runtimepath': >
3995 "lang/menu_" . &langmenu . ".vim"
3996< (without the spaces). For example, to always use the Dutch menus, no
3997 matter what $LANG is set to: >
3998 :set langmenu=nl_NL.ISO_8859-1
3999< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004000 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 If your $LANG is set to a non-English language but you do want to use
4002 the English menus: >
4003 :set langmenu=none
4004< This option must be set before loading menus, switching on filetype
4005 detection or syntax highlighting. Once the menus are defined setting
4006 this option has no effect. But you could do this: >
4007 :source $VIMRUNTIME/delmenu.vim
4008 :set langmenu=de_DE.ISO_8859-1
4009 :source $VIMRUNTIME/menu.vim
4010< Warning: This deletes all menus that you defined yourself!
4011
4012 *'laststatus'* *'ls'*
4013'laststatus' 'ls' number (default 1)
4014 global
4015 {not in Vi}
4016 The value of this option influences when the last window will have a
4017 status line:
4018 0: never
4019 1: only if there are at least two windows
4020 2: always
4021 The screen looks nicer with a status line if you have several
4022 windows, but it takes another screen line. |status-line|
4023
4024 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4025'lazyredraw' 'lz' boolean (default off)
4026 global
4027 {not in Vi}
4028 When this option is set, the screen will not be redrawn while
4029 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004030 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 update use |:redraw|.
4032
4033 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4034'linebreak' 'lbr' boolean (default off)
4035 local to window
4036 {not in Vi}
4037 {not available when compiled without the |+linebreak|
4038 feature}
4039 If on Vim will wrap long lines at a character in 'breakat' rather
4040 than at the last character that fits on the screen. Unlike
4041 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4042 it only affects the way the file is displayed, not its contents. The
4043 value of 'showbreak' is used to put in front of wrapped lines.
4044 This option is not used when the 'wrap' option is off or 'list' is on.
4045 Note that <Tab> characters after an <EOL> are mostly not displayed
4046 with the right amount of white space.
4047
4048 *'lines'* *E593*
4049'lines' number (default 24 or terminal height)
4050 global
4051 Number of lines of the Vim window.
4052 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004053 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 When Vim is running in the GUI or in a resizable window, setting this
4055 option will cause the window size to be changed. When you only want
4056 to use the size for the GUI, put the command in your |gvimrc| file.
4057 Vim limits the number of lines to what fits on the screen. You can
4058 use this command to get the tallest window possible: >
4059 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004060< Minimum value is 2, maximum value is 1000.
4061 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 When you set this option and Vim is unable to change the physical
4063 number of lines of the display, the display may be messed up.
4064
4065 *'linespace'* *'lsp'*
4066'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4067 global
4068 {not in Vi}
4069 {only in the GUI}
4070 Number of pixel lines inserted between characters. Useful if the font
4071 uses the full character cell height, making lines touch each other.
4072 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004073 With some fonts there can be too much room between lines (to have
4074 space for ascents and descents). Then it makes sense to set
4075 'linespace' to a negative value. This may cause display problems
4076 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077
4078 *'lisp'* *'nolisp'*
4079'lisp' boolean (default off)
4080 local to buffer
4081 {not available when compiled without the |+lispindent|
4082 feature}
4083 Lisp mode: When <Enter> is typed in insert mode set the indent for
4084 the next line to Lisp standards (well, sort of). Also happens with
4085 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4086 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4087 better. Also see 'lispwords'.
4088 The '-' character is included in keyword characters. Redefines the
4089 "=" operator to use this same indentation algorithm rather than
4090 calling an external program if 'equalprg' is empty.
4091 This option is not used when 'paste' is set.
4092 {Vi: Does it a little bit differently}
4093
4094 *'lispwords'* *'lw'*
4095'lispwords' 'lw' string (default is very long)
4096 global
4097 {not in Vi}
4098 {not available when compiled without the |+lispindent|
4099 feature}
4100 Comma separated list of words that influence the Lisp indenting.
4101 |'lisp'|
4102
4103 *'list'* *'nolist'*
4104'list' boolean (default off)
4105 local to window
4106 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4107 see the difference between tabs and spaces and for trailing blanks.
4108 Note that this will also affect formatting (set with 'textwidth' or
4109 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4110 changing the way tabs are displayed.
4111
4112 *'listchars'* *'lcs'*
4113'listchars' 'lcs' string (default "eol:$")
4114 global
4115 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004116 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 settings.
4118 eol:c Character to show at the end of each line. When
4119 omitted, there is no extra character at the end of the
4120 line.
4121 tab:xy Two characters to be used to show a Tab. The first
4122 char is used once. The second char is repeated to
4123 fill the space that the Tab normally occupies.
4124 "tab:>-" will show a Tab that takes four spaces as
4125 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004126 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 trailing spaces are blank.
4128 extends:c Character to show in the last column, when 'wrap' is
4129 off and the line continues beyond the right of the
4130 screen.
4131 precedes:c Character to show in the first column, when 'wrap'
4132 is off and there is text preceding the character
4133 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004134 nbsp:c Character to show for a non-breakable space (character
4135 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004137 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 be used when 'encoding' is "utf-8", otherwise only printable
4139 characters are allowed.
4140
4141 Examples: >
4142 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004143 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 :set lcs=extends:>,precedes:<
4145< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004146 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147
4148 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4149'loadplugins' 'lpl' boolean (default on)
4150 global
4151 {not in Vi}
4152 When on the plugin scripts are loaded when starting up |load-plugins|.
4153 This option can be reset in your |vimrc| file to disable the loading
4154 of plugins.
4155 Note that using the "-u NONE" and "--noplugin" command line arguments
4156 reset this option. |-u| |--noplugin|
4157
4158 *'magic'* *'nomagic'*
4159'magic' boolean (default on)
4160 global
4161 Changes the special characters that can be used in search patterns.
4162 See |pattern|.
4163 NOTE: To avoid portability problems with using patterns, always keep
4164 this option at the default "on". Only switch it off when working with
4165 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004166 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167
4168 *'makeef'* *'mef'*
4169'makeef' 'mef' string (default: "")
4170 global
4171 {not in Vi}
4172 {not available when compiled without the |+quickfix|
4173 feature}
4174 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4175 and the |:grep| command.
4176 When it is empty, an internally generated temp file will be used.
4177 When "##" is included, it is replaced by a number to make the name
4178 unique. This makes sure that the ":make" command doesn't overwrite an
4179 existing file.
4180 NOT used for the ":cf" command. See 'errorfile' for that.
4181 Environment variables are expanded |:set_env|.
4182 See |option-backslash| about including spaces and backslashes.
4183 This option cannot be set from a |modeline| or in the |sandbox|, for
4184 security reasons.
4185
4186 *'makeprg'* *'mp'*
4187'makeprg' 'mp' string (default "make", VMS: "MMS")
4188 global or local to buffer |global-local|
4189 {not in Vi}
4190 Program to use for the ":make" command. See |:make_makeprg|. This
4191 option may contain '%' and '#' characters, which are expanded like
4192 when used in a command-line. Environment variables are expanded
4193 |:set_env|. See |option-backslash| about including spaces and
4194 backslashes. Note that a '|' must be escaped twice: once for ":set"
4195 and once for the interpretation of a command. When you use a filter
4196 called "myfilter" do it like this: >
4197 :set makeprg=gmake\ \\\|\ myfilter
4198< The placeholder "$*" can be given (even multiple times) to specify
4199 where the arguments will be included, for example: >
4200 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4201< This option cannot be set from a |modeline| or in the |sandbox|, for
4202 security reasons.
4203
4204 *'matchpairs'* *'mps'*
4205'matchpairs' 'mps' string (default "(:),{:},[:]")
4206 local to buffer
4207 {not in Vi}
4208 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004209 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 must be different. The characters must be separated by a colon. The
4211 pairs must be separated by a comma. Example for including '<' and '>'
4212 (HTML): >
4213 :set mps+=<:>
4214
4215< A more exotic example, to jump between the '=' and ';' in an
4216 assignment, useful for languages like C and Java: >
4217 :au FileType c,cpp,java set mps+==:;
4218
4219< For a more advanced way of using "%", see the matchit.vim plugin in
4220 the $VIMRUNTIME/macros directory. |add-local-help|
4221
4222 *'matchtime'* *'mat'*
4223'matchtime' 'mat' number (default 5)
4224 global
4225 {not in Vi}{in Nvi}
4226 Tenths of a second to show the matching paren, when 'showmatch' is
4227 set. Note that this is not in milliseconds, like other options that
4228 set a time. This is to be compatible with Nvi.
4229
4230 *'maxfuncdepth'* *'mfd'*
4231'maxfuncdepth' 'mfd' number (default 100)
4232 global
4233 {not in Vi}
4234 Maximum depth of function calls for user functions. This normally
4235 catches endless recursion. When using a recursive function with
4236 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4237 more memory, there is the danger of failing when memory is exhausted.
4238 See also |:function|.
4239
4240 *'maxmapdepth'* *'mmd'* *E223*
4241'maxmapdepth' 'mmd' number (default 1000)
4242 global
4243 {not in Vi}
4244 Maximum number of times a mapping is done without resulting in a
4245 character to be used. This normally catches endless mappings, like
4246 ":map x y" with ":map y x". It still does not catch ":map g wg",
4247 because the 'w' is used before the next mapping is done. See also
4248 |key-mapping|.
4249
4250 *'maxmem'* *'mm'*
4251'maxmem' 'mm' number (default between 256 to 5120 (system
4252 dependent) or half the amount of memory
4253 available)
4254 global
4255 {not in Vi}
4256 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4257 limit is reached allocating extra memory for a buffer will cause
4258 other memory to be freed. Maximum value 2000000. Use this to work
4259 without a limit. Also see 'maxmemtot'.
4260
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004261 *'maxmempattern'* *'mmp'*
4262'maxmempattern' 'mmp' number (default 1000)
4263 global
4264 {not in Vi}
4265 Maximum amount of memory (in Kbyte) to use for pattern matching.
4266 Maximum value 2000000. Use this to work without a limit.
4267 *E363*
4268 When Vim runs into the limit it gives an error message mostly behaves
4269 like CTRL-C was typed.
4270 Running into the limit often means that the pattern is very
4271 inefficient or too complex. This may already happen with the pattern
4272 "\(.\)*" on a very long line. ".*" works much better.
4273 Vim may run out of memory before hitting the 'maxmempattern' limit.
4274
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 *'maxmemtot'* *'mmt'*
4276'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4277 dependent) or half the amount of memory
4278 available)
4279 global
4280 {not in Vi}
4281 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004282 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 'maxmem'.
4284
4285 *'menuitems'* *'mis'*
4286'menuitems' 'mis' number (default 25)
4287 global
4288 {not in Vi}
4289 {not available when compiled without the |+menu|
4290 feature}
4291 Maximum number of items to use in a menu. Used for menus that are
4292 generated from a list of items, e.g., the Buffers menu. Changing this
4293 option has no direct effect, the menu must be refreshed first.
4294
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004295 *'mkspellmem'* *'msm'*
4296'mkspellmem' 'msm' string (default "460000,2000,500")
4297 global
4298 {not in Vi}
4299 {not available when compiled without the |+syntax|
4300 feature}
4301 Parameters for |:mkspell|. This tunes when to start compressing the
4302 word tree. Compression can be slow when there are many words, but
4303 it's needed to avoid running out of memory. The amount of memory used
4304 per word depends very much on how similar the words are, that's why
4305 this tuning is complicated.
4306
4307 There are three numbers, separated by commas:
4308 {start},{inc},{added}
4309
4310 For most languages the uncompressed word tree fits in memory. {start}
4311 gives the amount of memory in Kbyte that can be used before any
4312 compression is done. It should be a bit smaller than the amount of
4313 memory that is available to Vim.
4314
4315 When going over the {start} limit the {inc} number specifies the
4316 amount of memory in Kbyte that can be allocated before another
4317 compression is done. A low number means compression is done after
4318 less words are added, which is slow. A high number means more memory
4319 will be allocated.
4320
4321 After doing compression, {added} times 1024 words can be added before
4322 the {inc} limit is ignored and compression is done when any extra
4323 amount of memory is needed. A low number means there is a smaller
4324 chance of hitting the {inc} limit, less memory is used but it's
4325 slower.
4326
4327 The languages for which these numbers are important are Italian and
4328 Hungarian. The default works for when you have about 512 Mbyte. If
4329 you have 1 Gbyte you could use: >
4330 :set mkspellmem=900000,3000,800
4331< If you have less than 512 Mbyte |:mkspell| may fail for some
4332 languages, no matter what you set 'mkspellmem' to.
4333
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4335'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4336 local to buffer
4337 *'modelines'* *'mls'*
4338'modelines' 'mls' number (default 5)
4339 global
4340 {not in Vi}
4341 If 'modeline' is on 'modelines' gives the number of lines that is
4342 checked for set commands. If 'modeline' is off or 'modelines' is zero
4343 no lines are checked. See |modeline|.
4344 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4345 set and to the Vim default value when 'compatible' is reset.
4346
4347 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4348'modifiable' 'ma' boolean (default on)
4349 local to buffer
4350 {not in Vi} *E21*
4351 When off the buffer contents cannot be changed. The 'fileformat' and
4352 'fileencoding' options also can't be changed.
4353 Can be reset with the |-M| command line argument.
4354
4355 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4356'modified' 'mod' boolean (default off)
4357 local to buffer
4358 {not in Vi}
4359 When on, the buffer is considered to be modified. This option is set
4360 when:
4361 1. A change was made to the text since it was last written. Using the
4362 |undo| command to go back to the original text will reset the
4363 option. But undoing changes that were made before writing the
4364 buffer will set the option again, since the text is different from
4365 when it was written.
4366 2. 'fileformat' or 'fileencoding' is different from its original
4367 value. The original value is set when the buffer is read or
4368 written. A ":set nomodified" command also resets the original
4369 values to the current values and the 'modified' option will be
4370 reset.
4371 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4372 will be ignored.
4373
4374 *'more'* *'nomore'*
4375'more' boolean (Vim default: on, Vi default: off)
4376 global
4377 {not in Vi}
4378 When on, listings pause when the whole screen is filled. You will get
4379 the |more-prompt|. When this option is off there are no pauses, the
4380 listing continues until finished.
4381 NOTE: This option is set to the Vi default value when 'compatible' is
4382 set and to the Vim default value when 'compatible' is reset.
4383
4384 *'mouse'* *E538*
4385'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4386 global
4387 {not in Vi}
4388 Enable the use of the mouse. Only works for certain terminals
4389 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4390 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4391 The mouse can be enabled for different modes:
4392 n Normal mode
4393 v Visual mode
4394 i Insert mode
4395 c Command-line mode
4396 h all previous modes when editing a help file
4397 a all previous modes
4398 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 Normally you would enable the mouse in all four modes with: >
4400 :set mouse=a
4401< When the mouse is not enabled, the GUI will still use the mouse for
4402 modeless selection. This doesn't move the text cursor.
4403
4404 See |mouse-using|. Also see |'clipboard'|.
4405
4406 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004407 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 the mouse buttons can still be used by keeping the shift key pressed.
4409 Also see the 'clipboard' option.
4410
4411 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4412'mousefocus' 'mousef' boolean (default off)
4413 global
4414 {not in Vi}
4415 {only works in the GUI}
4416 The window that the mouse pointer is on is automatically activated.
4417 When changing the window layout or window focus in another way, the
4418 mouse pointer is moved to the window with keyboard focus. Off is the
4419 default because it makes using the pull down menus a little goofy, as
4420 a pointer transit may activate a window unintentionally.
4421
4422 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4423'mousehide' 'mh' boolean (default on)
4424 global
4425 {not in Vi}
4426 {only works in the GUI}
4427 When on, the mouse pointer is hidden when characters are typed.
4428 The mouse pointer is restored when the mouse is moved.
4429
4430 *'mousemodel'* *'mousem'*
4431'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4432 global
4433 {not in Vi}
4434 Sets the model to use for the mouse. The name mostly specifies what
4435 the right mouse button is used for:
4436 extend Right mouse button extends a selection. This works
4437 like in an xterm.
4438 popup Right mouse button pops up a menu. The shifted left
4439 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004440 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 popup_setpos Like "popup", but the cursor will be moved to the
4442 position where the mouse was clicked, and thus the
4443 selected operation will act upon the clicked object.
4444 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004445 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 course, that right clicking outside a selection will
4447 end Visual mode.
4448 Overview of what button does what for each model:
4449 mouse extend popup(_setpos) ~
4450 left click place cursor place cursor
4451 left drag start selection start selection
4452 shift-left search word extend selection
4453 right click extend selection popup menu (place cursor)
4454 right drag extend selection -
4455 middle click paste paste
4456
4457 In the "popup" model the right mouse button produces a pop-up menu.
4458 You need to define this first, see |popup-menu|.
4459
4460 Note that you can further refine the meaning of buttons with mappings.
4461 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4462 selection (because that's handled in the GUI code directly).
4463
4464 The 'mousemodel' option is set by the |:behave| command.
4465
4466 *'mouseshape'* *'mouses'* *E547*
4467'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004468 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 global
4470 {not in Vi}
4471 {only available when compiled with the |+mouseshape|
4472 feature}
4473 This option tells Vim what the mouse pointer should look like in
4474 different modes. The option is a comma separated list of parts, much
4475 like used for 'guicursor'. Each part consist of a mode/location-list
4476 and an argument-list:
4477 mode-list:shape,mode-list:shape,..
4478 The mode-list is a dash separated list of these modes/locations:
4479 In a normal window: ~
4480 n Normal mode
4481 v Visual mode
4482 ve Visual mode with 'selection' "exclusive" (same as 'v',
4483 if not specified)
4484 o Operator-pending mode
4485 i Insert mode
4486 r Replace mode
4487
4488 Others: ~
4489 c appending to the command-line
4490 ci inserting in the command-line
4491 cr replacing in the command-line
4492 m at the 'Hit ENTER' or 'More' prompts
4493 ml idem, but cursor in the last line
4494 e any mode, pointer below last window
4495 s any mode, pointer on a status line
4496 sd any mode, while dragging a status line
4497 vs any mode, pointer on a vertical separator line
4498 vd any mode, while dragging a vertical separator line
4499 a everywhere
4500
4501 The shape is one of the following:
4502 avail name looks like ~
4503 w x arrow Normal mouse pointer
4504 w x blank no pointer at all (use with care!)
4505 w x beam I-beam
4506 w x updown up-down sizing arrows
4507 w x leftright left-right sizing arrows
4508 w x busy The system's usual busy pointer
4509 w x no The system's usual 'no input' pointer
4510 x udsizing indicates up-down resizing
4511 x lrsizing indicates left-right resizing
4512 x crosshair like a big thin +
4513 x hand1 black hand
4514 x hand2 white hand
4515 x pencil what you write with
4516 x question big ?
4517 x rightup-arrow arrow pointing right-up
4518 w x up-arrow arrow pointing up
4519 x <number> any X11 pointer number (see X11/cursorfont.h)
4520
4521 The "avail" column contains a 'w' if the shape is available for Win32,
4522 x for X11.
4523 Any modes not specified or shapes not available use the normal mouse
4524 pointer.
4525
4526 Example: >
4527 :set mouseshape=s:udsizing,m:no
4528< will make the mouse turn to a sizing arrow over the status lines and
4529 indicate no input when the hit-enter prompt is displayed (since
4530 clicking the mouse has no effect in this state.)
4531
4532 *'mousetime'* *'mouset'*
4533'mousetime' 'mouset' number (default 500)
4534 global
4535 {not in Vi}
4536 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4537 time in msec between two mouse clicks for the second click to be
4538 recognized as a multi click.
4539
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004540 *'mzquantum'* *'mzq'*
4541'mzquantum' 'mzq' number (default 100)
4542 global
4543 {not in Vi}
4544 {not available when compiled without the |+mzscheme|
4545 feature}
4546 The number of milliseconds between polls for MzScheme threads.
4547 Negative or zero value means no thread scheduling.
4548
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 *'nrformats'* *'nf'*
4550'nrformats' 'nf' string (default "octal,hex")
4551 local to buffer
4552 {not in Vi}
4553 This defines what bases Vim will consider for numbers when using the
4554 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4555 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004556 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 incremented or decremented. This is useful for a list with a
4558 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004559 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004561 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 considered to be hexadecimal. Example: Using CTRL-X on
4563 "0x100" results in "0x0ff".
4564 Numbers which simply begin with a digit in the range 1-9 are always
4565 considered decimal. This also happens for numbers that are not
4566 recognized as octal or hex.
4567
4568 *'number'* *'nu'* *'nonumber'* *'nonu'*
4569'number' 'nu' boolean (default off)
4570 local to window
4571 Print the line number in front of each line. When the 'n' option is
4572 excluded from 'cpoptions' a wrapped line will not use the column of
4573 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004574 The 'numberwidth' option can be used to set the room used for the line
4575 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 When a long, wrapped line doesn't start with the first character, '-'
4577 characters are put before the number.
4578 See |hl-LineNr| for the highlighting used for the number.
4579
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004580 *'numberwidth'* *'nuw'*
4581'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4582 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004583 {not in Vi}
4584 {only available when compiled with the |+linebreak|
4585 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004586 Minimal number of columns to use for the line number. Only relevant
4587 when the 'number' option is set.
4588 Since one space is always between the number and the text, there is
4589 one less character for the number itself.
4590 The value is the minimum width. A bigger width is used when needed to
4591 fit the highest line number in the buffer. Thus with the Vim default
4592 of 4 there is room for a line number up to 999. When the buffer has
4593 1000 lines five columns will be used.
4594 The minimum value is 1, the maximum value is 10.
4595 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4596
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004597 *'omnifunc'* *'ofu'*
4598'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004599 local to buffer
4600 {not in Vi}
4601 {not available when compiled without the +eval
4602 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004603 This option specifies a function to be used for Insert mode omni
4604 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004605 See |complete-functions| for an explanation of how the function is
4606 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004607
4608
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004609 *'operatorfunc'* *'opfunc'*
4610'operatorfunc' 'opfunc' string (default: empty)
4611 global
4612 {not in Vi}
4613 This option specifies a function to be called by the |g@| operator.
4614 See |:map-operator| for more info and an example.
4615
4616 This option cannot be set from a |modeline| or in the |sandbox|, for
4617 security reasons.
4618
4619
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 *'osfiletype'* *'oft'* *E366*
4621'osfiletype' 'oft' string (RISC-OS default: "Text",
4622 others default: "")
4623 local to buffer
4624 {not in Vi}
4625 {only available when compiled with the |+osfiletype|
4626 feature}
4627 Some operating systems store extra information about files besides
4628 name, datestamp and permissions. This option contains the extra
4629 information, the nature of which will vary between systems.
4630 The value of this option is usually set when the file is loaded, and
4631 use to set the file type when file is written.
4632 It can affect the pattern matching of the automatic commands.
4633 |autocmd-osfiletypes|
4634
4635 *'paragraphs'* *'para'*
4636'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4637 global
4638 Specifies the nroff macros that separate paragraphs. These are pairs
4639 of two letters (see |object-motions|).
4640
4641 *'paste'* *'nopaste'*
4642'paste' boolean (default off)
4643 global
4644 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004645 Put Vim in Paste mode. This is useful if you want to cut or copy
4646 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 unexpected effects.
4648 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004649 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 knows about pasting and will mostly do the right thing without 'paste'
4651 being set. The same is true for a terminal where Vim handles the
4652 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004653 This option is reset when starting the GUI. Thus if you set it in
4654 your .vimrc it will work in a terminal, but not in the GUI. Setting
4655 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4656 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 When the 'paste' option is switched on (also when it was already on):
4658 - mapping in Insert mode and Command-line mode is disabled
4659 - abbreviations are disabled
4660 - 'textwidth' is set to 0
4661 - 'wrapmargin' is set to 0
4662 - 'autoindent' is reset
4663 - 'smartindent' is reset
4664 - 'softtabstop' is set to 0
4665 - 'revins' is reset
4666 - 'ruler' is reset
4667 - 'showmatch' is reset
4668 - 'formatoptions' is used like it is empty
4669 These options keep their value, but their effect is disabled:
4670 - 'lisp'
4671 - 'indentexpr'
4672 - 'cindent'
4673 NOTE: When you start editing another file while the 'paste' option is
4674 on, settings from the modelines or autocommands may change the
4675 settings again, causing trouble when pasting text. You might want to
4676 set the 'paste' option again.
4677 When the 'paste' option is reset the mentioned options are restored to
4678 the value before the moment 'paste' was switched from off to on.
4679 Resetting 'paste' before ever setting it does not have any effect.
4680 Since mapping doesn't work while 'paste' is active, you need to use
4681 the 'pastetoggle' option to toggle the 'paste' option with some key.
4682
4683 *'pastetoggle'* *'pt'*
4684'pastetoggle' 'pt' string (default "")
4685 global
4686 {not in Vi}
4687 When non-empty, specifies the key sequence that toggles the 'paste'
4688 option. This is like specifying a mapping: >
4689 :map {keys} :set invpaste<CR>
4690< Where {keys} is the value of 'pastetoggle'.
4691 The difference is that it will work even when 'paste' is set.
4692 'pastetoggle' works in Insert mode and Normal mode, but not in
4693 Command-line mode.
4694 Mappings are checked first, thus overrule 'pastetoggle'. However,
4695 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4696 this: >
4697 :map <F10> :set paste<CR>
4698 :map <F11> :set nopaste<CR>
4699 :imap <F10> <C-O>:set paste<CR>
4700 :imap <F11> <nop>
4701 :set pastetoggle=<F11>
4702< This will make <F10> start paste mode and <F11> stop paste mode.
4703 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4704 mode everything is inserted literally, except the 'pastetoggle' key
4705 sequence.
4706
4707 *'pex'* *'patchexpr'*
4708'patchexpr' 'pex' string (default "")
4709 global
4710 {not in Vi}
4711 {not available when compiled without the |+diff|
4712 feature}
4713 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004714 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715
4716 *'patchmode'* *'pm'* *E206*
4717'patchmode' 'pm' string (default "")
4718 global
4719 {not in Vi}
4720 When non-empty the oldest version of a file is kept. This can be used
4721 to keep the original version of a file if you are changing files in a
4722 source distribution. Only the first time that a file is written a
4723 copy of the original file will be kept. The name of the copy is the
4724 name of the original file with the string in the 'patchmode' option
4725 appended. This option should start with a dot. Use a string like
4726 ".org". 'backupdir' must not be empty for this to work (Detail: The
4727 backup file is renamed to the patchmode file after the new file has
4728 been successfully written, that's why it must be possible to write a
4729 backup file). If there was no file to be backed up, an empty file is
4730 created.
4731 When the 'backupskip' pattern matches, a patchmode file is not made.
4732 Using 'patchmode' for compressed files appends the extension at the
4733 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4734 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004735 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736
4737 *'path'* *'pa'* *E343* *E345* *E347*
4738'path' 'pa' string (default on Unix: ".,/usr/include,,"
4739 on OS/2: ".,/emx/include,,"
4740 other systems: ".,,")
4741 global or local to buffer |global-local|
4742 {not in Vi}
4743 This is a list of directories which will be searched when using the
4744 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4745 being searched for has a relative path (not starting with '/'). The
4746 directories in the 'path' option may be relative or absolute.
4747 - Use commas to separate directory names: >
4748 :set path=.,/usr/local/include,/usr/include
4749< - Spaces can also be used to separate directory names (for backwards
4750 compatibility with version 3.0). To have a space in a directory
4751 name, precede it with an extra backslash, and escape the space: >
4752 :set path=.,/dir/with\\\ space
4753< - To include a comma in a directory name precede it with an extra
4754 backslash: >
4755 :set path=.,/dir/with\\,comma
4756< - To search relative to the directory of the current file, use: >
4757 :set path=.
4758< - To search in the current directory use an empty string between two
4759 commas: >
4760 :set path=,,
4761< - A directory name may end in a ':' or '/'.
4762 - Environment variables are expanded |:set_env|.
4763 - When using |netrw.vim| URLs can be used. For example, adding
4764 "http://www.vim.org" will make ":find index.html" work.
4765 - Search upwards and downwards in a directory tree:
4766 1) "*" matches a sequence of characters, e.g.: >
4767 :set path=/usr/include/*
4768< means all subdirectories in /usr/include (but not /usr/include
4769 itself). >
4770 :set path=/usr/*c
4771< matches /usr/doc and /usr/src.
4772 2) "**" matches a subtree, up to 100 directories deep. Example: >
4773 :set path=/home/user_x/src/**
4774< means search in the whole subtree under "/home/usr_x/src".
4775 3) If the path ends with a ';', this path is the startpoint
4776 for upward search.
4777 See |file-searching| for more info and exact syntax.
4778 {not available when compiled without the |+path_extra| feature}
4779 - Careful with '\' characters, type two to get one in the option: >
4780 :set path=.,c:\\include
4781< Or just use '/' instead: >
4782 :set path=.,c:/include
4783< Don't forget "." or files won't even be found in the same directory as
4784 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004785 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 it is something like 256 or 1024 characters.
4787 You can check if all the include files are found, using the value of
4788 'path', see |:checkpath|.
4789 The use of |:set+=| and |:set-=| is preferred when adding or removing
4790 directories from the list. This avoids problems when a future version
4791 uses another default. To remove the current directory use: >
4792 :set path-=
4793< To add the current directory use: >
4794 :set path+=
4795< To use an environment variable, you probably need to replace the
4796 separator. Here is an example to append $INCL, in which directory
4797 names are separated with a semi-colon: >
4798 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4799< Replace the ';' with a ':' or whatever separator is used. Note that
4800 this doesn't work when $INCL contains a comma or white space.
4801
4802 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4803'preserveindent' 'pi' boolean (default off)
4804 local to buffer
4805 {not in Vi}
4806 When changing the indent of the current line, preserve as much of the
4807 indent structure as possible. Normally the indent is replaced by a
4808 series of tabs followed by spaces as required (unless |'expandtab'| is
4809 enabled, in which case only spaces are used). Enabling this option
4810 means the indent will preserve as many existing characters as possible
4811 for indenting, and only add additional tabs or spaces as required.
4812 NOTE: When using ">>" multiple times the resulting indent is a mix of
4813 tabs and spaces. You might not like this.
4814 NOTE: 'preserveindent' is reset when 'compatible' is set.
4815 Also see 'copyindent'.
4816 Use |:retab| to clean up white space.
4817
4818 *'previewheight'* *'pvh'*
4819'previewheight' 'pvh' number (default 12)
4820 global
4821 {not in Vi}
4822 {not available when compiled without the |+windows| or
4823 |+quickfix| feature}
4824 Default height for a preview window. Used for |:ptag| and associated
4825 commands. Used for |CTRL-W_}| when no count is given.
4826
4827 *'previewwindow'* *'nopreviewwindow'*
4828 *'pvw'* *'nopvw'* *E590*
4829'previewwindow' 'pvw' boolean (default off)
4830 local to window
4831 {not in Vi}
4832 {not available when compiled without the |+windows| or
4833 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004834 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 set. It's normally not set directly, but by using one of the commands
4836 |:ptag|, |:pedit|, etc.
4837
4838 *'printdevice'* *'pdev'*
4839'printdevice' 'pdev' string (default empty)
4840 global
4841 {not in Vi}
4842 {only available when compiled with the |+printer|
4843 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004844 The name of the printer to be used for |:hardcopy|.
4845 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004846 This option cannot be set from a |modeline| or in the |sandbox|, for
4847 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848
Bram Moolenaar8299df92004-07-10 09:47:34 +00004849 *'printencoding'* *'penc'*
4850'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 global
4852 {not in Vi}
4853 {only available when compiled with the |+printer|
4854 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004855 Sets the character encoding used when printing.
4856 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857
4858 *'printexpr'* *'pexpr'*
4859'printexpr' 'pexpr' String (default: see below)
4860 global
4861 {not in Vi}
4862 {only available when compiled with the |+printer|
4863 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004864 Expression used to print the PostScript produced with |:hardcopy|.
4865 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866
Bram Moolenaar8299df92004-07-10 09:47:34 +00004867 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868'printfont' 'pfn' string (default "courier")
4869 global
4870 {not in Vi}
4871 {only available when compiled with the |+printer|
4872 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004873 The name of the font that will be used for |:hardcopy|.
4874 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875
4876 *'printheader'* *'pheader'*
4877'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4878 global
4879 {not in Vi}
4880 {only available when compiled with the |+printer|
4881 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004882 The format of the header produced in |:hardcopy| output.
4883 See |pheader-option|.
4884
4885 *'printmbcharset'* *'pmbcs'*
4886'printmbcharset' 'pmbcs' string (default "")
4887 global
4888 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004889 {only available when compiled with the |+printer|,
4890 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004891 The CJK character set to be used for CJK output from |:hardcopy|.
4892 See |pmbcs-option|.
4893
4894 *'printmbfont'* *'pmbfn'*
4895'printmbfont' 'pmbfn' string (default "")
4896 global
4897 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004898 {only available when compiled with the |+printer|,
4899 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004900 List of font names to be used for CJK output from |:hardcopy|.
4901 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902
4903 *'printoptions'* *'popt'*
4904'printoptions' 'popt' string (default "")
4905 global
4906 {not in Vi}
4907 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004908 List of items that control the format of the output of |:hardcopy|.
4909 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004911 *'prompt'* *'noprompt'*
4912'prompt' boolean (default on)
4913 global
4914 When on a ":" prompt is used in Ex mode.
4915
Bram Moolenaar677ee682005-01-27 14:41:15 +00004916 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004917'quoteescape' 'qe' string (default "\")
4918 local to buffer
4919 {not in Vi}
4920 The characters that are used to escape quotes in a string. Used for
4921 objects like a', a" and a` |a'|.
4922 When one of the characters in this option is found inside a string,
4923 the following character will be skipped. The default value makes the
4924 text "foo\"bar\\" considered to be one string.
4925
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4927'readonly' 'ro' boolean (default off)
4928 local to buffer
4929 If on, writes fail unless you use a '!'. Protects you from
4930 accidentally overwriting a file. Default on when Vim is started
4931 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004932 When using ":w!" the 'readonly' option is reset for the current
4933 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004935 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936
4937 *'remap'* *'noremap'*
4938'remap' boolean (default on)
4939 global
4940 Allows for mappings to work recursively. If you do not want this for
4941 a single entry, use the :noremap[!] command.
4942
4943 *'report'*
4944'report' number (default 2)
4945 global
4946 Threshold for reporting number of lines changed. When the number of
4947 changed lines is more than 'report' a message will be given for most
4948 ":" commands. If you want it always, set 'report' to 0.
4949 For the ":substitute" command the number of substitutions is used
4950 instead of the number of lines.
4951
4952 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4953'restorescreen' 'rs' boolean (default on)
4954 global
4955 {not in Vi} {only in Windows 95/NT console version}
4956 When set, the screen contents is restored when exiting Vim. This also
4957 happens when executing external commands.
4958
4959 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4960 options in your .vimrc. To disable restoring:
4961 set t_ti= t_te=
4962 To enable restoring (for an xterm):
4963 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4964 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4965
4966 *'revins'* *'ri'* *'norevins'* *'nori'*
4967'revins' 'ri' boolean (default off)
4968 global
4969 {not in Vi}
4970 {only available when compiled with the |+rightleft|
4971 feature}
4972 Inserting characters in Insert mode will work backwards. See "typing
4973 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4974 command in Insert mode, when 'allowrevins' is set.
4975 NOTE: This option is reset when 'compatible' or 'paste' is set.
4976
4977 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4978'rightleft' 'rl' boolean (default off)
4979 local to window
4980 {not in Vi}
4981 {only available when compiled with the |+rightleft|
4982 feature}
4983 When on, display orientation becomes right-to-left, i.e., characters
4984 that are stored in the file appear from the right to the left.
4985 Using this option, it is possible to edit files for languages that
4986 are written from the right to the left such as Hebrew and Arabic.
4987 This option is per window, so it is possible to edit mixed files
4988 simultaneously, or to view the same file in both ways (this is
4989 useful whenever you have a mixed text file with both right-to-left
4990 and left-to-right strings so that both sets are displayed properly
4991 in different windows). Also see |rileft.txt|.
4992
4993 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4994'rightleftcmd' 'rlc' string (default "search")
4995 local to window
4996 {not in Vi}
4997 {only available when compiled with the |+rightleft|
4998 feature}
4999 Each word in this option enables the command line editing to work in
5000 right-to-left mode for a group of commands:
5001
5002 search "/" and "?" commands
5003
5004 This is useful for languages such as Hebrew, Arabic and Farsi.
5005 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5006
5007 *'ruler'* *'ru'* *'noruler'* *'noru'*
5008'ruler' 'ru' boolean (default off)
5009 global
5010 {not in Vi}
5011 {not available when compiled without the
5012 |+cmdline_info| feature}
5013 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005014 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 text in the file is shown on the far right:
5016 Top first line is visible
5017 Bot last line is visible
5018 All first and last line are visible
5019 45% relative position in the file
5020 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005021 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005023 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 this option takes precedence over 'ruler' and 'rulerformat'
5025 If the number of characters displayed is different from the number of
5026 bytes in the text (e.g., for a TAB or a multi-byte character), both
5027 the text column (byte number) and the screen column are shown,
5028 separated with a dash.
5029 For an empty line "0-1" is shown.
5030 For an empty buffer the line number will also be zero: "0,0-1".
5031 This option is reset when the 'paste' option is set.
5032 If you don't want to see the ruler all the time but want to know where
5033 you are, use "g CTRL-G" |g_CTRL-G|.
5034 NOTE: This option is reset when 'compatible' is set.
5035
5036 *'rulerformat'* *'ruf'*
5037'rulerformat' 'ruf' string (default empty)
5038 global
5039 {not in Vi}
5040 {not available when compiled without the |+statusline|
5041 feature}
5042 When this option is not empty, it determines the content of the ruler
5043 string, as displayed for the 'ruler' option.
5044 The format of this option, is like that of 'statusline'.
5045 The default ruler width is 17 characters. To make the ruler 15
5046 characters wide, put "%15(" at the start and "%)" at the end.
5047 Example: >
5048 :set rulerformat=%15(%c%V\ %p%%%)
5049<
5050 *'runtimepath'* *'rtp'* *vimfiles*
5051'runtimepath' 'rtp' string (default:
5052 Unix: "$HOME/.vim,
5053 $VIM/vimfiles,
5054 $VIMRUNTIME,
5055 $VIM/vimfiles/after,
5056 $HOME/.vim/after"
5057 Amiga: "home:vimfiles,
5058 $VIM/vimfiles,
5059 $VIMRUNTIME,
5060 $VIM/vimfiles/after,
5061 home:vimfiles/after"
5062 PC, OS/2: "$HOME/vimfiles,
5063 $VIM/vimfiles,
5064 $VIMRUNTIME,
5065 $VIM/vimfiles/after,
5066 $HOME/vimfiles/after"
5067 Macintosh: "$VIM:vimfiles,
5068 $VIMRUNTIME,
5069 $VIM:vimfiles:after"
5070 RISC-OS: "Choices:vimfiles,
5071 $VIMRUNTIME,
5072 Choices:vimfiles/after"
5073 VMS: "sys$login:vimfiles,
5074 $VIM/vimfiles,
5075 $VIMRUNTIME,
5076 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005077 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 global
5079 {not in Vi}
5080 This is a list of directories which will be searched for runtime
5081 files:
5082 filetype.vim filetypes by file name |new-filetype|
5083 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005084 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 colors/ color scheme files |:colorscheme|
5086 compiler/ compiler files |:compiler|
5087 doc/ documentation |write-local-help|
5088 ftplugin/ filetype plugins |write-filetype-plugin|
5089 indent/ indent scripts |indent-expression|
5090 keymap/ key mapping files |mbyte-keymap|
5091 lang/ menu translations |:menutrans|
5092 menu.vim GUI menus |menu.vim|
5093 plugin/ plugin scripts |write-plugin|
5094 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005095 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 syntax/ syntax files |mysyntaxfile|
5097 tutor/ files for vimtutor |tutor|
5098
5099 And any other file searched for with the |:runtime| command.
5100
5101 The defaults for most systems are setup to search five locations:
5102 1. In your home directory, for your personal preferences.
5103 2. In a system-wide Vim directory, for preferences from the system
5104 administrator.
5105 3. In $VIMRUNTIME, for files distributed with Vim.
5106 *after-directory*
5107 4. In the "after" directory in the system-wide Vim directory. This is
5108 for the system administrator to overrule or add to the distributed
5109 defaults (rarely needed)
5110 5. In the "after" directory in your home directory. This is for
5111 personal preferences to overrule or add to the distributed defaults
5112 or system-wide settings (rarely needed).
5113
5114 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5115 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005116 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 wildcards.
5118 See |:runtime|.
5119 Example: >
5120 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5121< This will use the directory "~/vimruntime" first (containing your
5122 personal Vim runtime files), then "/mygroup/vim" (shared between a
5123 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5124 files).
5125 You probably should always include $VIMRUNTIME somewhere, to use the
5126 distributed runtime files. You can put a directory before $VIMRUNTIME
5127 to find files which replace a distributed runtime files. You can put
5128 a directory after $VIMRUNTIME to find files which add to distributed
5129 runtime files.
5130 This option cannot be set from a |modeline| or in the |sandbox|, for
5131 security reasons.
5132
5133 *'scroll'* *'scr'*
5134'scroll' 'scr' number (default: half the window height)
5135 local to window
5136 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5137 set to half the number of lines in the window when the window size
5138 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005139 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5141 the number of screen lines instead of file lines, makes a difference
5142 when lines wrap}
5143
5144 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5145'scrollbind' 'scb' boolean (default off)
5146 local to window
5147 {not in Vi}
5148 {not available when compiled without the |+scrollbind|
5149 feature}
5150 See also |scroll-binding|. When this option is set, the current
5151 window scrolls as other scrollbind windows (windows that also have
5152 this option set) scroll. This option is useful for viewing the
5153 differences between two versions of a file, see 'diff'.
5154 See |'scrollopt'| for options that determine how this option should be
5155 interpreted.
5156 This option is mostly reset when splitting a window to edit another
5157 file. This means that ":split | edit file" results in two windows
5158 with scroll-binding, but ":split file" does not.
5159
5160 *'scrolljump'* *'sj'*
5161'scrolljump' 'sj' number (default 1)
5162 global
5163 {not in Vi}
5164 Minimal number of lines to scroll when the cursor gets off the
5165 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5166 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005167 When set to a negative number from -1 to -100 this is used as the
5168 percentage of the window height. Thus -50 scrolls half the window
5169 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 NOTE: This option is set to 1 when 'compatible' is set.
5171
5172 *'scrolloff'* *'so'*
5173'scrolloff' 'so' number (default 0)
5174 global
5175 {not in Vi}
5176 Minimal number of screen lines to keep above and below the cursor.
5177 This will make some context visible around where you are working. If
5178 you set it to a very large value (999) the cursor line will always be
5179 in the middle of the window (except at the start or end of the file or
5180 when long lines wrap).
5181 For scrolling horizontally see 'sidescrolloff'.
5182 NOTE: This option is set to 0 when 'compatible' is set.
5183
5184 *'scrollopt'* *'sbo'*
5185'scrollopt' 'sbo' string (default "ver,jump")
5186 global
5187 {not available when compiled without the |+scrollbind|
5188 feature}
5189 {not in Vi}
5190 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005191 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5192 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 The following words are available:
5194 ver Bind vertical scrolling for 'scrollbind' windows
5195 hor Bind horizontal scrolling for 'scrollbind' windows
5196 jump Applies to the offset between two windows for vertical
5197 scrolling. This offset is the difference in the first
5198 displayed line of the bound windows. When moving
5199 around in a window, another 'scrollbind' window may
5200 reach a position before the start or after the end of
5201 the buffer. The offset is not changed though, when
5202 moving back the 'scrollbind' window will try to scroll
5203 to the desired position when possible.
5204 When now making that window the current one, two
5205 things can be done with the relative offset:
5206 1. When "jump" is not included, the relative offset is
5207 adjusted for the scroll position in the new current
5208 window. When going back to the other window, the
5209 the new relative offset will be used.
5210 2. When "jump" is included, the other windows are
5211 scrolled to keep the same relative offset. When
5212 going back to the other window, it still uses the
5213 same relative offset.
5214 Also see |scroll-binding|.
5215
5216 *'sections'* *'sect'*
5217'sections' 'sect' string (default "SHNHH HUnhsh")
5218 global
5219 Specifies the nroff macros that separate sections. These are pairs of
5220 two letters (See |object-motions|). The default makes a section start
5221 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5222
5223 *'secure'* *'nosecure'* *E523*
5224'secure' boolean (default off)
5225 global
5226 {not in Vi}
5227 When on, ":autocmd", shell and write commands are not allowed in
5228 ".vimrc" and ".exrc" in the current directory and map commands are
5229 displayed. Switch it off only if you know that you will not run into
5230 problems, or when the 'exrc' option is off. On Unix this option is
5231 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005232 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 'secure' at the end of your ~/.vimrc then.
5234 This option cannot be set from a |modeline| or in the |sandbox|, for
5235 security reasons.
5236
5237 *'selection'* *'sel'*
5238'selection' 'sel' string (default "inclusive")
5239 global
5240 {not in Vi}
5241 This option defines the behavior of the selection. It is only used
5242 in Visual and Select mode.
5243 Possible values:
5244 value past line inclusive ~
5245 old no yes
5246 inclusive yes yes
5247 exclusive yes no
5248 "past line" means that the cursor is allowed to be positioned one
5249 character past the line.
5250 "inclusive" means that the last character of the selection is included
5251 in an operation. For example, when "x" is used to delete the
5252 selection.
5253 Note that when "exclusive" is used and selecting from the end
5254 backwards, you cannot include the last character of a line, when
5255 starting in Normal mode and 'virtualedit' empty.
5256
5257 The 'selection' option is set by the |:behave| command.
5258
5259 *'selectmode'* *'slm'*
5260'selectmode' 'slm' string (default "")
5261 global
5262 {not in Vi}
5263 This is a comma separated list of words, which specifies when to start
5264 Select mode instead of Visual mode, when a selection is started.
5265 Possible values:
5266 mouse when using the mouse
5267 key when using shifted special keys
5268 cmd when using "v", "V" or CTRL-V
5269 See |Select-mode|.
5270 The 'selectmode' option is set by the |:behave| command.
5271
5272 *'sessionoptions'* *'ssop'*
5273'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5274 help,options,winsize")
5275 global
5276 {not in Vi}
5277 {not available when compiled without the +mksession
5278 feature}
5279 Changes the effect of the |:mksession| command. It is a comma
5280 separated list of words. Each word enables saving and restoring
5281 something:
5282 word save and restore ~
5283 blank empty windows
5284 buffers hidden and unloaded buffers, not just those in windows
5285 curdir the current directory
5286 folds manually created folds, opened/closed folds and local
5287 fold options
5288 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005289 and contain at least one lowercase letter. Only
5290 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 help the help window
5292 localoptions options and mappings local to a window or buffer (not
5293 global values for local options)
5294 options all options and mappings (also global values for local
5295 options)
5296 resize size of the Vim window: 'lines' and 'columns'
5297 sesdir the directory in which the session file is located
5298 will become the current directory (useful with
5299 projects accessed over a network from different
5300 systems)
5301 slash backslashes in file names replaced with forward
5302 slashes
5303 unix with Unix end-of-line format (single <NL>), even when
5304 on Windows or DOS
5305 winpos position of the whole Vim window
5306 winsize window sizes
5307
5308 Don't include both "curdir" and "sesdir".
5309 When "curdir" nor "sesdir" is included, file names are stored with
5310 absolute paths.
5311 "slash" and "unix" are useful on Windows when sharing session files
5312 with Unix. The Unix version of Vim cannot source dos format scripts,
5313 but the Windows version of Vim can source unix format scripts.
5314
5315 *'shell'* *'sh'* *E91*
5316'shell' 'sh' string (default $SHELL or "sh",
5317 MS-DOS and Win32: "command.com" or
5318 "cmd.exe", OS/2: "cmd")
5319 global
5320 Name of the shell to use for ! and :! commands. When changing the
5321 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5322 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005323 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 See |option-backslash| about including spaces and backslashes.
5325 Environment variables are expanded |:set_env|.
5326 If the name of the shell contains a space, you might need to enclose
5327 it in quotes. Example: >
5328 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5329< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005330 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 "-f" is not inside the quotes, because it is not part of the command
5332 name. And Vim automagically recognizes the backslashes that are path
5333 separators.
5334 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5335 variable to change the way external commands are executed. See the
5336 libc.inf file of DJGPP.
5337 Under MS-Windows, when the executable ends in ".com" it must be
5338 included. Thus setting the shell to "command.com" or "4dos.com"
5339 works, but "command" and "4dos" do not work for all commands (e.g.,
5340 filtering).
5341 For unknown reasons, when using "4dos.com" the current directory is
5342 changed to "C:\". To avoid this set 'shell' like this: >
5343 :set shell=command.com\ /c\ 4dos
5344< This option cannot be set from a |modeline| or in the |sandbox|, for
5345 security reasons.
5346
5347 *'shellcmdflag'* *'shcf'*
5348'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5349 does not contain "sh" somewhere: "/c")
5350 global
5351 {not in Vi}
5352 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5353 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5354 systems, the default is set according to the value of 'shell', to
5355 reduce the need to set this option by the user. It's not used for
5356 OS/2 (EMX figures this out itself). See |option-backslash| about
5357 including spaces and backslashes. See |dos-shell|.
5358 This option cannot be set from a |modeline| or in the |sandbox|, for
5359 security reasons.
5360
5361 *'shellpipe'* *'sp'*
5362'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5363 global
5364 {not in Vi}
5365 {not available when compiled without the |+quickfix|
5366 feature}
5367 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005368 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 including spaces and backslashes.
5370 The name of the temporary file can be represented by "%s" if necessary
5371 (the file name is appended automatically if no %s appears in the value
5372 of this option).
5373 For the Amiga and MS-DOS the default is ">". The output is directly
5374 saved in a file and not echoed to the screen.
5375 For Unix the default it "| tee". The stdout of the compiler is saved
5376 in a file and echoed to the screen. If the 'shell' option is "csh" or
5377 "tcsh" after initializations, the default becomes "|& tee". If the
5378 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5379 "2>&1| tee". This means that stderr is also included.
5380 The initialization of this option is done after reading the ".vimrc"
5381 and the other initializations, so that when the 'shell' option is set
5382 there, the 'shellpipe' option changes automatically, unless it was
5383 explicitly set before.
5384 When 'shellpipe' is set to an empty string, no redirection of the
5385 ":make" output will be done. This is useful if you use a 'makeprg'
5386 that writes to 'makeef' by itself. If you want no piping, but do
5387 want to include the 'makeef', set 'shellpipe' to a single space.
5388 Don't forget to precede the space with a backslash: ":set sp=\ ".
5389 In the future pipes may be used for filtering and this option will
5390 become obsolete (at least for Unix).
5391 This option cannot be set from a |modeline| or in the |sandbox|, for
5392 security reasons.
5393
5394 *'shellquote'* *'shq'*
5395'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5396 contains "sh" somewhere: "\"")
5397 global
5398 {not in Vi}
5399 Quoting character(s), put around the command passed to the shell, for
5400 the "!" and ":!" commands. The redirection is kept outside of the
5401 quoting. See 'shellxquote' to include the redirection. It's
5402 probably not useful to set both options.
5403 This is an empty string by default. Only known to be useful for
5404 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5405 or bash, where it should be "\"". The default is adjusted according
5406 the value of 'shell', to reduce the need to set this option by the
5407 user. See |dos-shell|.
5408 This option cannot be set from a |modeline| or in the |sandbox|, for
5409 security reasons.
5410
5411 *'shellredir'* *'srr'*
5412'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5413 global
5414 {not in Vi}
5415 String to be used to put the output of a filter command in a temporary
5416 file. See also |:!|. See |option-backslash| about including spaces
5417 and backslashes.
5418 The name of the temporary file can be represented by "%s" if necessary
5419 (the file name is appended automatically if no %s appears in the value
5420 of this option).
5421 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5422 or "zsh" during initializations, the default becomes ">&". If the
5423 'shell' option is "sh", "ksh" or "bash" the default becomes
5424 ">%s 2>&1". This means that stderr is also included.
5425 For Win32, the Unix checks are done and additionally "cmd" is checked
5426 for, which makes the default ">%s 2>&1". Also, the same names with
5427 ".exe" appended are checked for.
5428 The initialization of this option is done after reading the ".vimrc"
5429 and the other initializations, so that when the 'shell' option is set
5430 there, the 'shellredir' option changes automatically unless it was
5431 explicitly set before.
5432 In the future pipes may be used for filtering and this option will
5433 become obsolete (at least for Unix).
5434 This option cannot be set from a |modeline| or in the |sandbox|, for
5435 security reasons.
5436
5437 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5438'shellslash' 'ssl' boolean (default off)
5439 global
5440 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5441 When set, a forward slash is used when expanding file names. This is
5442 useful when a Unix-like shell is used instead of command.com or
5443 cmd.exe. Backward slashes can still be typed, but they are changed to
5444 forward slashes by Vim.
5445 Note that setting or resetting this option has no effect for some
5446 existing file names, thus this option needs to be set before opening
5447 any file for best results. This might change in the future.
5448 'shellslash' only works when a backslash can be used as a path
5449 separator. To test if this is so use: >
5450 if exists('+shellslash')
5451<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005452 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5453'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5454 global
5455 {not in Vi}
5456 When on, use temp files for shell commands. When off use a pipe.
5457 When using a pipe is not possible temp files are used anyway.
5458 Currently a pipe is only supported on Unix. You can check it with: >
5459 :if has("filterpipe")
5460< The advantage of using a pipe is that nobody can read the temp file
5461 and the 'shell' command does not need to support redirection.
5462 The advantage of using a temp file is that the file type and encoding
5463 can be detected.
5464 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5465 |FilterWritePost| autocommands event are not triggered when
5466 'shelltemp' is off.
5467
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 *'shelltype'* *'st'*
5469'shelltype' 'st' number (default 0)
5470 global
5471 {not in Vi} {only for the Amiga}
5472 On the Amiga this option influences the way how the commands work
5473 which use a shell.
5474 0 and 1: always use the shell
5475 2 and 3: use the shell only to filter lines
5476 4 and 5: use shell only for ':sh' command
5477 When not using the shell, the command is executed directly.
5478
5479 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5480 1 and 3: use "shell cmd" to start external commands
5481
5482 *'shellxquote'* *'sxq'*
5483'shellxquote' 'sxq' string (default: "";
5484 for Win32, when 'shell' contains "sh"
5485 somewhere: "\""
5486 for Unix, when using system(): "\"")
5487 global
5488 {not in Vi}
5489 Quoting character(s), put around the command passed to the shell, for
5490 the "!" and ":!" commands. Includes the redirection. See
5491 'shellquote' to exclude the redirection. It's probably not useful
5492 to set both options.
5493 This is an empty string by default. Known to be useful for
5494 third-party shells when using the Win32 version, such as the MKS Korn
5495 Shell or bash, where it should be "\"". The default is adjusted
5496 according the value of 'shell', to reduce the need to set this option
5497 by the user. See |dos-shell|.
5498 This option cannot be set from a |modeline| or in the |sandbox|, for
5499 security reasons.
5500
5501 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5502'shiftround' 'sr' boolean (default off)
5503 global
5504 {not in Vi}
5505 Round indent to multiple of 'shiftwidth'. Applies to > and <
5506 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5507 a multiple of 'shiftwidth' (this is Vi compatible).
5508 NOTE: This option is reset when 'compatible' is set.
5509
5510 *'shiftwidth'* *'sw'*
5511'shiftwidth' 'sw' number (default 8)
5512 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005513 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 |'cindent'|, |>>|, |<<|, etc.
5515
5516 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005517'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5518 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 global
5520 {not in Vi}
5521 This option helps to avoid all the |hit-enter| prompts caused by file
5522 messages, for example with CTRL-G, and to avoid some other messages.
5523 It is a list of flags:
5524 flag meaning when present ~
5525 f use "(3 of 5)" instead of "(file 3 of 5)"
5526 i use "[noeol]" instead of "[Incomplete last line]"
5527 l use "999L, 888C" instead of "999 lines, 888 characters"
5528 m use "[+]" instead of "[Modified]"
5529 n use "[New]" instead of "[New File]"
5530 r use "[RO]" instead of "[readonly]"
5531 w use "[w]" instead of "written" for file write message
5532 and "[a]" instead of "appended" for ':w >> file' command
5533 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5534 "[unix format]" and "[mac]" instead of "[mac format]".
5535 a all of the above abbreviations
5536
5537 o overwrite message for writing a file with subsequent message
5538 for reading a file (useful for ":wn" or when 'autowrite' on)
5539 O message for reading a file overwrites any previous message.
5540 Also for quickfix message (e.g., ":cn").
5541 s don't give "search hit BOTTOM, continuing at TOP" or "search
5542 hit TOP, continuing at BOTTOM" messages
5543 t truncate file message at the start if it is too long to fit
5544 on the command-line, "<" will appear in the left most column.
5545 Ignored in Ex mode.
5546 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005547 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 Ignored in Ex mode.
5549 W don't give "written" or "[w]" when writing a file
5550 A don't give the "ATTENTION" message when an existing swap file
5551 is found.
5552 I don't give the intro message when starting Vim |:intro|.
5553
5554 This gives you the opportunity to avoid that a change between buffers
5555 requires you to hit <Enter>, but still gives as useful a message as
5556 possible for the space available. To get the whole message that you
5557 would have got with 'shm' empty, use ":file!"
5558 Useful values:
5559 shm= No abbreviation of message.
5560 shm=a Abbreviation, but no loss of information.
5561 shm=at Abbreviation, and truncate message when necessary.
5562
5563 NOTE: This option is set to the Vi default value when 'compatible' is
5564 set and to the Vim default value when 'compatible' is reset.
5565
5566 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5567'shortname' 'sn' boolean (default off)
5568 local to buffer
5569 {not in Vi, not in MS-DOS versions}
5570 Filenames are assumed to be 8 characters plus one extension of 3
5571 characters. Multiple dots in file names are not allowed. When this
5572 option is on, dots in file names are replaced with underscores when
5573 adding an extension (".~" or ".swp"). This option is not available
5574 for MS-DOS, because then it would always be on. This option is useful
5575 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5576 or crossdos. When running the Win32 GUI version under Win32s, this
5577 option is always on by default.
5578
5579 *'showbreak'* *'sbr'* *E595*
5580'showbreak' 'sbr' string (default "")
5581 global
5582 {not in Vi}
5583 {not available when compiled without the |+linebreak|
5584 feature}
5585 String to put at the start of lines that have been wrapped. Useful
5586 values are "> " or "+++ ".
5587 Only printable single-cell characters are allowed, excluding <Tab> and
5588 comma (in a future version the comma might be used to separate the
5589 part that is shown at the end and at the start of a line).
5590 The characters are highlighted according to the '@' flag in
5591 'highlight'.
5592 Note that tabs after the showbreak will be displayed differently.
5593 If you want the 'showbreak' to appear in between line numbers, add the
5594 "n" flag to 'cpoptions'.
5595
5596 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5597'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5598 off)
5599 global
5600 {not in Vi}
5601 {not available when compiled without the
5602 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005603 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 terminal is slow.
5605 In Visual mode the size of the selected area is shown:
5606 - When selecting characters within a line, the number of characters.
5607 - When selecting more than one line, the number of lines.
5608 - When selecting a block, the size in screen characters: linesxcolumns.
5609 NOTE: This option is set to the Vi default value when 'compatible' is
5610 set and to the Vim default value when 'compatible' is reset.
5611
5612 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5613'showfulltag' 'sft' boolean (default off)
5614 global
5615 {not in Vi}
5616 When completing a word in insert mode (see |ins-completion|) from the
5617 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005618 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 matched a C function, you can see a template for what arguments are
5620 required (coding style permitting).
5621
5622 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5623'showmatch' 'sm' boolean (default off)
5624 global
5625 When a bracket is inserted, briefly jump to the matching one. The
5626 jump is only done if the match can be seen on the screen. The time to
5627 show the match can be set with 'matchtime'.
5628 A Beep is given if there is no match (no matter if the match can be
5629 seen or not). This option is reset when the 'paste' option is set.
5630 When the 'm' flag is not included in 'cpoptions', typing a character
5631 will immediately move the cursor back to where it belongs.
5632 See the "sm" field in 'guicursor' for setting the cursor shape and
5633 blinking when showing the match.
5634 The 'matchpairs' option can be used to specify the characters to show
5635 matches for. 'rightleft' and 'revins' are used to look for opposite
5636 matches.
5637 Note: For the use of the short form parental guidance is advised.
5638
5639 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5640'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5641 global
5642 If in Insert, Replace or Visual mode put a message on the last line.
5643 Use the 'M' flag in 'highlight' to set the type of highlighting for
5644 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005645 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 doesn't mean XIM is really active, especially when 'imactivatekey' is
5647 not set.
5648 NOTE: This option is set to the Vi default value when 'compatible' is
5649 set and to the Vim default value when 'compatible' is reset.
5650
5651 *'sidescroll'* *'ss'*
5652'sidescroll' 'ss' number (default 0)
5653 global
5654 {not in Vi}
5655 The minimal number of columns to scroll horizontally. Used only when
5656 the 'wrap' option is off and the cursor is moved off of the screen.
5657 When it is zero the cursor will be put in the middle of the screen.
5658 When using a slow terminal set it to a large number or 0. When using
5659 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5660 commands.
5661
5662 *'sidescrolloff'* *'siso'*
5663'sidescrolloff' 'siso' number (default 0)
5664 global
5665 {not in Vi}
5666 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005667 right of the cursor if 'nowrap' is set. Setting this option to a
5668 value greater than 0 while having |'sidescroll'| also at a non-zero
5669 value makes some context visible in the line you are scrolling in
5670 horizontally (except at beginning of the line). Setting this option
5671 to a large value (like 999) has the effect of keeping the cursor
5672 horizontally centered in the window, as long as one does not come too
5673 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 NOTE: This option is set to 0 when 'compatible' is set.
5675
5676 Example: Try this together with 'sidescroll' and 'listchars' as
5677 in the following example to never allow the cursor to move
5678 onto the "extends" character:
5679
5680 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5681 :set sidescrolloff=1
5682
5683
5684 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5685'smartcase' 'scs' boolean (default off)
5686 global
5687 {not in Vi}
5688 Override the 'ignorecase' option if the search pattern contains upper
5689 case characters. Only used when the search pattern is typed and
5690 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005691 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5693 recalling the search pattern from history and hitting <Enter>.
5694 NOTE: This option is reset when 'compatible' is set.
5695
5696 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5697'smartindent' 'si' boolean (default off)
5698 local to buffer
5699 {not in Vi}
5700 {not available when compiled without the
5701 |+smartindent| feature}
5702 Do smart autoindenting when starting a new line. Works for C-like
5703 programs, but can also be used for other languages. 'cindent' does
5704 something like this, works better in most cases, but is more strict,
5705 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5706 'indentexpr' is a more advanced alternative.
5707 Normally 'autoindent' should also be on when using 'smartindent'.
5708 An indent is automatically inserted:
5709 - After a line ending in '{'.
5710 - After a line starting with a keyword from 'cinwords'.
5711 - Before a line starting with '}' (only with the "O" command).
5712 When typing '}' as the first character in a new line, that line is
5713 given the same indent as the matching '{'.
5714 When typing '#' as the first character in a new line, the indent for
5715 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005716 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5718 When using the ">>" command, lines starting with '#' are not shifted
5719 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005720 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 is set smart indenting is disabled.
5722
5723 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5724'smarttab' 'sta' boolean (default off)
5725 global
5726 {not in Vi}
5727 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005728 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5729 <BS> will delete a 'shiftwidth' worth of space at the start of the
5730 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005731 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005732 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5733 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5735 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005736 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 NOTE: This option is reset when 'compatible' is set.
5738
5739 *'softtabstop'* *'sts'*
5740'softtabstop' 'sts' number (default 0)
5741 local to buffer
5742 {not in Vi}
5743 Number of spaces that a <Tab> counts for while performing editing
5744 operations, like inserting a <Tab> or using <BS>. It "feels" like
5745 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5746 used. This is useful to keep the 'ts' setting at its standard value
5747 of 8, while being able to edit like it is set to 'sts'. However,
5748 commands like "x" still work on the actual characters.
5749 When 'sts' is zero, this feature is off.
5750 'softtabstop' is set to 0 when the 'paste' option is set.
5751 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5752 spaces is minimized by using <Tab>s.
5753 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5754 set.
5755 NOTE: This option is set to 0 when 'compatible' is set.
5756
Bram Moolenaar217ad922005-03-20 22:37:15 +00005757 *'spell'* *'nospell'*
5758'spell' boolean (default off)
5759 local to window
5760 {not in Vi}
5761 {not available when compiled without the |+syntax|
5762 feature}
5763 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005764 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005765
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005766 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005767'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005768 local to buffer
5769 {not in Vi}
5770 {not available when compiled without the |+syntax|
5771 feature}
5772 Pattern to locate the end of a sentence. The following word will be
5773 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005774 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005775 When this check is not wanted make this option empty.
5776 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005777 Be careful with special characters, see |option-backslash| about
5778 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005779 To set this option automatically depending on the language, see
5780 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005781
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005782 *'spellfile'* *'spf'*
5783'spellfile' 'spf' string (default empty)
5784 local to buffer
5785 {not in Vi}
5786 {not available when compiled without the |+syntax|
5787 feature}
5788 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005789 commands. It must end in ".{encoding}.add". You need to include the
5790 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005791 *E765*
5792 It may also be a comma separated list of names. A count before the
5793 |zg| and |zw| commands can be used to access each. This allows using
5794 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005795 When a word is added while this option is empty Vim will set it for
5796 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005797 writable and the first language name that appears in 'spelllang',
5798 ignoring the region.
5799 The resulting ".spl" file will be used for spell checking, it does not
5800 have to appear in 'spelllang'.
5801 Normally one file is used for all regions, but you can add the region
5802 name if you want to. However, it will then only be used when
5803 'spellfile' is set to it, for entries in 'spelllang' only files
5804 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005805 This option cannot be set from a |modeline| or in the |sandbox|, for
5806 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005807
Bram Moolenaar217ad922005-03-20 22:37:15 +00005808 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005809'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005810 local to buffer
5811 {not in Vi}
5812 {not available when compiled without the |+syntax|
5813 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005814 A comma separated list of word list names. When the 'spell' option is
5815 on spellchecking will be done for these languages. Example: >
5816 set spelllang=en_us,nl,medical
5817< This means US English, Dutch and medical words are recognized. Words
5818 that are not recognized will be highlighted.
5819 The word list name must not include a comma or dot. Using a dash is
5820 recommended to separate the two letter language name from a
5821 specification. Thus "en-rare" is used for rare English words.
5822 A region name must come last and have the form "_xx", where "xx" is
5823 the two-letter, lower case region name. You can use more than one
5824 region by listing them: "en_us,en_ca" supports both US and Canadian
5825 English, but not words specific for Australia, New Zealand or Great
5826 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005827 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005828 As a special case the name of a .spl file can be given as-is. The
5829 first "_xx" in the name is removed and used as the region name
5830 (_xx is an underscore, two letters and followed by a non-letter).
5831 This is mainly for testing purposes. You must make sure the correct
5832 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005833 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005834 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5835 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005836 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005837
Bram Moolenaar98692072006-02-04 00:57:42 +00005838 If the |spellfile.vim| plugin is active and you use a language name
5839 for which Vim cannot find the .spl file in 'runtimepath' the plugin
5840 will ask you if you want to download the file.
5841
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005842 After this option has been set successfully, Vim will source the files
5843 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005844 up to the first comma, dot or underscore.
5845 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005846
5847
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005848 *'spellsuggest'* *'sps'*
5849'spellsuggest' 'sps' string (default "best")
5850 global
5851 {not in Vi}
5852 {not available when compiled without the |+syntax|
5853 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005854 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005855 the |spellsuggest()| function. This is a comma-separated list of
5856 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005857
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005858 best Internal method that works best for English. Finds
5859 changes like "fast" and uses a bit of sound-a-like
5860 scoring to improve the ordering.
5861
5862 double Internal method that uses two methods and mixes the
5863 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005864 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005865 word. That only works when the language specifies
5866 sound folding. Can be slow and doesn't always give
5867 better results.
5868
5869 fast Internal method that only checks for simple changes:
5870 character inserts/deletes/swaps. Works well for
5871 simple typing mistakes.
5872
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005873 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005874 Not used for |spellsuggest()|. The number of
5875 suggestions is never more than the value of 'lines'
5876 minus two.
5877
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005878 file:{filename} Read file {filename}, which must have two columns,
5879 separated by a slash. The first column contains the
5880 bad word, the second column the suggested good word.
5881 Example:
5882 theribal/terrible ~
5883 Use this for common mistakes that do not appear at the
5884 top of the suggestion list with the internal methods.
5885 Lines without a slash are ignored, use this for
5886 comments.
5887 The file is used for all languages.
5888
5889 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5890 trouble with spaces. |v:val| holds the badly spelled
5891 word. The expression must evaluate to a List of
5892 Lists, each with a suggestion and a score.
5893 Example:
5894 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005895 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005896 internal methods use. A lower score is better.
5897 This may invoke |spellsuggest()| if you temporarily
5898 set 'spellsuggest' to exclude the "expr:" part.
5899 Errors are silently ignored, unless you set the
5900 'verbose' option to a non-zero value.
5901
5902 Only one of "best", "double" or "fast" may be used. The others may
5903 appear several times in any order. Example: >
5904 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5905<
5906 This option cannot be set from a |modeline| or in the |sandbox|, for
5907 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005908
5909
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5911'splitbelow' 'sb' boolean (default off)
5912 global
5913 {not in Vi}
5914 {not available when compiled without the +windows
5915 feature}
5916 When on, splitting a window will put the new window below the current
5917 one. |:split|
5918
5919 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5920'splitright' 'spr' boolean (default off)
5921 global
5922 {not in Vi}
5923 {not available when compiled without the +vertsplit
5924 feature}
5925 When on, splitting a window will put the new window right of the
5926 current one. |:vsplit|
5927
5928 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5929'startofline' 'sol' boolean (default on)
5930 global
5931 {not in Vi}
5932 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005933 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005934 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005935 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005936 with a linewise operator, with "%" with a count and to buffer changing
5937 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5938 only has a line number, e.g., ":25" or ":+".
5939 In case of buffer changing commands the cursor is placed at the column
5940 where it was the last time the buffer was edited.
5941 NOTE: This option is set when 'compatible' is set.
5942
5943 *'statusline'* *'stl'* *E540* *E541* *E542*
5944'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005945 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946 {not in Vi}
5947 {not available when compiled without the |+statusline|
5948 feature}
5949 When nonempty, this option determines the content of the status line.
5950 Also see |status-line|.
5951
5952 The option consists of printf style '%' items interspersed with
5953 normal text. Each status line item is of the form:
5954 %-0{minwid}.{maxwid}{item}
5955 All fields except the {item} is optional. A single percent sign can
5956 be given as "%%". Up to 80 items can be specified.
5957
5958 Note that the only effect of 'ruler' when this option is set (and
5959 'laststatus' is 2) is controlling the output of |CTRL-G|.
5960
5961 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005962 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005964 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 minwid Minimum width of the item, padding as set by '-' & '0'.
5966 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005967 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 on the left for text items. Numeric items will be
5969 shifted down to maxwid-2 digits followed by '>'number
5970 where number is the amount of missing digits, much like
5971 an exponential notation.
5972 item A one letter code as described below.
5973
5974 Following is a description of the possible statusline items. The
5975 second character in "item" is the type:
5976 N for number
5977 S for string
5978 F for flags as described below
5979 - not applicable
5980
5981 item meaning ~
5982 f S Path to the file in the buffer, relative to current directory.
5983 F S Full path to the file in the buffer.
5984 t S File name (tail) of file in the buffer.
5985 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5986 M F Modified flag, text is ",+" or ",-".
5987 r F Readonly flag, text is " [RO]".
5988 R F Readonly flag, text is ",RO".
5989 h F Help buffer flag, text is " [help]".
5990 H F Help buffer flag, text is ",HLP".
5991 w F Preview window flag, text is " [Preview]".
5992 W F Preview window flag, text is ",PRV".
5993 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5994 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5995 {not available when compiled without |+autocmd| feature}
5996 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5997 being used: "<keymap>"
5998 n N Buffer number.
5999 b N Value of byte under cursor.
6000 B N As above, in hexadecimal.
6001 o N Byte number in file of byte under cursor, first byte is 1.
6002 Mnemonic: Offset from start of file (with one added)
6003 {not available when compiled without |+byte_offset| feature}
6004 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006005 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 l N Line number.
6007 L N Number of lines in buffer.
6008 c N Column number.
6009 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006010 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 p N Percentage through file in lines as in |CTRL-G|.
6012 P S Percentage through file of displayed window. This is like the
6013 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006014 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 Empty if the argument file count is zero or one.
6016 { NF Evaluate expression between '{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006017 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 ( - Start of item group. Can be used for setting the width and
6019 alignment of a section. Must be followed by %) somewhere.
6020 ) - End of item group. No width fields allowed.
6021 < - Where to truncate line if too long. Default is at the start.
6022 No width fields allowed.
6023 = - Separation point between left and right aligned items.
6024 No width fields allowed.
6025 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006026 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 The difference between User{N} and StatusLine will be applied
6028 to StatusLineNC for the statusline of non-current windows.
6029 The number N must be between 1 and 9. See |hl-User1..9|
6030
6031 Display of flags are controlled by the following heuristic:
6032 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006033 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034 with a space it is assumed that it wants to separate itself from
6035 anything but other flags. That is: A leading comma is removed if the
6036 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006037 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 make a nice display when flags are used like in the examples below.
6039
Bram Moolenaar582fd852005-03-28 20:58:01 +00006040 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 not set) and a minwid is not set for the group, the whole group will
6042 become empty. This will make a group like the following disappear
6043 completely from the statusline when none of the flags are set. >
6044 :set statusline=...%(\ [%M%R%H]%)...
6045<
6046 Beware that an expression is evaluated each and every time the status
6047 line is displayed. The current buffer and current window will be set
6048 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006049 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006051 real current buffer.
6052
6053 The 'statusline' option may be evaluated in the |sandbox|, see
6054 |sandbox-option|.
6055
6056 It is not allowed to change text or jump to another window while
6057 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058
6059 If the statusline is not updated when you want it (e.g., after setting
6060 a variable that's used in an expression), you can force an update by
6061 setting an option without changing its value. Example: >
6062 :let &ro = &ro
6063
6064< A result of all digits is regarded a number for display purposes.
6065 Otherwise the result is taken as flag text and applied to the rules
6066 described above.
6067
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006068 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6070 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6071
6072 Examples:
6073 Emulate standard status line with 'ruler' set >
6074 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6075< Similar, but add ASCII value of char under the cursor (like "ga") >
6076 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6077< Display byte count and byte value, modified flag in red. >
6078 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6079 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6080< Display a ,GZ flag if a compressed file is loaded >
6081 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6082< In the |:autocmd|'s: >
6083 :let b:gzflag = 1
6084< And: >
6085 :unlet b:gzflag
6086< And define this function: >
6087 :function VarExists(var, val)
6088 : if exists(a:var) | return a:val | else | return '' | endif
6089 :endfunction
6090<
6091 *'suffixes'* *'su'*
6092'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6093 global
6094 {not in Vi}
6095 Files with these suffixes get a lower priority when multiple files
6096 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006097 suffixes. Spaces after the comma are ignored. A dot is also seen as
6098 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 separator, precede it with a backslash (see |option-backslash| about
6100 including spaces and backslashes).
6101 See 'wildignore' for completely ignoring files.
6102 The use of |:set+=| and |:set-=| is preferred when adding or removing
6103 suffixes from the list. This avoids problems when a future version
6104 uses another default.
6105
6106 *'suffixesadd'* *'sua'*
6107'suffixesadd' 'sua' string (default "")
6108 local to buffer
6109 {not in Vi}
6110 {not available when compiled without the
6111 |+file_in_path| feature}
6112 Comma separated list of suffixes, which are used when searching for a
6113 file for the "gf", "[I", etc. commands. Example: >
6114 :set suffixesadd=.java
6115<
6116 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6117'swapfile' 'swf' boolean (default on)
6118 local to buffer
6119 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006120 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 swapfile is not wanted for a specific buffer. For example, with
6122 confidential information that even root must not be able to access.
6123 Careful: All text will be in memory:
6124 - Don't use this for big files.
6125 - Recovery will be impossible!
6126 A swapfile will only be present when |'updatecount'| is non-zero and
6127 'swapfile' is set.
6128 When 'swapfile' is reset, the swap file for the current buffer is
6129 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6130 non-zero, a swap file is immediately created.
6131 Also see |swap-file| and |'swapsync'|.
6132
6133 This option is used together with 'bufhidden' and 'buftype' to
6134 specify special kinds of buffers. See |special-buffers|.
6135
6136 *'swapsync'* *'sws'*
6137'swapsync' 'sws' string (default "fsync")
6138 global
6139 {not in Vi}
6140 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006141 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 When this option is empty parts of the swap file may be in memory and
6143 not written to disk. When the system crashes you may lose more work.
6144 On Unix the system does a sync now and then without Vim asking for it,
6145 so the disadvantage of setting this option off is small. On some
6146 systems the swap file will not be written at all. For a unix system
6147 setting it to "sync" will use the sync() call instead of the default
6148 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006149 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150
6151 *'switchbuf'* *'swb'*
6152'switchbuf' 'swb' string (default "")
6153 global
6154 {not in Vi}
6155 This option controls the behavior when switching between buffers.
6156 Possible values (comma separated list):
6157 useopen If included, jump to the first open window that
6158 contains the specified buffer (if there is one).
6159 Otherwise: Do not examine other windows.
6160 This setting is checked with |quickfix| commands, when
6161 jumping to errors (":cc", ":cn", "cp", etc.). It is
6162 also used in all buffer related split commands, for
6163 example ":sbuffer", ":sbnext", or ":sbrewind".
6164 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006165 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166 Supported in |quickfix| commands that display errors.
6167
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006168 *'synmaxcol'* *'smc'*
6169'synmaxcol' 'smc' number (default 3000)
6170 local to buffer
6171 {not in Vi}
6172 {not available when compiled without the |+syntax|
6173 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006174 Maximum column in which to search for syntax items. In long lines the
6175 text after this column is not highlighted and following lines may not
6176 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006177 This helps to avoid very slow redrawing for an XML file that is one
6178 long line.
6179 Set to zero to remove the limit.
6180
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 *'syntax'* *'syn'*
6182'syntax' 'syn' string (default empty)
6183 local to buffer
6184 {not in Vi}
6185 {not available when compiled without the |+syntax|
6186 feature}
6187 When this option is set, the syntax with this name is loaded, unless
6188 syntax highlighting has been switched off with ":syntax off".
6189 Otherwise this option does not always reflect the current syntax (the
6190 b:current_syntax variable does).
6191 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006192 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193 /* vim: set syntax=idl : */
6194< To switch off syntax highlighting for the current file, use: >
6195 :set syntax=OFF
6196< To switch syntax highlighting on according to the current value of the
6197 'filetype' option: >
6198 :set syntax=ON
6199< What actually happens when setting the 'syntax' option is that the
6200 Syntax autocommand event is triggered with the value as argument.
6201 This option is not copied to another buffer, independent of the 's' or
6202 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006203 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204
6205 *'tabstop'* *'ts'*
6206'tabstop' 'ts' number (default 8)
6207 local to buffer
6208 Number of spaces that a <Tab> in the file counts for. Also see
6209 |:retab| command, and 'softtabstop' option.
6210
6211 Note: Setting 'tabstop' to any other value than 8 can make your file
6212 appear wrong in many places (e.g., when printing it).
6213
6214 There are four main ways to use tabs in Vim:
6215 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6216 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6217 will use a mix of tabs and spaces, but typing Tab and BS will
6218 behave like a tab appears every 4 (or 3) characters.
6219 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6220 'expandtab'. This way you will always insert spaces. The
6221 formatting will never be messed up when 'tabstop' is changed.
6222 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006223 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 works when using Vim to edit the file.
6225 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6226 'noexpandtab'. This should then work (for initial indents only)
6227 for any tabstop setting that people use. It might be nice to have
6228 tabs after the first non-blank inserted as spaces if you do this
6229 though. Otherwise aligned comments will be wrong when 'tabstop' is
6230 changed.
6231
6232 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6233'tagbsearch' 'tbs' boolean (default on)
6234 global
6235 {not in Vi}
6236 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006237 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 searching makes searching for a tag a LOT faster, but a linear search
6239 will find more tags if the tags file wasn't properly sorted.
6240 Vim normally assumes that your tags files are sorted, or indicate that
6241 they are not sorted. Only when this is not the case does the
6242 'tagbsearch' option need to be switched off.
6243
6244 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006245 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 certain files, or retry all files with a linear search. When
6247 'tagbsearch' is off, only a linear search is done.
6248
6249 Linear searching is done anyway, for one file, when Vim finds a line
6250 at the start of the file indicating that it's not sorted: >
6251 !_TAG_FILE_SORTED 0 /some command/
6252< [The whitespace before and after the '0' must be a single <Tab>]
6253
6254 When a binary search was done and no match was found in any of the
6255 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6256 instead of a normal tag name, a retry is done with a linear search.
6257 Tags in unsorted tags files, and matches with different case will only
6258 be found in the retry.
6259
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006260 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 linear search can be avoided for the 'ignorecase' case. Use a value
6262 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6263 case-fold sorted with the -f switch to "sort" in most unices, as in
6264 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6265 5.3 or higher the -f or --fold-case-sort switch can be used for this
6266 as well. Note that case must be folded to uppercase for this to work.
6267
6268 When 'tagbsearch' is off, tags searching is slower when a full match
6269 exists, but faster when no full match exists. Tags in unsorted tags
6270 files may only be found with 'tagbsearch' off.
6271 When the tags file is not sorted, or sorted in a wrong way (not on
6272 ASCII byte value), 'tagbsearch' should be off, or the line given above
6273 must be included in the tags file.
6274 This option doesn't affect commands that find all matching tags (e.g.,
6275 command-line completion and ":help").
6276 {Vi: always uses binary search in some versions}
6277
6278 *'taglength'* *'tl'*
6279'taglength' 'tl' number (default 0)
6280 global
6281 If non-zero, tags are significant up to this number of characters.
6282
6283 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6284'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6285 global
6286 {not in Vi}
6287 If on and using a tag file in another directory, file names in that
6288 tag file are relative to the directory where the tag file is.
6289 NOTE: This option is set to the Vi default value when 'compatible' is
6290 set and to the Vim default value when 'compatible' is reset.
6291
6292 *'tags'* *'tag'* *E433*
6293'tags' 'tag' string (default "./tags,tags", when compiled with
6294 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6295 global or local to buffer |global-local|
6296 Filenames for the tag command, separated by spaces or commas. To
6297 include a space or comma in a file name, precede it with a backslash
6298 (see |option-backslash| about including spaces and backslashes).
6299 When a file name starts with "./", the '.' is replaced with the path
6300 of the current file. But only when the 'd' flag is not included in
6301 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6302 |tags-option|.
6303 "*", "**" and other wildcards can be used to search for tags files in
6304 a directory tree. See |file-searching|. {not available when compiled
6305 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006306 The |tagfiles()| function can be used to get a list of the file names
6307 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6309 files are also supported. They are automatically recognized. The
6310 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6311 differences are ignored (MS-Windows). |emacs-tags|
6312 The use of |:set+=| and |:set-=| is preferred when adding or removing
6313 file names from the list. This avoids problems when a future version
6314 uses another default.
6315 {Vi: default is "tags /usr/lib/tags"}
6316
6317 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6318'tagstack' 'tgst' boolean (default on)
6319 global
6320 {not in all versions of Vi}
6321 When on, the |tagstack| is used normally. When off, a ":tag" or
6322 ":tselect" command with an argument will not push the tag onto the
6323 tagstack. A following ":tag" without an argument, a ":pop" command or
6324 any other command that uses the tagstack will use the unmodified
6325 tagstack, but does change the pointer to the active entry.
6326 Resetting this option is useful when using a ":tag" command in a
6327 mapping which should not change the tagstack.
6328
6329 *'term'* *E529* *E530* *E531*
6330'term' string (default is $TERM, if that fails:
6331 in the GUI: "builtin_gui"
6332 on Amiga: "amiga"
6333 on BeOS: "beos-ansi"
6334 on Mac: "mac-ansi"
6335 on MiNT: "vt52"
6336 on MS-DOS: "pcterm"
6337 on OS/2: "os2ansi"
6338 on Unix: "ansi"
6339 on VMS: "ansi"
6340 on Win 32: "win32")
6341 global
6342 Name of the terminal. Used for choosing the terminal control
6343 characters. Environment variables are expanded |:set_env|.
6344 For example: >
6345 :set term=$TERM
6346< See |termcap|.
6347
6348 *'termbidi'* *'tbidi'*
6349 *'notermbidi'* *'notbidi'*
6350'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6351 global
6352 {not in Vi}
6353 {only available when compiled with the |+arabic|
6354 feature}
6355 The terminal is in charge of Bi-directionality of text (as specified
6356 by Unicode). The terminal is also expected to do the required shaping
6357 that some languages (such as Arabic) require.
6358 Setting this option implies that 'rightleft' will not be set when
6359 'arabic' is set and the value of 'arabicshape' will be ignored.
6360 Note that setting 'termbidi' has the immediate effect that
6361 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6362 This option is reset when the GUI is started.
6363 For further details see |arabic.txt|.
6364
6365 *'termencoding'* *'tenc'*
6366'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6367 Macintosh GUI: "macroman")
6368 global
6369 {only available when compiled with the |+multi_byte|
6370 feature}
6371 {not in Vi}
6372 Encoding used for the terminal. This specifies what character
6373 encoding the keyboard produces and the display will understand. For
6374 the GUI it only applies to the keyboard ('encoding' is used for the
6375 display).
6376 In the Win32 console version the default value is the console codepage
6377 when it differs from the ANSI codepage.
6378 *E617*
6379 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6380 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6381 Any attempts to set a different value will be rejected, and an error
6382 message is shown.
6383 For the Win32 GUI 'termencoding' is not used for typed characters,
6384 because the Win32 system always passes Unicode characters.
6385 When empty, the same encoding is used as for the 'encoding' option.
6386 This is the normal value.
6387 Not all combinations for 'termencoding' and 'encoding' are valid. See
6388 |encoding-table|.
6389 The value for this option must be supported by internal conversions or
6390 iconv(). When this is not possible no conversion will be done and you
6391 will probably experience problems with non-ASCII characters.
6392 Example: You are working with the locale set to euc-jp (Japanese) and
6393 want to edit a UTF-8 file: >
6394 :let &termencoding = &encoding
6395 :set encoding=utf-8
6396< You need to do this when your system has no locale support for UTF-8.
6397
6398 *'terse'* *'noterse'*
6399'terse' boolean (default off)
6400 global
6401 When set: Add 's' flag to 'shortmess' option (this makes the message
6402 for a search that hits the start or end of the file not being
6403 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6404 shortens a lot of messages}
6405
6406 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6407'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6408 global
6409 {not in Vi}
6410 This option is obsolete. Use 'fileformats'.
6411 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6412 set to the default value for the current system. When 'textauto' is
6413 reset, 'fileformats' is made empty.
6414 NOTE: This option is set to the Vi default value when 'compatible' is
6415 set and to the Vim default value when 'compatible' is reset.
6416
6417 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6418'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6419 others: default off)
6420 local to buffer
6421 {not in Vi}
6422 This option is obsolete. Use 'fileformat'.
6423 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6424 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6425 "unix".
6426
6427 *'textwidth'* *'tw'*
6428'textwidth' 'tw' number (default 0)
6429 local to buffer
6430 {not in Vi}
6431 Maximum width of text that is being inserted. A longer line will be
6432 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006433 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6434 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 'formatoptions' and |ins-textwidth|.
6436 NOTE: This option is set to 0 when 'compatible' is set.
6437
6438 *'thesaurus'* *'tsr'*
6439'thesaurus' 'tsr' string (default "")
6440 global or local to buffer |global-local|
6441 {not in Vi}
6442 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006443 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 the file should contain words with similar meaning, separated by
6445 non-keyword characters (white space is preferred). Maximum line
6446 length is 510 bytes.
6447 To obtain a file to be used here, check out the wordlist FAQ at
6448 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006449 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 after a comma are ignored, otherwise spaces are included in the file
6451 name. See |option-backslash| about using backslashes.
6452 The use of |:set+=| and |:set-=| is preferred when adding or removing
6453 directories from the list. This avoids problems when a future version
6454 uses another default.
6455 Backticks cannot be used in this option for security reasons.
6456
6457 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6458'tildeop' 'top' boolean (default off)
6459 global
6460 {not in Vi}
6461 When on: The tilde command "~" behaves like an operator.
6462 NOTE: This option is reset when 'compatible' is set.
6463
6464 *'timeout'* *'to'* *'notimeout'* *'noto'*
6465'timeout' 'to' boolean (default on)
6466 global
6467 *'ttimeout'* *'nottimeout'*
6468'ttimeout' boolean (default off)
6469 global
6470 {not in Vi}
6471 These two options together determine the behavior when part of a
6472 mapped key sequence or keyboard code has been received:
6473
6474 'timeout' 'ttimeout' action ~
6475 off off do not time out
6476 on on or off time out on :mappings and key codes
6477 off on time out on key codes
6478
6479 If both options are off, Vim will wait until either the complete
6480 mapping or key sequence has been received, or it is clear that there
6481 is no mapping or key sequence for the received characters. For
6482 example: if you have mapped "vl" and Vim has received 'v', the next
6483 character is needed to see if the 'v' is followed by an 'l'.
6484 When one of the options is on, Vim will wait for about 1 second for
6485 the next character to arrive. After that the already received
6486 characters are interpreted as single characters. The waiting time can
6487 be changed with the 'timeoutlen' option.
6488 On slow terminals or very busy systems timing out may cause
6489 malfunctioning cursor keys. If both options are off, Vim waits
6490 forever after an entered <Esc> if there are key codes that start
6491 with <Esc>. You will have to type <Esc> twice. If you do not have
6492 problems with key codes, but would like to have :mapped key
6493 sequences not timing out in 1 second, set the 'ttimeout' option and
6494 reset the 'timeout' option.
6495
6496 NOTE: 'ttimeout' is reset when 'compatible' is set.
6497
6498 *'timeoutlen'* *'tm'*
6499'timeoutlen' 'tm' number (default 1000)
6500 global
6501 {not in all versions of Vi}
6502 *'ttimeoutlen'* *'ttm'*
6503'ttimeoutlen' 'ttm' number (default -1)
6504 global
6505 {not in Vi}
6506 The time in milliseconds that is waited for a key code or mapped key
6507 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6508 when part of a command has been typed.
6509 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6510 different timeout value for key codes is desired set 'ttimeoutlen' to
6511 a non-negative number.
6512
6513 ttimeoutlen mapping delay key code delay ~
6514 < 0 'timeoutlen' 'timeoutlen'
6515 >= 0 'timeoutlen' 'ttimeoutlen'
6516
6517 The timeout only happens when the 'timeout' and 'ttimeout' options
6518 tell so. A useful setting would be >
6519 :set timeout timeoutlen=3000 ttimeoutlen=100
6520< (time out on mapping after three seconds, time out on key codes after
6521 a tenth of a second).
6522
6523 *'title'* *'notitle'*
6524'title' boolean (default off, on when title can be restored)
6525 global
6526 {not in Vi}
6527 {not available when compiled without the |+title|
6528 feature}
6529 When on, the title of the window will be set to the value of
6530 'titlestring' (if it is not empty), or to:
6531 filename [+=-] (path) - VIM
6532 Where:
6533 filename the name of the file being edited
6534 - indicates the file cannot be modified, 'ma' off
6535 + indicates the file was modified
6536 = indicates the file is read-only
6537 =+ indicates the file is read-only and modified
6538 (path) is the path of the file being edited
6539 - VIM the server name |v:servername| or "VIM"
6540 Only works if the terminal supports setting window titles
6541 (currently Amiga console, Win32 console, all GUI versions and
6542 terminals with a non- empty 't_ts' option - these are Unix xterm and
6543 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6544 *X11*
6545 When Vim was compiled with HAVE_X11 defined, the original title will
6546 be restored if possible. The output of ":version" will include "+X11"
6547 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6548 works for the icon name |'icon'|.
6549 But: When Vim was started with the |-X| argument, restoring the title
6550 will not work (except in the GUI).
6551 If the title cannot be restored, it is set to the value of 'titleold'.
6552 You might want to restore the title outside of Vim then.
6553 When using an xterm from a remote machine you can use this command:
6554 rsh machine_name xterm -display $DISPLAY &
6555 then the WINDOWID environment variable should be inherited and the
6556 title of the window should change back to what it should be after
6557 exiting Vim.
6558
6559 *'titlelen'*
6560'titlelen' number (default 85)
6561 global
6562 {not in Vi}
6563 {not available when compiled without the |+title|
6564 feature}
6565 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006566 title. When the title is longer, only the end of the path name is
6567 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 Using a percentage makes this adapt to the width of the window. But
6569 it won't work perfectly, because the actual number of characters
6570 available also depends on the font used and other things in the title
6571 bar. When 'titlelen' is zero the full path is used. Otherwise,
6572 values from 1 to 30000 percent can be used.
6573 'titlelen' is also used for the 'titlestring' option.
6574
6575 *'titleold'*
6576'titleold' string (default "Thanks for flying Vim")
6577 global
6578 {not in Vi}
6579 {only available when compiled with the |+title|
6580 feature}
6581 This option will be used for the window title when exiting Vim if the
6582 original title cannot be restored. Only happens if 'title' is on or
6583 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006584 This option cannot be set from a |modeline| or in the |sandbox|, for
6585 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 *'titlestring'*
6587'titlestring' string (default "")
6588 global
6589 {not in Vi}
6590 {not available when compiled without the |+title|
6591 feature}
6592 When this option is not empty, it will be used for the title of the
6593 window. This happens only when the 'title' option is on.
6594 Only works if the terminal supports setting window titles (currently
6595 Amiga console, Win32 console, all GUI versions and terminals with a
6596 non-empty 't_ts' option).
6597 When Vim was compiled with HAVE_X11 defined, the original title will
6598 be restored if possible |X11|.
6599 When this option contains printf-style '%' items, they will be
6600 expanded according to the rules used for 'statusline'.
6601 Example: >
6602 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6603 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6604< The value of 'titlelen' is used to align items in the middle or right
6605 of the available space.
6606 Some people prefer to have the file name first: >
6607 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6608< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006609 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 separating space only when needed.
6611 NOTE: Use of special characters in 'titlestring' may cause the display
6612 to be garbled (e.g., when it contains a CR or NL character).
6613 {not available when compiled without the |+statusline| feature}
6614
6615 *'toolbar'* *'tb'*
6616'toolbar' 'tb' string (default "icons,tooltips")
6617 global
6618 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6619 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006620 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 possible values are:
6622 icons Toolbar buttons are shown with icons.
6623 text Toolbar buttons shown with text.
6624 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006625 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 tooltips Tooltips are active for toolbar buttons.
6627 Tooltips refer to the popup help text which appears after the mouse
6628 cursor is placed over a toolbar button for a brief moment.
6629
6630 If you want the toolbar to be shown with icons as well as text, do the
6631 following: >
6632 :set tb=icons,text
6633< Motif and Athena cannot display icons and text at the same time. They
6634 will show icons if both are requested.
6635
6636 If none of the strings specified in 'toolbar' are valid or if
6637 'toolbar' is empty, this option is ignored. If you want to disable
6638 the toolbar, you need to set the 'guioptions' option. For example: >
6639 :set guioptions-=T
6640< Also see |gui-toolbar|.
6641
6642 *'toolbariconsize'* *'tbis'*
6643'toolbariconsize' 'tbis' string (default "small")
6644 global
6645 {not in Vi}
6646 {only in the GTK+ 2 GUI}
6647 Controls the size of toolbar icons. The possible values are:
6648 tiny Use tiny toolbar icons.
6649 small Use small toolbar icons (default).
6650 medium Use medium-sized toolbar icons.
6651 large Use large toolbar icons.
6652 The exact dimensions in pixels of the various icon sizes depend on
6653 the current theme. Common dimensions are large=32x32, medium=24x24,
6654 small=20x20 and tiny=16x16.
6655
6656 If 'toolbariconsize' is empty, the global default size as determined
6657 by user preferences or the current theme is used.
6658
6659 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6660'ttybuiltin' 'tbi' boolean (default on)
6661 global
6662 {not in Vi}
6663 When on, the builtin termcaps are searched before the external ones.
6664 When off the builtin termcaps are searched after the external ones.
6665 When this option is changed, you should set the 'term' option next for
6666 the change to take effect, for example: >
6667 :set notbi term=$TERM
6668< See also |termcap|.
6669 Rationale: The default for this option is "on", because the builtin
6670 termcap entries are generally better (many systems contain faulty
6671 xterm entries...).
6672
6673 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6674'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6675 sun-cmd, screen, rxvt, dtterm or
6676 iris-ansi; also on when running Vim in
6677 a DOS console)
6678 global
6679 {not in Vi}
6680 Indicates a fast terminal connection. More characters will be sent to
6681 the screen for redrawing, instead of using insert/delete line
6682 commands. Improves smoothness of redrawing when there are multiple
6683 windows and the terminal does not support a scrolling region.
6684 Also enables the extra writing of characters at the end of each screen
6685 line for lines that wrap. This helps when using copy/paste with the
6686 mouse in an xterm and other terminals.
6687
6688 *'ttymouse'* *'ttym'*
6689'ttymouse' 'ttym' string (default depends on 'term')
6690 global
6691 {not in Vi}
6692 {only in Unix and VMS, doesn't work in the GUI; not
6693 available when compiled without |+mouse|}
6694 Name of the terminal type for which mouse codes are to be recognized.
6695 Currently these three strings are valid:
6696 *xterm-mouse*
6697 xterm xterm-like mouse handling. The mouse generates
6698 "<Esc>[Mscr", where "scr" is three bytes:
6699 "s" = button state
6700 "c" = column plus 33
6701 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006702 This only works up to 223 columns! See "dec" for a
6703 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 xterm2 Works like "xterm", but with the xterm reporting the
6705 mouse position while the mouse is dragged. This works
6706 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006707 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 work. See below for how Vim detects this
6709 automatically.
6710 *netterm-mouse*
6711 netterm NetTerm mouse handling. The mouse generates
6712 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6713 for the row and column.
6714 *dec-mouse*
6715 dec DEC terminal mouse handling. The mouse generates a
6716 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006717 This is also available for an Xterm, if it was
6718 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 *jsbterm-mouse*
6720 jsbterm JSB term mouse handling.
6721 *pterm-mouse*
6722 pterm QNX pterm mouse handling.
6723
6724 The mouse handling must be enabled at compile time |+mouse_xterm|
6725 |+mouse_dec| |+mouse_netterm|.
6726 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6727 recognized, if enabled at compile time. DEC terminal mouse codes
6728 are recognized if enabled at compile time, and 'ttymouse' is not
6729 "xterm" (because the xterm and dec mouse codes conflict).
6730 This option is automatically set to "xterm", when the 'term' option is
6731 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6732 or "xterm2" already. The main use of this option is to set it to
6733 "xterm", when the terminal name doesn't start with "xterm", but it can
6734 handle xterm mouse codes.
6735 The "xterm2" value will be set if the xterm version is reported to be
6736 95 of higher. This only works when compiled with the |+termresponse|
6737 feature and if |t_RV| is set to the escape sequence to request the
6738 xterm version number. Otherwise "xterm2" must be set explicitly.
6739 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6740 t_RV to an empty string: >
6741 :set t_RV=
6742<
6743 *'ttyscroll'* *'tsl'*
6744'ttyscroll' 'tsl' number (default 999)
6745 global
6746 Maximum number of lines to scroll the screen. If there are more lines
6747 to scroll the window is redrawn. For terminals where scrolling is
6748 very slow and redrawing is not slow this can be set to a small number,
6749 e.g., 3, to speed up displaying.
6750
6751 *'ttytype'* *'tty'*
6752'ttytype' 'tty' string (default from $TERM)
6753 global
6754 Alias for 'term', see above.
6755
6756 *'undolevels'* *'ul'*
6757'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6758 Win32 and OS/2)
6759 global
6760 {not in Vi}
6761 Maximum number of changes that can be undone. Since undo information
6762 is kept in memory, higher numbers will cause more memory to be used
6763 (nevertheless, a single change can use an unlimited amount of memory).
6764 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6765 itself: >
6766 set ul=0
6767< But you can also get Vi compatibility by including the 'u' flag in
6768 'cpoptions', and still be able to use CTRL-R to repeat undo.
6769 Set to a negative number for no undo at all: >
6770 set ul=-1
6771< This helps when you run out of memory for a single change.
6772 Also see |undo-two-ways|.
6773
6774 *'updatecount'* *'uc'*
6775'updatecount' 'uc' number (default: 200)
6776 global
6777 {not in Vi}
6778 After typing this many characters the swap file will be written to
6779 disk. When zero, no swap file will be created at all (see chapter on
6780 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6781 Vim with the "-n" option, see |startup|. When editing in readonly
6782 mode this option will be initialized to 10000.
6783 The swapfile can be disabled per buffer with |'swapfile'|.
6784 When 'updatecount' is set from zero to non-zero, swap files are
6785 created for all buffers that have 'swapfile' set. When 'updatecount'
6786 is set to zero, existing swap files are not deleted.
6787 Also see |'swapsync'|.
6788 This option has no meaning in buffers where |'buftype'| is "nofile"
6789 or "nowrite".
6790
6791 *'updatetime'* *'ut'*
6792'updatetime' 'ut' number (default 4000)
6793 global
6794 {not in Vi}
6795 If this many milliseconds nothing is typed the swap file will be
6796 written to disk (see |crash-recovery|). Also used for the
6797 |CursorHold| autocommand event.
6798
6799 *'verbose'* *'vbs'*
6800'verbose' 'vbs' number (default 0)
6801 global
6802 {not in Vi, although some versions have a boolean
6803 verbose option}
6804 When bigger than zero, Vim will give messages about what it is doing.
6805 Currently, these messages are given:
6806 >= 1 When the viminfo file is read or written.
6807 >= 2 When a file is ":source"'ed.
6808 >= 5 Every searched tags file.
6809 >= 8 Files for which a group of autocommands is executed.
6810 >= 9 Every executed autocommand.
6811 >= 12 Every executed function.
6812 >= 13 When an exception is thrown, caught, finished, or discarded.
6813 >= 14 Anything pending in a ":finally" clause.
6814 >= 15 Every executed Ex command (truncated at 200 characters).
6815
6816 This option can also be set with the "-V" argument. See |-V|.
6817 This option is also set by the |:verbose| command.
6818
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006819 When the 'verbosefile' option is set then the verbose messages are not
6820 displayed.
6821
6822 *'verbosefile'* *'vfile'*
6823'verbosefile' 'vfile' string (default empty)
6824 global
6825 {not in Vi}
6826 When not empty all messages are written in a file with this name.
6827 When the file exists messages are appended.
6828 Writing to the file ends when Vim exits or when 'verbosefile' is made
6829 empty.
6830 Setting 'verbosefile' to a new value is like making it empty first.
6831 The difference with |:redir| is that verbose messages are not
6832 displayed when 'verbosefile' is set.
6833
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 *'viewdir'* *'vdir'*
6835'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6836 "$VIM/vimfiles/view",
6837 for Unix: "~/.vim/view",
6838 for Macintosh: "$VIM:vimfiles:view"
6839 for VMS: "sys$login:vimfiles/view"
6840 for RiscOS: "Choices:vimfiles/view")
6841 global
6842 {not in Vi}
6843 {not available when compiled without the +mksession
6844 feature}
6845 Name of the directory where to store files for |:mkview|.
6846 This option cannot be set from a |modeline| or in the |sandbox|, for
6847 security reasons.
6848
6849 *'viewoptions'* *'vop'*
6850'viewoptions' 'vop' string (default: "folds,options,cursor")
6851 global
6852 {not in Vi}
6853 {not available when compiled without the +mksession
6854 feature}
6855 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006856 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 word save and restore ~
6858 cursor cursor position in file and in window
6859 folds manually created folds, opened/closed folds and local
6860 fold options
6861 options options and mappings local to a window or buffer (not
6862 global values for local options)
6863 slash backslashes in file names replaced with forward
6864 slashes
6865 unix with Unix end-of-line format (single <NL>), even when
6866 on Windows or DOS
6867
6868 "slash" and "unix" are useful on Windows when sharing view files
6869 with Unix. The Unix version of Vim cannot source dos format scripts,
6870 but the Windows version of Vim can source unix format scripts.
6871
6872 *'viminfo'* *'vi'* *E526* *E527* *E528*
6873'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6874 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6875 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6876 for others: '20,<50,s10,h)
6877 global
6878 {not in Vi}
6879 {not available when compiled without the |+viminfo|
6880 feature}
6881 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006882 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 separated list of parameters, each consisting of a single character
6884 identifying the particular parameter, followed by a number or string
6885 which specifies the value of that parameter. If a particular
6886 character is left out, then the default value is used for that
6887 parameter. The following is a list of the identifying characters and
6888 the effect of their value.
6889 CHAR VALUE ~
6890 ! When included, save and restore global variables that start
6891 with an uppercase letter, and don't contain a lowercase
6892 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006893 and "_K_L_M" are not. Only String and Number types are
6894 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 " Maximum number of lines saved for each register. Old name of
6896 the '<' item, with the disadvantage that you need to put a
6897 backslash before the ", otherwise it will be recognized as the
6898 start of a comment!
6899 % When included, save and restore the buffer list. If Vim is
6900 started with a file name argument, the buffer list is not
6901 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006902 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 without a file name and buffers for help files are not written
6904 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006905 When followed by a number, the number specifies the maximum
6906 number of buffers that are stored. Without a number all
6907 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 ' Maximum number of previously edited files for which the marks
6909 are remembered. This parameter must always be included when
6910 'viminfo' is non-empty.
6911 Including this item also means that the |jumplist| and the
6912 |changelist| are stored in the viminfo file.
6913 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006914 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 patterns are also saved. When not included, the value of
6916 'history' is used.
6917 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006918 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 < Maximum number of lines saved for each register. If zero then
6920 registers are not saved. When not included, all lines are
6921 saved. '"' is the old name for this item.
6922 Also see the 's' item below: limit specified in Kbyte.
6923 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006924 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 c When included, convert the text in the viminfo file from the
6926 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006927 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 f Whether file marks need to be stored. If zero, file marks ('0
6929 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006930 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 cursor position (when exiting or when doing ":wviminfo").
6932 h Disable the effect of 'hlsearch' when loading the viminfo
6933 file. When not included, it depends on whether ":nohlsearch"
6934 has been used since the last search command.
6935 n Name of the viminfo file. The name must immediately follow
6936 the 'n'. Must be the last one! If the "-i" argument was
6937 given when starting Vim, that file name overrides the one
6938 given here with 'viminfo'. Environment variables are expanded
6939 when opening the file, not when setting the option.
6940 r Removable media. The argument is a string (up to the next
6941 ','). This parameter can be given several times. Each
6942 specifies the start of a path for which no marks will be
6943 stored. This is to avoid removable media. For MS-DOS you
6944 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6945 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6946 ignored. Maximum length of each 'r' argument is 50
6947 characters.
6948 s Maximum size of an item in Kbyte. If zero then registers are
6949 not saved. Currently only applies to registers. The default
6950 "s10" will exclude registers with more than 10 Kbyte of text.
6951 Also see the '<' item above: line count limit.
6952
6953 Example: >
6954 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6955<
6956 '50 Marks will be remembered for the last 50 files you
6957 edited.
6958 <1000 Contents of registers (up to 1000 lines each) will be
6959 remembered.
6960 s100 Registers with more than 100 Kbyte text are skipped.
6961 :0 Command-line history will not be saved.
6962 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6963 no / Since '/' is not specified, the default will be used,
6964 that is, save all of the search history, and also the
6965 previous search and substitute patterns.
6966 no % The buffer list will not be saved nor read back.
6967 no h 'hlsearch' highlighting will be restored.
6968
6969 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6970 load the contents of the file, this is not done automatically.
6971
6972 This option cannot be set from a |modeline| or in the |sandbox|, for
6973 security reasons.
6974
6975 *'virtualedit'* *'ve'*
6976'virtualedit' 've' string (default "")
6977 global
6978 {not in Vi}
6979 {not available when compiled without the
6980 |+virtualedit| feature}
6981 A comma separated list of these words:
6982 block Allow virtual editing in Visual block mode.
6983 insert Allow virtual editing in Insert mode.
6984 all Allow virtual editing in all modes.
6985 Virtual editing means that the cursor can be positioned where there is
6986 no actual character. This can be halfway into a Tab or beyond the end
6987 of the line. Useful for selecting a rectangle in Visual mode and
6988 editing a table.
6989
6990 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6991'visualbell' 'vb' boolean (default off)
6992 global
6993 {not in Vi}
6994 Use visual bell instead of beeping. The terminal code to display the
6995 visual bell is given with 't_vb'. When no beep or flash is wanted,
6996 use ":set vb t_vb=".
6997 Note: When the GUI starts, 't_vb' is reset to its default value. You
6998 might want to set it again in your |gvimrc|.
6999 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7000 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7001 where 40 is the time in msec.
7002 Does not work on the Amiga, you always get a screen flash.
7003 Also see 'errorbells'.
7004
7005 *'warn'* *'nowarn'*
7006'warn' boolean (default on)
7007 global
7008 Give a warning message when a shell command is used while the buffer
7009 has been changed.
7010
7011 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7012'weirdinvert' 'wiv' boolean (default off)
7013 global
7014 {not in Vi}
7015 This option has the same effect as the 't_xs' termcap option.
7016 It is provided for backwards compatibility with version 4.x.
7017 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7018 vice versa. Has no effect when the GUI is running.
7019
7020 *'whichwrap'* *'ww'*
7021'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7022 global
7023 {not in Vi}
7024 Allow specified keys that move the cursor left/right to move to the
7025 previous/next line when the cursor is on the first/last character in
7026 the line. Concatenate characters to allow this for these keys:
7027 char key mode ~
7028 b <BS> Normal and Visual
7029 s <Space> Normal and Visual
7030 h "h" Normal and Visual
7031 l "l" Normal and Visual
7032 < <Left> Normal and Visual
7033 > <Right> Normal and Visual
7034 ~ "~" Normal
7035 [ <Left> Insert and Replace
7036 ] <Right> Insert and Replace
7037 For example: >
7038 :set ww=<,>,[,]
7039< allows wrap only when cursor keys are used.
7040 When the movement keys are used in combination with a delete or change
7041 operator, the <EOL> also counts for a character. This makes "3h"
7042 different from "3dh" when the cursor crosses the end of a line. This
7043 is also true for "x" and "X", because they do the same as "dl" and
7044 "dh". If you use this, you may also want to use the mapping
7045 ":map <BS> X" to make backspace delete the character in front of the
7046 cursor.
7047 When 'l' is included, you get a side effect: "yl" on an empty line
7048 will include the <EOL>, so that "p" will insert a new line.
7049 NOTE: This option is set to the Vi default value when 'compatible' is
7050 set and to the Vim default value when 'compatible' is reset.
7051
7052 *'wildchar'* *'wc'*
7053'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7054 global
7055 {not in Vi}
7056 Character you have to type to start wildcard expansion in the
7057 command-line, as specified with 'wildmode'.
7058 The character is not recognized when used inside a macro. See
7059 'wildcharm' for that.
7060 Although 'wc' is a number option, you can set it to a special key: >
7061 :set wc=<Esc>
7062< NOTE: This option is set to the Vi default value when 'compatible' is
7063 set and to the Vim default value when 'compatible' is reset.
7064
7065 *'wildcharm'* *'wcm'*
7066'wildcharm' 'wcm' number (default: none (0))
7067 global
7068 {not in Vi}
7069 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007070 recognized when used inside a macro. You can find "spare" command-line
7071 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 you'll never actually type 'wildcharm', just use it in mappings that
7073 automatically invoke completion mode, e.g.: >
7074 :set wcm=<C-Z>
7075 :cmap ss so $vim/sessions/*.vim<C-Z>
7076< Then after typing :ss you can use CTRL-P & CTRL-N.
7077
7078 *'wildignore'* *'wig'*
7079'wildignore' 'wig' string (default "")
7080 global
7081 {not in Vi}
7082 {not available when compiled without the |+wildignore|
7083 feature}
7084 A list of file patterns. A file that matches with one of these
7085 patterns is ignored when completing file or directory names.
7086 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7087 Also see 'suffixes'.
7088 Example: >
7089 :set wildignore=*.o,*.obj
7090< The use of |:set+=| and |:set-=| is preferred when adding or removing
7091 a pattern from the list. This avoids problems when a future version
7092 uses another default.
7093
7094 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7095'wildmenu' 'wmnu' boolean (default off)
7096 global
7097 {not in Vi}
7098 {not available if compiled without the |+wildmenu|
7099 feature}
7100 When 'wildmenu' is on, command-line completion operates in an enhanced
7101 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7102 the possible matches are shown just above the command line, with the
7103 first match highlighted (overwriting the status line, if there is
7104 one). Keys that show the previous/next match, such as <Tab> or
7105 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7106 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7107 specified. "longest" and "list" do not start "wildmenu" mode.
7108 If there are more matches than can fit in the line, a ">" is shown on
7109 the right and/or a "<" is shown on the left. The status line scrolls
7110 as needed.
7111 The "wildmenu" mode is abandoned when a key is hit that is not used
7112 for selecting a completion.
7113 While the "wildmenu" is active the following keys have special
7114 meanings:
7115
7116 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7117 <Down> - in filename/menu name completion: move into a
7118 subdirectory or submenu.
7119 <CR> - in menu completion, when the cursor is just after a
7120 dot: move into a submenu.
7121 <Up> - in filename/menu name completion: move up into
7122 parent directory or parent menu.
7123
7124 This makes the menus accessible from the console |console-menus|.
7125
7126 If you prefer the <Left> and <Right> keys to move the cursor instead
7127 of selecting a different match, use this: >
7128 :cnoremap <Left> <Space><BS><Left>
7129 :cnoremap <Right> <Space><BS><Right>
7130<
7131 The "WildMenu" highlighting is used for displaying the current match
7132 |hl-WildMenu|.
7133
7134 *'wildmode'* *'wim'*
7135'wildmode' 'wim' string (Vim default: "full")
7136 global
7137 {not in Vi}
7138 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007139 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 part specifies what to do for each consecutive use of 'wildchar. The
7141 first part specifies the behavior for the first use of 'wildchar',
7142 The second part for the second use, etc.
7143 These are the possible values for each part:
7144 "" Complete only the first match.
7145 "full" Complete the next full match. After the last match,
7146 the original string is used and then the first match
7147 again.
7148 "longest" Complete till longest common string. If this doesn't
7149 result in a longer string, use the next part.
7150 "longest:full" Like "longest", but also start 'wildmenu' if it is
7151 enabled.
7152 "list" When more than one match, list all matches.
7153 "list:full" When more than one match, list all matches and
7154 complete first match.
7155 "list:longest" When more than one match, list all matches and
7156 complete till longest common string.
7157 When there is only a single match, it is fully completed in all cases.
7158
7159 Examples: >
7160 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007161< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 :set wildmode=longest,full
7163< Complete longest common string, then each full match >
7164 :set wildmode=list:full
7165< List all matches and complete each full match >
7166 :set wildmode=list,full
7167< List all matches without completing, then each full match >
7168 :set wildmode=longest,list
7169< Complete longest common string, then list alternatives.
7170
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007171 *'wildoptions'* *'wop'*
7172'wildoptions' 'wop' string (default "")
7173 global
7174 {not in Vi}
7175 {not available when compiled without the |+wildignore|
7176 feature}
7177 A list of words that change how command line completion is done.
7178 Currently only one word is allowed:
7179 tagfile When using CTRL-D to list matching tags, the kind of
7180 tag and the file of the tag is listed. Only one match
7181 is displayed per line. Often used tag kinds are:
7182 d #define
7183 f function
7184 Also see |cmdline-completion|.
7185
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 *'winaltkeys'* *'wak'*
7187'winaltkeys' 'wak' string (default "menu")
7188 global
7189 {not in Vi}
7190 {only used in Win32, Motif, GTK and Photon GUI}
7191 Some GUI versions allow the access to menu entries by using the ALT
7192 key in combination with a character that appears underlined in the
7193 menu. This conflicts with the use of the ALT key for mappings and
7194 entering special characters. This option tells what to do:
7195 no Don't use ALT keys for menus. ALT key combinations can be
7196 mapped, but there is no automatic handling. This can then be
7197 done with the |:simalt| command.
7198 yes ALT key handling is done by the windowing system. ALT key
7199 combinations cannot be mapped.
7200 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007201 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 keys can be mapped.
7203 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7204 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007205 This option is not used for <F10>; on Win32 and with GTK <F10> will
7206 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007208 *'window'* *'wi'*
7209'window' 'wi' number (default screen height - 1)
7210 global
7211 Window height. Do not confuse this with the height of the Vim window,
7212 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007213 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7214 value is smaller than 'lines' minus one. The screen will scroll
7215 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007216 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7217 in a much smarter way, taking care of wrapping lines.
7218 When resizing the Vim window, the value is smaller than 1 or more than
7219 or equal to 'lines' it will be set to 'lines' minus 1.
7220 {Vi also uses the option to specify the number of displayed lines}
7221
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 *'winheight'* *'wh'* *E591*
7223'winheight' 'wh' number (default 1)
7224 global
7225 {not in Vi}
7226 {not available when compiled without the +windows
7227 feature}
7228 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007229 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 current window is smaller, its size is increased, at the cost of the
7231 height of other windows. Set it to 999 to make the current window
7232 always fill the screen (although this has the drawback that ":all"
7233 will create only two windows). Set it to a small number for normal
7234 editing.
7235 Minimum value is 1.
7236 The height is not adjusted after one of the commands to change the
7237 height of the current window.
7238 'winheight' applies to the current window. Use 'winminheight' to set
7239 the minimal height for other windows.
7240
7241 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7242'winfixheight' 'wfh' boolean (default off)
7243 local to window
7244 {not in Vi}
7245 {not available when compiled without the +windows
7246 feature}
7247 Keep the window height when windows are opened or closed and
7248 'equalalways' is set. Set by default for the |preview-window| and
7249 |quickfix-window|.
7250 The height may be changed anyway when running out of room.
7251
7252 *'winminheight'* *'wmh'*
7253'winminheight' 'wmh' number (default 1)
7254 global
7255 {not in Vi}
7256 {not available when compiled without the +windows
7257 feature}
7258 The minimal height of a window, when it's not the current window.
7259 This is a hard minimum, windows will never become smaller.
7260 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7261 status bar) if necessary. They will return to at least one line when
7262 they become active (since the cursor has to have somewhere to go.)
7263 Use 'winheight' to set the minimal height of the current window.
7264 This option is only checked when making a window smaller. Don't use a
7265 large number, it will cause errors when opening more than a few
7266 windows. A value of 0 to 3 is reasonable.
7267
7268 *'winminwidth'* *'wmw'*
7269'winminwidth' 'wmw' number (default 1)
7270 global
7271 {not in Vi}
7272 {not available when compiled without the +vertsplit
7273 feature}
7274 The minimal width of a window, when it's not the current window.
7275 This is a hard minimum, windows will never become smaller.
7276 When set to zero, windows may be "squashed" to zero columns (i.e. just
7277 a vertical separator) if necessary. They will return to at least one
7278 line when they become active (since the cursor has to have somewhere
7279 to go.)
7280 Use 'winwidth' to set the minimal width of the current window.
7281 This option is only checked when making a window smaller. Don't use a
7282 large number, it will cause errors when opening more than a few
7283 windows. A value of 0 to 12 is reasonable.
7284
7285 *'winwidth'* *'wiw'* *E592*
7286'winwidth' 'wiw' number (default 20)
7287 global
7288 {not in Vi}
7289 {not available when compiled without the +vertsplit
7290 feature}
7291 Minimal number of columns for the current window. This is not a hard
7292 minimum, Vim will use fewer columns if there is not enough room. If
7293 the current window is smaller, its size is increased, at the cost of
7294 the width of other windows. Set it to 999 to make the current window
7295 always fill the screen. Set it to a small number for normal editing.
7296 The width is not adjusted after one of the commands to change the
7297 width of the current window.
7298 'winwidth' applies to the current window. Use 'winminwidth' to set
7299 the minimal width for other windows.
7300
7301 *'wrap'* *'nowrap'*
7302'wrap' boolean (default on)
7303 local to window
7304 {not in Vi}
7305 This option changes how text is displayed. It doesn't change the text
7306 in the buffer, see 'textwidth' for that.
7307 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007308 displaying continues on the next line. When off lines will not wrap
7309 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 moved to a part that is not shown, the screen will scroll
7311 horizontally.
7312 The line will be broken in the middle of a word if necessary. See
7313 'linebreak' to get the break at a word boundary.
7314 To make scrolling horizontally a bit more useful, try this: >
7315 :set sidescroll=5
7316 :set listchars+=precedes:<,extends:>
7317< See 'sidescroll', 'listchars' and |wrap-off|.
7318
7319 *'wrapmargin'* *'wm'*
7320'wrapmargin' 'wm' number (default 0)
7321 local to buffer
7322 Number of characters from the right window border where wrapping
7323 starts. When typing text beyond this limit, an <EOL> will be inserted
7324 and inserting continues on the next line.
7325 Options that add a margin, such as 'number' and 'foldcolumn', cause
7326 the text width to be further reduced. This is Vi compatible.
7327 When 'textwidth' is non-zero, this option is not used.
7328 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7329 and less usefully}
7330
7331 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7332'wrapscan' 'ws' boolean (default on) *E384* *E385*
7333 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007334 Searches wrap around the end of the file. Also applies to |]s| and
7335 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336
7337 *'write'* *'nowrite'*
7338'write' boolean (default on)
7339 global
7340 {not in Vi}
7341 Allows writing files. When not set, writing a file is not allowed.
7342 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007343 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 argument. Filtering text is still possible, even though this requires
7345 writing a temporary file.
7346
7347 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7348'writeany' 'wa' boolean (default off)
7349 global
7350 Allows writing to any file with no need for "!" override.
7351
7352 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7353'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7354 otherwise)
7355 global
7356 {not in Vi}
7357 Make a backup before overwriting a file. The backup is removed after
7358 the file was successfully written, unless the 'backup' option is
7359 also on. Reset this option if your file system is almost full. See
7360 |backup-table| for another explanation.
7361 When the 'backupskip' pattern matches, a backup is not made anyway.
7362 NOTE: This option is set to the default value when 'compatible' is
7363 set.
7364
7365 *'writedelay'* *'wd'*
7366'writedelay' 'wd' number (default 0)
7367 global
7368 {not in Vi}
7369 The number of microseconds to wait for each character sent to the
7370 screen. When non-zero, characters are sent to the terminal one by
7371 one. For MS-DOS pcterm this does not work. For debugging purposes.
7372
7373 vim:tw=78:ts=8:ft=help:norl: