blob: b17fba95e280f3ba3428fd320bb980af7f1b9e55 [file] [log] [blame]
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00001*options.txt* For Vim version 7.0aa. Last change: 2006 Feb 27
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*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000130For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131override 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}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001624 A comma separated list of options for Insert mode completion
1625 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001626
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
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001631 longest Only insert the longest common text of the matches. Use
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001632 CTRL-L to add more characters. Whether case is ignored
1633 depends on the kind of completion. For buffer text the
1634 'ignorecase' option is used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001635
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001636
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1638'confirm' 'cf' boolean (default off)
1639 global
1640 {not in Vi}
1641 When 'confirm' is on, certain operations that would normally
1642 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1643 instead raise a |dialog| asking if you wish to save the current
1644 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1645 If 'confirm' is off you can still activate confirmation for one
1646 command only (this is most useful in mappings) with the |:confirm|
1647 command.
1648 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1649
1650 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1651'conskey' 'consk' boolean (default off)
1652 global
1653 {not in Vi} {only for MS-DOS}
1654 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001655 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 three methods of console input are available:
1657 'conskey' 'bioskey' action ~
1658 on on or off direct console input
1659 off on BIOS
1660 off off STDIN
1661
1662 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1663'copyindent' 'ci' boolean (default off)
1664 local to buffer
1665 {not in Vi}
1666 Copy the structure of the existing lines indent when autoindenting a
1667 new line. Normally the new indent is reconstructed by a series of
1668 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1669 in which case only spaces are used). Enabling this option makes the
1670 new line copy whatever characters were used for indenting on the
1671 existing line. If the new indent is greater than on the existing
1672 line, the remaining space is filled in the normal manner.
1673 NOTE: 'copyindent' is reset when 'compatible' is set.
1674 Also see 'preserveindent'.
1675
1676 *'cpoptions'* *'cpo'*
1677'cpoptions' 'cpo' string (Vim default: "aABceFs",
1678 Vi default: all flags)
1679 global
1680 {not in Vi}
1681 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001682 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683 not being vi-compatible is mostly or sometimes preferred.
1684 'cpoptions' stands for "compatible-options".
1685 Commas can be added for readability.
1686 To avoid problems with flags that are added in the future, use the
1687 "+=" and "-=" feature of ":set" |add-option-flags|.
1688 NOTE: This option is set to the Vi default value when 'compatible' is
1689 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001690 NOTE: This option is set to the POSIX default value at startup when
1691 the Vi default value would be used and the $VIM_POSIX environment
1692 variable exists |posix|. This means tries to behave like the POSIX
1693 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694
1695 contains behavior ~
1696 *cpo-a*
1697 a When included, a ":read" command with a file name
1698 argument will set the alternate file name for the
1699 current window.
1700 *cpo-A*
1701 A When included, a ":write" command with a file name
1702 argument will set the alternate file name for the
1703 current window.
1704 *cpo-b*
1705 b "\|" in a ":map" command is recognized as the end of
1706 the map command. The '\' is included in the mapping,
1707 the text after the '|' is interpreted as the next
1708 command. Use a CTRL-V instead of a backslash to
1709 include the '|' in the mapping. Applies to all
1710 mapping, abbreviation, menu and autocmd commands.
1711 See also |map_bar|.
1712 *cpo-B*
1713 B A backslash has no special meaning in mappings,
1714 abbreviations and the "to" part of the menu commands.
1715 Remove this flag to be able to use a backslash like a
1716 CTRL-V. For example, the command ":map X \<Esc>"
1717 results in X being mapped to:
1718 'B' included: "\^[" (^[ is a real <Esc>)
1719 'B' excluded: "<Esc>" (5 characters)
1720 ('<' excluded in both cases)
1721 *cpo-c*
1722 c Searching continues at the end of any match at the
1723 cursor position, but not further than the start of the
1724 next line. When not present searching continues
1725 one character from the cursor position. With 'c'
1726 "abababababab" only gets three matches when repeating
1727 "/abab", without 'c' there are five matches.
1728 *cpo-C*
1729 C Do not concatenate sourced lines that start with a
1730 backslash. See |line-continuation|.
1731 *cpo-d*
1732 d Using "./" in the 'tags' option doesn't mean to use
1733 the tags file relative to the current file, but the
1734 tags file in the current directory.
1735 *cpo-D*
1736 D Can't use CTRL-K to enter a digraph after Normal mode
1737 commands with a character argument, like |r|, |f| and
1738 |t|.
1739 *cpo-e*
1740 e When executing a register with ":@r", always add a
1741 <CR> to the last line, also when the register is not
1742 linewise. If this flag is not present, the register
1743 is not linewise and the last line does not end in a
1744 <CR>, then the last line is put on the command-line
1745 and can be edited before hitting <CR>.
1746 *cpo-E*
1747 E It is an error when using "y", "d", "c", "g~", "gu" or
1748 "gU" on an Empty region. The operators only work when
1749 at least one character is to be operate on. Example:
1750 This makes "y0" fail in the first column.
1751 *cpo-f*
1752 f When included, a ":read" command with a file name
1753 argument will set the file name for the current buffer,
1754 if the current buffer doesn't have a file name yet.
1755 *cpo-F*
1756 F When included, a ":write" command with a file name
1757 argument will set the file name for the current
1758 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001759 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 *cpo-g*
1761 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001762 *cpo-H*
1763 H When using "I" on a line with only blanks, insert
1764 before the last blank. Without this flag insert after
1765 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 *cpo-i*
1767 i When included, interrupting the reading of a file will
1768 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001769 *cpo-I*
1770 I When moving the cursor up or down just after inserting
1771 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 *cpo-j*
1773 j When joining lines, only add two spaces after a '.',
1774 not after '!' or '?'. Also see 'joinspaces'.
1775 *cpo-J*
1776 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001777 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 white space.
1779 *cpo-k*
1780 k Disable the recognition of raw key codes in
1781 mappings, abbreviations, and the "to" part of menu
1782 commands. For example, if <Key> sends ^[OA (where ^[
1783 is <Esc>), the command ":map X ^[OA" results in X
1784 being mapped to:
1785 'k' included: "^[OA" (3 characters)
1786 'k' excluded: "<Key>" (one key code)
1787 Also see the '<' flag below.
1788 *cpo-K*
1789 K Don't wait for a key code to complete when it is
1790 halfway a mapping. This breaks mapping <F1><F1> when
1791 only part of the second <F1> has been read. It
1792 enables cancelling the mapping by typing <F1><Esc>.
1793 *cpo-l*
1794 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001795 literally, only "\]", "\^", "\-" and "\\" are special.
1796 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1798 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001799 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 *cpo-L*
1801 L When the 'list' option is set, 'wrapmargin',
1802 'textwidth', 'softtabstop' and Virtual Replace mode
1803 (see |gR|) count a <Tab> as two characters, instead of
1804 the normal behavior of a <Tab>.
1805 *cpo-m*
1806 m When included, a showmatch will always wait half a
1807 second. When not included, a showmatch will wait half
1808 a second or until a character is typed. |'showmatch'|
1809 *cpo-M*
1810 M When excluded, "%" matching will take backslashes into
1811 account. Thus in "( \( )" and "\( ( \)" the outer
1812 parenthesis match. When included "%" ignores
1813 backslashes, which is Vi compatible.
1814 *cpo-n*
1815 n When included, the column used for 'number' will also
1816 be used for text of wrapped lines.
1817 *cpo-o*
1818 o Line offset to search command is not remembered for
1819 next search.
1820 *cpo-O*
1821 O Don't complain if a file is being overwritten, even
1822 when it didn't exist when editing it. This is a
1823 protection against a file unexpectedly created by
1824 someone else. Vi didn't complain about this.
1825 *cpo-p*
1826 p Vi compatible Lisp indenting. When not present, a
1827 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001828 *cpo-P*
1829 P When included, a ":write" command that appends to a
1830 file will set the file name for the current buffer, if
1831 the current buffer doesn't have a file name yet and
1832 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001833 *cpo-q*
1834 q When joining multiple lines leave the cursor at the
1835 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 *cpo-r*
1837 r Redo ("." command) uses "/" to repeat a search
1838 command, instead of the actually used search string.
1839 *cpo-R*
1840 R Remove marks from filtered lines. Without this flag
1841 marks are kept like |:keepmarks| was used.
1842 *cpo-s*
1843 s Set buffer options when entering the buffer for the
1844 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001845 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 set when the buffer is created.
1847 *cpo-S*
1848 S Set buffer options always when entering a buffer
1849 (except 'readonly', 'fileformat', 'filetype' and
1850 'syntax'). This is the (most) Vi compatible setting.
1851 The options are set to the values in the current
1852 buffer. When you change an option and go to another
1853 buffer, the value is copied. Effectively makes the
1854 buffer options global to all buffers.
1855
1856 's' 'S' copy buffer options
1857 no no when buffer created
1858 yes no when buffer first entered (default)
1859 X yes each time when buffer entered (vi comp.)
1860 *cpo-t*
1861 t Search pattern for the tag command is remembered for
1862 "n" command. Otherwise Vim only puts the pattern in
1863 the history for search pattern, but doesn't change the
1864 last used search pattern.
1865 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001866 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 *cpo-v*
1868 v Backspaced characters remain visible on the screen in
1869 Insert mode. Without this flag the characters are
1870 erased from the screen right away. With this flag the
1871 screen newly typed text overwrites backspaced
1872 characters.
1873 *cpo-w*
1874 w When using "cw" on a blank character, only change one
1875 character and not all blanks until the start of the
1876 next word.
1877 *cpo-W*
1878 W Don't overwrite a readonly file. When omitted, ":w!"
1879 overwrites a readonly file, if possible.
1880 *cpo-x*
1881 x <Esc> on the command-line executes the command-line.
1882 The default in Vim is to abandon the command-line,
1883 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001884 *cpo-X*
1885 X When using a count with "R" the replaced text is
1886 deleted only once. Also when repeating "R" with "."
1887 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 *cpo-y*
1889 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001890 *cpo-Z*
1891 Z When using "w!" while the 'readonly' option is set,
1892 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 *cpo-!*
1894 ! When redoing a filter command, use the last used
1895 external command, whatever it was. Otherwise the last
1896 used -filter- command is used.
1897 *cpo-$*
1898 $ When making a change to one line, don't redisplay the
1899 line, but put a '$' at the end of the changed text.
1900 The changed text will be overwritten when you type the
1901 new text. The line is redisplayed if you type any
1902 command that moves the cursor from the insertion
1903 point.
1904 *cpo-%*
1905 % Vi-compatible matching is done for the "%" command.
1906 Does not recognize "#if", "#endif", etc.
1907 Does not recognize "/*" and "*/".
1908 Parens inside single and double quotes are also
1909 counted, causing a string that contains a paren to
1910 disturb the matching. For example, in a line like
1911 "if (strcmp("foo(", s))" the first paren does not
1912 match the last one. When this flag is not included,
1913 parens inside single and double quotes are treated
1914 specially. When matching a paren outside of quotes,
1915 everything inside quotes is ignored. When matching a
1916 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001917 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001918 This flag is also used for other features, such as
1919 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001920 *cpo--*
1921 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001922 it would go above the first line or below the last
1923 line. Without it the cursor moves to the first or
1924 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001925 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001926 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001927 *cpo-+*
1928 + When included, a ":write file" command will reset the
1929 'modified' flag of the buffer, even though the buffer
1930 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001931 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 * Use ":*" in the same way as ":@". When not included,
1933 ":*" is an alias for ":'<,'>", select the Visual area.
1934 *cpo-<*
1935 < Disable the recognition of special key codes in |<>|
1936 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001937 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938 ":map X <Tab>" results in X being mapped to:
1939 '<' included: "<Tab>" (5 characters)
1940 '<' excluded: "^I" (^I is a real <Tab>)
1941 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001942 *cpo->*
1943 > When appending to a register, put a line break before
1944 the appended text.
1945
1946 POSIX flags. These are not included in the Vi default value, except
1947 when $VIM_POSIX was set on startup. |posix|
1948
1949 contains behavior ~
1950 *cpo-#*
1951 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001952 *cpo-&*
1953 & When ":preserve" was used keep the swap file when
1954 exiting normally while this buffer is still loaded.
1955 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001956 *cpo-\*
1957 \ Backslash in a [] range in a search pattern is taken
1958 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001959 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1960 '\' excluded: "/[ \-]" finds <Space> and '-'
1961 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001962 *cpo-/*
1963 / When "%" is used as the replacement string in a |:s|
1964 command, use the previous replacement string. |:s%|
1965 *cpo-{*
1966 { The |{| and |}| commands also stop at a "{" character
1967 at the start of a line.
1968 *cpo-.*
1969 . The ":chdir" and ":cd" commands fail if the current
1970 buffer is modified, unless ! is used. Vim doesn't
1971 need this, since it remembers the full path of an
1972 opened file.
1973 *cpo-bar*
1974 | The value of the $LINES and $COLUMNS environment
1975 variables overrule the terminal size values obtained
1976 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001977
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978
1979 *'cscopepathcomp'* *'cspc'*
1980'cscopepathcomp' 'cspc' number (default 0)
1981 global
1982 {not available when compiled without the |+cscope|
1983 feature}
1984 {not in Vi}
1985 Determines how many components of the path to show in a list of tags.
1986 See |cscopepathcomp|.
1987
1988 *'cscopeprg'* *'csprg'*
1989'cscopeprg' 'csprg' string (default "cscope")
1990 global
1991 {not available when compiled without the |+cscope|
1992 feature}
1993 {not in Vi}
1994 Specifies the command to execute cscope. See |cscopeprg|.
1995 This option cannot be set from a |modeline| or in the |sandbox|, for
1996 security reasons.
1997
1998 *'cscopequickfix'* *'csqf'*
1999'cscopequickfix' 'csqf' string (default "")
2000 global
2001 {not available when compiled without the |+cscope|
2002 or |+quickfix| features}
2003 {not in Vi}
2004 Specifies whether to use quickfix window to show cscope results.
2005 See |cscopequickfix|.
2006
2007 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2008'cscopetag' 'cst' boolean (default off)
2009 global
2010 {not available when compiled without the |+cscope|
2011 feature}
2012 {not in Vi}
2013 Use cscope for tag commands. See |cscope-options|.
2014 NOTE: This option is reset when 'compatible' is set.
2015
2016 *'cscopetagorder'* *'csto'*
2017'cscopetagorder' 'csto' number (default 0)
2018 global
2019 {not available when compiled without the |+cscope|
2020 feature}
2021 {not in Vi}
2022 Determines the order in which ":cstag" performs a search. See
2023 |cscopetagorder|.
2024 NOTE: This option is set to 0 when 'compatible' is set.
2025
2026 *'cscopeverbose'* *'csverb'*
2027 *'nocscopeverbose'* *'nocsverb'*
2028'cscopeverbose' 'csverb' boolean (default off)
2029 global
2030 {not available when compiled without the |+cscope|
2031 feature}
2032 {not in Vi}
2033 Give messages when adding a cscope database. See |cscopeverbose|.
2034 NOTE: This option is reset when 'compatible' is set.
2035
2036 *'debug'*
2037'debug' string (default "")
2038 global
2039 {not in Vi}
2040 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002041 be given anyway. This is useful when debugging 'foldexpr',
2042 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002043 When set to "beep", a message will be given when otherwise only a beep
2044 would be produced.
2045 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046
2047 *'define'* *'def'*
2048'define' 'def' string (default "^\s*#\s*define")
2049 global or local to buffer |global-local|
2050 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002051 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 pattern, just like for the "/" command. This option is used for the
2053 commands like "[i" and "[d" |include-search|. The 'isident' option is
2054 used to recognize the defined name after the match:
2055 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2056 See |option-backslash| about inserting backslashes to include a space
2057 or backslash.
2058 The default value is for C programs. For C++ this value would be
2059 useful, to include const type declarations: >
2060 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2061< When using the ":set" command, you need to double the backslashes!
2062
2063 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2064'delcombine' 'deco' boolean (default off)
2065 global
2066 {not in Vi}
2067 {only available when compiled with the |+multi_byte|
2068 feature}
2069 If editing Unicode and this option is set, backspace and Normal mode
2070 "x" delete each combining character on its own. When it is off (the
2071 default) the character along with its combining characters are
2072 deleted.
2073 Note: When 'delcombine' is set "xx" may work different from "2x"!
2074
2075 This is useful for Arabic, Hebrew and many other languages where one
2076 may have combining characters overtop of base characters, and want
2077 to remove only the combining ones.
2078
2079 *'dictionary'* *'dict'*
2080'dictionary' 'dict' string (default "")
2081 global or local to buffer |global-local|
2082 {not in Vi}
2083 List of file names, separated by commas, that are used to lookup words
2084 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2085 contain a list of words. This can be one word per line, or several
2086 words per line, separated by non-keyword characters (white space is
2087 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002088 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 after a comma are ignored, otherwise spaces are included in the file
2090 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002091 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 Where to find a list of words?
2093 - On FreeBSD, there is the file "/usr/share/dict/words".
2094 - In the Simtel archive, look in the "msdos/linguist" directory.
2095 - In "miscfiles" of the GNU collection.
2096 The use of |:set+=| and |:set-=| is preferred when adding or removing
2097 directories from the list. This avoids problems when a future version
2098 uses another default.
2099 Backticks cannot be used in this option for security reasons.
2100
2101 *'diff'* *'nodiff'*
2102'diff' boolean (default off)
2103 local to window
2104 {not in Vi}
2105 {not available when compiled without the |+diff|
2106 feature}
2107 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002108 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109
2110 *'dex'* *'diffexpr'*
2111'diffexpr' 'dex' string (default "")
2112 global
2113 {not in Vi}
2114 {not available when compiled without the |+diff|
2115 feature}
2116 Expression which is evaluated to obtain an ed-style diff file from two
2117 versions of a file. See |diff-diffexpr|.
2118 This option cannot be set from a |modeline| or in the |sandbox|, for
2119 security reasons.
2120
2121 *'dip'* *'diffopt'*
2122'diffopt' 'dip' string (default "filler")
2123 global
2124 {not in Vi}
2125 {not available when compiled without the |+diff|
2126 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002127 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 All are optional. Items must be separated by a comma.
2129
2130 filler Show filler lines, to keep the text
2131 synchronized with a window that has inserted
2132 lines at the same position. Mostly useful
2133 when windows are side-by-side and 'scrollbind'
2134 is set.
2135
2136 context:{n} Use a context of {n} lines between a change
2137 and a fold that contains unchanged lines.
2138 When omitted a context of six lines is used.
2139 See |fold-diff|.
2140
2141 icase Ignore changes in case of text. "a" and "A"
2142 are considered the same. Adds the "-i" flag
2143 to the "diff" command if 'diffexpr' is empty.
2144
2145 iwhite Ignore changes in amount of white space. Adds
2146 the "-b" flag to the "diff" command if
2147 'diffexpr' is empty. Check the documentation
2148 of the "diff" command for what this does
2149 exactly. It should ignore adding trailing
2150 white space, but not leading white space.
2151
2152 Examples: >
2153
2154 :set diffopt=filler,context:4
2155 :set diffopt=
2156 :set diffopt=filler
2157<
2158 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2159'digraph' 'dg' boolean (default off)
2160 global
2161 {not in Vi}
2162 {not available when compiled without the |+digraphs|
2163 feature}
2164 Enable the entering of digraphs in Insert mode with {char1} <BS>
2165 {char2}. See |digraphs|.
2166 NOTE: This option is reset when 'compatible' is set.
2167
2168 *'directory'* *'dir'*
2169'directory' 'dir' string (default for Amiga: ".,t:",
2170 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2171 for Unix: ".,~/tmp,/var/tmp,/tmp")
2172 global
2173 List of directory names for the swap file, separated with commas.
2174 - The swap file will be created in the first directory where this is
2175 possible.
2176 - Empty means that no swap file will be used (recovery is
2177 impossible!).
2178 - A directory "." means to put the swap file in the same directory as
2179 the edited file. On Unix, a dot is prepended to the file name, so
2180 it doesn't show in a directory listing. On MS-Windows the "hidden"
2181 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002182 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 put the swap file relative to where the edited file is. The leading
2184 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002185 - For Unix and Win32, if a directory ends in two path separators "//"
2186 or "\\", the swap file name will be built from the complete path to
2187 the file with all path separators substituted to percent '%' signs.
2188 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 - Spaces after the comma are ignored, other spaces are considered part
2190 of the directory name. To have a space at the start of a directory
2191 name, precede it with a backslash.
2192 - To include a comma in a directory name precede it with a backslash.
2193 - A directory name may end in an ':' or '/'.
2194 - Environment variables are expanded |:set_env|.
2195 - Careful with '\' characters, type one before a space, type two to
2196 get one in the option (see |option-backslash|), for example: >
2197 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2198< - For backwards compatibility with Vim version 3.0 a '>' at the start
2199 of the option is removed.
2200 Using "." first in the list is recommended. This means that editing
2201 the same file twice will result in a warning. Using "/tmp" on Unix is
2202 discouraged: When the system crashes you lose the swap file.
2203 "/var/tmp" is often not cleared when rebooting, thus is a better
2204 choice than "/tmp". But it can contain a lot of files, your swap
2205 files get lost in the crowd. That is why a "tmp" directory in your
2206 home directory is tried first.
2207 The use of |:set+=| and |:set-=| is preferred when adding or removing
2208 directories from the list. This avoids problems when a future version
2209 uses another default.
2210 This option cannot be set from a |modeline| or in the |sandbox|, for
2211 security reasons.
2212 {Vi: directory to put temp file in, defaults to "/tmp"}
2213
2214 *'display'* *'dy'*
2215'display' 'dy' string (default "")
2216 global
2217 {not in Vi}
2218 Change the way text is displayed. This is comma separated list of
2219 flags:
2220 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002221 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222 last line that doesn't fit is replaced with "@" lines.
2223 uhex Show unprintable characters hexadecimal as <xx>
2224 instead of using ^C and ~C.
2225
2226 *'eadirection'* *'ead'*
2227'eadirection' 'ead' string (default "both")
2228 global
2229 {not in Vi}
2230 {not available when compiled without the +vertsplit
2231 feature}
2232 Tells when the 'equalalways' option applies:
2233 ver vertically, width of windows is not affected
2234 hor horizontally, height of windows is not affected
2235 both width and height of windows is affected
2236
2237 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2238'edcompatible' 'ed' boolean (default off)
2239 global
2240 Makes the 'g' and 'c' flags of the ":substitute" command to be
2241 toggled each time the flag is given. See |complex-change|. See
2242 also 'gdefault' option.
2243 Switching this option on is discouraged!
2244
2245 *'encoding'* *'enc'* *E543*
2246'encoding' 'enc' string (default: "latin1" or value from $LANG)
2247 global
2248 {only available when compiled with the |+multi_byte|
2249 feature}
2250 {not in Vi}
2251 Sets the character encoding used inside Vim. It applies to text in
2252 the buffers, registers, Strings in expressions, text stored in the
2253 viminfo file, etc. It sets the kind of characters which Vim can work
2254 with. See |encoding-names| for the possible values.
2255
2256 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002257 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 It should normally be kept at its default value, or set when Vim
2259 starts up. See |multibyte|.
2260
2261 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2262 "utf-8". Although care has been taken to allow different values of
2263 'encoding', "utf-8" is the natural choice for the environment and
2264 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002265 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 versions, and to avoid changing the encoding of newly created files
2267 without your knowledge (in case 'fileencodings' is empty).
2268
2269 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002270 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 iconv() or as specified with 'charconvert'.
2272
2273 Normally 'encoding' will be equal to your current locale. This will
2274 be the default if Vim recognizes your environment settings. If
2275 'encoding' is not set to the current locale, 'termencoding' must be
2276 set to convert typed and displayed text. See |encoding-table|.
2277
2278 When you set this option, it fires the |EncodingChanged| autocommand
2279 event so that you can set up fonts if necessary.
2280
2281 When the option is set, the value is converted to lowercase. Thus
2282 you can set it with uppercase values too. Underscores are translated
2283 to '-' signs.
2284 When the encoding is recognized, it is changed to the standard name.
2285 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2286 "iso-8859-2" and "utf8" becomes "utf-8".
2287
2288 Note: "latin1" is also used when the encoding could not be detected.
2289 This only works when editing files in the same encoding! When the
2290 actual character set is not latin1, make sure 'fileencoding' and
2291 'fileencodings' are empty. When conversion is needed, switch to using
2292 utf-8.
2293
2294 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2295 You don't notice this while editing, but it does matter for the
2296 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2297 setting 'encoding' to one of these values instead of utf-8 only has
2298 effect for encoding used for files when 'fileencoding' is empty.
2299
Bram Moolenaar661b1822005-07-28 22:36:45 +00002300 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2301 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302
2303 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2304'endofline' 'eol' boolean (default on)
2305 local to buffer
2306 {not in Vi}
2307 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002308 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 option is automatically set when starting to edit a new file, unless
2310 the file does not have an <EOL> for the last line in the file, in
2311 which case it is reset. Normally you don't have to set or reset this
2312 option. When 'binary' is off the value is not used when writing the
2313 file. When 'binary' is on it is used to remember the presence of a
2314 <EOL> for the last line in the file, so that when you write the file
2315 the situation from the original file can be kept. But you can change
2316 it if you want to.
2317
2318 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2319'equalalways' 'ea' boolean (default on)
2320 global
2321 {not in Vi}
2322 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002323 splitting or closing a window. This also happens the moment the
2324 option is switched on. When off, splitting a window will reduce the
2325 size of the current window and leave the other windows the same. When
2326 closing a window the extra lines are given to the window next to it
2327 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 When mixing vertically and horizontally split windows, a minimal size
2329 is computed and some windows may be larger if there is room. The
2330 'eadirection' option tells in which direction the size is affected.
2331 Changing the height of a window can be avoided by setting
2332 'winfixheight'.
2333
2334 *'equalprg'* *'ep'*
2335'equalprg' 'ep' string (default "")
2336 global or local to buffer |global-local|
2337 {not in Vi}
2338 External program to use for "=" command. When this option is empty
2339 the internal formatting functions are used ('lisp', 'cindent' or
2340 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002341 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342 about including spaces and backslashes.
2343 This option cannot be set from a |modeline| or in the |sandbox|, for
2344 security reasons.
2345
2346 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2347'errorbells' 'eb' boolean (default off)
2348 global
2349 Ring the bell (beep or screen flash) for error messages. This only
2350 makes a difference for error messages, the bell will be used always
2351 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002352 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 screen flash or do nothing.
2354
2355 *'errorfile'* *'ef'*
2356'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2357 others: "errors.err")
2358 global
2359 {not in Vi}
2360 {not available when compiled without the |+quickfix|
2361 feature}
2362 Name of the errorfile for the QuickFix mode (see |:cf|).
2363 When the "-q" command-line argument is used, 'errorfile' is set to the
2364 following argument. See |-q|.
2365 NOT used for the ":make" command. See 'makeef' for that.
2366 Environment variables are expanded |:set_env|.
2367 See |option-backslash| about including spaces and backslashes.
2368 This option cannot be set from a |modeline| or in the |sandbox|, for
2369 security reasons.
2370
2371 *'errorformat'* *'efm'*
2372'errorformat' 'efm' string (default is very long)
2373 global or local to buffer |global-local|
2374 {not in Vi}
2375 {not available when compiled without the |+quickfix|
2376 feature}
2377 Scanf-like description of the format for the lines in the error file
2378 (see |errorformat|).
2379
2380 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2381'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2382 global
2383 {not in Vi}
2384 Function keys that start with an <Esc> are recognized in Insert
2385 mode. When this option is off, the cursor and function keys cannot be
2386 used in Insert mode if they start with an <Esc>. The advantage of
2387 this is that the single <Esc> is recognized immediately, instead of
2388 after one second. Instead of resetting this option, you might want to
2389 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2390 when 'esckeys' is off, you can still map anything, but the cursor keys
2391 won't work by default.
2392 NOTE: This option is set to the Vi default value when 'compatible' is
2393 set and to the Vim default value when 'compatible' is reset.
2394
2395 *'eventignore'* *'ei'*
2396'eventignore' 'ei' string (default "")
2397 global
2398 {not in Vi}
2399 {not available when compiled without the |+autocmd|
2400 feature}
2401 A list of autocommand event names, which are to be ignored.
2402 When set to "all", all autocommand events are ignored, autocommands
2403 will not be executed.
2404 Otherwise this is a comma separated list of event names. Example: >
2405 :set ei=WinEnter,WinLeave
2406<
2407 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2408'expandtab' 'et' boolean (default off)
2409 local to buffer
2410 {not in Vi}
2411 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002412 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2414 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2415 NOTE: This option is reset when 'compatible' is set.
2416
2417 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2418'exrc' 'ex' boolean (default off)
2419 global
2420 {not in Vi}
2421 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2422 directory. If you switch this option on you should also consider
2423 setting the 'secure' option (see |initialization|). Using a local
2424 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2425 also see |.vimrc| and |gui-init|.
2426 This option cannot be set from a |modeline| or in the |sandbox|, for
2427 security reasons.
2428
2429 *'fileencoding'* *'fenc'* *E213*
2430'fileencoding' 'fenc' string (default: "")
2431 local to buffer
2432 {only available when compiled with the |+multi_byte|
2433 feature}
2434 {not in Vi}
2435 Sets the character encoding for the file of this buffer.
2436 When 'fileencoding' is different from 'encoding', conversion will be
2437 done when reading and writing the file.
2438 When 'fileencoding' is empty, the same value as 'encoding' will be
2439 used (no conversion when reading or writing a file).
2440 WARNING: Conversion can cause loss of information! When
2441 'encoding' is "utf-8" conversion is most likely done in a way
2442 that the reverse conversion results in the same text. When
2443 'encoding' is not "utf-8" some characters may be lost!
2444 See 'encoding' for the possible values. Additionally, values may be
2445 specified that can be handled by the converter, see
2446 |mbyte-conversion|.
2447 When reading a file 'fileencoding' will be set from 'fileencodings'.
2448 To read a file in a certain encoding it won't work by setting
2449 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002450 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2452 When the option is set, the value is converted to lowercase. Thus
2453 you can set it with uppercase values too. '_' characters are
2454 replaced with '-'. If a name is recognized from the list for
2455 'encoding', it is replaced by the standard name. For example
2456 "ISO8859-2" becomes "iso-8859-2".
2457 When this option is set, after starting to edit a file, the 'modified'
2458 option is set, because the file would be different when written.
2459 If you do this in a modeline, you might want to set 'nomodified' to
2460 avoid this.
2461 This option can not be changed when 'modifiable' is off.
2462
2463 *'fe'*
2464 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002465 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466 old short name was 'fe', which is no longer used.
2467
2468 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002469'fileencodings' 'fencs' string (default: "ucs-bom",
2470 "ucs-bom,utf-8,default,latin1" when
2471 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 global
2473 {only available when compiled with the |+multi_byte|
2474 feature}
2475 {not in Vi}
2476 This is a list of character encodings considered when starting to edit
2477 an existing file. When a file is read, Vim tries to use the first
2478 mentioned character encoding. If an error is detected, the next one
2479 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002480 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 an empty string, which means the value of 'encoding' is used.
2482 WARNING: Conversion can cause loss of information! When
2483 'encoding' is "utf-8" (or one of the other Unicode variants)
2484 conversion is most likely done in a way that the reverse
2485 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002486 "utf-8" some non-ASCII characters may be lost! You can use
2487 the |++bad| argument to specify what is done with characters
2488 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 For an empty file or a file with only ASCII characters most encodings
2490 will work and the first entry of 'fileencodings' will be used (except
2491 "ucs-bom", which requires the BOM to be present). If you prefer
2492 another encoding use an BufReadPost autocommand event to test if your
2493 preferred encoding is to be used. Example: >
2494 au BufReadPost * if search('\S', 'w') == 0 |
2495 \ set fenc=iso-2022-jp | endif
2496< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2497 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002498 When the |++enc| argument is used then the value of 'fileencodings' is
2499 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002500 Note that 'fileencodings' is not used for a new file, the global value
2501 of 'fileencoding' is used instead. You can set it with: >
2502 :setglobal fenc=iso-8859-2
2503< This means that a non-existing file may get a different encoding than
2504 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505 The special value "ucs-bom" can be used to check for a Unicode BOM
2506 (Byte Order Mark) at the start of the file. It must not be preceded
2507 by "utf-8" or another Unicode encoding for this to work properly.
2508 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2509 because Vim cannot detect an error, thus the encoding is always
2510 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002511 The special value "default" can be used for the encoding from the
2512 environment. This is the default value for 'encoding'. It is useful
2513 when 'encoding' is set to "utf-8" and your environment uses a
2514 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 WRONG VALUES: WHAT'S WRONG:
2516 latin1,utf-8 "latin1" will always be used
2517 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2518 file
2519 cp1250,latin1 "cp1250" will always be used
2520 If 'fileencodings' is empty, 'fileencoding' is not modified.
2521 See 'fileencoding' for the possible values.
2522 Setting this option does not have an effect until the next time a file
2523 is read.
2524
2525 *'fileformat'* *'ff'*
2526'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2527 Unix default: "unix",
2528 Macintosh default: "mac")
2529 local to buffer
2530 {not in Vi}
2531 This gives the <EOL> of the current buffer, which is used for
2532 reading/writing the buffer from/to a file:
2533 dos <CR> <NL>
2534 unix <NL>
2535 mac <CR>
2536 When "dos" is used, CTRL-Z at the end of a file is ignored.
2537 See |file-formats| and |file-read|.
2538 For the character encoding of the file see 'fileencoding'.
2539 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2540 works like it was set to "unix'.
2541 This option is set automatically when starting to edit a file and
2542 'fileformats' is not empty and 'binary' is off.
2543 When this option is set, after starting to edit a file, the 'modified'
2544 option is set, because the file would be different when written.
2545 This option can not be changed when 'modifiable' is off.
2546 For backwards compatibility: When this option is set to "dos",
2547 'textmode' is set, otherwise 'textmode' is reset.
2548
2549 *'fileformats'* *'ffs'*
2550'fileformats' 'ffs' string (default:
2551 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2552 Vim Unix: "unix,dos",
2553 Vim Mac: "mac,unix,dos",
2554 Vi Cygwin: "unix,dos",
2555 Vi others: "")
2556 global
2557 {not in Vi}
2558 This gives the end-of-line (<EOL>) formats that will be tried when
2559 starting to edit a new buffer and when reading a file into an existing
2560 buffer:
2561 - When empty, the format defined with 'fileformat' will be used
2562 always. It is not set automatically.
2563 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002564 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 'fileformats' name will be used when a file is read into an existing
2566 buffer, no matter what 'fileformat' for that buffer is set to.
2567 - When more than one name is present, separated by commas, automatic
2568 <EOL> detection will be done when reading a file. When starting to
2569 edit a file, a check is done for the <EOL>:
2570 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2571 'fileformat' is set to "dos".
2572 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002573 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 preceding <CR>, "unix" is preferred over "dos".
2575 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2576 This means that "mac" is only chosen when "unix" is not present,
2577 or when no <NL> is found in the file, and when "dos" is not
2578 present, or no <CR><NL> is present in the file.
2579 Also if "unix" was first chosen, but the first <CR> is before
2580 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2581 the file, then 'fileformat' is set to "mac".
2582 4. If 'fileformat' is still not set, the first name from
2583 'fileformats' is used.
2584 When reading a file into an existing buffer, the same is done, but
2585 this happens like 'fileformat' has been set appropriately for that
2586 file only, the option is not changed.
2587 When 'binary' is set, the value of 'fileformats' is not used.
2588
2589 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2590 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2591 done:
2592 - When 'fileformats' is empty, there is no automatic detection. Dos
2593 format will be used.
2594 - When 'fileformats' is set to one or more names, automatic detection
2595 is done. This is based on the first <NL> in the file: If there is a
2596 <CR> in front of it, Dos format is used, otherwise Unix format is
2597 used.
2598 Also see |file-formats|.
2599 For backwards compatibility: When this option is set to an empty
2600 string or one format (no comma is included), 'textauto' is reset,
2601 otherwise 'textauto' is set.
2602 NOTE: This option is set to the Vi default value when 'compatible' is
2603 set and to the Vim default value when 'compatible' is reset.
2604
2605 *'filetype'* *'ft'*
2606'filetype' 'ft' string (default: "")
2607 local to buffer
2608 {not in Vi}
2609 {not available when compiled without the |+autocmd|
2610 feature}
2611 When this option is set, the FileType autocommand event is triggered.
2612 All autocommands that match with the value of this option will be
2613 executed. Thus the value of 'filetype' is used in place of the file
2614 name.
2615 Otherwise this option does not always reflect the current file type.
2616 This option is normally set when the file type is detected. To enable
2617 this use the ":filetype on" command. |:filetype|
2618 Setting this option to a different value is most useful in a modeline,
2619 for a file for which the file type is not automatically recognized.
2620 Example, for in an IDL file: >
2621 /* vim: set filetype=idl : */
2622< |FileType| |filetypes|
2623 Do not confuse this option with 'osfiletype', which is for the file
2624 type that is actually stored with the file.
2625 This option is not copied to another buffer, independent of the 's' or
2626 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002627 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628
2629 *'fillchars'* *'fcs'*
2630'fillchars' 'fcs' string (default "vert:|,fold:-")
2631 global
2632 {not in Vi}
2633 {not available when compiled without the |+windows|
2634 and |+folding| features}
2635 Characters to fill the statuslines and vertical separators.
2636 It is a comma separated list of items:
2637
2638 item default Used for ~
2639 stl:c ' ' or '^' statusline of the current window
2640 stlnc:c ' ' or '-' statusline of the non-current windows
2641 vert:c '|' vertical separators |:vsplit|
2642 fold:c '-' filling 'foldtext'
2643 diff:c '-' deleted lines of the 'diff' option
2644
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002645 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646 "stlnc" the space will be used when there is highlighting, '^' or '-'
2647 otherwise.
2648
2649 Example: >
2650 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2651< This is similar to the default, except that these characters will also
2652 be used when there is highlighting.
2653
2654 The highlighting used for these items:
2655 item highlight group ~
2656 stl:c StatusLine |hl-StatusLine|
2657 stlnc:c StatusLineNC |hl-StatusLineNC|
2658 vert:c VertSplit |hl-VertSplit|
2659 fold:c Folded |hl-Folded|
2660 diff:c DiffDelete |hl-DiffDelete|
2661
2662 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2663'fkmap' 'fk' boolean (default off) *E198*
2664 global
2665 {not in Vi}
2666 {only available when compiled with the |+rightleft|
2667 feature}
2668 When on, the keyboard is mapped for the Farsi character set.
2669 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002670 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671
2672 *'foldclose'* *'fcl'*
2673'foldclose' 'fcl' string (default "")
2674 global
2675 {not in Vi}
2676 {not available when compiled without the |+folding|
2677 feature}
2678 When set to "all", a fold is closed when the cursor isn't in it and
2679 its level is higher than 'foldlevel'. Useful if you want folds to
2680 automatically close when moving out of them.
2681
2682 *'foldcolumn'* *'fdc'*
2683'foldcolumn' 'fdc' number (default 0)
2684 local to window
2685 {not in Vi}
2686 {not available when compiled without the |+folding|
2687 feature}
2688 When non-zero, a column with the specified width is shown at the side
2689 of the window which indicates open and closed folds. The maximum
2690 value is 12.
2691 See |folding|.
2692
2693 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2694'foldenable' 'fen' boolean (default on)
2695 local to window
2696 {not in Vi}
2697 {not available when compiled without the |+folding|
2698 feature}
2699 When off, all folds are open. This option can be used to quickly
2700 switch between showing all text unfolded and viewing the text with
2701 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002702 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 'foldenable' is off.
2704 This option is set by commands that create a new fold or close a fold.
2705 See |folding|.
2706
2707 *'foldexpr'* *'fde'*
2708'foldexpr' 'fde' string (default: "0")
2709 local to window
2710 {not in Vi}
2711 {not available when compiled without the |+folding|
2712 or |+eval| feature}
2713 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002714 for each line to obtain its fold level. See |fold-expr|.
2715
2716 The expression may be evaluated in the |sandbox|, see
2717 |sandbox-option|.
2718
2719 It is not allowed to change text or jump to another window while
2720 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721
2722 *'foldignore'* *'fdi'*
2723'foldignore' 'fdi' string (default: "#")
2724 local to window
2725 {not in Vi}
2726 {not available when compiled without the |+folding|
2727 feature}
2728 Used only when 'foldmethod' is "indent". Lines starting with
2729 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002730 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 The default "#" works well for C programs. See |fold-indent|.
2732
2733 *'foldlevel'* *'fdl'*
2734'foldlevel' 'fdl' number (default: 0)
2735 local to window
2736 {not in Vi}
2737 {not available when compiled without the |+folding|
2738 feature}
2739 Sets the fold level: Folds with a higher level will be closed.
2740 Setting this option to zero will close all folds. Higher numbers will
2741 close fewer folds.
2742 This option is set by commands like |zm|, |zM| and |zR|.
2743 See |fold-foldlevel|.
2744
2745 *'foldlevelstart'* *'fdls'*
2746'foldlevelstart' 'fdls' number (default: -1)
2747 global
2748 {not in Vi}
2749 {not available when compiled without the |+folding|
2750 feature}
2751 Sets 'foldlevel' when starting to edit another buffer in a window.
2752 Useful to always start editing with all folds closed (value zero),
2753 some folds closed (one) or no folds closed (99).
2754 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002755 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 ignores this option and closes all folds.
2757 It is also done before BufReadPre autocommands, to allow an autocmd to
2758 overrule the 'foldlevel' value for specific files.
2759 When the value is negative, it is not used.
2760
2761 *'foldmarker'* *'fmr'* *E536*
2762'foldmarker' 'fmr' string (default: "{{{,}}}")
2763 local to window
2764 {not in Vi}
2765 {not available when compiled without the |+folding|
2766 feature}
2767 The start and end marker used when 'foldmethod' is "marker". There
2768 must be one comma, which separates the start and end marker. The
2769 marker is a literal string (a regular expression would be too slow).
2770 See |fold-marker|.
2771
2772 *'foldmethod'* *'fdm'*
2773'foldmethod' 'fdm' string (default: "manual")
2774 local to window
2775 {not in Vi}
2776 {not available when compiled without the |+folding|
2777 feature}
2778 The kind of folding used for the current window. Possible values:
2779 |fold-manual| manual Folds are created manually.
2780 |fold-indent| indent Lines with equal indent form a fold.
2781 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2782 |fold-marker| marker Markers are used to specify folds.
2783 |fold-syntax| syntax Syntax highlighting items specify folds.
2784 |fold-diff| diff Fold text that is not changed.
2785
2786 *'foldminlines'* *'fml'*
2787'foldminlines' 'fml' number (default: 1)
2788 local to window
2789 {not in Vi}
2790 {not available when compiled without the |+folding|
2791 feature}
2792 Sets the minimum number of screen lines for a fold to be displayed
2793 closed. Also for manually closed folds.
2794 Note that this only has an effect of what is displayed. After using
2795 "zc" to close a fold, which is displayed open because it's smaller
2796 than 'foldminlines', a following "zc" may close a containing fold.
2797
2798 *'foldnestmax'* *'fdn'*
2799'foldnestmax' 'fdn' number (default: 20)
2800 local to window
2801 {not in Vi}
2802 {not available when compiled without the |+folding|
2803 feature}
2804 Sets the maximum nesting of folds for the "indent" and "syntax"
2805 methods. This avoids that too many folds will be created. Using more
2806 than 20 doesn't work, because the internal limit is 20.
2807
2808 *'foldopen'* *'fdo'*
2809'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2810 search,tag,undo")
2811 global
2812 {not in Vi}
2813 {not available when compiled without the |+folding|
2814 feature}
2815 Specifies for which type of commands folds will be opened, if the
2816 command moves the cursor into a closed fold. It is a comma separated
2817 list of items.
2818 item commands ~
2819 all any
2820 block "(", "{", "[[", "[{", etc.
2821 hor horizontal movements: "l", "w", "fx", etc.
2822 insert any command in Insert mode
2823 jump far jumps: "G", "gg", etc.
2824 mark jumping to a mark: "'m", CTRL-O, etc.
2825 percent "%"
2826 quickfix ":cn", ":crew", ":make", etc.
2827 search search for a pattern: "/", "n", "*", "gd", etc.
2828 (not for a search pattern in a ":" command)
2829 tag jumping to a tag: ":ta", CTRL-T, etc.
2830 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002831 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832 the |zv| command to the mapping to get the same effect.
2833 When a movement command is used for an operator (e.g., "dl" or "y%")
2834 this option is not used. This means the operator will include the
2835 whole closed fold.
2836 Note that vertical movements are not here, because it would make it
2837 very difficult to move onto a closed fold.
2838 In insert mode the folds containing the cursor will always be open
2839 when text is inserted.
2840 To close folds you can re-apply 'foldlevel' with the |zx| command or
2841 set the 'foldclose' option to "all".
2842
2843 *'foldtext'* *'fdt'*
2844'foldtext' 'fdt' string (default: "foldtext()")
2845 local to window
2846 {not in Vi}
2847 {not available when compiled without the |+folding|
2848 feature}
2849 An expression which is used to specify the text displayed for a closed
2850 fold. See |fold-foldtext|.
2851
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002852 The expression may be evaluated in the |sandbox|, see
2853 |sandbox-option|.
2854
2855 It is not allowed to change text or jump to another window while
2856 evaluating 'foldtext' |textlock|.
2857
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 *'formatoptions'* *'fo'*
2859'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2860 local to buffer
2861 {not in Vi}
2862 This is a sequence of letters which describes how automatic
2863 formatting is to be done. See |fo-table|. When the 'paste' option is
2864 on, no formatting is done (like 'formatoptions' is empty). Commas can
2865 be inserted for readability.
2866 To avoid problems with flags that are added in the future, use the
2867 "+=" and "-=" feature of ":set" |add-option-flags|.
2868 NOTE: This option is set to the Vi default value when 'compatible' is
2869 set and to the Vim default value when 'compatible' is reset.
2870
Bram Moolenaar86b68352004-12-27 21:59:20 +00002871 *'formatlistpat'* *'flp'*
2872'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2873 local to buffer
2874 {not in Vi}
2875 A pattern that is used to recognize a list header. This is used for
2876 the "n" flag in 'formatoptions'.
2877 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002878 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002879 while still checking more characters. There must be a character
2880 following the pattern, when it matches the whole line it is handled
2881 like there is no match.
2882 The default recognizes a number, followed by an optional punctuation
2883 character and white space.
2884
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 *'formatprg'* *'fp'*
2886'formatprg' 'fp' string (default "")
2887 global
2888 {not in Vi}
2889 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002890 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002892 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002893 If the 'formatexpr' option is not empty it will be used instead.
2894 Otherwise, if 'formatprg' option is an empty string, the internal
2895 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002896 Environment variables are expanded |:set_env|. See |option-backslash|
2897 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002898 The expression may be evaluated in the |sandbox|, see
2899 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002901 *'formatexpr'* *'fex'*
2902'formatexpr' 'fex' string (default "")
2903 local to buffer
2904 {not in Vi}
2905 {not available when compiled without the |+eval|
2906 feature}
2907 Expression which is evaluated to format a range of lines for the |gq|
2908 operator. The |v:lnum| variable holds the first line to be formatted,
2909 |v:count| the number of lines to be formatted.
2910 When this option is empty 'formatprg' is used.
2911 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002912 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002913< This will invoke the mylang#Format() function in the
2914 autoload/mylang.vim file in 'runtimepath'. |autoload|
2915
2916 The expression is also evaluated when 'textwidth' is set and adding
2917 text beyond that limit. This happens under the same conditions as
2918 when internal formatting is used. Make sure the cursor is kept in the
2919 same spot relative to the text then! The |mode()| function will
2920 return "i" or "R" in this situation. When the function returns
2921 non-zero Vim will fall back to using the internal format mechanism.
2922
2923 The expression may be evaluated in the |sandbox|, see
2924 |sandbox-option|.
2925
2926 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002927'fsync' 'fs' boolean (default on)
2928 global
2929 {not in Vi}
2930 When on, the library function fsync() will be called after writing a
2931 file. This will flush a file to disk, ensuring that it is safely
2932 written even on filesystems which do metadata-only journaling. This
2933 will force the harddrive to spin up on Linux systems running in laptop
2934 mode, so it may be undesirable in some situations. Be warned that
2935 turning this off increases the chances of data loss after a crash. On
2936 systems without an fsync() implementation, this variable is always
2937 off.
2938 Also see 'swapsync' for controlling fsync() on swap files.
2939
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2941'gdefault' 'gd' boolean (default off)
2942 global
2943 {not in Vi}
2944 When on, the ":substitute" flag 'g' is default on. This means that
2945 all matches in a line are substituted instead of one. When a 'g' flag
2946 is given to a ":substitute" command, this will toggle the substitution
2947 of all or one match. See |complex-change|.
2948
2949 command 'gdefault' on 'gdefault' off ~
2950 :s/// subst. all subst. one
2951 :s///g subst. one subst. all
2952 :s///gg subst. all subst. one
2953
2954 NOTE: This option is reset when 'compatible' is set.
2955
2956 *'grepformat'* *'gfm'*
2957'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2958 global
2959 {not in Vi}
2960 Format to recognize for the ":grep" command output.
2961 This is a scanf-like string that uses the same format as the
2962 'errorformat' option: see |errorformat|.
2963
2964 *'grepprg'* *'gp'*
2965'grepprg' 'gp' string (default "grep -n ",
2966 Unix: "grep -n $* /dev/null",
2967 Win32: "findstr /n" or "grep -n",
2968 VMS: "SEARCH/NUMBERS ")
2969 global or local to buffer |global-local|
2970 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002971 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 and '#' characters, which are expanded like when used in a command-
2973 line. The placeholder "$*" is allowed to specify where the arguments
2974 will be included. Environment variables are expanded |:set_env|. See
2975 |option-backslash| about including spaces and backslashes.
2976 When your "grep" accepts the "-H" argument, use this to make ":grep"
2977 also work well with a single file: >
2978 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002979< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00002980 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
2981 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002982 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 apply equally to 'grepprg'.
2984 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2985 otherwise it's "grep -n".
2986 This option cannot be set from a |modeline| or in the |sandbox|, for
2987 security reasons.
2988
2989 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2990'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2991 ve:ver35-Cursor,
2992 o:hor50-Cursor,
2993 i-ci:ver25-Cursor/lCursor,
2994 r-cr:hor20-Cursor/lCursor,
2995 sm:block-Cursor
2996 -blinkwait175-blinkoff150-blinkon175",
2997 for MS-DOS and Win32 console:
2998 "n-v-c:block,o:hor50,i-ci:hor15,
2999 r-cr:hor30,sm:block")
3000 global
3001 {not in Vi}
3002 {only available when compiled with GUI enabled, and
3003 for MS-DOS and Win32 console}
3004 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003005 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 the height of the cursor can be changed. This can be done by
3007 specifying a block cursor, or a percentage for a vertical or
3008 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003009 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003011 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 mode-list and an argument-list:
3013 mode-list:argument-list,mode-list:argument-list,..
3014 The mode-list is a dash separated list of these modes:
3015 n Normal mode
3016 v Visual mode
3017 ve Visual mode with 'selection' "exclusive" (same as 'v',
3018 if not specified)
3019 o Operator-pending mode
3020 i Insert mode
3021 r Replace mode
3022 c Command-line Normal (append) mode
3023 ci Command-line Insert mode
3024 cr Command-line Replace mode
3025 sm showmatch in Insert mode
3026 a all modes
3027 The argument-list is a dash separated list of these arguments:
3028 hor{N} horizontal bar, {N} percent of the character height
3029 ver{N} vertical bar, {N} percent of the character width
3030 block block cursor, fills the whole character
3031 [only one of the above three should be present]
3032 blinkwait{N} *cursor-blinking*
3033 blinkon{N}
3034 blinkoff{N}
3035 blink times for cursor: blinkwait is the delay before
3036 the cursor starts blinking, blinkon is the time that
3037 the cursor is shown and blinkoff is the time that the
3038 cursor is not shown. The times are in msec. When one
3039 of the numbers is zero, there is no blinking. The
3040 default is: "blinkwait700-blinkon400-blinkoff250".
3041 These numbers are used for a missing entry. This
3042 means that blinking is enabled by default. To switch
3043 blinking off you can use "blinkon0". The cursor only
3044 blinks when Vim is waiting for input, not while
3045 executing a command.
3046 To make the cursor blink in an xterm, see
3047 |xterm-blink|.
3048 {group-name}
3049 a highlight group name, that sets the color and font
3050 for the cursor
3051 {group-name}/{group-name}
3052 Two highlight group names, the first is used when
3053 no language mappings are used, the other when they
3054 are. |language-mapping|
3055
3056 Examples of parts:
3057 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3058 block cursor with colors from the "nCursor"
3059 highlight group
3060 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3061 In Insert and Command-line Insert mode, use a
3062 30% vertical bar cursor with colors from the
3063 "iCursor" highlight group. Blink a bit
3064 faster.
3065
3066 The 'a' mode is different. It will set the given argument-list for
3067 all modes. It does not reset anything to defaults. This can be used
3068 to do a common setting for all modes. For example, to switch off
3069 blinking: "a:blinkon0"
3070
3071 Examples of cursor highlighting: >
3072 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3073 :highlight Cursor gui=NONE guifg=bg guibg=fg
3074<
3075 *'guifont'* *'gfn'*
3076 *E235* *E596* *E610* *E611*
3077'guifont' 'gfn' string (default "")
3078 global
3079 {not in Vi}
3080 {only available when compiled with GUI enabled}
3081 This is a list of fonts which will be used for the GUI version of Vim.
3082 In its simplest form the value is just one font name. When
3083 the font cannot be found you will get an error message. To try other
3084 font names a list can be specified, font names separated with commas.
3085 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003086
Bram Moolenaar05159a02005-02-26 23:04:13 +00003087 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3088 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003089
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 Spaces after a comma are ignored. To include a comma in a font name
3091 precede it with a backslash. Setting an option requires an extra
3092 backslash before a space and a backslash. See also
3093 |option-backslash|. For example: >
3094 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003095< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003097
3098 If none of the fonts can be loaded, Vim will keep the current setting.
3099 If an empty font list is given, Vim will try using other resource
3100 settings (for X, it will use the Vim.font resource), and finally it
3101 will try some builtin default which should always be there ("7x13" in
3102 the case of X). The font names given should be "normal" fonts. Vim
3103 will try to find the related bold and italic fonts.
3104
Bram Moolenaar05159a02005-02-26 23:04:13 +00003105 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003106 :set guifont=*
3107< will bring up a font requester, where you can pick the font you want.
3108
3109 The font name depends on the GUI used. See |setting-guifont| for a
3110 way to set 'guifont' for various systems.
3111
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 For the GTK+ 2 GUI the font name looks like this: >
3113 :set guifont=Andale\ Mono\ 11
3114< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003115
3116 For Mac OSX you can use something like this: >
3117 :set guifont=Monaco:h10
3118< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003120 width). An exception is GTK 2: all fonts are accepted, but
3121 mono-spaced fonts look best.
3122
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 To preview a font on X11, you might be able to use the "xfontsel"
3124 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003125
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 For the Win32 GUI *E244* *E245*
3127 - takes these options in the font name:
3128 hXX - height is XX (points, can be floating-point)
3129 wXX - width is XX (points, can be floating-point)
3130 b - bold
3131 i - italic
3132 u - underline
3133 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003134 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3136 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3137 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003138 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139
3140 Use a ':' to separate the options.
3141 - A '_' can be used in the place of a space, so you don't need to use
3142 backslashes to escape the spaces.
3143 - Examples: >
3144 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3145 :set guifont=Andale_Mono:h7.5:w4.5
3146< See also |font-sizes|.
3147
3148 *'guifontset'* *'gfs'*
3149 *E250* *E252* *E234* *E597* *E598*
3150'guifontset' 'gfs' string (default "")
3151 global
3152 {not in Vi}
3153 {only available when compiled with GUI enabled and
3154 with the |+xfontset| feature}
3155 {not available in the GTK+ 2 GUI}
3156 When not empty, specifies two (or more) fonts to be used. The first
3157 one for normal English, the second one for your special language. See
3158 |xfontset|.
3159 Setting this option also means that all font names will be handled as
3160 a fontset name. Also the ones used for the "font" argument of the
3161 |:highlight| command.
3162 The fonts must match with the current locale. If fonts for the
3163 character sets that the current locale uses are not included, setting
3164 'guifontset' will fail.
3165 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3166 the comma-separated names are alternative names, one of which will be
3167 used. In 'guifontset' the whole string is one fontset name,
3168 including the commas. It is not possible to specify alternative
3169 fontset names.
3170 This example works on many X11 systems: >
3171 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3172<
3173 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3174'guifontwide' 'gfw' string (default "")
3175 global
3176 {not in Vi}
3177 {only available when compiled with GUI enabled}
3178 When not empty, specifies a comma-separated list of fonts to be used
3179 for double-width characters. The first font that can be loaded is
3180 used.
3181 Note: The size of these fonts must be exactly twice as wide as the one
3182 specified with 'guifont' and the same height.
3183
3184 All GUI versions but GTK+ 2:
3185
3186 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3187 'guifontset' is empty or invalid.
3188 When 'guifont' is set and a valid font is found in it and
3189 'guifontwide' is empty Vim will attempt to find a matching
3190 double-width font and set 'guifontwide' to it.
3191
3192 GTK+ 2 GUI only: *guifontwide_gtk2*
3193
3194 If set and valid, 'guifontwide' is always used for double width
3195 characters, even if 'encoding' is not set to "utf-8".
3196 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003197 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 font for characters not available in 'guifont'. Thus you do not need
3199 to set 'guifontwide' at all unless you want to override the choice
3200 made by Pango/Xft.
3201
3202 *'guiheadroom'* *'ghr'*
3203'guiheadroom' 'ghr' number (default 50)
3204 global
3205 {not in Vi} {only for GTK and X11 GUI}
3206 The number of pixels subtracted from the screen height when fitting
3207 the GUI window on the screen. Set this before the GUI is started,
3208 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003209 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 lines will be left for window decorations and other items on the
3211 screen. Set it to a negative value to allow windows taller than the
3212 screen.
3213
3214 *'guioptions'* *'go'*
3215'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003216 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 global
3218 {not in Vi}
3219 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003220 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 sequence of letters which describes what components and options of the
3222 GUI should be used.
3223 To avoid problems with flags that are added in the future, use the
3224 "+=" and "-=" feature of ":set" |add-option-flags|.
3225
3226 Valid letters are as follows:
3227 *guioptions_a*
3228 'a' Autoselect: If present, then whenever VISUAL mode is started,
3229 or the Visual area extended, Vim tries to become the owner of
3230 the windowing system's global selection. This means that the
3231 Visually highlighted text is available for pasting into other
3232 applications as well as into Vim itself. When the Visual mode
3233 ends, possibly due to an operation on the text, or when an
3234 application wants to paste the selection, the highlighted text
3235 is automatically yanked into the "* selection register.
3236 Thus the selection is still available for pasting into other
3237 applications after the VISUAL mode has ended.
3238 If not present, then Vim won't become the owner of the
3239 windowing system's global selection unless explicitly told to
3240 by a yank or delete operation for the "* register.
3241 The same applies to the modeless selection.
3242
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003243 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 applies to the modeless selection.
3245
3246 'guioptions' autoselect Visual autoselect modeless ~
3247 "" - -
3248 "a" yes yes
3249 "A" - yes
3250 "aA" yes yes
3251
3252 'c' Use console dialogs instead of popup dialogs for simple
3253 choices.
3254
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003255 'e' Add tab pages when indicated with 'showtabpages'.
3256 'guitablabel' can be used to change the text in the labels.
3257 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003258
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 'f' Foreground: Don't use fork() to detach the GUI from the shell
3260 where it was started. Use this for programs that wait for the
3261 editor to finish (e.g., an e-mail program). Alternatively you
3262 can use "gvim -f" or ":gui -f" to start the GUI in the
3263 foreground. |gui-fork|
3264 Note: Set this option in the vimrc file. The forking may have
3265 happened already when the gvimrc file is read.
3266
3267 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3268 corner of the window. It's black&white on non-GTK, because of
3269 limitations of X11. For a color icon, see |X11-icon|.
3270
3271 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003272 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 that this flag must be added in the .vimrc file, before
3274 switching on syntax or filetype recognition (when the .gvimrc
3275 file is sourced the system menu has already been loaded; the
3276 ":syntax on" and ":filetype on" commands load the menu too).
3277 'g' Grey menu items: Make menu items that are not active grey. If
3278 'g' is not included inactive menu items are not shown at all.
3279 Exception: Athena will always use grey menu items.
3280
3281 't' Include tearoff menu items. Currently only works for Win32,
3282 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003283 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3284 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285
3286 'r' Right-hand scrollbar is always present.
3287 'R' Right-hand scrollbar is present when there is a vertically
3288 split window.
3289 'l' Left-hand scrollbar is always present.
3290 'L' Left-hand scrollbar is present when there is a vertically
3291 split window.
3292 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3293 the longest visible line, or on the cursor line if the 'h'
3294 flag is included. |gui-horiz-scroll|
3295 'h' Limit horizontal scrollbar size to the length of the cursor
3296 line. Reduces computations. |gui-horiz-scroll|
3297
3298 And yes, you may even have scrollbars on the left AND the right if
3299 you really want to :-). See |gui-scrollbars| for more information.
3300
3301 'v' Use a vertical button layout for dialogs. When not included,
3302 a horizontal layout is preferred, but when it doesn't fit a
3303 vertical layout is used anyway.
3304 'p' Use Pointer callbacks for X11 GUI. This is required for some
3305 window managers. If the cursor is not blinking or hollow at
3306 the right moment, try adding this flag. This must be done
3307 before starting the GUI. Set it in your gvimrc. Adding or
3308 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003309 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310
3311 *'guipty'* *'noguipty'*
3312'guipty' boolean (default on)
3313 global
3314 {not in Vi}
3315 {only available when compiled with GUI enabled}
3316 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3317 I/O to/from shell commands. See |gui-pty|.
3318
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003319 *'guitablabel'* *'gtl'*
3320'guitablabel' 'gtl' string (default empty)
3321 global
3322 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003323 {only available when compiled with GUI enabled and
3324 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003325 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003326 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003327 |setting-guitablabel| for more info.
3328
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003329 The format of this option is like that of 'statusline'.
3330
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003331 Only used when the GUI tab pages line is displayed. 'e' must be
3332 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3333 used.
3334
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 *'helpfile'* *'hf'*
3336'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3337 (others) "$VIMRUNTIME/doc/help.txt")
3338 global
3339 {not in Vi}
3340 Name of the main help file. All distributed help files should be
3341 placed together in one directory. Additionally, all "doc" directories
3342 in 'runtimepath' will be used.
3343 Environment variables are expanded |:set_env|. For example:
3344 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003345 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 spaces and backslashes.
3347 This option cannot be set from a |modeline| or in the |sandbox|, for
3348 security reasons.
3349
3350 *'helpheight'* *'hh'*
3351'helpheight' 'hh' number (default 20)
3352 global
3353 {not in Vi}
3354 {not available when compiled without the +windows
3355 feature}
3356 Minimal initial height of the help window when it is opened with the
3357 ":help" command. The initial height of the help window is half of the
3358 current window, or (when the 'ea' option is on) the same as other
3359 windows. When the height is less than 'helpheight', the height is
3360 set to 'helpheight'. Set to zero to disable.
3361
3362 *'helplang'* *'hlg'*
3363'helplang' 'hlg' string (default: messages language or empty)
3364 global
3365 {only available when compiled with the |+multi_lang|
3366 feature}
3367 {not in Vi}
3368 Comma separated list of languages. Vim will use the first language
3369 for which the desired help can be found. The English help will always
3370 be used as a last resort. You can add "en" to prefer English over
3371 another language, but that will only find tags that exist in that
3372 language and not in the English help.
3373 Example: >
3374 :set helplang=de,it
3375< This will first search German, then Italian and finally English help
3376 files.
3377 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3378 try to find the tag in the current language before using this option.
3379 See |help-translated|.
3380
3381 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3382'hidden' 'hid' boolean (default off)
3383 global
3384 {not in Vi}
3385 When off a buffer is unloaded when it is |abandon|ed. When on a
3386 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3387 displayed in another window, it does not become hidden, of course.
3388 The commands that move through the buffer list sometimes make a buffer
3389 hidden although the 'hidden' option is off: When the buffer is
3390 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003391 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003392 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 This option is set for one command with ":hide {command}" |:hide|.
3394 WARNING: It's easy to forget that you have changes in hidden buffers.
3395 Think twice when using ":q!" or ":qa!".
3396
3397 *'highlight'* *'hl'*
3398'highlight' 'hl' string (default (as a single string):
3399 "8:SpecialKey,@:NonText,d:Directory,
3400 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3401 M:ModeMsg,n:LineNr,r:Question,
3402 s:StatusLine,S:StatusLineNC,c:VertSplit
3403 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3404 f:Folded,F:FoldColumn,A:DiffAdd,
3405 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003406 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003407 R:SpellRare,L:SpellLocal,
3408 +:Pmenu,=:PmenuSel,
3409 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 global
3411 {not in Vi}
3412 This option can be used to set highlighting mode for various
3413 occasions. It is a comma separated list of character pairs. The
3414 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003415 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3417 |hl-NonText| @ '~' and '@' at the end of the window and
3418 characters from 'showbreak'
3419 |hl-Directory| d directories in CTRL-D listing and other special
3420 things in listings
3421 |hl-ErrorMsg| e error messages
3422 h (obsolete, ignored)
3423 |hl-IncSearch| i 'incsearch' highlighting
3424 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3425 |hl-MoreMsg| m |more-prompt|
3426 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3427 |hl-LineNr| n line number for ":number" and ":#" commands
3428 |hl-Question| r |hit-enter| prompt and yes/no questions
3429 |hl-StatusLine| s status line of current window |status-line|
3430 |hl-StatusLineNC| S status lines of not-current windows
3431 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3432 |hl-VertSplit| c column used to separate vertically split windows
3433 |hl-Visual| v Visual mode
3434 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3435 Selection" Only X11 Gui's |gui-x11| and
3436 |xterm-clipboard|.
3437 |hl-WarningMsg| w warning messages
3438 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3439 |hl-Folded| f line used for closed folds
3440 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003441 |hl-DiffAdd| A added line in diff mode
3442 |hl-DiffChange| C changed line in diff mode
3443 |hl-DiffDelete| D deleted line in diff mode
3444 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003446 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003447 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003448 |hl-SpellRare| R rare word |spell|
3449 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003450 |hl-Pmenu| + popup menu normal line
3451 |hl-PmenuSel| = popup menu normal line
3452 |hl-PmenuSbar| x popup menu scrollbar
3453 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454
3455 The display modes are:
3456 r reverse (termcap entry "mr" and "me")
3457 i italic (termcap entry "ZH" and "ZR")
3458 b bold (termcap entry "md" and "me")
3459 s standout (termcap entry "so" and "se")
3460 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003461 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 n no highlighting
3463 - no highlighting
3464 : use a highlight group
3465 The default is used for occasions that are not included.
3466 If you want to change what the display modes do, see |dos-colors|
3467 for an example.
3468 When using the ':' display mode, this must be followed by the name of
3469 a highlight group. A highlight group can be used to define any type
3470 of highlighting, including using color. See |:highlight| on how to
3471 define one. The default uses a different group for each occasion.
3472 See |highlight-default| for the default highlight groups.
3473
3474 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3475'hlsearch' 'hls' boolean (default off)
3476 global
3477 {not in Vi}
3478 {not available when compiled without the
3479 |+extra_search| feature}
3480 When there is a previous search pattern, highlight all its matches.
3481 The type of highlighting used can be set with the 'l' occasion in the
3482 'highlight' option. This uses the "Search" highlight group by
3483 default. Note that only the matching text is highlighted, any offsets
3484 are not applied.
3485 See also: 'incsearch' and |:match|.
3486 When you get bored looking at the highlighted matches, you can turn it
3487 off with |:nohlsearch|. As soon as you use a search command, the
3488 highlighting comes back.
3489 When the search pattern can match an end-of-line, Vim will try to
3490 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003491 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 line below a closed fold. A match in a previous line which is not
3493 drawn may not continue in an newly drawn line.
3494 NOTE: This option is reset when 'compatible' is set.
3495
3496 *'history'* *'hi'*
3497'history' 'hi' number (Vim default: 20, Vi default: 0)
3498 global
3499 {not in Vi}
3500 A history of ":" commands, and a history of previous search patterns
3501 are remembered. This option decides how many entries may be stored in
3502 each of these histories (see |cmdline-editing|).
3503 NOTE: This option is set to the Vi default value when 'compatible' is
3504 set and to the Vim default value when 'compatible' is reset.
3505
3506 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3507'hkmap' 'hk' boolean (default off)
3508 global
3509 {not in Vi}
3510 {only available when compiled with the |+rightleft|
3511 feature}
3512 When on, the keyboard is mapped for the Hebrew character set.
3513 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3514 toggle this option. See |rileft.txt|.
3515 NOTE: This option is reset when 'compatible' is set.
3516
3517 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3518'hkmapp' 'hkp' boolean (default off)
3519 global
3520 {not in Vi}
3521 {only available when compiled with the |+rightleft|
3522 feature}
3523 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3524 This is useful if you have a non-Hebrew keyboard.
3525 See |rileft.txt|.
3526 NOTE: This option is reset when 'compatible' is set.
3527
3528 *'icon'* *'noicon'*
3529'icon' boolean (default off, on when title can be restored)
3530 global
3531 {not in Vi}
3532 {not available when compiled without the |+title|
3533 feature}
3534 When on, the icon text of the window will be set to the value of
3535 'iconstring' (if it is not empty), or to the name of the file
3536 currently being edited. Only the last part of the name is used.
3537 Overridden by the 'iconstring' option.
3538 Only works if the terminal supports setting window icons (currently
3539 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3540 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3541 builtin termcap).
3542 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003543 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 X11.
3545
3546 *'iconstring'*
3547'iconstring' string (default "")
3548 global
3549 {not in Vi}
3550 {not available when compiled without the |+title|
3551 feature}
3552 When this option is not empty, it will be used for the icon text of
3553 the window. This happens only when the 'icon' option is on.
3554 Only works if the terminal supports setting window icon text
3555 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3556 Does not work for MS Windows.
3557 When Vim was compiled with HAVE_X11 defined, the original icon will be
3558 restored if possible |X11|.
3559 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003560 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 'titlestring' for example settings.
3562 {not available when compiled without the |+statusline| feature}
3563
3564 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3565'ignorecase' 'ic' boolean (default off)
3566 global
3567 Ignore case in search patterns. Also used when searching in the tags
3568 file.
3569 Also see 'smartcase'.
3570 Can be overruled by using "\c" or "\C" in the pattern, see
3571 |/ignorecase|.
3572
3573 *'imactivatekey'* *'imak'*
3574'imactivatekey' 'imak' string (default "")
3575 global
3576 {not in Vi}
3577 {only available when compiled with |+xim| and
3578 |+GUI_GTK|}
3579 Specifies the key that your Input Method in X-Windows uses for
3580 activation. When this is specified correctly, vim can fully control
3581 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3582 You can't use this option to change the activation key, the option
3583 tells Vim what the key is.
3584 Format:
3585 [MODIFIER_FLAG-]KEY_STRING
3586
3587 These characters can be used for MODIFIER_FLAG (case is ignored):
3588 S Shift key
3589 L Lock key
3590 C Control key
3591 1 Mod1 key
3592 2 Mod2 key
3593 3 Mod3 key
3594 4 Mod4 key
3595 5 Mod5 key
3596 Combinations are allowed, for example "S-C-space" or "SC-space" are
3597 both shift+ctrl+space.
3598 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3599
3600 Example: >
3601 :set imactivatekey=S-space
3602< "S-space" means shift+space. This is the activation key for kinput2 +
3603 canna (Japanese), and ami (Korean).
3604
3605 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3606'imcmdline' 'imc' boolean (default off)
3607 global
3608 {not in Vi}
3609 {only available when compiled with the |+xim|
3610 |+multi_byte_ime| or |global-ime| feature}
3611 When set the Input Method is always on when starting to edit a command
3612 line, unless entering a search pattern (see 'imsearch' for that).
3613 Setting this option is useful when your input method allows entering
3614 English characters directly, e.g., when it's used to type accented
3615 characters with dead keys.
3616
3617 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3618'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3619 global
3620 {not in Vi}
3621 {only available when compiled with the |+xim|
3622 |+multi_byte_ime| or |global-ime| feature}
3623 When set the Input Method is never used. This is useful to disable
3624 the IM when it doesn't work properly.
3625 Currently this option is on by default for SGI/IRIX machines. This
3626 may change in later releases.
3627
3628 *'iminsert'* *'imi'*
3629'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3630 local to buffer
3631 {not in Vi}
3632 Specifies whether :lmap or an Input Method (IM) is to be used in
3633 Insert mode. Valid values:
3634 0 :lmap is off and IM is off
3635 1 :lmap is ON and IM is off
3636 2 :lmap is off and IM is ON
3637 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3638 or |global-ime|.
3639 To always reset the option to zero when leaving Insert mode with <Esc>
3640 this can be used: >
3641 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3642< This makes :lmap and IM turn off automatically when leaving Insert
3643 mode.
3644 Note that this option changes when using CTRL-^ in Insert mode
3645 |i_CTRL-^|.
3646 The value is set to 1 when setting 'keymap' to a valid keymap name.
3647 It is also used for the argument of commands like "r" and "f".
3648 The value 0 may not work correctly with Athena and Motif with some XIM
3649 methods. Use 'imdisable' to disable XIM then.
3650
3651 *'imsearch'* *'ims'*
3652'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3653 local to buffer
3654 {not in Vi}
3655 Specifies whether :lmap or an Input Method (IM) is to be used when
3656 entering a search pattern. Valid values:
3657 -1 the value of 'iminsert' is used, makes it look like
3658 'iminsert' is also used when typing a search pattern
3659 0 :lmap is off and IM is off
3660 1 :lmap is ON and IM is off
3661 2 :lmap is off and IM is ON
3662 Note that this option changes when using CTRL-^ in Command-line mode
3663 |c_CTRL-^|.
3664 The value is set to 1 when it is not -1 and setting the 'keymap'
3665 option to a valid keymap name.
3666 The value 0 may not work correctly with Athena and Motif with some XIM
3667 methods. Use 'imdisable' to disable XIM then.
3668
3669 *'include'* *'inc'*
3670'include' 'inc' string (default "^\s*#\s*include")
3671 global or local to buffer |global-local|
3672 {not in Vi}
3673 {not available when compiled without the
3674 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003675 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 pattern, just like for the "/" command (See |pattern|). The default
3677 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003678 "]I", "[d", etc.
3679 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003680 comes after the matched pattern. But if "\zs" appears in the pattern
3681 then the text matched from "\zs" to the end, or until "\ze" if it
3682 appears, is used as the file name. Use this to include characters
3683 that are not in 'isfname', such as a space. You can then use
3684 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003685 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686
3687 *'includeexpr'* *'inex'*
3688'includeexpr' 'inex' string (default "")
3689 local to buffer
3690 {not in Vi}
3691 {not available when compiled without the
3692 |+find_in_path| or |+eval| feature}
3693 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003694 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 :set includeexpr=substitute(v:fname,'\\.','/','g')
3696< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003697
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003699 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 Also used for |<cfile>|.
3701
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003702 The expression may be evaluated in the |sandbox|, see
3703 |sandbox-option|.
3704
3705 It is not allowed to change text or jump to another window while
3706 evaluating 'includeexpr' |textlock|.
3707
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3709'incsearch' 'is' boolean (default off)
3710 global
3711 {not in Vi}
3712 {not available when compiled without the
3713 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003714 While typing a search command, show where the pattern, as it was typed
3715 so far, matches. The matched string is highlighted. If the pattern
3716 is invalid or not found, nothing is shown. The screen will be updated
3717 often, this is only useful on fast terminals.
3718 Note that the match will be shown, but the cursor will return to its
3719 original position when no match is found and when pressing <Esc>. You
3720 still need to finish the search command with <Enter> to move the
3721 cursor to the match.
3722 The highlighting can be set with the 'i' flag in 'highlight'.
3723 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 NOTE: This option is reset when 'compatible' is set.
3725
3726 *'indentexpr'* *'inde'*
3727'indentexpr' 'inde' string (default "")
3728 local to buffer
3729 {not in Vi}
3730 {not available when compiled without the |+cindent|
3731 or |+eval| features}
3732 Expression which is evaluated to obtain the proper indent for a line.
3733 It is used when a new line is created, for the |=| operator and
3734 in Insert mode as specified with the 'indentkeys' option.
3735 When this option is not empty, it overrules the 'cindent' and
3736 'smartindent' indenting.
3737 When 'paste' is set this option is not used for indenting.
3738 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003739 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 when the expression is evaluated (but it may be moved around).
3741 The expression must return the number of spaces worth of indent. It
3742 can return "-1" to keep the current indent (this means 'autoindent' is
3743 used for the indent).
3744 Functions useful for computing the indent are |indent()|, |cindent()|
3745 and |lispindent()|.
3746 The evaluation of the expression must not have side effects! It must
3747 not change the text, jump to another window, etc. Afterwards the
3748 cursor position is always restored, thus the cursor may be moved.
3749 Normally this option would be set to call a function: >
3750 :set indentexpr=GetMyIndent()
3751< Error messages will be suppressed, unless the 'debug' option contains
3752 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003753 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 NOTE: This option is made empty when 'compatible' is set.
3755
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003756 The expression may be evaluated in the |sandbox|, see
3757 |sandbox-option|.
3758
3759 It is not allowed to change text or jump to another window while
3760 evaluating 'indentexpr' |textlock|.
3761
3762
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 *'indentkeys'* *'indk'*
3764'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3765 local to buffer
3766 {not in Vi}
3767 {not available when compiled without the |+cindent|
3768 feature}
3769 A list of keys that, when typed in Insert mode, cause reindenting of
3770 the current line. Only happens if 'indentexpr' isn't empty.
3771 The format is identical to 'cinkeys', see |indentkeys-format|.
3772 See |C-indenting| and |indent-expression|.
3773
3774 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3775'infercase' 'inf' boolean (default off)
3776 local to buffer
3777 {not in Vi}
3778 When doing keyword completion in insert mode |ins-completion|, and
3779 'ignorecase' is also on, the case of the match is adjusted. If the
3780 typed text contains a lowercase letter where the match has an upper
3781 case letter, the completed part is made lowercase. If the typed text
3782 has no lowercase letters and the match has a lowercase letter where
3783 the typed text has an uppercase letter, and there is a letter before
3784 it, the completed part is made uppercase.
3785
3786 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3787'insertmode' 'im' boolean (default off)
3788 global
3789 {not in Vi}
3790 Makes Vim work in a way that Insert mode is the default mode. Useful
3791 if you want to use Vim as a modeless editor. Used for |evim|.
3792 These Insert mode commands will be useful:
3793 - Use the cursor keys to move around.
3794 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3795 this is a mapping, it is executed as if 'insertmode' was off.
3796 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003798 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3799 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800
3801 These items change when 'insertmode' is set:
3802 - when starting to edit of a file, Vim goes to Insert mode.
3803 - <Esc> in Insert mode is a no-op and beeps.
3804 - <Esc> in Normal mode makes Vim go to Insert mode.
3805 - CTRL-L in Insert mode is a command, it is not inserted.
3806 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3807 However, when <Esc> is used inside a mapping, it behaves like
3808 'insertmode' was not set. This was done to be able to use the same
3809 mappings with 'insertmode' set or not set.
3810 When executing commands with |:normal| 'insertmode' is not used.
3811
3812 NOTE: This option is reset when 'compatible' is set.
3813
3814 *'isfname'* *'isf'*
3815'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3816 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3817 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3818 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3819 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3820 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3821 global
3822 {not in Vi}
3823 The characters specified by this option are included in file names and
3824 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003825 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 Multi-byte characters 256 and above are always included, only the
3827 characters up to 255 are specified with this option.
3828 For UTF-8 the characters 0xa0 to 0xff are included as well.
3829
3830 Note that on systems using a backslash as path separator, Vim tries to
3831 do its best to make it work as you would expect. That is a bit
3832 tricky, since Vi originally used the backslash to escape special
3833 characters. Vim will not remove a backslash in front of a normal file
3834 name character on these systems, but it will on Unix and alikes. The
3835 '&' and '^' are not included by default, because these are special for
3836 cmd.exe.
3837
3838 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003839 Each part can be a single character number or a range. A range is two
3840 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 decimal number between 0 and 255 or the ASCII character itself (does
3842 not work for digits). Example:
3843 "_,-,128-140,#-43" (include '_' and '-' and the range
3844 128 to 140 and '#' to 43)
3845 If a part starts with '^', the following character number or range
3846 will be excluded from the option. The option is interpreted from left
3847 to right. Put the excluded character after the range where it is
3848 included. To include '^' itself use it as the last character of the
3849 option or the end of a range. Example:
3850 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3851 If the character is '@', all characters where isalpha() returns TRUE
3852 are included. Normally these are the characters a to z and A to Z,
3853 plus accented characters. To include '@' itself use "@-@". Examples:
3854 "@,^a-z" All alphabetic characters, excluding lower
3855 case letters.
3856 "a-z,A-Z,@-@" All letters plus the '@' character.
3857 A comma can be included by using it where a character number is
3858 expected. Example:
3859 "48-57,,,_" Digits, comma and underscore.
3860 A comma can be excluded by prepending a '^'. Example:
3861 " -~,^,,9" All characters from space to '~', excluding
3862 comma, plus <Tab>.
3863 See |option-backslash| about including spaces and backslashes.
3864
3865 *'isident'* *'isi'*
3866'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3867 "@,48-57,_,128-167,224-235"
3868 otherwise: "@,48-57,_,192-255")
3869 global
3870 {not in Vi}
3871 The characters given by this option are included in identifiers.
3872 Identifiers are used in recognizing environment variables and after a
3873 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003874 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 option.
3876 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003877 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3879
3880 *'iskeyword'* *'isk'*
3881'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3882 "@,48-57,_,128-167,224-235"
3883 otherwise: "@,48-57,_,192-255"
3884 Vi default: "@,48-57,_")
3885 local to buffer
3886 {not in Vi}
3887 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003888 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 'isfname' for a description of the format of this option. For C
3890 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3891 For a help file it is set to all non-blank printable characters except
3892 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3893 command).
3894 When the 'lisp' option is on the '-' character is always included.
3895 NOTE: This option is set to the Vi default value when 'compatible' is
3896 set and to the Vim default value when 'compatible' is reset.
3897
3898 *'isprint'* *'isp'*
3899'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3900 "@,~-255"; otherwise: "@,161-255")
3901 global
3902 {not in Vi}
3903 The characters given by this option are displayed directly on the
3904 screen. It is also used for "\p" in a |pattern|. The characters from
3905 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3906 even when they are not included in 'isprint' or excluded. See
3907 'isfname' for a description of the format of this option.
3908
3909 Non-printable characters are displayed with two characters:
3910 0 - 31 "^@" - "^_"
3911 32 - 126 always single characters
3912 127 "^?"
3913 128 - 159 "~@" - "~_"
3914 160 - 254 "| " - "|~"
3915 255 "~?"
3916 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3917 displayed as <xx>, with the hexadecimal value of the byte.
3918 When 'display' contains "uhex" all unprintable characters are
3919 displayed as <xx>.
3920 The NonText highlighting will be used for unprintable characters.
3921 |hl-NonText|
3922
3923 Multi-byte characters 256 and above are always included, only the
3924 characters up to 255 are specified with this option. When a character
3925 is printable but it is not available in the current font, a
3926 replacement character will be shown.
3927 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3928 There is no option to specify these characters.
3929
3930 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3931'joinspaces' 'js' boolean (default on)
3932 global
3933 {not in Vi}
3934 Insert two spaces after a '.', '?' and '!' with a join command.
3935 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3936 Otherwise only one space is inserted.
3937 NOTE: This option is set when 'compatible' is set.
3938
3939 *'key'*
3940'key' string (default "")
3941 local to buffer
3942 {not in Vi}
3943 The key that is used for encrypting and decrypting the current buffer.
3944 See |encryption|.
3945 Careful: Do not set the key value by hand, someone might see the typed
3946 key. Use the |:X| command. But you can make 'key' empty: >
3947 :set key=
3948< It is not possible to get the value of this option with ":set key" or
3949 "echo &key". This is to avoid showing it to someone who shouldn't
3950 know. It also means you cannot see it yourself once you have set it,
3951 be careful not to make a typing error!
3952
3953 *'keymap'* *'kmp'* *E544*
3954'keymap' 'kmp' string (default "")
3955 local to buffer
3956 {not in Vi}
3957 {only available when compiled with the |+keymap|
3958 feature}
3959 Name of a keyboard mapping. See |mbyte-keymap|.
3960 Setting this option to a valid keymap name has the side effect of
3961 setting 'iminsert' to one, so that the keymap becomes effective.
3962 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003963 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964
3965 *'keymodel'* *'km'*
3966'keymodel' 'km' string (default "")
3967 global
3968 {not in Vi}
3969 List of comma separated words, which enable special things that keys
3970 can do. These values can be used:
3971 startsel Using a shifted special key starts selection (either
3972 Select mode or Visual mode, depending on "key" being
3973 present in 'selectmode').
3974 stopsel Using a not-shifted special key stops selection.
3975 Special keys in this context are the cursor keys, <End>, <Home>,
3976 <PageUp> and <PageDown>.
3977 The 'keymodel' option is set by the |:behave| command.
3978
3979 *'keywordprg'* *'kp'*
3980'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3981 OS/2: "view /", VMS: "help")
3982 global or local to buffer |global-local|
3983 {not in Vi}
3984 Program to use for the |K| command. Environment variables are
3985 expanded |:set_env|. ":help" may be used to access the Vim internal
3986 help. (Note that previously setting the global option to the empty
3987 value did this, which is now deprecated.)
3988 When "man" is used, Vim will automatically translate a count for the
3989 "K" command to a section number. Also for "man -s", in which case the
3990 "-s" is removed when there is no count.
3991 See |option-backslash| about including spaces and backslashes.
3992 Example: >
3993 :set keywordprg=man\ -s
3994< This option cannot be set from a |modeline| or in the |sandbox|, for
3995 security reasons.
3996
3997 *'langmap'* *'lmap'* *E357* *E358*
3998'langmap' 'lmap' string (default "")
3999 global
4000 {not in Vi}
4001 {only available when compiled with the |+langmap|
4002 feature}
4003 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004004 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 inserted directly. When in command mode the 'langmap' option takes
4006 care of translating these special characters to the original meaning
4007 of the key. This means you don't have to change the keyboard mode to
4008 be able to execute Normal mode commands.
4009 This is the opposite of the 'keymap' option, where characters are
4010 mapped in Insert mode.
4011 This only works for 8-bit characters. The value of 'langmap' may be
4012 specified with multi-byte characters (e.g., UTF-8), but only the lower
4013 8 bits of each character will be used.
4014
4015 Example (for Greek): *greek* >
4016 :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
4017< Example (exchanges meaning of z and y for commands): >
4018 :set langmap=zy,yz,ZY,YZ
4019<
4020 The 'langmap' option is a list of parts, separated with commas. Each
4021 part can be in one of two forms:
4022 1. A list of pairs. Each pair is a "from" character immediately
4023 followed by the "to" character. Examples: "aA", "aAbBcC".
4024 2. A list of "from" characters, a semi-colon and a list of "to"
4025 characters. Example: "abc;ABC"
4026 Example: "aA,fgh;FGH,cCdDeE"
4027 Special characters need to be preceded with a backslash. These are
4028 ";", ',' and backslash itself.
4029
4030 This will allow you to activate vim actions without having to switch
4031 back and forth between the languages. Your language characters will
4032 be understood as normal vim English characters (according to the
4033 langmap mappings) in the following cases:
4034 o Normal/Visual mode (commands, buffer/register names, user mappings)
4035 o Insert/Replace Mode: Register names after CTRL-R
4036 o Insert/Replace Mode: Mappings
4037 Characters entered in Command-line mode will NOT be affected by
4038 this option. Note that this option can be changed at any time
4039 allowing to switch between mappings for different languages/encodings.
4040 Use a mapping to avoid having to type it each time!
4041
4042 *'langmenu'* *'lm'*
4043'langmenu' 'lm' string (default "")
4044 global
4045 {not in Vi}
4046 {only available when compiled with the |+menu| and
4047 |+multi_lang| features}
4048 Language to use for menu translation. Tells which file is loaded
4049 from the "lang" directory in 'runtimepath': >
4050 "lang/menu_" . &langmenu . ".vim"
4051< (without the spaces). For example, to always use the Dutch menus, no
4052 matter what $LANG is set to: >
4053 :set langmenu=nl_NL.ISO_8859-1
4054< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004055 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 If your $LANG is set to a non-English language but you do want to use
4057 the English menus: >
4058 :set langmenu=none
4059< This option must be set before loading menus, switching on filetype
4060 detection or syntax highlighting. Once the menus are defined setting
4061 this option has no effect. But you could do this: >
4062 :source $VIMRUNTIME/delmenu.vim
4063 :set langmenu=de_DE.ISO_8859-1
4064 :source $VIMRUNTIME/menu.vim
4065< Warning: This deletes all menus that you defined yourself!
4066
4067 *'laststatus'* *'ls'*
4068'laststatus' 'ls' number (default 1)
4069 global
4070 {not in Vi}
4071 The value of this option influences when the last window will have a
4072 status line:
4073 0: never
4074 1: only if there are at least two windows
4075 2: always
4076 The screen looks nicer with a status line if you have several
4077 windows, but it takes another screen line. |status-line|
4078
4079 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4080'lazyredraw' 'lz' boolean (default off)
4081 global
4082 {not in Vi}
4083 When this option is set, the screen will not be redrawn while
4084 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004085 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 update use |:redraw|.
4087
4088 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4089'linebreak' 'lbr' boolean (default off)
4090 local to window
4091 {not in Vi}
4092 {not available when compiled without the |+linebreak|
4093 feature}
4094 If on Vim will wrap long lines at a character in 'breakat' rather
4095 than at the last character that fits on the screen. Unlike
4096 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4097 it only affects the way the file is displayed, not its contents. The
4098 value of 'showbreak' is used to put in front of wrapped lines.
4099 This option is not used when the 'wrap' option is off or 'list' is on.
4100 Note that <Tab> characters after an <EOL> are mostly not displayed
4101 with the right amount of white space.
4102
4103 *'lines'* *E593*
4104'lines' number (default 24 or terminal height)
4105 global
4106 Number of lines of the Vim window.
4107 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004108 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 When Vim is running in the GUI or in a resizable window, setting this
4110 option will cause the window size to be changed. When you only want
4111 to use the size for the GUI, put the command in your |gvimrc| file.
4112 Vim limits the number of lines to what fits on the screen. You can
4113 use this command to get the tallest window possible: >
4114 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004115< Minimum value is 2, maximum value is 1000.
4116 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 When you set this option and Vim is unable to change the physical
4118 number of lines of the display, the display may be messed up.
4119
4120 *'linespace'* *'lsp'*
4121'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4122 global
4123 {not in Vi}
4124 {only in the GUI}
4125 Number of pixel lines inserted between characters. Useful if the font
4126 uses the full character cell height, making lines touch each other.
4127 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004128 With some fonts there can be too much room between lines (to have
4129 space for ascents and descents). Then it makes sense to set
4130 'linespace' to a negative value. This may cause display problems
4131 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132
4133 *'lisp'* *'nolisp'*
4134'lisp' boolean (default off)
4135 local to buffer
4136 {not available when compiled without the |+lispindent|
4137 feature}
4138 Lisp mode: When <Enter> is typed in insert mode set the indent for
4139 the next line to Lisp standards (well, sort of). Also happens with
4140 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4141 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4142 better. Also see 'lispwords'.
4143 The '-' character is included in keyword characters. Redefines the
4144 "=" operator to use this same indentation algorithm rather than
4145 calling an external program if 'equalprg' is empty.
4146 This option is not used when 'paste' is set.
4147 {Vi: Does it a little bit differently}
4148
4149 *'lispwords'* *'lw'*
4150'lispwords' 'lw' string (default is very long)
4151 global
4152 {not in Vi}
4153 {not available when compiled without the |+lispindent|
4154 feature}
4155 Comma separated list of words that influence the Lisp indenting.
4156 |'lisp'|
4157
4158 *'list'* *'nolist'*
4159'list' boolean (default off)
4160 local to window
4161 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4162 see the difference between tabs and spaces and for trailing blanks.
4163 Note that this will also affect formatting (set with 'textwidth' or
4164 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4165 changing the way tabs are displayed.
4166
4167 *'listchars'* *'lcs'*
4168'listchars' 'lcs' string (default "eol:$")
4169 global
4170 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004171 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 settings.
4173 eol:c Character to show at the end of each line. When
4174 omitted, there is no extra character at the end of the
4175 line.
4176 tab:xy Two characters to be used to show a Tab. The first
4177 char is used once. The second char is repeated to
4178 fill the space that the Tab normally occupies.
4179 "tab:>-" will show a Tab that takes four spaces as
4180 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004181 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 trailing spaces are blank.
4183 extends:c Character to show in the last column, when 'wrap' is
4184 off and the line continues beyond the right of the
4185 screen.
4186 precedes:c Character to show in the first column, when 'wrap'
4187 is off and there is text preceding the character
4188 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004189 nbsp:c Character to show for a non-breakable space (character
4190 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004192 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 be used when 'encoding' is "utf-8", otherwise only printable
4194 characters are allowed.
4195
4196 Examples: >
4197 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004198 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 :set lcs=extends:>,precedes:<
4200< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004201 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202
4203 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4204'loadplugins' 'lpl' boolean (default on)
4205 global
4206 {not in Vi}
4207 When on the plugin scripts are loaded when starting up |load-plugins|.
4208 This option can be reset in your |vimrc| file to disable the loading
4209 of plugins.
4210 Note that using the "-u NONE" and "--noplugin" command line arguments
4211 reset this option. |-u| |--noplugin|
4212
4213 *'magic'* *'nomagic'*
4214'magic' boolean (default on)
4215 global
4216 Changes the special characters that can be used in search patterns.
4217 See |pattern|.
4218 NOTE: To avoid portability problems with using patterns, always keep
4219 this option at the default "on". Only switch it off when working with
4220 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004221 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222
4223 *'makeef'* *'mef'*
4224'makeef' 'mef' string (default: "")
4225 global
4226 {not in Vi}
4227 {not available when compiled without the |+quickfix|
4228 feature}
4229 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4230 and the |:grep| command.
4231 When it is empty, an internally generated temp file will be used.
4232 When "##" is included, it is replaced by a number to make the name
4233 unique. This makes sure that the ":make" command doesn't overwrite an
4234 existing file.
4235 NOT used for the ":cf" command. See 'errorfile' for that.
4236 Environment variables are expanded |:set_env|.
4237 See |option-backslash| about including spaces and backslashes.
4238 This option cannot be set from a |modeline| or in the |sandbox|, for
4239 security reasons.
4240
4241 *'makeprg'* *'mp'*
4242'makeprg' 'mp' string (default "make", VMS: "MMS")
4243 global or local to buffer |global-local|
4244 {not in Vi}
4245 Program to use for the ":make" command. See |:make_makeprg|. This
4246 option may contain '%' and '#' characters, which are expanded like
4247 when used in a command-line. Environment variables are expanded
4248 |:set_env|. See |option-backslash| about including spaces and
4249 backslashes. Note that a '|' must be escaped twice: once for ":set"
4250 and once for the interpretation of a command. When you use a filter
4251 called "myfilter" do it like this: >
4252 :set makeprg=gmake\ \\\|\ myfilter
4253< The placeholder "$*" can be given (even multiple times) to specify
4254 where the arguments will be included, for example: >
4255 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4256< This option cannot be set from a |modeline| or in the |sandbox|, for
4257 security reasons.
4258
4259 *'matchpairs'* *'mps'*
4260'matchpairs' 'mps' string (default "(:),{:},[:]")
4261 local to buffer
4262 {not in Vi}
4263 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004264 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 must be different. The characters must be separated by a colon. The
4266 pairs must be separated by a comma. Example for including '<' and '>'
4267 (HTML): >
4268 :set mps+=<:>
4269
4270< A more exotic example, to jump between the '=' and ';' in an
4271 assignment, useful for languages like C and Java: >
4272 :au FileType c,cpp,java set mps+==:;
4273
4274< For a more advanced way of using "%", see the matchit.vim plugin in
4275 the $VIMRUNTIME/macros directory. |add-local-help|
4276
4277 *'matchtime'* *'mat'*
4278'matchtime' 'mat' number (default 5)
4279 global
4280 {not in Vi}{in Nvi}
4281 Tenths of a second to show the matching paren, when 'showmatch' is
4282 set. Note that this is not in milliseconds, like other options that
4283 set a time. This is to be compatible with Nvi.
4284
4285 *'maxfuncdepth'* *'mfd'*
4286'maxfuncdepth' 'mfd' number (default 100)
4287 global
4288 {not in Vi}
4289 Maximum depth of function calls for user functions. This normally
4290 catches endless recursion. When using a recursive function with
4291 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4292 more memory, there is the danger of failing when memory is exhausted.
4293 See also |:function|.
4294
4295 *'maxmapdepth'* *'mmd'* *E223*
4296'maxmapdepth' 'mmd' number (default 1000)
4297 global
4298 {not in Vi}
4299 Maximum number of times a mapping is done without resulting in a
4300 character to be used. This normally catches endless mappings, like
4301 ":map x y" with ":map y x". It still does not catch ":map g wg",
4302 because the 'w' is used before the next mapping is done. See also
4303 |key-mapping|.
4304
4305 *'maxmem'* *'mm'*
4306'maxmem' 'mm' number (default between 256 to 5120 (system
4307 dependent) or half the amount of memory
4308 available)
4309 global
4310 {not in Vi}
4311 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4312 limit is reached allocating extra memory for a buffer will cause
4313 other memory to be freed. Maximum value 2000000. Use this to work
4314 without a limit. Also see 'maxmemtot'.
4315
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004316 *'maxmempattern'* *'mmp'*
4317'maxmempattern' 'mmp' number (default 1000)
4318 global
4319 {not in Vi}
4320 Maximum amount of memory (in Kbyte) to use for pattern matching.
4321 Maximum value 2000000. Use this to work without a limit.
4322 *E363*
4323 When Vim runs into the limit it gives an error message mostly behaves
4324 like CTRL-C was typed.
4325 Running into the limit often means that the pattern is very
4326 inefficient or too complex. This may already happen with the pattern
4327 "\(.\)*" on a very long line. ".*" works much better.
4328 Vim may run out of memory before hitting the 'maxmempattern' limit.
4329
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 *'maxmemtot'* *'mmt'*
4331'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4332 dependent) or half the amount of memory
4333 available)
4334 global
4335 {not in Vi}
4336 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004337 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 'maxmem'.
4339
4340 *'menuitems'* *'mis'*
4341'menuitems' 'mis' number (default 25)
4342 global
4343 {not in Vi}
4344 {not available when compiled without the |+menu|
4345 feature}
4346 Maximum number of items to use in a menu. Used for menus that are
4347 generated from a list of items, e.g., the Buffers menu. Changing this
4348 option has no direct effect, the menu must be refreshed first.
4349
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004350 *'mkspellmem'* *'msm'*
4351'mkspellmem' 'msm' string (default "460000,2000,500")
4352 global
4353 {not in Vi}
4354 {not available when compiled without the |+syntax|
4355 feature}
4356 Parameters for |:mkspell|. This tunes when to start compressing the
4357 word tree. Compression can be slow when there are many words, but
4358 it's needed to avoid running out of memory. The amount of memory used
4359 per word depends very much on how similar the words are, that's why
4360 this tuning is complicated.
4361
4362 There are three numbers, separated by commas:
4363 {start},{inc},{added}
4364
4365 For most languages the uncompressed word tree fits in memory. {start}
4366 gives the amount of memory in Kbyte that can be used before any
4367 compression is done. It should be a bit smaller than the amount of
4368 memory that is available to Vim.
4369
4370 When going over the {start} limit the {inc} number specifies the
4371 amount of memory in Kbyte that can be allocated before another
4372 compression is done. A low number means compression is done after
4373 less words are added, which is slow. A high number means more memory
4374 will be allocated.
4375
4376 After doing compression, {added} times 1024 words can be added before
4377 the {inc} limit is ignored and compression is done when any extra
4378 amount of memory is needed. A low number means there is a smaller
4379 chance of hitting the {inc} limit, less memory is used but it's
4380 slower.
4381
4382 The languages for which these numbers are important are Italian and
4383 Hungarian. The default works for when you have about 512 Mbyte. If
4384 you have 1 Gbyte you could use: >
4385 :set mkspellmem=900000,3000,800
4386< If you have less than 512 Mbyte |:mkspell| may fail for some
4387 languages, no matter what you set 'mkspellmem' to.
4388
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4390'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4391 local to buffer
4392 *'modelines'* *'mls'*
4393'modelines' 'mls' number (default 5)
4394 global
4395 {not in Vi}
4396 If 'modeline' is on 'modelines' gives the number of lines that is
4397 checked for set commands. If 'modeline' is off or 'modelines' is zero
4398 no lines are checked. See |modeline|.
4399 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4400 set and to the Vim default value when 'compatible' is reset.
4401
4402 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4403'modifiable' 'ma' boolean (default on)
4404 local to buffer
4405 {not in Vi} *E21*
4406 When off the buffer contents cannot be changed. The 'fileformat' and
4407 'fileencoding' options also can't be changed.
4408 Can be reset with the |-M| command line argument.
4409
4410 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4411'modified' 'mod' boolean (default off)
4412 local to buffer
4413 {not in Vi}
4414 When on, the buffer is considered to be modified. This option is set
4415 when:
4416 1. A change was made to the text since it was last written. Using the
4417 |undo| command to go back to the original text will reset the
4418 option. But undoing changes that were made before writing the
4419 buffer will set the option again, since the text is different from
4420 when it was written.
4421 2. 'fileformat' or 'fileencoding' is different from its original
4422 value. The original value is set when the buffer is read or
4423 written. A ":set nomodified" command also resets the original
4424 values to the current values and the 'modified' option will be
4425 reset.
4426 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4427 will be ignored.
4428
4429 *'more'* *'nomore'*
4430'more' boolean (Vim default: on, Vi default: off)
4431 global
4432 {not in Vi}
4433 When on, listings pause when the whole screen is filled. You will get
4434 the |more-prompt|. When this option is off there are no pauses, the
4435 listing continues until finished.
4436 NOTE: This option is set to the Vi default value when 'compatible' is
4437 set and to the Vim default value when 'compatible' is reset.
4438
4439 *'mouse'* *E538*
4440'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4441 global
4442 {not in Vi}
4443 Enable the use of the mouse. Only works for certain terminals
4444 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4445 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4446 The mouse can be enabled for different modes:
4447 n Normal mode
4448 v Visual mode
4449 i Insert mode
4450 c Command-line mode
4451 h all previous modes when editing a help file
4452 a all previous modes
4453 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 Normally you would enable the mouse in all four modes with: >
4455 :set mouse=a
4456< When the mouse is not enabled, the GUI will still use the mouse for
4457 modeless selection. This doesn't move the text cursor.
4458
4459 See |mouse-using|. Also see |'clipboard'|.
4460
4461 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004462 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 the mouse buttons can still be used by keeping the shift key pressed.
4464 Also see the 'clipboard' option.
4465
4466 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4467'mousefocus' 'mousef' boolean (default off)
4468 global
4469 {not in Vi}
4470 {only works in the GUI}
4471 The window that the mouse pointer is on is automatically activated.
4472 When changing the window layout or window focus in another way, the
4473 mouse pointer is moved to the window with keyboard focus. Off is the
4474 default because it makes using the pull down menus a little goofy, as
4475 a pointer transit may activate a window unintentionally.
4476
4477 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4478'mousehide' 'mh' boolean (default on)
4479 global
4480 {not in Vi}
4481 {only works in the GUI}
4482 When on, the mouse pointer is hidden when characters are typed.
4483 The mouse pointer is restored when the mouse is moved.
4484
4485 *'mousemodel'* *'mousem'*
4486'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4487 global
4488 {not in Vi}
4489 Sets the model to use for the mouse. The name mostly specifies what
4490 the right mouse button is used for:
4491 extend Right mouse button extends a selection. This works
4492 like in an xterm.
4493 popup Right mouse button pops up a menu. The shifted left
4494 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004495 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 popup_setpos Like "popup", but the cursor will be moved to the
4497 position where the mouse was clicked, and thus the
4498 selected operation will act upon the clicked object.
4499 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004500 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 course, that right clicking outside a selection will
4502 end Visual mode.
4503 Overview of what button does what for each model:
4504 mouse extend popup(_setpos) ~
4505 left click place cursor place cursor
4506 left drag start selection start selection
4507 shift-left search word extend selection
4508 right click extend selection popup menu (place cursor)
4509 right drag extend selection -
4510 middle click paste paste
4511
4512 In the "popup" model the right mouse button produces a pop-up menu.
4513 You need to define this first, see |popup-menu|.
4514
4515 Note that you can further refine the meaning of buttons with mappings.
4516 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4517 selection (because that's handled in the GUI code directly).
4518
4519 The 'mousemodel' option is set by the |:behave| command.
4520
4521 *'mouseshape'* *'mouses'* *E547*
4522'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004523 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 global
4525 {not in Vi}
4526 {only available when compiled with the |+mouseshape|
4527 feature}
4528 This option tells Vim what the mouse pointer should look like in
4529 different modes. The option is a comma separated list of parts, much
4530 like used for 'guicursor'. Each part consist of a mode/location-list
4531 and an argument-list:
4532 mode-list:shape,mode-list:shape,..
4533 The mode-list is a dash separated list of these modes/locations:
4534 In a normal window: ~
4535 n Normal mode
4536 v Visual mode
4537 ve Visual mode with 'selection' "exclusive" (same as 'v',
4538 if not specified)
4539 o Operator-pending mode
4540 i Insert mode
4541 r Replace mode
4542
4543 Others: ~
4544 c appending to the command-line
4545 ci inserting in the command-line
4546 cr replacing in the command-line
4547 m at the 'Hit ENTER' or 'More' prompts
4548 ml idem, but cursor in the last line
4549 e any mode, pointer below last window
4550 s any mode, pointer on a status line
4551 sd any mode, while dragging a status line
4552 vs any mode, pointer on a vertical separator line
4553 vd any mode, while dragging a vertical separator line
4554 a everywhere
4555
4556 The shape is one of the following:
4557 avail name looks like ~
4558 w x arrow Normal mouse pointer
4559 w x blank no pointer at all (use with care!)
4560 w x beam I-beam
4561 w x updown up-down sizing arrows
4562 w x leftright left-right sizing arrows
4563 w x busy The system's usual busy pointer
4564 w x no The system's usual 'no input' pointer
4565 x udsizing indicates up-down resizing
4566 x lrsizing indicates left-right resizing
4567 x crosshair like a big thin +
4568 x hand1 black hand
4569 x hand2 white hand
4570 x pencil what you write with
4571 x question big ?
4572 x rightup-arrow arrow pointing right-up
4573 w x up-arrow arrow pointing up
4574 x <number> any X11 pointer number (see X11/cursorfont.h)
4575
4576 The "avail" column contains a 'w' if the shape is available for Win32,
4577 x for X11.
4578 Any modes not specified or shapes not available use the normal mouse
4579 pointer.
4580
4581 Example: >
4582 :set mouseshape=s:udsizing,m:no
4583< will make the mouse turn to a sizing arrow over the status lines and
4584 indicate no input when the hit-enter prompt is displayed (since
4585 clicking the mouse has no effect in this state.)
4586
4587 *'mousetime'* *'mouset'*
4588'mousetime' 'mouset' number (default 500)
4589 global
4590 {not in Vi}
4591 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4592 time in msec between two mouse clicks for the second click to be
4593 recognized as a multi click.
4594
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004595 *'mzquantum'* *'mzq'*
4596'mzquantum' 'mzq' number (default 100)
4597 global
4598 {not in Vi}
4599 {not available when compiled without the |+mzscheme|
4600 feature}
4601 The number of milliseconds between polls for MzScheme threads.
4602 Negative or zero value means no thread scheduling.
4603
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 *'nrformats'* *'nf'*
4605'nrformats' 'nf' string (default "octal,hex")
4606 local to buffer
4607 {not in Vi}
4608 This defines what bases Vim will consider for numbers when using the
4609 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4610 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004611 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 incremented or decremented. This is useful for a list with a
4613 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004614 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004616 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 considered to be hexadecimal. Example: Using CTRL-X on
4618 "0x100" results in "0x0ff".
4619 Numbers which simply begin with a digit in the range 1-9 are always
4620 considered decimal. This also happens for numbers that are not
4621 recognized as octal or hex.
4622
4623 *'number'* *'nu'* *'nonumber'* *'nonu'*
4624'number' 'nu' boolean (default off)
4625 local to window
4626 Print the line number in front of each line. When the 'n' option is
4627 excluded from 'cpoptions' a wrapped line will not use the column of
4628 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004629 The 'numberwidth' option can be used to set the room used for the line
4630 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 When a long, wrapped line doesn't start with the first character, '-'
4632 characters are put before the number.
4633 See |hl-LineNr| for the highlighting used for the number.
4634
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004635 *'numberwidth'* *'nuw'*
4636'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4637 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004638 {not in Vi}
4639 {only available when compiled with the |+linebreak|
4640 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004641 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004642 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004643 Since one space is always between the number and the text, there is
4644 one less character for the number itself.
4645 The value is the minimum width. A bigger width is used when needed to
4646 fit the highest line number in the buffer. Thus with the Vim default
4647 of 4 there is room for a line number up to 999. When the buffer has
4648 1000 lines five columns will be used.
4649 The minimum value is 1, the maximum value is 10.
4650 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4651
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004652 *'omnifunc'* *'ofu'*
4653'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004654 local to buffer
4655 {not in Vi}
4656 {not available when compiled without the +eval
4657 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004658 This option specifies a function to be used for Insert mode omni
4659 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004660 See |complete-functions| for an explanation of how the function is
4661 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004662
4663
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004664 *'operatorfunc'* *'opfunc'*
4665'operatorfunc' 'opfunc' string (default: empty)
4666 global
4667 {not in Vi}
4668 This option specifies a function to be called by the |g@| operator.
4669 See |:map-operator| for more info and an example.
4670
4671 This option cannot be set from a |modeline| or in the |sandbox|, for
4672 security reasons.
4673
4674
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 *'osfiletype'* *'oft'* *E366*
4676'osfiletype' 'oft' string (RISC-OS default: "Text",
4677 others default: "")
4678 local to buffer
4679 {not in Vi}
4680 {only available when compiled with the |+osfiletype|
4681 feature}
4682 Some operating systems store extra information about files besides
4683 name, datestamp and permissions. This option contains the extra
4684 information, the nature of which will vary between systems.
4685 The value of this option is usually set when the file is loaded, and
4686 use to set the file type when file is written.
4687 It can affect the pattern matching of the automatic commands.
4688 |autocmd-osfiletypes|
4689
4690 *'paragraphs'* *'para'*
4691'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4692 global
4693 Specifies the nroff macros that separate paragraphs. These are pairs
4694 of two letters (see |object-motions|).
4695
4696 *'paste'* *'nopaste'*
4697'paste' boolean (default off)
4698 global
4699 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004700 Put Vim in Paste mode. This is useful if you want to cut or copy
4701 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 unexpected effects.
4703 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004704 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 knows about pasting and will mostly do the right thing without 'paste'
4706 being set. The same is true for a terminal where Vim handles the
4707 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004708 This option is reset when starting the GUI. Thus if you set it in
4709 your .vimrc it will work in a terminal, but not in the GUI. Setting
4710 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4711 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 When the 'paste' option is switched on (also when it was already on):
4713 - mapping in Insert mode and Command-line mode is disabled
4714 - abbreviations are disabled
4715 - 'textwidth' is set to 0
4716 - 'wrapmargin' is set to 0
4717 - 'autoindent' is reset
4718 - 'smartindent' is reset
4719 - 'softtabstop' is set to 0
4720 - 'revins' is reset
4721 - 'ruler' is reset
4722 - 'showmatch' is reset
4723 - 'formatoptions' is used like it is empty
4724 These options keep their value, but their effect is disabled:
4725 - 'lisp'
4726 - 'indentexpr'
4727 - 'cindent'
4728 NOTE: When you start editing another file while the 'paste' option is
4729 on, settings from the modelines or autocommands may change the
4730 settings again, causing trouble when pasting text. You might want to
4731 set the 'paste' option again.
4732 When the 'paste' option is reset the mentioned options are restored to
4733 the value before the moment 'paste' was switched from off to on.
4734 Resetting 'paste' before ever setting it does not have any effect.
4735 Since mapping doesn't work while 'paste' is active, you need to use
4736 the 'pastetoggle' option to toggle the 'paste' option with some key.
4737
4738 *'pastetoggle'* *'pt'*
4739'pastetoggle' 'pt' string (default "")
4740 global
4741 {not in Vi}
4742 When non-empty, specifies the key sequence that toggles the 'paste'
4743 option. This is like specifying a mapping: >
4744 :map {keys} :set invpaste<CR>
4745< Where {keys} is the value of 'pastetoggle'.
4746 The difference is that it will work even when 'paste' is set.
4747 'pastetoggle' works in Insert mode and Normal mode, but not in
4748 Command-line mode.
4749 Mappings are checked first, thus overrule 'pastetoggle'. However,
4750 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4751 this: >
4752 :map <F10> :set paste<CR>
4753 :map <F11> :set nopaste<CR>
4754 :imap <F10> <C-O>:set paste<CR>
4755 :imap <F11> <nop>
4756 :set pastetoggle=<F11>
4757< This will make <F10> start paste mode and <F11> stop paste mode.
4758 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4759 mode everything is inserted literally, except the 'pastetoggle' key
4760 sequence.
4761
4762 *'pex'* *'patchexpr'*
4763'patchexpr' 'pex' string (default "")
4764 global
4765 {not in Vi}
4766 {not available when compiled without the |+diff|
4767 feature}
4768 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004769 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770
4771 *'patchmode'* *'pm'* *E206*
4772'patchmode' 'pm' string (default "")
4773 global
4774 {not in Vi}
4775 When non-empty the oldest version of a file is kept. This can be used
4776 to keep the original version of a file if you are changing files in a
4777 source distribution. Only the first time that a file is written a
4778 copy of the original file will be kept. The name of the copy is the
4779 name of the original file with the string in the 'patchmode' option
4780 appended. This option should start with a dot. Use a string like
4781 ".org". 'backupdir' must not be empty for this to work (Detail: The
4782 backup file is renamed to the patchmode file after the new file has
4783 been successfully written, that's why it must be possible to write a
4784 backup file). If there was no file to be backed up, an empty file is
4785 created.
4786 When the 'backupskip' pattern matches, a patchmode file is not made.
4787 Using 'patchmode' for compressed files appends the extension at the
4788 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4789 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004790 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791
4792 *'path'* *'pa'* *E343* *E345* *E347*
4793'path' 'pa' string (default on Unix: ".,/usr/include,,"
4794 on OS/2: ".,/emx/include,,"
4795 other systems: ".,,")
4796 global or local to buffer |global-local|
4797 {not in Vi}
4798 This is a list of directories which will be searched when using the
4799 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4800 being searched for has a relative path (not starting with '/'). The
4801 directories in the 'path' option may be relative or absolute.
4802 - Use commas to separate directory names: >
4803 :set path=.,/usr/local/include,/usr/include
4804< - Spaces can also be used to separate directory names (for backwards
4805 compatibility with version 3.0). To have a space in a directory
4806 name, precede it with an extra backslash, and escape the space: >
4807 :set path=.,/dir/with\\\ space
4808< - To include a comma in a directory name precede it with an extra
4809 backslash: >
4810 :set path=.,/dir/with\\,comma
4811< - To search relative to the directory of the current file, use: >
4812 :set path=.
4813< - To search in the current directory use an empty string between two
4814 commas: >
4815 :set path=,,
4816< - A directory name may end in a ':' or '/'.
4817 - Environment variables are expanded |:set_env|.
4818 - When using |netrw.vim| URLs can be used. For example, adding
4819 "http://www.vim.org" will make ":find index.html" work.
4820 - Search upwards and downwards in a directory tree:
4821 1) "*" matches a sequence of characters, e.g.: >
4822 :set path=/usr/include/*
4823< means all subdirectories in /usr/include (but not /usr/include
4824 itself). >
4825 :set path=/usr/*c
4826< matches /usr/doc and /usr/src.
4827 2) "**" matches a subtree, up to 100 directories deep. Example: >
4828 :set path=/home/user_x/src/**
4829< means search in the whole subtree under "/home/usr_x/src".
4830 3) If the path ends with a ';', this path is the startpoint
4831 for upward search.
4832 See |file-searching| for more info and exact syntax.
4833 {not available when compiled without the |+path_extra| feature}
4834 - Careful with '\' characters, type two to get one in the option: >
4835 :set path=.,c:\\include
4836< Or just use '/' instead: >
4837 :set path=.,c:/include
4838< Don't forget "." or files won't even be found in the same directory as
4839 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004840 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 it is something like 256 or 1024 characters.
4842 You can check if all the include files are found, using the value of
4843 'path', see |:checkpath|.
4844 The use of |:set+=| and |:set-=| is preferred when adding or removing
4845 directories from the list. This avoids problems when a future version
4846 uses another default. To remove the current directory use: >
4847 :set path-=
4848< To add the current directory use: >
4849 :set path+=
4850< To use an environment variable, you probably need to replace the
4851 separator. Here is an example to append $INCL, in which directory
4852 names are separated with a semi-colon: >
4853 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4854< Replace the ';' with a ':' or whatever separator is used. Note that
4855 this doesn't work when $INCL contains a comma or white space.
4856
4857 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4858'preserveindent' 'pi' boolean (default off)
4859 local to buffer
4860 {not in Vi}
4861 When changing the indent of the current line, preserve as much of the
4862 indent structure as possible. Normally the indent is replaced by a
4863 series of tabs followed by spaces as required (unless |'expandtab'| is
4864 enabled, in which case only spaces are used). Enabling this option
4865 means the indent will preserve as many existing characters as possible
4866 for indenting, and only add additional tabs or spaces as required.
4867 NOTE: When using ">>" multiple times the resulting indent is a mix of
4868 tabs and spaces. You might not like this.
4869 NOTE: 'preserveindent' is reset when 'compatible' is set.
4870 Also see 'copyindent'.
4871 Use |:retab| to clean up white space.
4872
4873 *'previewheight'* *'pvh'*
4874'previewheight' 'pvh' number (default 12)
4875 global
4876 {not in Vi}
4877 {not available when compiled without the |+windows| or
4878 |+quickfix| feature}
4879 Default height for a preview window. Used for |:ptag| and associated
4880 commands. Used for |CTRL-W_}| when no count is given.
4881
4882 *'previewwindow'* *'nopreviewwindow'*
4883 *'pvw'* *'nopvw'* *E590*
4884'previewwindow' 'pvw' boolean (default off)
4885 local to window
4886 {not in Vi}
4887 {not available when compiled without the |+windows| or
4888 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004889 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 set. It's normally not set directly, but by using one of the commands
4891 |:ptag|, |:pedit|, etc.
4892
4893 *'printdevice'* *'pdev'*
4894'printdevice' 'pdev' string (default empty)
4895 global
4896 {not in Vi}
4897 {only available when compiled with the |+printer|
4898 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004899 The name of the printer to be used for |:hardcopy|.
4900 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004901 This option cannot be set from a |modeline| or in the |sandbox|, for
4902 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903
Bram Moolenaar8299df92004-07-10 09:47:34 +00004904 *'printencoding'* *'penc'*
4905'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 global
4907 {not in Vi}
4908 {only available when compiled with the |+printer|
4909 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004910 Sets the character encoding used when printing.
4911 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912
4913 *'printexpr'* *'pexpr'*
4914'printexpr' 'pexpr' String (default: see below)
4915 global
4916 {not in Vi}
4917 {only available when compiled with the |+printer|
4918 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004919 Expression used to print the PostScript produced with |:hardcopy|.
4920 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921
Bram Moolenaar8299df92004-07-10 09:47:34 +00004922 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923'printfont' 'pfn' string (default "courier")
4924 global
4925 {not in Vi}
4926 {only available when compiled with the |+printer|
4927 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004928 The name of the font that will be used for |:hardcopy|.
4929 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930
4931 *'printheader'* *'pheader'*
4932'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4933 global
4934 {not in Vi}
4935 {only available when compiled with the |+printer|
4936 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004937 The format of the header produced in |:hardcopy| output.
4938 See |pheader-option|.
4939
4940 *'printmbcharset'* *'pmbcs'*
4941'printmbcharset' 'pmbcs' string (default "")
4942 global
4943 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004944 {only available when compiled with the |+printer|,
4945 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004946 The CJK character set to be used for CJK output from |:hardcopy|.
4947 See |pmbcs-option|.
4948
4949 *'printmbfont'* *'pmbfn'*
4950'printmbfont' 'pmbfn' string (default "")
4951 global
4952 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004953 {only available when compiled with the |+printer|,
4954 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004955 List of font names to be used for CJK output from |:hardcopy|.
4956 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957
4958 *'printoptions'* *'popt'*
4959'printoptions' 'popt' string (default "")
4960 global
4961 {not in Vi}
4962 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004963 List of items that control the format of the output of |:hardcopy|.
4964 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004966 *'prompt'* *'noprompt'*
4967'prompt' boolean (default on)
4968 global
4969 When on a ":" prompt is used in Ex mode.
4970
Bram Moolenaar677ee682005-01-27 14:41:15 +00004971 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004972'quoteescape' 'qe' string (default "\")
4973 local to buffer
4974 {not in Vi}
4975 The characters that are used to escape quotes in a string. Used for
4976 objects like a', a" and a` |a'|.
4977 When one of the characters in this option is found inside a string,
4978 the following character will be skipped. The default value makes the
4979 text "foo\"bar\\" considered to be one string.
4980
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4982'readonly' 'ro' boolean (default off)
4983 local to buffer
4984 If on, writes fail unless you use a '!'. Protects you from
4985 accidentally overwriting a file. Default on when Vim is started
4986 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004987 When using ":w!" the 'readonly' option is reset for the current
4988 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004990 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991
4992 *'remap'* *'noremap'*
4993'remap' boolean (default on)
4994 global
4995 Allows for mappings to work recursively. If you do not want this for
4996 a single entry, use the :noremap[!] command.
4997
4998 *'report'*
4999'report' number (default 2)
5000 global
5001 Threshold for reporting number of lines changed. When the number of
5002 changed lines is more than 'report' a message will be given for most
5003 ":" commands. If you want it always, set 'report' to 0.
5004 For the ":substitute" command the number of substitutions is used
5005 instead of the number of lines.
5006
5007 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5008'restorescreen' 'rs' boolean (default on)
5009 global
5010 {not in Vi} {only in Windows 95/NT console version}
5011 When set, the screen contents is restored when exiting Vim. This also
5012 happens when executing external commands.
5013
5014 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5015 options in your .vimrc. To disable restoring:
5016 set t_ti= t_te=
5017 To enable restoring (for an xterm):
5018 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5019 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5020
5021 *'revins'* *'ri'* *'norevins'* *'nori'*
5022'revins' 'ri' boolean (default off)
5023 global
5024 {not in Vi}
5025 {only available when compiled with the |+rightleft|
5026 feature}
5027 Inserting characters in Insert mode will work backwards. See "typing
5028 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5029 command in Insert mode, when 'allowrevins' is set.
5030 NOTE: This option is reset when 'compatible' or 'paste' is set.
5031
5032 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5033'rightleft' 'rl' boolean (default off)
5034 local to window
5035 {not in Vi}
5036 {only available when compiled with the |+rightleft|
5037 feature}
5038 When on, display orientation becomes right-to-left, i.e., characters
5039 that are stored in the file appear from the right to the left.
5040 Using this option, it is possible to edit files for languages that
5041 are written from the right to the left such as Hebrew and Arabic.
5042 This option is per window, so it is possible to edit mixed files
5043 simultaneously, or to view the same file in both ways (this is
5044 useful whenever you have a mixed text file with both right-to-left
5045 and left-to-right strings so that both sets are displayed properly
5046 in different windows). Also see |rileft.txt|.
5047
5048 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5049'rightleftcmd' 'rlc' string (default "search")
5050 local to window
5051 {not in Vi}
5052 {only available when compiled with the |+rightleft|
5053 feature}
5054 Each word in this option enables the command line editing to work in
5055 right-to-left mode for a group of commands:
5056
5057 search "/" and "?" commands
5058
5059 This is useful for languages such as Hebrew, Arabic and Farsi.
5060 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5061
5062 *'ruler'* *'ru'* *'noruler'* *'noru'*
5063'ruler' 'ru' boolean (default off)
5064 global
5065 {not in Vi}
5066 {not available when compiled without the
5067 |+cmdline_info| feature}
5068 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005069 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 text in the file is shown on the far right:
5071 Top first line is visible
5072 Bot last line is visible
5073 All first and last line are visible
5074 45% relative position in the file
5075 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005076 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005078 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 this option takes precedence over 'ruler' and 'rulerformat'
5080 If the number of characters displayed is different from the number of
5081 bytes in the text (e.g., for a TAB or a multi-byte character), both
5082 the text column (byte number) and the screen column are shown,
5083 separated with a dash.
5084 For an empty line "0-1" is shown.
5085 For an empty buffer the line number will also be zero: "0,0-1".
5086 This option is reset when the 'paste' option is set.
5087 If you don't want to see the ruler all the time but want to know where
5088 you are, use "g CTRL-G" |g_CTRL-G|.
5089 NOTE: This option is reset when 'compatible' is set.
5090
5091 *'rulerformat'* *'ruf'*
5092'rulerformat' 'ruf' string (default empty)
5093 global
5094 {not in Vi}
5095 {not available when compiled without the |+statusline|
5096 feature}
5097 When this option is not empty, it determines the content of the ruler
5098 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005099 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 The default ruler width is 17 characters. To make the ruler 15
5101 characters wide, put "%15(" at the start and "%)" at the end.
5102 Example: >
5103 :set rulerformat=%15(%c%V\ %p%%%)
5104<
5105 *'runtimepath'* *'rtp'* *vimfiles*
5106'runtimepath' 'rtp' string (default:
5107 Unix: "$HOME/.vim,
5108 $VIM/vimfiles,
5109 $VIMRUNTIME,
5110 $VIM/vimfiles/after,
5111 $HOME/.vim/after"
5112 Amiga: "home:vimfiles,
5113 $VIM/vimfiles,
5114 $VIMRUNTIME,
5115 $VIM/vimfiles/after,
5116 home:vimfiles/after"
5117 PC, OS/2: "$HOME/vimfiles,
5118 $VIM/vimfiles,
5119 $VIMRUNTIME,
5120 $VIM/vimfiles/after,
5121 $HOME/vimfiles/after"
5122 Macintosh: "$VIM:vimfiles,
5123 $VIMRUNTIME,
5124 $VIM:vimfiles:after"
5125 RISC-OS: "Choices:vimfiles,
5126 $VIMRUNTIME,
5127 Choices:vimfiles/after"
5128 VMS: "sys$login:vimfiles,
5129 $VIM/vimfiles,
5130 $VIMRUNTIME,
5131 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005132 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 global
5134 {not in Vi}
5135 This is a list of directories which will be searched for runtime
5136 files:
5137 filetype.vim filetypes by file name |new-filetype|
5138 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005139 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 colors/ color scheme files |:colorscheme|
5141 compiler/ compiler files |:compiler|
5142 doc/ documentation |write-local-help|
5143 ftplugin/ filetype plugins |write-filetype-plugin|
5144 indent/ indent scripts |indent-expression|
5145 keymap/ key mapping files |mbyte-keymap|
5146 lang/ menu translations |:menutrans|
5147 menu.vim GUI menus |menu.vim|
5148 plugin/ plugin scripts |write-plugin|
5149 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005150 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 syntax/ syntax files |mysyntaxfile|
5152 tutor/ files for vimtutor |tutor|
5153
5154 And any other file searched for with the |:runtime| command.
5155
5156 The defaults for most systems are setup to search five locations:
5157 1. In your home directory, for your personal preferences.
5158 2. In a system-wide Vim directory, for preferences from the system
5159 administrator.
5160 3. In $VIMRUNTIME, for files distributed with Vim.
5161 *after-directory*
5162 4. In the "after" directory in the system-wide Vim directory. This is
5163 for the system administrator to overrule or add to the distributed
5164 defaults (rarely needed)
5165 5. In the "after" directory in your home directory. This is for
5166 personal preferences to overrule or add to the distributed defaults
5167 or system-wide settings (rarely needed).
5168
5169 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5170 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005171 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 wildcards.
5173 See |:runtime|.
5174 Example: >
5175 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5176< This will use the directory "~/vimruntime" first (containing your
5177 personal Vim runtime files), then "/mygroup/vim" (shared between a
5178 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5179 files).
5180 You probably should always include $VIMRUNTIME somewhere, to use the
5181 distributed runtime files. You can put a directory before $VIMRUNTIME
5182 to find files which replace a distributed runtime files. You can put
5183 a directory after $VIMRUNTIME to find files which add to distributed
5184 runtime files.
5185 This option cannot be set from a |modeline| or in the |sandbox|, for
5186 security reasons.
5187
5188 *'scroll'* *'scr'*
5189'scroll' 'scr' number (default: half the window height)
5190 local to window
5191 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5192 set to half the number of lines in the window when the window size
5193 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005194 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5196 the number of screen lines instead of file lines, makes a difference
5197 when lines wrap}
5198
5199 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5200'scrollbind' 'scb' boolean (default off)
5201 local to window
5202 {not in Vi}
5203 {not available when compiled without the |+scrollbind|
5204 feature}
5205 See also |scroll-binding|. When this option is set, the current
5206 window scrolls as other scrollbind windows (windows that also have
5207 this option set) scroll. This option is useful for viewing the
5208 differences between two versions of a file, see 'diff'.
5209 See |'scrollopt'| for options that determine how this option should be
5210 interpreted.
5211 This option is mostly reset when splitting a window to edit another
5212 file. This means that ":split | edit file" results in two windows
5213 with scroll-binding, but ":split file" does not.
5214
5215 *'scrolljump'* *'sj'*
5216'scrolljump' 'sj' number (default 1)
5217 global
5218 {not in Vi}
5219 Minimal number of lines to scroll when the cursor gets off the
5220 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5221 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005222 When set to a negative number from -1 to -100 this is used as the
5223 percentage of the window height. Thus -50 scrolls half the window
5224 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225 NOTE: This option is set to 1 when 'compatible' is set.
5226
5227 *'scrolloff'* *'so'*
5228'scrolloff' 'so' number (default 0)
5229 global
5230 {not in Vi}
5231 Minimal number of screen lines to keep above and below the cursor.
5232 This will make some context visible around where you are working. If
5233 you set it to a very large value (999) the cursor line will always be
5234 in the middle of the window (except at the start or end of the file or
5235 when long lines wrap).
5236 For scrolling horizontally see 'sidescrolloff'.
5237 NOTE: This option is set to 0 when 'compatible' is set.
5238
5239 *'scrollopt'* *'sbo'*
5240'scrollopt' 'sbo' string (default "ver,jump")
5241 global
5242 {not available when compiled without the |+scrollbind|
5243 feature}
5244 {not in Vi}
5245 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005246 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5247 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 The following words are available:
5249 ver Bind vertical scrolling for 'scrollbind' windows
5250 hor Bind horizontal scrolling for 'scrollbind' windows
5251 jump Applies to the offset between two windows for vertical
5252 scrolling. This offset is the difference in the first
5253 displayed line of the bound windows. When moving
5254 around in a window, another 'scrollbind' window may
5255 reach a position before the start or after the end of
5256 the buffer. The offset is not changed though, when
5257 moving back the 'scrollbind' window will try to scroll
5258 to the desired position when possible.
5259 When now making that window the current one, two
5260 things can be done with the relative offset:
5261 1. When "jump" is not included, the relative offset is
5262 adjusted for the scroll position in the new current
5263 window. When going back to the other window, the
5264 the new relative offset will be used.
5265 2. When "jump" is included, the other windows are
5266 scrolled to keep the same relative offset. When
5267 going back to the other window, it still uses the
5268 same relative offset.
5269 Also see |scroll-binding|.
5270
5271 *'sections'* *'sect'*
5272'sections' 'sect' string (default "SHNHH HUnhsh")
5273 global
5274 Specifies the nroff macros that separate sections. These are pairs of
5275 two letters (See |object-motions|). The default makes a section start
5276 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5277
5278 *'secure'* *'nosecure'* *E523*
5279'secure' boolean (default off)
5280 global
5281 {not in Vi}
5282 When on, ":autocmd", shell and write commands are not allowed in
5283 ".vimrc" and ".exrc" in the current directory and map commands are
5284 displayed. Switch it off only if you know that you will not run into
5285 problems, or when the 'exrc' option is off. On Unix this option is
5286 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005287 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 'secure' at the end of your ~/.vimrc then.
5289 This option cannot be set from a |modeline| or in the |sandbox|, for
5290 security reasons.
5291
5292 *'selection'* *'sel'*
5293'selection' 'sel' string (default "inclusive")
5294 global
5295 {not in Vi}
5296 This option defines the behavior of the selection. It is only used
5297 in Visual and Select mode.
5298 Possible values:
5299 value past line inclusive ~
5300 old no yes
5301 inclusive yes yes
5302 exclusive yes no
5303 "past line" means that the cursor is allowed to be positioned one
5304 character past the line.
5305 "inclusive" means that the last character of the selection is included
5306 in an operation. For example, when "x" is used to delete the
5307 selection.
5308 Note that when "exclusive" is used and selecting from the end
5309 backwards, you cannot include the last character of a line, when
5310 starting in Normal mode and 'virtualedit' empty.
5311
5312 The 'selection' option is set by the |:behave| command.
5313
5314 *'selectmode'* *'slm'*
5315'selectmode' 'slm' string (default "")
5316 global
5317 {not in Vi}
5318 This is a comma separated list of words, which specifies when to start
5319 Select mode instead of Visual mode, when a selection is started.
5320 Possible values:
5321 mouse when using the mouse
5322 key when using shifted special keys
5323 cmd when using "v", "V" or CTRL-V
5324 See |Select-mode|.
5325 The 'selectmode' option is set by the |:behave| command.
5326
5327 *'sessionoptions'* *'ssop'*
5328'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5329 help,options,winsize")
5330 global
5331 {not in Vi}
5332 {not available when compiled without the +mksession
5333 feature}
5334 Changes the effect of the |:mksession| command. It is a comma
5335 separated list of words. Each word enables saving and restoring
5336 something:
5337 word save and restore ~
5338 blank empty windows
5339 buffers hidden and unloaded buffers, not just those in windows
5340 curdir the current directory
5341 folds manually created folds, opened/closed folds and local
5342 fold options
5343 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005344 and contain at least one lowercase letter. Only
5345 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 help the help window
5347 localoptions options and mappings local to a window or buffer (not
5348 global values for local options)
5349 options all options and mappings (also global values for local
5350 options)
5351 resize size of the Vim window: 'lines' and 'columns'
5352 sesdir the directory in which the session file is located
5353 will become the current directory (useful with
5354 projects accessed over a network from different
5355 systems)
5356 slash backslashes in file names replaced with forward
5357 slashes
5358 unix with Unix end-of-line format (single <NL>), even when
5359 on Windows or DOS
5360 winpos position of the whole Vim window
5361 winsize window sizes
5362
5363 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005364 There is no option to include tab pages yet, only the current tab page
5365 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 When "curdir" nor "sesdir" is included, file names are stored with
5367 absolute paths.
5368 "slash" and "unix" are useful on Windows when sharing session files
5369 with Unix. The Unix version of Vim cannot source dos format scripts,
5370 but the Windows version of Vim can source unix format scripts.
5371
5372 *'shell'* *'sh'* *E91*
5373'shell' 'sh' string (default $SHELL or "sh",
5374 MS-DOS and Win32: "command.com" or
5375 "cmd.exe", OS/2: "cmd")
5376 global
5377 Name of the shell to use for ! and :! commands. When changing the
5378 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5379 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005380 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 See |option-backslash| about including spaces and backslashes.
5382 Environment variables are expanded |:set_env|.
5383 If the name of the shell contains a space, you might need to enclose
5384 it in quotes. Example: >
5385 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5386< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005387 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 "-f" is not inside the quotes, because it is not part of the command
5389 name. And Vim automagically recognizes the backslashes that are path
5390 separators.
5391 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5392 variable to change the way external commands are executed. See the
5393 libc.inf file of DJGPP.
5394 Under MS-Windows, when the executable ends in ".com" it must be
5395 included. Thus setting the shell to "command.com" or "4dos.com"
5396 works, but "command" and "4dos" do not work for all commands (e.g.,
5397 filtering).
5398 For unknown reasons, when using "4dos.com" the current directory is
5399 changed to "C:\". To avoid this set 'shell' like this: >
5400 :set shell=command.com\ /c\ 4dos
5401< This option cannot be set from a |modeline| or in the |sandbox|, for
5402 security reasons.
5403
5404 *'shellcmdflag'* *'shcf'*
5405'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5406 does not contain "sh" somewhere: "/c")
5407 global
5408 {not in Vi}
5409 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5410 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5411 systems, the default is set according to the value of 'shell', to
5412 reduce the need to set this option by the user. It's not used for
5413 OS/2 (EMX figures this out itself). See |option-backslash| about
5414 including spaces and backslashes. See |dos-shell|.
5415 This option cannot be set from a |modeline| or in the |sandbox|, for
5416 security reasons.
5417
5418 *'shellpipe'* *'sp'*
5419'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5420 global
5421 {not in Vi}
5422 {not available when compiled without the |+quickfix|
5423 feature}
5424 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005425 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 including spaces and backslashes.
5427 The name of the temporary file can be represented by "%s" if necessary
5428 (the file name is appended automatically if no %s appears in the value
5429 of this option).
5430 For the Amiga and MS-DOS the default is ">". The output is directly
5431 saved in a file and not echoed to the screen.
5432 For Unix the default it "| tee". The stdout of the compiler is saved
5433 in a file and echoed to the screen. If the 'shell' option is "csh" or
5434 "tcsh" after initializations, the default becomes "|& tee". If the
5435 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5436 "2>&1| tee". This means that stderr is also included.
5437 The initialization of this option is done after reading the ".vimrc"
5438 and the other initializations, so that when the 'shell' option is set
5439 there, the 'shellpipe' option changes automatically, unless it was
5440 explicitly set before.
5441 When 'shellpipe' is set to an empty string, no redirection of the
5442 ":make" output will be done. This is useful if you use a 'makeprg'
5443 that writes to 'makeef' by itself. If you want no piping, but do
5444 want to include the 'makeef', set 'shellpipe' to a single space.
5445 Don't forget to precede the space with a backslash: ":set sp=\ ".
5446 In the future pipes may be used for filtering and this option will
5447 become obsolete (at least for Unix).
5448 This option cannot be set from a |modeline| or in the |sandbox|, for
5449 security reasons.
5450
5451 *'shellquote'* *'shq'*
5452'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5453 contains "sh" somewhere: "\"")
5454 global
5455 {not in Vi}
5456 Quoting character(s), put around the command passed to the shell, for
5457 the "!" and ":!" commands. The redirection is kept outside of the
5458 quoting. See 'shellxquote' to include the redirection. It's
5459 probably not useful to set both options.
5460 This is an empty string by default. Only known to be useful for
5461 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5462 or bash, where it should be "\"". The default is adjusted according
5463 the value of 'shell', to reduce the need to set this option by the
5464 user. See |dos-shell|.
5465 This option cannot be set from a |modeline| or in the |sandbox|, for
5466 security reasons.
5467
5468 *'shellredir'* *'srr'*
5469'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5470 global
5471 {not in Vi}
5472 String to be used to put the output of a filter command in a temporary
5473 file. See also |:!|. See |option-backslash| about including spaces
5474 and backslashes.
5475 The name of the temporary file can be represented by "%s" if necessary
5476 (the file name is appended automatically if no %s appears in the value
5477 of this option).
5478 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5479 or "zsh" during initializations, the default becomes ">&". If the
5480 'shell' option is "sh", "ksh" or "bash" the default becomes
5481 ">%s 2>&1". This means that stderr is also included.
5482 For Win32, the Unix checks are done and additionally "cmd" is checked
5483 for, which makes the default ">%s 2>&1". Also, the same names with
5484 ".exe" appended are checked for.
5485 The initialization of this option is done after reading the ".vimrc"
5486 and the other initializations, so that when the 'shell' option is set
5487 there, the 'shellredir' option changes automatically unless it was
5488 explicitly set before.
5489 In the future pipes may be used for filtering and this option will
5490 become obsolete (at least for Unix).
5491 This option cannot be set from a |modeline| or in the |sandbox|, for
5492 security reasons.
5493
5494 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5495'shellslash' 'ssl' boolean (default off)
5496 global
5497 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5498 When set, a forward slash is used when expanding file names. This is
5499 useful when a Unix-like shell is used instead of command.com or
5500 cmd.exe. Backward slashes can still be typed, but they are changed to
5501 forward slashes by Vim.
5502 Note that setting or resetting this option has no effect for some
5503 existing file names, thus this option needs to be set before opening
5504 any file for best results. This might change in the future.
5505 'shellslash' only works when a backslash can be used as a path
5506 separator. To test if this is so use: >
5507 if exists('+shellslash')
5508<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005509 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5510'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5511 global
5512 {not in Vi}
5513 When on, use temp files for shell commands. When off use a pipe.
5514 When using a pipe is not possible temp files are used anyway.
5515 Currently a pipe is only supported on Unix. You can check it with: >
5516 :if has("filterpipe")
5517< The advantage of using a pipe is that nobody can read the temp file
5518 and the 'shell' command does not need to support redirection.
5519 The advantage of using a temp file is that the file type and encoding
5520 can be detected.
5521 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5522 |FilterWritePost| autocommands event are not triggered when
5523 'shelltemp' is off.
5524
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 *'shelltype'* *'st'*
5526'shelltype' 'st' number (default 0)
5527 global
5528 {not in Vi} {only for the Amiga}
5529 On the Amiga this option influences the way how the commands work
5530 which use a shell.
5531 0 and 1: always use the shell
5532 2 and 3: use the shell only to filter lines
5533 4 and 5: use shell only for ':sh' command
5534 When not using the shell, the command is executed directly.
5535
5536 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5537 1 and 3: use "shell cmd" to start external commands
5538
5539 *'shellxquote'* *'sxq'*
5540'shellxquote' 'sxq' string (default: "";
5541 for Win32, when 'shell' contains "sh"
5542 somewhere: "\""
5543 for Unix, when using system(): "\"")
5544 global
5545 {not in Vi}
5546 Quoting character(s), put around the command passed to the shell, for
5547 the "!" and ":!" commands. Includes the redirection. See
5548 'shellquote' to exclude the redirection. It's probably not useful
5549 to set both options.
5550 This is an empty string by default. Known to be useful for
5551 third-party shells when using the Win32 version, such as the MKS Korn
5552 Shell or bash, where it should be "\"". The default is adjusted
5553 according the value of 'shell', to reduce the need to set this option
5554 by the user. See |dos-shell|.
5555 This option cannot be set from a |modeline| or in the |sandbox|, for
5556 security reasons.
5557
5558 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5559'shiftround' 'sr' boolean (default off)
5560 global
5561 {not in Vi}
5562 Round indent to multiple of 'shiftwidth'. Applies to > and <
5563 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5564 a multiple of 'shiftwidth' (this is Vi compatible).
5565 NOTE: This option is reset when 'compatible' is set.
5566
5567 *'shiftwidth'* *'sw'*
5568'shiftwidth' 'sw' number (default 8)
5569 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005570 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 |'cindent'|, |>>|, |<<|, etc.
5572
5573 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005574'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5575 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 global
5577 {not in Vi}
5578 This option helps to avoid all the |hit-enter| prompts caused by file
5579 messages, for example with CTRL-G, and to avoid some other messages.
5580 It is a list of flags:
5581 flag meaning when present ~
5582 f use "(3 of 5)" instead of "(file 3 of 5)"
5583 i use "[noeol]" instead of "[Incomplete last line]"
5584 l use "999L, 888C" instead of "999 lines, 888 characters"
5585 m use "[+]" instead of "[Modified]"
5586 n use "[New]" instead of "[New File]"
5587 r use "[RO]" instead of "[readonly]"
5588 w use "[w]" instead of "written" for file write message
5589 and "[a]" instead of "appended" for ':w >> file' command
5590 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5591 "[unix format]" and "[mac]" instead of "[mac format]".
5592 a all of the above abbreviations
5593
5594 o overwrite message for writing a file with subsequent message
5595 for reading a file (useful for ":wn" or when 'autowrite' on)
5596 O message for reading a file overwrites any previous message.
5597 Also for quickfix message (e.g., ":cn").
5598 s don't give "search hit BOTTOM, continuing at TOP" or "search
5599 hit TOP, continuing at BOTTOM" messages
5600 t truncate file message at the start if it is too long to fit
5601 on the command-line, "<" will appear in the left most column.
5602 Ignored in Ex mode.
5603 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005604 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 Ignored in Ex mode.
5606 W don't give "written" or "[w]" when writing a file
5607 A don't give the "ATTENTION" message when an existing swap file
5608 is found.
5609 I don't give the intro message when starting Vim |:intro|.
5610
5611 This gives you the opportunity to avoid that a change between buffers
5612 requires you to hit <Enter>, but still gives as useful a message as
5613 possible for the space available. To get the whole message that you
5614 would have got with 'shm' empty, use ":file!"
5615 Useful values:
5616 shm= No abbreviation of message.
5617 shm=a Abbreviation, but no loss of information.
5618 shm=at Abbreviation, and truncate message when necessary.
5619
5620 NOTE: This option is set to the Vi default value when 'compatible' is
5621 set and to the Vim default value when 'compatible' is reset.
5622
5623 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5624'shortname' 'sn' boolean (default off)
5625 local to buffer
5626 {not in Vi, not in MS-DOS versions}
5627 Filenames are assumed to be 8 characters plus one extension of 3
5628 characters. Multiple dots in file names are not allowed. When this
5629 option is on, dots in file names are replaced with underscores when
5630 adding an extension (".~" or ".swp"). This option is not available
5631 for MS-DOS, because then it would always be on. This option is useful
5632 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5633 or crossdos. When running the Win32 GUI version under Win32s, this
5634 option is always on by default.
5635
5636 *'showbreak'* *'sbr'* *E595*
5637'showbreak' 'sbr' string (default "")
5638 global
5639 {not in Vi}
5640 {not available when compiled without the |+linebreak|
5641 feature}
5642 String to put at the start of lines that have been wrapped. Useful
5643 values are "> " or "+++ ".
5644 Only printable single-cell characters are allowed, excluding <Tab> and
5645 comma (in a future version the comma might be used to separate the
5646 part that is shown at the end and at the start of a line).
5647 The characters are highlighted according to the '@' flag in
5648 'highlight'.
5649 Note that tabs after the showbreak will be displayed differently.
5650 If you want the 'showbreak' to appear in between line numbers, add the
5651 "n" flag to 'cpoptions'.
5652
5653 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5654'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5655 off)
5656 global
5657 {not in Vi}
5658 {not available when compiled without the
5659 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005660 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 terminal is slow.
5662 In Visual mode the size of the selected area is shown:
5663 - When selecting characters within a line, the number of characters.
5664 - When selecting more than one line, the number of lines.
5665 - When selecting a block, the size in screen characters: linesxcolumns.
5666 NOTE: This option is set to the Vi default value when 'compatible' is
5667 set and to the Vim default value when 'compatible' is reset.
5668
5669 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5670'showfulltag' 'sft' boolean (default off)
5671 global
5672 {not in Vi}
5673 When completing a word in insert mode (see |ins-completion|) from the
5674 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005675 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 matched a C function, you can see a template for what arguments are
5677 required (coding style permitting).
5678
5679 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5680'showmatch' 'sm' boolean (default off)
5681 global
5682 When a bracket is inserted, briefly jump to the matching one. The
5683 jump is only done if the match can be seen on the screen. The time to
5684 show the match can be set with 'matchtime'.
5685 A Beep is given if there is no match (no matter if the match can be
5686 seen or not). This option is reset when the 'paste' option is set.
5687 When the 'm' flag is not included in 'cpoptions', typing a character
5688 will immediately move the cursor back to where it belongs.
5689 See the "sm" field in 'guicursor' for setting the cursor shape and
5690 blinking when showing the match.
5691 The 'matchpairs' option can be used to specify the characters to show
5692 matches for. 'rightleft' and 'revins' are used to look for opposite
5693 matches.
5694 Note: For the use of the short form parental guidance is advised.
5695
5696 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5697'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5698 global
5699 If in Insert, Replace or Visual mode put a message on the last line.
5700 Use the 'M' flag in 'highlight' to set the type of highlighting for
5701 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005702 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 doesn't mean XIM is really active, especially when 'imactivatekey' is
5704 not set.
5705 NOTE: This option is set to the Vi default value when 'compatible' is
5706 set and to the Vim default value when 'compatible' is reset.
5707
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005708 *'showtabline'* *'stal'*
5709'showtabline' 'stal' number (default 1)
5710 global
5711 {not in Vi}
5712 {not available when compiled without the +windows
5713 feature}
5714 The value of this option specifies when the line with tab page labels
5715 will be displayed:
5716 0: never
5717 1: only if there are at least two tab pages
5718 2: always
5719 This is both for the GUI and non-GUI implementation of the tab pages
5720 line.
5721 See |tab-page| for more information about tab pages.
5722
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 *'sidescroll'* *'ss'*
5724'sidescroll' 'ss' number (default 0)
5725 global
5726 {not in Vi}
5727 The minimal number of columns to scroll horizontally. Used only when
5728 the 'wrap' option is off and the cursor is moved off of the screen.
5729 When it is zero the cursor will be put in the middle of the screen.
5730 When using a slow terminal set it to a large number or 0. When using
5731 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5732 commands.
5733
5734 *'sidescrolloff'* *'siso'*
5735'sidescrolloff' 'siso' number (default 0)
5736 global
5737 {not in Vi}
5738 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005739 right of the cursor if 'nowrap' is set. Setting this option to a
5740 value greater than 0 while having |'sidescroll'| also at a non-zero
5741 value makes some context visible in the line you are scrolling in
5742 horizontally (except at beginning of the line). Setting this option
5743 to a large value (like 999) has the effect of keeping the cursor
5744 horizontally centered in the window, as long as one does not come too
5745 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 NOTE: This option is set to 0 when 'compatible' is set.
5747
5748 Example: Try this together with 'sidescroll' and 'listchars' as
5749 in the following example to never allow the cursor to move
5750 onto the "extends" character:
5751
5752 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5753 :set sidescrolloff=1
5754
5755
5756 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5757'smartcase' 'scs' boolean (default off)
5758 global
5759 {not in Vi}
5760 Override the 'ignorecase' option if the search pattern contains upper
5761 case characters. Only used when the search pattern is typed and
5762 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005763 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5765 recalling the search pattern from history and hitting <Enter>.
5766 NOTE: This option is reset when 'compatible' is set.
5767
5768 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5769'smartindent' 'si' boolean (default off)
5770 local to buffer
5771 {not in Vi}
5772 {not available when compiled without the
5773 |+smartindent| feature}
5774 Do smart autoindenting when starting a new line. Works for C-like
5775 programs, but can also be used for other languages. 'cindent' does
5776 something like this, works better in most cases, but is more strict,
5777 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5778 'indentexpr' is a more advanced alternative.
5779 Normally 'autoindent' should also be on when using 'smartindent'.
5780 An indent is automatically inserted:
5781 - After a line ending in '{'.
5782 - After a line starting with a keyword from 'cinwords'.
5783 - Before a line starting with '}' (only with the "O" command).
5784 When typing '}' as the first character in a new line, that line is
5785 given the same indent as the matching '{'.
5786 When typing '#' as the first character in a new line, the indent for
5787 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005788 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5790 When using the ">>" command, lines starting with '#' are not shifted
5791 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005792 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 is set smart indenting is disabled.
5794
5795 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5796'smarttab' 'sta' boolean (default off)
5797 global
5798 {not in Vi}
5799 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005800 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5801 <BS> will delete a 'shiftwidth' worth of space at the start of the
5802 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005803 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005804 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5805 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5807 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005808 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 NOTE: This option is reset when 'compatible' is set.
5810
5811 *'softtabstop'* *'sts'*
5812'softtabstop' 'sts' number (default 0)
5813 local to buffer
5814 {not in Vi}
5815 Number of spaces that a <Tab> counts for while performing editing
5816 operations, like inserting a <Tab> or using <BS>. It "feels" like
5817 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5818 used. This is useful to keep the 'ts' setting at its standard value
5819 of 8, while being able to edit like it is set to 'sts'. However,
5820 commands like "x" still work on the actual characters.
5821 When 'sts' is zero, this feature is off.
5822 'softtabstop' is set to 0 when the 'paste' option is set.
5823 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5824 spaces is minimized by using <Tab>s.
5825 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5826 set.
5827 NOTE: This option is set to 0 when 'compatible' is set.
5828
Bram Moolenaar217ad922005-03-20 22:37:15 +00005829 *'spell'* *'nospell'*
5830'spell' boolean (default off)
5831 local to window
5832 {not in Vi}
5833 {not available when compiled without the |+syntax|
5834 feature}
5835 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005836 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005837
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005838 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005839'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005840 local to buffer
5841 {not in Vi}
5842 {not available when compiled without the |+syntax|
5843 feature}
5844 Pattern to locate the end of a sentence. The following word will be
5845 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005846 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005847 When this check is not wanted make this option empty.
5848 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005849 Be careful with special characters, see |option-backslash| about
5850 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005851 To set this option automatically depending on the language, see
5852 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005853
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005854 *'spellfile'* *'spf'*
5855'spellfile' 'spf' string (default empty)
5856 local to buffer
5857 {not in Vi}
5858 {not available when compiled without the |+syntax|
5859 feature}
5860 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005861 commands. It must end in ".{encoding}.add". You need to include the
5862 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005863 *E765*
5864 It may also be a comma separated list of names. A count before the
5865 |zg| and |zw| commands can be used to access each. This allows using
5866 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005867 When a word is added while this option is empty Vim will set it for
5868 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005869 writable and the first language name that appears in 'spelllang',
5870 ignoring the region.
5871 The resulting ".spl" file will be used for spell checking, it does not
5872 have to appear in 'spelllang'.
5873 Normally one file is used for all regions, but you can add the region
5874 name if you want to. However, it will then only be used when
5875 'spellfile' is set to it, for entries in 'spelllang' only files
5876 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005877 This option cannot be set from a |modeline| or in the |sandbox|, for
5878 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005879
Bram Moolenaar217ad922005-03-20 22:37:15 +00005880 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005881'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005882 local to buffer
5883 {not in Vi}
5884 {not available when compiled without the |+syntax|
5885 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005886 A comma separated list of word list names. When the 'spell' option is
5887 on spellchecking will be done for these languages. Example: >
5888 set spelllang=en_us,nl,medical
5889< This means US English, Dutch and medical words are recognized. Words
5890 that are not recognized will be highlighted.
5891 The word list name must not include a comma or dot. Using a dash is
5892 recommended to separate the two letter language name from a
5893 specification. Thus "en-rare" is used for rare English words.
5894 A region name must come last and have the form "_xx", where "xx" is
5895 the two-letter, lower case region name. You can use more than one
5896 region by listing them: "en_us,en_ca" supports both US and Canadian
5897 English, but not words specific for Australia, New Zealand or Great
5898 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005899 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005900 As a special case the name of a .spl file can be given as-is. The
5901 first "_xx" in the name is removed and used as the region name
5902 (_xx is an underscore, two letters and followed by a non-letter).
5903 This is mainly for testing purposes. You must make sure the correct
5904 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005905 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005906 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5907 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005908 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005909
Bram Moolenaar98692072006-02-04 00:57:42 +00005910 If the |spellfile.vim| plugin is active and you use a language name
5911 for which Vim cannot find the .spl file in 'runtimepath' the plugin
5912 will ask you if you want to download the file.
5913
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005914 After this option has been set successfully, Vim will source the files
5915 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005916 up to the first comma, dot or underscore.
5917 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005918
5919
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005920 *'spellsuggest'* *'sps'*
5921'spellsuggest' 'sps' string (default "best")
5922 global
5923 {not in Vi}
5924 {not available when compiled without the |+syntax|
5925 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005926 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005927 the |spellsuggest()| function. This is a comma-separated list of
5928 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005929
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005930 best Internal method that works best for English. Finds
5931 changes like "fast" and uses a bit of sound-a-like
5932 scoring to improve the ordering.
5933
5934 double Internal method that uses two methods and mixes the
5935 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005936 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005937 word. That only works when the language specifies
5938 sound folding. Can be slow and doesn't always give
5939 better results.
5940
5941 fast Internal method that only checks for simple changes:
5942 character inserts/deletes/swaps. Works well for
5943 simple typing mistakes.
5944
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005945 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005946 Not used for |spellsuggest()|. The number of
5947 suggestions is never more than the value of 'lines'
5948 minus two.
5949
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005950 file:{filename} Read file {filename}, which must have two columns,
5951 separated by a slash. The first column contains the
5952 bad word, the second column the suggested good word.
5953 Example:
5954 theribal/terrible ~
5955 Use this for common mistakes that do not appear at the
5956 top of the suggestion list with the internal methods.
5957 Lines without a slash are ignored, use this for
5958 comments.
5959 The file is used for all languages.
5960
5961 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5962 trouble with spaces. |v:val| holds the badly spelled
5963 word. The expression must evaluate to a List of
5964 Lists, each with a suggestion and a score.
5965 Example:
5966 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005967 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005968 internal methods use. A lower score is better.
5969 This may invoke |spellsuggest()| if you temporarily
5970 set 'spellsuggest' to exclude the "expr:" part.
5971 Errors are silently ignored, unless you set the
5972 'verbose' option to a non-zero value.
5973
5974 Only one of "best", "double" or "fast" may be used. The others may
5975 appear several times in any order. Example: >
5976 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5977<
5978 This option cannot be set from a |modeline| or in the |sandbox|, for
5979 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005980
5981
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5983'splitbelow' 'sb' boolean (default off)
5984 global
5985 {not in Vi}
5986 {not available when compiled without the +windows
5987 feature}
5988 When on, splitting a window will put the new window below the current
5989 one. |:split|
5990
5991 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5992'splitright' 'spr' boolean (default off)
5993 global
5994 {not in Vi}
5995 {not available when compiled without the +vertsplit
5996 feature}
5997 When on, splitting a window will put the new window right of the
5998 current one. |:vsplit|
5999
6000 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6001'startofline' 'sol' boolean (default on)
6002 global
6003 {not in Vi}
6004 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006005 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006006 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006007 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 with a linewise operator, with "%" with a count and to buffer changing
6009 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6010 only has a line number, e.g., ":25" or ":+".
6011 In case of buffer changing commands the cursor is placed at the column
6012 where it was the last time the buffer was edited.
6013 NOTE: This option is set when 'compatible' is set.
6014
6015 *'statusline'* *'stl'* *E540* *E541* *E542*
6016'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006017 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018 {not in Vi}
6019 {not available when compiled without the |+statusline|
6020 feature}
6021 When nonempty, this option determines the content of the status line.
6022 Also see |status-line|.
6023
6024 The option consists of printf style '%' items interspersed with
6025 normal text. Each status line item is of the form:
6026 %-0{minwid}.{maxwid}{item}
6027 All fields except the {item} is optional. A single percent sign can
6028 be given as "%%". Up to 80 items can be specified.
6029
Bram Moolenaar238a5642006-02-21 22:12:05 +00006030 When the option starts with "%!" then it is used as an expression,
6031 evaluated and the result is used as the option value. Example: >
6032 :set statusline=%!MyStatusLine()
6033< The result can contain %{} items that will be evaluated too.
6034
6035 When there is error while evaluating the option then it will be made
6036 empty to avoid further errors. Otherwise screen updating would loop.
6037
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 Note that the only effect of 'ruler' when this option is set (and
6039 'laststatus' is 2) is controlling the output of |CTRL-G|.
6040
6041 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006042 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006044 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 minwid Minimum width of the item, padding as set by '-' & '0'.
6046 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006047 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006048 on the left for text items. Numeric items will be
6049 shifted down to maxwid-2 digits followed by '>'number
6050 where number is the amount of missing digits, much like
6051 an exponential notation.
6052 item A one letter code as described below.
6053
6054 Following is a description of the possible statusline items. The
6055 second character in "item" is the type:
6056 N for number
6057 S for string
6058 F for flags as described below
6059 - not applicable
6060
6061 item meaning ~
6062 f S Path to the file in the buffer, relative to current directory.
6063 F S Full path to the file in the buffer.
6064 t S File name (tail) of file in the buffer.
6065 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6066 M F Modified flag, text is ",+" or ",-".
6067 r F Readonly flag, text is " [RO]".
6068 R F Readonly flag, text is ",RO".
6069 h F Help buffer flag, text is " [help]".
6070 H F Help buffer flag, text is ",HLP".
6071 w F Preview window flag, text is " [Preview]".
6072 W F Preview window flag, text is ",PRV".
6073 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6074 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6075 {not available when compiled without |+autocmd| feature}
6076 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6077 being used: "<keymap>"
6078 n N Buffer number.
6079 b N Value of byte under cursor.
6080 B N As above, in hexadecimal.
6081 o N Byte number in file of byte under cursor, first byte is 1.
6082 Mnemonic: Offset from start of file (with one added)
6083 {not available when compiled without |+byte_offset| feature}
6084 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006085 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 l N Line number.
6087 L N Number of lines in buffer.
6088 c N Column number.
6089 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006090 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 p N Percentage through file in lines as in |CTRL-G|.
6092 P S Percentage through file of displayed window. This is like the
6093 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006094 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006096 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006097 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 ( - Start of item group. Can be used for setting the width and
6099 alignment of a section. Must be followed by %) somewhere.
6100 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006101 T N For 'tabline': start of tab page N label. Use %T after the last
6102 label. This information is used for mouse clicks.
6103 X N For 'tabline': start of close tab N label. Use %X after the
6104 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6105 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 < - Where to truncate line if too long. Default is at the start.
6107 No width fields allowed.
6108 = - Separation point between left and right aligned items.
6109 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006110 # - Set highlight group. The name must follow and then a # again.
6111 Thus use %#HLname# for highlight group HLname. The same
6112 highlighting is used, also for the statusline of non-current
6113 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006115 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 The difference between User{N} and StatusLine will be applied
6117 to StatusLineNC for the statusline of non-current windows.
6118 The number N must be between 1 and 9. See |hl-User1..9|
6119
6120 Display of flags are controlled by the following heuristic:
6121 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006122 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 with a space it is assumed that it wants to separate itself from
6124 anything but other flags. That is: A leading comma is removed if the
6125 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006126 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 make a nice display when flags are used like in the examples below.
6128
Bram Moolenaar582fd852005-03-28 20:58:01 +00006129 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130 not set) and a minwid is not set for the group, the whole group will
6131 become empty. This will make a group like the following disappear
6132 completely from the statusline when none of the flags are set. >
6133 :set statusline=...%(\ [%M%R%H]%)...
6134<
6135 Beware that an expression is evaluated each and every time the status
6136 line is displayed. The current buffer and current window will be set
6137 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006138 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006140 real current buffer.
6141
6142 The 'statusline' option may be evaluated in the |sandbox|, see
6143 |sandbox-option|.
6144
6145 It is not allowed to change text or jump to another window while
6146 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147
6148 If the statusline is not updated when you want it (e.g., after setting
6149 a variable that's used in an expression), you can force an update by
6150 setting an option without changing its value. Example: >
6151 :let &ro = &ro
6152
6153< A result of all digits is regarded a number for display purposes.
6154 Otherwise the result is taken as flag text and applied to the rules
6155 described above.
6156
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006157 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6159 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6160
6161 Examples:
6162 Emulate standard status line with 'ruler' set >
6163 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6164< Similar, but add ASCII value of char under the cursor (like "ga") >
6165 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6166< Display byte count and byte value, modified flag in red. >
6167 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6168 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6169< Display a ,GZ flag if a compressed file is loaded >
6170 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6171< In the |:autocmd|'s: >
6172 :let b:gzflag = 1
6173< And: >
6174 :unlet b:gzflag
6175< And define this function: >
6176 :function VarExists(var, val)
6177 : if exists(a:var) | return a:val | else | return '' | endif
6178 :endfunction
6179<
6180 *'suffixes'* *'su'*
6181'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6182 global
6183 {not in Vi}
6184 Files with these suffixes get a lower priority when multiple files
6185 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006186 suffixes. Spaces after the comma are ignored. A dot is also seen as
6187 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 separator, precede it with a backslash (see |option-backslash| about
6189 including spaces and backslashes).
6190 See 'wildignore' for completely ignoring files.
6191 The use of |:set+=| and |:set-=| is preferred when adding or removing
6192 suffixes from the list. This avoids problems when a future version
6193 uses another default.
6194
6195 *'suffixesadd'* *'sua'*
6196'suffixesadd' 'sua' string (default "")
6197 local to buffer
6198 {not in Vi}
6199 {not available when compiled without the
6200 |+file_in_path| feature}
6201 Comma separated list of suffixes, which are used when searching for a
6202 file for the "gf", "[I", etc. commands. Example: >
6203 :set suffixesadd=.java
6204<
6205 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6206'swapfile' 'swf' boolean (default on)
6207 local to buffer
6208 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006209 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 swapfile is not wanted for a specific buffer. For example, with
6211 confidential information that even root must not be able to access.
6212 Careful: All text will be in memory:
6213 - Don't use this for big files.
6214 - Recovery will be impossible!
6215 A swapfile will only be present when |'updatecount'| is non-zero and
6216 'swapfile' is set.
6217 When 'swapfile' is reset, the swap file for the current buffer is
6218 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6219 non-zero, a swap file is immediately created.
6220 Also see |swap-file| and |'swapsync'|.
6221
6222 This option is used together with 'bufhidden' and 'buftype' to
6223 specify special kinds of buffers. See |special-buffers|.
6224
6225 *'swapsync'* *'sws'*
6226'swapsync' 'sws' string (default "fsync")
6227 global
6228 {not in Vi}
6229 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006230 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 When this option is empty parts of the swap file may be in memory and
6232 not written to disk. When the system crashes you may lose more work.
6233 On Unix the system does a sync now and then without Vim asking for it,
6234 so the disadvantage of setting this option off is small. On some
6235 systems the swap file will not be written at all. For a unix system
6236 setting it to "sync" will use the sync() call instead of the default
6237 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006238 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239
6240 *'switchbuf'* *'swb'*
6241'switchbuf' 'swb' string (default "")
6242 global
6243 {not in Vi}
6244 This option controls the behavior when switching between buffers.
6245 Possible values (comma separated list):
6246 useopen If included, jump to the first open window that
6247 contains the specified buffer (if there is one).
6248 Otherwise: Do not examine other windows.
6249 This setting is checked with |quickfix| commands, when
6250 jumping to errors (":cc", ":cn", "cp", etc.). It is
6251 also used in all buffer related split commands, for
6252 example ":sbuffer", ":sbnext", or ":sbrewind".
6253 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006254 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 Supported in |quickfix| commands that display errors.
6256
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006257 *'synmaxcol'* *'smc'*
6258'synmaxcol' 'smc' number (default 3000)
6259 local to buffer
6260 {not in Vi}
6261 {not available when compiled without the |+syntax|
6262 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006263 Maximum column in which to search for syntax items. In long lines the
6264 text after this column is not highlighted and following lines may not
6265 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006266 This helps to avoid very slow redrawing for an XML file that is one
6267 long line.
6268 Set to zero to remove the limit.
6269
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 *'syntax'* *'syn'*
6271'syntax' 'syn' string (default empty)
6272 local to buffer
6273 {not in Vi}
6274 {not available when compiled without the |+syntax|
6275 feature}
6276 When this option is set, the syntax with this name is loaded, unless
6277 syntax highlighting has been switched off with ":syntax off".
6278 Otherwise this option does not always reflect the current syntax (the
6279 b:current_syntax variable does).
6280 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006281 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 /* vim: set syntax=idl : */
6283< To switch off syntax highlighting for the current file, use: >
6284 :set syntax=OFF
6285< To switch syntax highlighting on according to the current value of the
6286 'filetype' option: >
6287 :set syntax=ON
6288< What actually happens when setting the 'syntax' option is that the
6289 Syntax autocommand event is triggered with the value as argument.
6290 This option is not copied to another buffer, independent of the 's' or
6291 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006292 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006294 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006295'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006296 global
6297 {not in Vi}
6298 {not available when compiled without the +windows
6299 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006300 When nonempty, this option determines the content of the tab pages
6301 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006302 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006303
6304 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006305 option and only when there is no GUI tab line. When 'e' is in
6306 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6307 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006308
6309 The value is evaluated like with 'statusline'. You can use
6310 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006311 the text to be displayed. Use "%1T" for the first label, "%2T" for
6312 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006313
6314 Keep in mind that only one of the tab pages is the current one, others
6315 are invisible and you can't jump to their windows.
6316
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006317
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 *'tabstop'* *'ts'*
6319'tabstop' 'ts' number (default 8)
6320 local to buffer
6321 Number of spaces that a <Tab> in the file counts for. Also see
6322 |:retab| command, and 'softtabstop' option.
6323
6324 Note: Setting 'tabstop' to any other value than 8 can make your file
6325 appear wrong in many places (e.g., when printing it).
6326
6327 There are four main ways to use tabs in Vim:
6328 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6329 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6330 will use a mix of tabs and spaces, but typing Tab and BS will
6331 behave like a tab appears every 4 (or 3) characters.
6332 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6333 'expandtab'. This way you will always insert spaces. The
6334 formatting will never be messed up when 'tabstop' is changed.
6335 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006336 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 works when using Vim to edit the file.
6338 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6339 'noexpandtab'. This should then work (for initial indents only)
6340 for any tabstop setting that people use. It might be nice to have
6341 tabs after the first non-blank inserted as spaces if you do this
6342 though. Otherwise aligned comments will be wrong when 'tabstop' is
6343 changed.
6344
6345 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6346'tagbsearch' 'tbs' boolean (default on)
6347 global
6348 {not in Vi}
6349 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006350 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 searching makes searching for a tag a LOT faster, but a linear search
6352 will find more tags if the tags file wasn't properly sorted.
6353 Vim normally assumes that your tags files are sorted, or indicate that
6354 they are not sorted. Only when this is not the case does the
6355 'tagbsearch' option need to be switched off.
6356
6357 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006358 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 certain files, or retry all files with a linear search. When
6360 'tagbsearch' is off, only a linear search is done.
6361
6362 Linear searching is done anyway, for one file, when Vim finds a line
6363 at the start of the file indicating that it's not sorted: >
6364 !_TAG_FILE_SORTED 0 /some command/
6365< [The whitespace before and after the '0' must be a single <Tab>]
6366
6367 When a binary search was done and no match was found in any of the
6368 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6369 instead of a normal tag name, a retry is done with a linear search.
6370 Tags in unsorted tags files, and matches with different case will only
6371 be found in the retry.
6372
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006373 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 linear search can be avoided for the 'ignorecase' case. Use a value
6375 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6376 case-fold sorted with the -f switch to "sort" in most unices, as in
6377 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6378 5.3 or higher the -f or --fold-case-sort switch can be used for this
6379 as well. Note that case must be folded to uppercase for this to work.
6380
6381 When 'tagbsearch' is off, tags searching is slower when a full match
6382 exists, but faster when no full match exists. Tags in unsorted tags
6383 files may only be found with 'tagbsearch' off.
6384 When the tags file is not sorted, or sorted in a wrong way (not on
6385 ASCII byte value), 'tagbsearch' should be off, or the line given above
6386 must be included in the tags file.
6387 This option doesn't affect commands that find all matching tags (e.g.,
6388 command-line completion and ":help").
6389 {Vi: always uses binary search in some versions}
6390
6391 *'taglength'* *'tl'*
6392'taglength' 'tl' number (default 0)
6393 global
6394 If non-zero, tags are significant up to this number of characters.
6395
6396 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6397'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6398 global
6399 {not in Vi}
6400 If on and using a tag file in another directory, file names in that
6401 tag file are relative to the directory where the tag file is.
6402 NOTE: This option is set to the Vi default value when 'compatible' is
6403 set and to the Vim default value when 'compatible' is reset.
6404
6405 *'tags'* *'tag'* *E433*
6406'tags' 'tag' string (default "./tags,tags", when compiled with
6407 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6408 global or local to buffer |global-local|
6409 Filenames for the tag command, separated by spaces or commas. To
6410 include a space or comma in a file name, precede it with a backslash
6411 (see |option-backslash| about including spaces and backslashes).
6412 When a file name starts with "./", the '.' is replaced with the path
6413 of the current file. But only when the 'd' flag is not included in
6414 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6415 |tags-option|.
6416 "*", "**" and other wildcards can be used to search for tags files in
6417 a directory tree. See |file-searching|. {not available when compiled
6418 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006419 The |tagfiles()| function can be used to get a list of the file names
6420 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6422 files are also supported. They are automatically recognized. The
6423 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6424 differences are ignored (MS-Windows). |emacs-tags|
6425 The use of |:set+=| and |:set-=| is preferred when adding or removing
6426 file names from the list. This avoids problems when a future version
6427 uses another default.
6428 {Vi: default is "tags /usr/lib/tags"}
6429
6430 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6431'tagstack' 'tgst' boolean (default on)
6432 global
6433 {not in all versions of Vi}
6434 When on, the |tagstack| is used normally. When off, a ":tag" or
6435 ":tselect" command with an argument will not push the tag onto the
6436 tagstack. A following ":tag" without an argument, a ":pop" command or
6437 any other command that uses the tagstack will use the unmodified
6438 tagstack, but does change the pointer to the active entry.
6439 Resetting this option is useful when using a ":tag" command in a
6440 mapping which should not change the tagstack.
6441
6442 *'term'* *E529* *E530* *E531*
6443'term' string (default is $TERM, if that fails:
6444 in the GUI: "builtin_gui"
6445 on Amiga: "amiga"
6446 on BeOS: "beos-ansi"
6447 on Mac: "mac-ansi"
6448 on MiNT: "vt52"
6449 on MS-DOS: "pcterm"
6450 on OS/2: "os2ansi"
6451 on Unix: "ansi"
6452 on VMS: "ansi"
6453 on Win 32: "win32")
6454 global
6455 Name of the terminal. Used for choosing the terminal control
6456 characters. Environment variables are expanded |:set_env|.
6457 For example: >
6458 :set term=$TERM
6459< See |termcap|.
6460
6461 *'termbidi'* *'tbidi'*
6462 *'notermbidi'* *'notbidi'*
6463'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6464 global
6465 {not in Vi}
6466 {only available when compiled with the |+arabic|
6467 feature}
6468 The terminal is in charge of Bi-directionality of text (as specified
6469 by Unicode). The terminal is also expected to do the required shaping
6470 that some languages (such as Arabic) require.
6471 Setting this option implies that 'rightleft' will not be set when
6472 'arabic' is set and the value of 'arabicshape' will be ignored.
6473 Note that setting 'termbidi' has the immediate effect that
6474 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6475 This option is reset when the GUI is started.
6476 For further details see |arabic.txt|.
6477
6478 *'termencoding'* *'tenc'*
6479'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6480 Macintosh GUI: "macroman")
6481 global
6482 {only available when compiled with the |+multi_byte|
6483 feature}
6484 {not in Vi}
6485 Encoding used for the terminal. This specifies what character
6486 encoding the keyboard produces and the display will understand. For
6487 the GUI it only applies to the keyboard ('encoding' is used for the
6488 display).
6489 In the Win32 console version the default value is the console codepage
6490 when it differs from the ANSI codepage.
6491 *E617*
6492 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6493 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6494 Any attempts to set a different value will be rejected, and an error
6495 message is shown.
6496 For the Win32 GUI 'termencoding' is not used for typed characters,
6497 because the Win32 system always passes Unicode characters.
6498 When empty, the same encoding is used as for the 'encoding' option.
6499 This is the normal value.
6500 Not all combinations for 'termencoding' and 'encoding' are valid. See
6501 |encoding-table|.
6502 The value for this option must be supported by internal conversions or
6503 iconv(). When this is not possible no conversion will be done and you
6504 will probably experience problems with non-ASCII characters.
6505 Example: You are working with the locale set to euc-jp (Japanese) and
6506 want to edit a UTF-8 file: >
6507 :let &termencoding = &encoding
6508 :set encoding=utf-8
6509< You need to do this when your system has no locale support for UTF-8.
6510
6511 *'terse'* *'noterse'*
6512'terse' boolean (default off)
6513 global
6514 When set: Add 's' flag to 'shortmess' option (this makes the message
6515 for a search that hits the start or end of the file not being
6516 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6517 shortens a lot of messages}
6518
6519 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6520'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6521 global
6522 {not in Vi}
6523 This option is obsolete. Use 'fileformats'.
6524 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6525 set to the default value for the current system. When 'textauto' is
6526 reset, 'fileformats' is made empty.
6527 NOTE: This option is set to the Vi default value when 'compatible' is
6528 set and to the Vim default value when 'compatible' is reset.
6529
6530 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6531'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6532 others: default off)
6533 local to buffer
6534 {not in Vi}
6535 This option is obsolete. Use 'fileformat'.
6536 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6537 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6538 "unix".
6539
6540 *'textwidth'* *'tw'*
6541'textwidth' 'tw' number (default 0)
6542 local to buffer
6543 {not in Vi}
6544 Maximum width of text that is being inserted. A longer line will be
6545 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006546 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6547 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 'formatoptions' and |ins-textwidth|.
6549 NOTE: This option is set to 0 when 'compatible' is set.
6550
6551 *'thesaurus'* *'tsr'*
6552'thesaurus' 'tsr' string (default "")
6553 global or local to buffer |global-local|
6554 {not in Vi}
6555 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006556 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 the file should contain words with similar meaning, separated by
6558 non-keyword characters (white space is preferred). Maximum line
6559 length is 510 bytes.
6560 To obtain a file to be used here, check out the wordlist FAQ at
6561 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006562 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 after a comma are ignored, otherwise spaces are included in the file
6564 name. See |option-backslash| about using backslashes.
6565 The use of |:set+=| and |:set-=| is preferred when adding or removing
6566 directories from the list. This avoids problems when a future version
6567 uses another default.
6568 Backticks cannot be used in this option for security reasons.
6569
6570 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6571'tildeop' 'top' boolean (default off)
6572 global
6573 {not in Vi}
6574 When on: The tilde command "~" behaves like an operator.
6575 NOTE: This option is reset when 'compatible' is set.
6576
6577 *'timeout'* *'to'* *'notimeout'* *'noto'*
6578'timeout' 'to' boolean (default on)
6579 global
6580 *'ttimeout'* *'nottimeout'*
6581'ttimeout' boolean (default off)
6582 global
6583 {not in Vi}
6584 These two options together determine the behavior when part of a
6585 mapped key sequence or keyboard code has been received:
6586
6587 'timeout' 'ttimeout' action ~
6588 off off do not time out
6589 on on or off time out on :mappings and key codes
6590 off on time out on key codes
6591
6592 If both options are off, Vim will wait until either the complete
6593 mapping or key sequence has been received, or it is clear that there
6594 is no mapping or key sequence for the received characters. For
6595 example: if you have mapped "vl" and Vim has received 'v', the next
6596 character is needed to see if the 'v' is followed by an 'l'.
6597 When one of the options is on, Vim will wait for about 1 second for
6598 the next character to arrive. After that the already received
6599 characters are interpreted as single characters. The waiting time can
6600 be changed with the 'timeoutlen' option.
6601 On slow terminals or very busy systems timing out may cause
6602 malfunctioning cursor keys. If both options are off, Vim waits
6603 forever after an entered <Esc> if there are key codes that start
6604 with <Esc>. You will have to type <Esc> twice. If you do not have
6605 problems with key codes, but would like to have :mapped key
6606 sequences not timing out in 1 second, set the 'ttimeout' option and
6607 reset the 'timeout' option.
6608
6609 NOTE: 'ttimeout' is reset when 'compatible' is set.
6610
6611 *'timeoutlen'* *'tm'*
6612'timeoutlen' 'tm' number (default 1000)
6613 global
6614 {not in all versions of Vi}
6615 *'ttimeoutlen'* *'ttm'*
6616'ttimeoutlen' 'ttm' number (default -1)
6617 global
6618 {not in Vi}
6619 The time in milliseconds that is waited for a key code or mapped key
6620 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6621 when part of a command has been typed.
6622 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6623 different timeout value for key codes is desired set 'ttimeoutlen' to
6624 a non-negative number.
6625
6626 ttimeoutlen mapping delay key code delay ~
6627 < 0 'timeoutlen' 'timeoutlen'
6628 >= 0 'timeoutlen' 'ttimeoutlen'
6629
6630 The timeout only happens when the 'timeout' and 'ttimeout' options
6631 tell so. A useful setting would be >
6632 :set timeout timeoutlen=3000 ttimeoutlen=100
6633< (time out on mapping after three seconds, time out on key codes after
6634 a tenth of a second).
6635
6636 *'title'* *'notitle'*
6637'title' boolean (default off, on when title can be restored)
6638 global
6639 {not in Vi}
6640 {not available when compiled without the |+title|
6641 feature}
6642 When on, the title of the window will be set to the value of
6643 'titlestring' (if it is not empty), or to:
6644 filename [+=-] (path) - VIM
6645 Where:
6646 filename the name of the file being edited
6647 - indicates the file cannot be modified, 'ma' off
6648 + indicates the file was modified
6649 = indicates the file is read-only
6650 =+ indicates the file is read-only and modified
6651 (path) is the path of the file being edited
6652 - VIM the server name |v:servername| or "VIM"
6653 Only works if the terminal supports setting window titles
6654 (currently Amiga console, Win32 console, all GUI versions and
6655 terminals with a non- empty 't_ts' option - these are Unix xterm and
6656 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6657 *X11*
6658 When Vim was compiled with HAVE_X11 defined, the original title will
6659 be restored if possible. The output of ":version" will include "+X11"
6660 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6661 works for the icon name |'icon'|.
6662 But: When Vim was started with the |-X| argument, restoring the title
6663 will not work (except in the GUI).
6664 If the title cannot be restored, it is set to the value of 'titleold'.
6665 You might want to restore the title outside of Vim then.
6666 When using an xterm from a remote machine you can use this command:
6667 rsh machine_name xterm -display $DISPLAY &
6668 then the WINDOWID environment variable should be inherited and the
6669 title of the window should change back to what it should be after
6670 exiting Vim.
6671
6672 *'titlelen'*
6673'titlelen' number (default 85)
6674 global
6675 {not in Vi}
6676 {not available when compiled without the |+title|
6677 feature}
6678 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006679 title. When the title is longer, only the end of the path name is
6680 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 Using a percentage makes this adapt to the width of the window. But
6682 it won't work perfectly, because the actual number of characters
6683 available also depends on the font used and other things in the title
6684 bar. When 'titlelen' is zero the full path is used. Otherwise,
6685 values from 1 to 30000 percent can be used.
6686 'titlelen' is also used for the 'titlestring' option.
6687
6688 *'titleold'*
6689'titleold' string (default "Thanks for flying Vim")
6690 global
6691 {not in Vi}
6692 {only available when compiled with the |+title|
6693 feature}
6694 This option will be used for the window title when exiting Vim if the
6695 original title cannot be restored. Only happens if 'title' is on or
6696 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006697 This option cannot be set from a |modeline| or in the |sandbox|, for
6698 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 *'titlestring'*
6700'titlestring' string (default "")
6701 global
6702 {not in Vi}
6703 {not available when compiled without the |+title|
6704 feature}
6705 When this option is not empty, it will be used for the title of the
6706 window. This happens only when the 'title' option is on.
6707 Only works if the terminal supports setting window titles (currently
6708 Amiga console, Win32 console, all GUI versions and terminals with a
6709 non-empty 't_ts' option).
6710 When Vim was compiled with HAVE_X11 defined, the original title will
6711 be restored if possible |X11|.
6712 When this option contains printf-style '%' items, they will be
6713 expanded according to the rules used for 'statusline'.
6714 Example: >
6715 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6716 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6717< The value of 'titlelen' is used to align items in the middle or right
6718 of the available space.
6719 Some people prefer to have the file name first: >
6720 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6721< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006722 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 separating space only when needed.
6724 NOTE: Use of special characters in 'titlestring' may cause the display
6725 to be garbled (e.g., when it contains a CR or NL character).
6726 {not available when compiled without the |+statusline| feature}
6727
6728 *'toolbar'* *'tb'*
6729'toolbar' 'tb' string (default "icons,tooltips")
6730 global
6731 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6732 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006733 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 possible values are:
6735 icons Toolbar buttons are shown with icons.
6736 text Toolbar buttons shown with text.
6737 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006738 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 tooltips Tooltips are active for toolbar buttons.
6740 Tooltips refer to the popup help text which appears after the mouse
6741 cursor is placed over a toolbar button for a brief moment.
6742
6743 If you want the toolbar to be shown with icons as well as text, do the
6744 following: >
6745 :set tb=icons,text
6746< Motif and Athena cannot display icons and text at the same time. They
6747 will show icons if both are requested.
6748
6749 If none of the strings specified in 'toolbar' are valid or if
6750 'toolbar' is empty, this option is ignored. If you want to disable
6751 the toolbar, you need to set the 'guioptions' option. For example: >
6752 :set guioptions-=T
6753< Also see |gui-toolbar|.
6754
6755 *'toolbariconsize'* *'tbis'*
6756'toolbariconsize' 'tbis' string (default "small")
6757 global
6758 {not in Vi}
6759 {only in the GTK+ 2 GUI}
6760 Controls the size of toolbar icons. The possible values are:
6761 tiny Use tiny toolbar icons.
6762 small Use small toolbar icons (default).
6763 medium Use medium-sized toolbar icons.
6764 large Use large toolbar icons.
6765 The exact dimensions in pixels of the various icon sizes depend on
6766 the current theme. Common dimensions are large=32x32, medium=24x24,
6767 small=20x20 and tiny=16x16.
6768
6769 If 'toolbariconsize' is empty, the global default size as determined
6770 by user preferences or the current theme is used.
6771
6772 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6773'ttybuiltin' 'tbi' boolean (default on)
6774 global
6775 {not in Vi}
6776 When on, the builtin termcaps are searched before the external ones.
6777 When off the builtin termcaps are searched after the external ones.
6778 When this option is changed, you should set the 'term' option next for
6779 the change to take effect, for example: >
6780 :set notbi term=$TERM
6781< See also |termcap|.
6782 Rationale: The default for this option is "on", because the builtin
6783 termcap entries are generally better (many systems contain faulty
6784 xterm entries...).
6785
6786 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6787'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6788 sun-cmd, screen, rxvt, dtterm or
6789 iris-ansi; also on when running Vim in
6790 a DOS console)
6791 global
6792 {not in Vi}
6793 Indicates a fast terminal connection. More characters will be sent to
6794 the screen for redrawing, instead of using insert/delete line
6795 commands. Improves smoothness of redrawing when there are multiple
6796 windows and the terminal does not support a scrolling region.
6797 Also enables the extra writing of characters at the end of each screen
6798 line for lines that wrap. This helps when using copy/paste with the
6799 mouse in an xterm and other terminals.
6800
6801 *'ttymouse'* *'ttym'*
6802'ttymouse' 'ttym' string (default depends on 'term')
6803 global
6804 {not in Vi}
6805 {only in Unix and VMS, doesn't work in the GUI; not
6806 available when compiled without |+mouse|}
6807 Name of the terminal type for which mouse codes are to be recognized.
6808 Currently these three strings are valid:
6809 *xterm-mouse*
6810 xterm xterm-like mouse handling. The mouse generates
6811 "<Esc>[Mscr", where "scr" is three bytes:
6812 "s" = button state
6813 "c" = column plus 33
6814 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006815 This only works up to 223 columns! See "dec" for a
6816 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 xterm2 Works like "xterm", but with the xterm reporting the
6818 mouse position while the mouse is dragged. This works
6819 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006820 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 work. See below for how Vim detects this
6822 automatically.
6823 *netterm-mouse*
6824 netterm NetTerm mouse handling. The mouse generates
6825 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6826 for the row and column.
6827 *dec-mouse*
6828 dec DEC terminal mouse handling. The mouse generates a
6829 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006830 This is also available for an Xterm, if it was
6831 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 *jsbterm-mouse*
6833 jsbterm JSB term mouse handling.
6834 *pterm-mouse*
6835 pterm QNX pterm mouse handling.
6836
6837 The mouse handling must be enabled at compile time |+mouse_xterm|
6838 |+mouse_dec| |+mouse_netterm|.
6839 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6840 recognized, if enabled at compile time. DEC terminal mouse codes
6841 are recognized if enabled at compile time, and 'ttymouse' is not
6842 "xterm" (because the xterm and dec mouse codes conflict).
6843 This option is automatically set to "xterm", when the 'term' option is
6844 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6845 or "xterm2" already. The main use of this option is to set it to
6846 "xterm", when the terminal name doesn't start with "xterm", but it can
6847 handle xterm mouse codes.
6848 The "xterm2" value will be set if the xterm version is reported to be
6849 95 of higher. This only works when compiled with the |+termresponse|
6850 feature and if |t_RV| is set to the escape sequence to request the
6851 xterm version number. Otherwise "xterm2" must be set explicitly.
6852 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6853 t_RV to an empty string: >
6854 :set t_RV=
6855<
6856 *'ttyscroll'* *'tsl'*
6857'ttyscroll' 'tsl' number (default 999)
6858 global
6859 Maximum number of lines to scroll the screen. If there are more lines
6860 to scroll the window is redrawn. For terminals where scrolling is
6861 very slow and redrawing is not slow this can be set to a small number,
6862 e.g., 3, to speed up displaying.
6863
6864 *'ttytype'* *'tty'*
6865'ttytype' 'tty' string (default from $TERM)
6866 global
6867 Alias for 'term', see above.
6868
6869 *'undolevels'* *'ul'*
6870'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6871 Win32 and OS/2)
6872 global
6873 {not in Vi}
6874 Maximum number of changes that can be undone. Since undo information
6875 is kept in memory, higher numbers will cause more memory to be used
6876 (nevertheless, a single change can use an unlimited amount of memory).
6877 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6878 itself: >
6879 set ul=0
6880< But you can also get Vi compatibility by including the 'u' flag in
6881 'cpoptions', and still be able to use CTRL-R to repeat undo.
6882 Set to a negative number for no undo at all: >
6883 set ul=-1
6884< This helps when you run out of memory for a single change.
6885 Also see |undo-two-ways|.
6886
6887 *'updatecount'* *'uc'*
6888'updatecount' 'uc' number (default: 200)
6889 global
6890 {not in Vi}
6891 After typing this many characters the swap file will be written to
6892 disk. When zero, no swap file will be created at all (see chapter on
6893 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6894 Vim with the "-n" option, see |startup|. When editing in readonly
6895 mode this option will be initialized to 10000.
6896 The swapfile can be disabled per buffer with |'swapfile'|.
6897 When 'updatecount' is set from zero to non-zero, swap files are
6898 created for all buffers that have 'swapfile' set. When 'updatecount'
6899 is set to zero, existing swap files are not deleted.
6900 Also see |'swapsync'|.
6901 This option has no meaning in buffers where |'buftype'| is "nofile"
6902 or "nowrite".
6903
6904 *'updatetime'* *'ut'*
6905'updatetime' 'ut' number (default 4000)
6906 global
6907 {not in Vi}
6908 If this many milliseconds nothing is typed the swap file will be
6909 written to disk (see |crash-recovery|). Also used for the
6910 |CursorHold| autocommand event.
6911
6912 *'verbose'* *'vbs'*
6913'verbose' 'vbs' number (default 0)
6914 global
6915 {not in Vi, although some versions have a boolean
6916 verbose option}
6917 When bigger than zero, Vim will give messages about what it is doing.
6918 Currently, these messages are given:
6919 >= 1 When the viminfo file is read or written.
6920 >= 2 When a file is ":source"'ed.
6921 >= 5 Every searched tags file.
6922 >= 8 Files for which a group of autocommands is executed.
6923 >= 9 Every executed autocommand.
6924 >= 12 Every executed function.
6925 >= 13 When an exception is thrown, caught, finished, or discarded.
6926 >= 14 Anything pending in a ":finally" clause.
6927 >= 15 Every executed Ex command (truncated at 200 characters).
6928
6929 This option can also be set with the "-V" argument. See |-V|.
6930 This option is also set by the |:verbose| command.
6931
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006932 When the 'verbosefile' option is set then the verbose messages are not
6933 displayed.
6934
6935 *'verbosefile'* *'vfile'*
6936'verbosefile' 'vfile' string (default empty)
6937 global
6938 {not in Vi}
6939 When not empty all messages are written in a file with this name.
6940 When the file exists messages are appended.
6941 Writing to the file ends when Vim exits or when 'verbosefile' is made
6942 empty.
6943 Setting 'verbosefile' to a new value is like making it empty first.
6944 The difference with |:redir| is that verbose messages are not
6945 displayed when 'verbosefile' is set.
6946
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 *'viewdir'* *'vdir'*
6948'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6949 "$VIM/vimfiles/view",
6950 for Unix: "~/.vim/view",
6951 for Macintosh: "$VIM:vimfiles:view"
6952 for VMS: "sys$login:vimfiles/view"
6953 for RiscOS: "Choices:vimfiles/view")
6954 global
6955 {not in Vi}
6956 {not available when compiled without the +mksession
6957 feature}
6958 Name of the directory where to store files for |:mkview|.
6959 This option cannot be set from a |modeline| or in the |sandbox|, for
6960 security reasons.
6961
6962 *'viewoptions'* *'vop'*
6963'viewoptions' 'vop' string (default: "folds,options,cursor")
6964 global
6965 {not in Vi}
6966 {not available when compiled without the +mksession
6967 feature}
6968 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006969 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 word save and restore ~
6971 cursor cursor position in file and in window
6972 folds manually created folds, opened/closed folds and local
6973 fold options
6974 options options and mappings local to a window or buffer (not
6975 global values for local options)
6976 slash backslashes in file names replaced with forward
6977 slashes
6978 unix with Unix end-of-line format (single <NL>), even when
6979 on Windows or DOS
6980
6981 "slash" and "unix" are useful on Windows when sharing view files
6982 with Unix. The Unix version of Vim cannot source dos format scripts,
6983 but the Windows version of Vim can source unix format scripts.
6984
6985 *'viminfo'* *'vi'* *E526* *E527* *E528*
6986'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6987 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6988 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6989 for others: '20,<50,s10,h)
6990 global
6991 {not in Vi}
6992 {not available when compiled without the |+viminfo|
6993 feature}
6994 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006995 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 separated list of parameters, each consisting of a single character
6997 identifying the particular parameter, followed by a number or string
6998 which specifies the value of that parameter. If a particular
6999 character is left out, then the default value is used for that
7000 parameter. The following is a list of the identifying characters and
7001 the effect of their value.
7002 CHAR VALUE ~
7003 ! When included, save and restore global variables that start
7004 with an uppercase letter, and don't contain a lowercase
7005 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007006 and "_K_L_M" are not. Only String and Number types are
7007 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 " Maximum number of lines saved for each register. Old name of
7009 the '<' item, with the disadvantage that you need to put a
7010 backslash before the ", otherwise it will be recognized as the
7011 start of a comment!
7012 % When included, save and restore the buffer list. If Vim is
7013 started with a file name argument, the buffer list is not
7014 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007015 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 without a file name and buffers for help files are not written
7017 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007018 When followed by a number, the number specifies the maximum
7019 number of buffers that are stored. Without a number all
7020 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 ' Maximum number of previously edited files for which the marks
7022 are remembered. This parameter must always be included when
7023 'viminfo' is non-empty.
7024 Including this item also means that the |jumplist| and the
7025 |changelist| are stored in the viminfo file.
7026 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007027 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 patterns are also saved. When not included, the value of
7029 'history' is used.
7030 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007031 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 < Maximum number of lines saved for each register. If zero then
7033 registers are not saved. When not included, all lines are
7034 saved. '"' is the old name for this item.
7035 Also see the 's' item below: limit specified in Kbyte.
7036 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007037 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 c When included, convert the text in the viminfo file from the
7039 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007040 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 f Whether file marks need to be stored. If zero, file marks ('0
7042 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007043 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 cursor position (when exiting or when doing ":wviminfo").
7045 h Disable the effect of 'hlsearch' when loading the viminfo
7046 file. When not included, it depends on whether ":nohlsearch"
7047 has been used since the last search command.
7048 n Name of the viminfo file. The name must immediately follow
7049 the 'n'. Must be the last one! If the "-i" argument was
7050 given when starting Vim, that file name overrides the one
7051 given here with 'viminfo'. Environment variables are expanded
7052 when opening the file, not when setting the option.
7053 r Removable media. The argument is a string (up to the next
7054 ','). This parameter can be given several times. Each
7055 specifies the start of a path for which no marks will be
7056 stored. This is to avoid removable media. For MS-DOS you
7057 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7058 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7059 ignored. Maximum length of each 'r' argument is 50
7060 characters.
7061 s Maximum size of an item in Kbyte. If zero then registers are
7062 not saved. Currently only applies to registers. The default
7063 "s10" will exclude registers with more than 10 Kbyte of text.
7064 Also see the '<' item above: line count limit.
7065
7066 Example: >
7067 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7068<
7069 '50 Marks will be remembered for the last 50 files you
7070 edited.
7071 <1000 Contents of registers (up to 1000 lines each) will be
7072 remembered.
7073 s100 Registers with more than 100 Kbyte text are skipped.
7074 :0 Command-line history will not be saved.
7075 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7076 no / Since '/' is not specified, the default will be used,
7077 that is, save all of the search history, and also the
7078 previous search and substitute patterns.
7079 no % The buffer list will not be saved nor read back.
7080 no h 'hlsearch' highlighting will be restored.
7081
7082 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7083 load the contents of the file, this is not done automatically.
7084
7085 This option cannot be set from a |modeline| or in the |sandbox|, for
7086 security reasons.
7087
7088 *'virtualedit'* *'ve'*
7089'virtualedit' 've' string (default "")
7090 global
7091 {not in Vi}
7092 {not available when compiled without the
7093 |+virtualedit| feature}
7094 A comma separated list of these words:
7095 block Allow virtual editing in Visual block mode.
7096 insert Allow virtual editing in Insert mode.
7097 all Allow virtual editing in all modes.
7098 Virtual editing means that the cursor can be positioned where there is
7099 no actual character. This can be halfway into a Tab or beyond the end
7100 of the line. Useful for selecting a rectangle in Visual mode and
7101 editing a table.
7102
7103 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7104'visualbell' 'vb' boolean (default off)
7105 global
7106 {not in Vi}
7107 Use visual bell instead of beeping. The terminal code to display the
7108 visual bell is given with 't_vb'. When no beep or flash is wanted,
7109 use ":set vb t_vb=".
7110 Note: When the GUI starts, 't_vb' is reset to its default value. You
7111 might want to set it again in your |gvimrc|.
7112 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7113 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7114 where 40 is the time in msec.
7115 Does not work on the Amiga, you always get a screen flash.
7116 Also see 'errorbells'.
7117
7118 *'warn'* *'nowarn'*
7119'warn' boolean (default on)
7120 global
7121 Give a warning message when a shell command is used while the buffer
7122 has been changed.
7123
7124 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7125'weirdinvert' 'wiv' boolean (default off)
7126 global
7127 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007128 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 It is provided for backwards compatibility with version 4.x.
7130 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7131 vice versa. Has no effect when the GUI is running.
7132
7133 *'whichwrap'* *'ww'*
7134'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7135 global
7136 {not in Vi}
7137 Allow specified keys that move the cursor left/right to move to the
7138 previous/next line when the cursor is on the first/last character in
7139 the line. Concatenate characters to allow this for these keys:
7140 char key mode ~
7141 b <BS> Normal and Visual
7142 s <Space> Normal and Visual
7143 h "h" Normal and Visual
7144 l "l" Normal and Visual
7145 < <Left> Normal and Visual
7146 > <Right> Normal and Visual
7147 ~ "~" Normal
7148 [ <Left> Insert and Replace
7149 ] <Right> Insert and Replace
7150 For example: >
7151 :set ww=<,>,[,]
7152< allows wrap only when cursor keys are used.
7153 When the movement keys are used in combination with a delete or change
7154 operator, the <EOL> also counts for a character. This makes "3h"
7155 different from "3dh" when the cursor crosses the end of a line. This
7156 is also true for "x" and "X", because they do the same as "dl" and
7157 "dh". If you use this, you may also want to use the mapping
7158 ":map <BS> X" to make backspace delete the character in front of the
7159 cursor.
7160 When 'l' is included, you get a side effect: "yl" on an empty line
7161 will include the <EOL>, so that "p" will insert a new line.
7162 NOTE: This option is set to the Vi default value when 'compatible' is
7163 set and to the Vim default value when 'compatible' is reset.
7164
7165 *'wildchar'* *'wc'*
7166'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7167 global
7168 {not in Vi}
7169 Character you have to type to start wildcard expansion in the
7170 command-line, as specified with 'wildmode'.
7171 The character is not recognized when used inside a macro. See
7172 'wildcharm' for that.
7173 Although 'wc' is a number option, you can set it to a special key: >
7174 :set wc=<Esc>
7175< NOTE: This option is set to the Vi default value when 'compatible' is
7176 set and to the Vim default value when 'compatible' is reset.
7177
7178 *'wildcharm'* *'wcm'*
7179'wildcharm' 'wcm' number (default: none (0))
7180 global
7181 {not in Vi}
7182 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007183 recognized when used inside a macro. You can find "spare" command-line
7184 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 you'll never actually type 'wildcharm', just use it in mappings that
7186 automatically invoke completion mode, e.g.: >
7187 :set wcm=<C-Z>
7188 :cmap ss so $vim/sessions/*.vim<C-Z>
7189< Then after typing :ss you can use CTRL-P & CTRL-N.
7190
7191 *'wildignore'* *'wig'*
7192'wildignore' 'wig' string (default "")
7193 global
7194 {not in Vi}
7195 {not available when compiled without the |+wildignore|
7196 feature}
7197 A list of file patterns. A file that matches with one of these
7198 patterns is ignored when completing file or directory names.
7199 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7200 Also see 'suffixes'.
7201 Example: >
7202 :set wildignore=*.o,*.obj
7203< The use of |:set+=| and |:set-=| is preferred when adding or removing
7204 a pattern from the list. This avoids problems when a future version
7205 uses another default.
7206
7207 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7208'wildmenu' 'wmnu' boolean (default off)
7209 global
7210 {not in Vi}
7211 {not available if compiled without the |+wildmenu|
7212 feature}
7213 When 'wildmenu' is on, command-line completion operates in an enhanced
7214 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7215 the possible matches are shown just above the command line, with the
7216 first match highlighted (overwriting the status line, if there is
7217 one). Keys that show the previous/next match, such as <Tab> or
7218 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7219 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7220 specified. "longest" and "list" do not start "wildmenu" mode.
7221 If there are more matches than can fit in the line, a ">" is shown on
7222 the right and/or a "<" is shown on the left. The status line scrolls
7223 as needed.
7224 The "wildmenu" mode is abandoned when a key is hit that is not used
7225 for selecting a completion.
7226 While the "wildmenu" is active the following keys have special
7227 meanings:
7228
7229 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7230 <Down> - in filename/menu name completion: move into a
7231 subdirectory or submenu.
7232 <CR> - in menu completion, when the cursor is just after a
7233 dot: move into a submenu.
7234 <Up> - in filename/menu name completion: move up into
7235 parent directory or parent menu.
7236
7237 This makes the menus accessible from the console |console-menus|.
7238
7239 If you prefer the <Left> and <Right> keys to move the cursor instead
7240 of selecting a different match, use this: >
7241 :cnoremap <Left> <Space><BS><Left>
7242 :cnoremap <Right> <Space><BS><Right>
7243<
7244 The "WildMenu" highlighting is used for displaying the current match
7245 |hl-WildMenu|.
7246
7247 *'wildmode'* *'wim'*
7248'wildmode' 'wim' string (Vim default: "full")
7249 global
7250 {not in Vi}
7251 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007252 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 part specifies what to do for each consecutive use of 'wildchar. The
7254 first part specifies the behavior for the first use of 'wildchar',
7255 The second part for the second use, etc.
7256 These are the possible values for each part:
7257 "" Complete only the first match.
7258 "full" Complete the next full match. After the last match,
7259 the original string is used and then the first match
7260 again.
7261 "longest" Complete till longest common string. If this doesn't
7262 result in a longer string, use the next part.
7263 "longest:full" Like "longest", but also start 'wildmenu' if it is
7264 enabled.
7265 "list" When more than one match, list all matches.
7266 "list:full" When more than one match, list all matches and
7267 complete first match.
7268 "list:longest" When more than one match, list all matches and
7269 complete till longest common string.
7270 When there is only a single match, it is fully completed in all cases.
7271
7272 Examples: >
7273 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007274< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 :set wildmode=longest,full
7276< Complete longest common string, then each full match >
7277 :set wildmode=list:full
7278< List all matches and complete each full match >
7279 :set wildmode=list,full
7280< List all matches without completing, then each full match >
7281 :set wildmode=longest,list
7282< Complete longest common string, then list alternatives.
7283
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007284 *'wildoptions'* *'wop'*
7285'wildoptions' 'wop' string (default "")
7286 global
7287 {not in Vi}
7288 {not available when compiled without the |+wildignore|
7289 feature}
7290 A list of words that change how command line completion is done.
7291 Currently only one word is allowed:
7292 tagfile When using CTRL-D to list matching tags, the kind of
7293 tag and the file of the tag is listed. Only one match
7294 is displayed per line. Often used tag kinds are:
7295 d #define
7296 f function
7297 Also see |cmdline-completion|.
7298
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 *'winaltkeys'* *'wak'*
7300'winaltkeys' 'wak' string (default "menu")
7301 global
7302 {not in Vi}
7303 {only used in Win32, Motif, GTK and Photon GUI}
7304 Some GUI versions allow the access to menu entries by using the ALT
7305 key in combination with a character that appears underlined in the
7306 menu. This conflicts with the use of the ALT key for mappings and
7307 entering special characters. This option tells what to do:
7308 no Don't use ALT keys for menus. ALT key combinations can be
7309 mapped, but there is no automatic handling. This can then be
7310 done with the |:simalt| command.
7311 yes ALT key handling is done by the windowing system. ALT key
7312 combinations cannot be mapped.
7313 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007314 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 keys can be mapped.
7316 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7317 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007318 This option is not used for <F10>; on Win32 and with GTK <F10> will
7319 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007321 *'window'* *'wi'*
7322'window' 'wi' number (default screen height - 1)
7323 global
7324 Window height. Do not confuse this with the height of the Vim window,
7325 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007326 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7327 value is smaller than 'lines' minus one. The screen will scroll
7328 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007329 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7330 in a much smarter way, taking care of wrapping lines.
7331 When resizing the Vim window, the value is smaller than 1 or more than
7332 or equal to 'lines' it will be set to 'lines' minus 1.
7333 {Vi also uses the option to specify the number of displayed lines}
7334
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 *'winheight'* *'wh'* *E591*
7336'winheight' 'wh' number (default 1)
7337 global
7338 {not in Vi}
7339 {not available when compiled without the +windows
7340 feature}
7341 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007342 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 current window is smaller, its size is increased, at the cost of the
7344 height of other windows. Set it to 999 to make the current window
7345 always fill the screen (although this has the drawback that ":all"
7346 will create only two windows). Set it to a small number for normal
7347 editing.
7348 Minimum value is 1.
7349 The height is not adjusted after one of the commands to change the
7350 height of the current window.
7351 'winheight' applies to the current window. Use 'winminheight' to set
7352 the minimal height for other windows.
7353
7354 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7355'winfixheight' 'wfh' boolean (default off)
7356 local to window
7357 {not in Vi}
7358 {not available when compiled without the +windows
7359 feature}
7360 Keep the window height when windows are opened or closed and
7361 'equalalways' is set. Set by default for the |preview-window| and
7362 |quickfix-window|.
7363 The height may be changed anyway when running out of room.
7364
7365 *'winminheight'* *'wmh'*
7366'winminheight' 'wmh' number (default 1)
7367 global
7368 {not in Vi}
7369 {not available when compiled without the +windows
7370 feature}
7371 The minimal height of a window, when it's not the current window.
7372 This is a hard minimum, windows will never become smaller.
7373 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7374 status bar) if necessary. They will return to at least one line when
7375 they become active (since the cursor has to have somewhere to go.)
7376 Use 'winheight' to set the minimal height of the current window.
7377 This option is only checked when making a window smaller. Don't use a
7378 large number, it will cause errors when opening more than a few
7379 windows. A value of 0 to 3 is reasonable.
7380
7381 *'winminwidth'* *'wmw'*
7382'winminwidth' 'wmw' number (default 1)
7383 global
7384 {not in Vi}
7385 {not available when compiled without the +vertsplit
7386 feature}
7387 The minimal width of a window, when it's not the current window.
7388 This is a hard minimum, windows will never become smaller.
7389 When set to zero, windows may be "squashed" to zero columns (i.e. just
7390 a vertical separator) if necessary. They will return to at least one
7391 line when they become active (since the cursor has to have somewhere
7392 to go.)
7393 Use 'winwidth' to set the minimal width of the current window.
7394 This option is only checked when making a window smaller. Don't use a
7395 large number, it will cause errors when opening more than a few
7396 windows. A value of 0 to 12 is reasonable.
7397
7398 *'winwidth'* *'wiw'* *E592*
7399'winwidth' 'wiw' number (default 20)
7400 global
7401 {not in Vi}
7402 {not available when compiled without the +vertsplit
7403 feature}
7404 Minimal number of columns for the current window. This is not a hard
7405 minimum, Vim will use fewer columns if there is not enough room. If
7406 the current window is smaller, its size is increased, at the cost of
7407 the width of other windows. Set it to 999 to make the current window
7408 always fill the screen. Set it to a small number for normal editing.
7409 The width is not adjusted after one of the commands to change the
7410 width of the current window.
7411 'winwidth' applies to the current window. Use 'winminwidth' to set
7412 the minimal width for other windows.
7413
7414 *'wrap'* *'nowrap'*
7415'wrap' boolean (default on)
7416 local to window
7417 {not in Vi}
7418 This option changes how text is displayed. It doesn't change the text
7419 in the buffer, see 'textwidth' for that.
7420 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007421 displaying continues on the next line. When off lines will not wrap
7422 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423 moved to a part that is not shown, the screen will scroll
7424 horizontally.
7425 The line will be broken in the middle of a word if necessary. See
7426 'linebreak' to get the break at a word boundary.
7427 To make scrolling horizontally a bit more useful, try this: >
7428 :set sidescroll=5
7429 :set listchars+=precedes:<,extends:>
7430< See 'sidescroll', 'listchars' and |wrap-off|.
7431
7432 *'wrapmargin'* *'wm'*
7433'wrapmargin' 'wm' number (default 0)
7434 local to buffer
7435 Number of characters from the right window border where wrapping
7436 starts. When typing text beyond this limit, an <EOL> will be inserted
7437 and inserting continues on the next line.
7438 Options that add a margin, such as 'number' and 'foldcolumn', cause
7439 the text width to be further reduced. This is Vi compatible.
7440 When 'textwidth' is non-zero, this option is not used.
7441 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7442 and less usefully}
7443
7444 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7445'wrapscan' 'ws' boolean (default on) *E384* *E385*
7446 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007447 Searches wrap around the end of the file. Also applies to |]s| and
7448 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449
7450 *'write'* *'nowrite'*
7451'write' boolean (default on)
7452 global
7453 {not in Vi}
7454 Allows writing files. When not set, writing a file is not allowed.
7455 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007456 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 argument. Filtering text is still possible, even though this requires
7458 writing a temporary file.
7459
7460 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7461'writeany' 'wa' boolean (default off)
7462 global
7463 Allows writing to any file with no need for "!" override.
7464
7465 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7466'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7467 otherwise)
7468 global
7469 {not in Vi}
7470 Make a backup before overwriting a file. The backup is removed after
7471 the file was successfully written, unless the 'backup' option is
7472 also on. Reset this option if your file system is almost full. See
7473 |backup-table| for another explanation.
7474 When the 'backupskip' pattern matches, a backup is not made anyway.
7475 NOTE: This option is set to the default value when 'compatible' is
7476 set.
7477
7478 *'writedelay'* *'wd'*
7479'writedelay' 'wd' number (default 0)
7480 global
7481 {not in Vi}
7482 The number of microseconds to wait for each character sent to the
7483 screen. When non-zero, characters are sent to the terminal one by
7484 one. For MS-DOS pcterm this does not work. For debugging purposes.
7485
7486 vim:tw=78:ts=8:ft=help:norl: