blob: 31cd1407696eb048015add79fd769d16b21eb3e3 [file] [log] [blame]
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00001*options.txt* For Vim version 7.0aa. Last change: 2006 Mar 04
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
Bram Moolenaar0b238792006-03-02 22:49:12 +00001579 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 k{dict} scan the file {dict}. Several "k" flags can be given,
1581 patterns are valid too. For example: >
1582 :set cpt=k/usr/dict/*,k~/spanish
1583< s scan the files given with the 'thesaurus' option
1584 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1585 are valid too.
1586 i scan current and included files
1587 d scan current and included files for defined name or macro
1588 |i_CTRL-X_CTRL-D|
1589 ] tag completion
1590 t same as "]"
1591
1592 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1593 not executed, this may lead to unexpected completions from some files
1594 (gzipped files for example). Unloaded buffers are not scanned for
1595 whole-line completion.
1596
1597 The default is ".,w,b,u,t,i", which means to scan:
1598 1. the current buffer
1599 2. buffers in other windows
1600 3. other loaded buffers
1601 4. unloaded buffers
1602 5. tags
1603 6. included files
1604
1605 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001606 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1607 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001609 *'completefunc'* *'cfu'*
1610'completefunc' 'cfu' string (default: empty)
1611 local to buffer
1612 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001613 {not available when compiled without the +eval
1614 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001615 This option specifies a function to be used for Insert mode completion
1616 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001617 See |complete-functions| for an explanation of how the function is
1618 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001619
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001620
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001621 *'completeopt'* *'cot'*
1622'completeopt' 'cot' string (default: "menu")
1623 global
1624 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001625 A comma separated list of options for Insert mode completion
1626 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001627
1628 menu Use a popup menu to show the possible completions. The
1629 menu is only shown when there is more than one match and
1630 sufficient colors are available. |ins-completion-menu|
1631
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001632 menuone Use the popup menu also when there is only one match.
1633 Useful when there is additional information about the
1634 match, e.g., what file it comes from.
1635
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001636 longest Only insert the longest common text of the matches. Use
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001637 CTRL-L to add more characters. Whether case is ignored
1638 depends on the kind of completion. For buffer text the
1639 'ignorecase' option is used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001640
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001641
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1643'confirm' 'cf' boolean (default off)
1644 global
1645 {not in Vi}
1646 When 'confirm' is on, certain operations that would normally
1647 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1648 instead raise a |dialog| asking if you wish to save the current
1649 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1650 If 'confirm' is off you can still activate confirmation for one
1651 command only (this is most useful in mappings) with the |:confirm|
1652 command.
1653 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1654
1655 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1656'conskey' 'consk' boolean (default off)
1657 global
1658 {not in Vi} {only for MS-DOS}
1659 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001660 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 three methods of console input are available:
1662 'conskey' 'bioskey' action ~
1663 on on or off direct console input
1664 off on BIOS
1665 off off STDIN
1666
1667 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1668'copyindent' 'ci' boolean (default off)
1669 local to buffer
1670 {not in Vi}
1671 Copy the structure of the existing lines indent when autoindenting a
1672 new line. Normally the new indent is reconstructed by a series of
1673 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1674 in which case only spaces are used). Enabling this option makes the
1675 new line copy whatever characters were used for indenting on the
1676 existing line. If the new indent is greater than on the existing
1677 line, the remaining space is filled in the normal manner.
1678 NOTE: 'copyindent' is reset when 'compatible' is set.
1679 Also see 'preserveindent'.
1680
1681 *'cpoptions'* *'cpo'*
1682'cpoptions' 'cpo' string (Vim default: "aABceFs",
1683 Vi default: all flags)
1684 global
1685 {not in Vi}
1686 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001687 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 not being vi-compatible is mostly or sometimes preferred.
1689 'cpoptions' stands for "compatible-options".
1690 Commas can be added for readability.
1691 To avoid problems with flags that are added in the future, use the
1692 "+=" and "-=" feature of ":set" |add-option-flags|.
1693 NOTE: This option is set to the Vi default value when 'compatible' is
1694 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001695 NOTE: This option is set to the POSIX default value at startup when
1696 the Vi default value would be used and the $VIM_POSIX environment
1697 variable exists |posix|. This means tries to behave like the POSIX
1698 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699
1700 contains behavior ~
1701 *cpo-a*
1702 a When included, a ":read" command with a file name
1703 argument will set the alternate file name for the
1704 current window.
1705 *cpo-A*
1706 A When included, a ":write" command with a file name
1707 argument will set the alternate file name for the
1708 current window.
1709 *cpo-b*
1710 b "\|" in a ":map" command is recognized as the end of
1711 the map command. The '\' is included in the mapping,
1712 the text after the '|' is interpreted as the next
1713 command. Use a CTRL-V instead of a backslash to
1714 include the '|' in the mapping. Applies to all
1715 mapping, abbreviation, menu and autocmd commands.
1716 See also |map_bar|.
1717 *cpo-B*
1718 B A backslash has no special meaning in mappings,
1719 abbreviations and the "to" part of the menu commands.
1720 Remove this flag to be able to use a backslash like a
1721 CTRL-V. For example, the command ":map X \<Esc>"
1722 results in X being mapped to:
1723 'B' included: "\^[" (^[ is a real <Esc>)
1724 'B' excluded: "<Esc>" (5 characters)
1725 ('<' excluded in both cases)
1726 *cpo-c*
1727 c Searching continues at the end of any match at the
1728 cursor position, but not further than the start of the
1729 next line. When not present searching continues
1730 one character from the cursor position. With 'c'
1731 "abababababab" only gets three matches when repeating
1732 "/abab", without 'c' there are five matches.
1733 *cpo-C*
1734 C Do not concatenate sourced lines that start with a
1735 backslash. See |line-continuation|.
1736 *cpo-d*
1737 d Using "./" in the 'tags' option doesn't mean to use
1738 the tags file relative to the current file, but the
1739 tags file in the current directory.
1740 *cpo-D*
1741 D Can't use CTRL-K to enter a digraph after Normal mode
1742 commands with a character argument, like |r|, |f| and
1743 |t|.
1744 *cpo-e*
1745 e When executing a register with ":@r", always add a
1746 <CR> to the last line, also when the register is not
1747 linewise. If this flag is not present, the register
1748 is not linewise and the last line does not end in a
1749 <CR>, then the last line is put on the command-line
1750 and can be edited before hitting <CR>.
1751 *cpo-E*
1752 E It is an error when using "y", "d", "c", "g~", "gu" or
1753 "gU" on an Empty region. The operators only work when
1754 at least one character is to be operate on. Example:
1755 This makes "y0" fail in the first column.
1756 *cpo-f*
1757 f When included, a ":read" command with a file name
1758 argument will set the file name for the current buffer,
1759 if the current buffer doesn't have a file name yet.
1760 *cpo-F*
1761 F When included, a ":write" command with a file name
1762 argument will set the file name for the current
1763 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001764 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 *cpo-g*
1766 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001767 *cpo-H*
1768 H When using "I" on a line with only blanks, insert
1769 before the last blank. Without this flag insert after
1770 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771 *cpo-i*
1772 i When included, interrupting the reading of a file will
1773 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001774 *cpo-I*
1775 I When moving the cursor up or down just after inserting
1776 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 *cpo-j*
1778 j When joining lines, only add two spaces after a '.',
1779 not after '!' or '?'. Also see 'joinspaces'.
1780 *cpo-J*
1781 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001782 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 white space.
1784 *cpo-k*
1785 k Disable the recognition of raw key codes in
1786 mappings, abbreviations, and the "to" part of menu
1787 commands. For example, if <Key> sends ^[OA (where ^[
1788 is <Esc>), the command ":map X ^[OA" results in X
1789 being mapped to:
1790 'k' included: "^[OA" (3 characters)
1791 'k' excluded: "<Key>" (one key code)
1792 Also see the '<' flag below.
1793 *cpo-K*
1794 K Don't wait for a key code to complete when it is
1795 halfway a mapping. This breaks mapping <F1><F1> when
1796 only part of the second <F1> has been read. It
1797 enables cancelling the mapping by typing <F1><Esc>.
1798 *cpo-l*
1799 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001800 literally, only "\]", "\^", "\-" and "\\" are special.
1801 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1803 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001804 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 *cpo-L*
1806 L When the 'list' option is set, 'wrapmargin',
1807 'textwidth', 'softtabstop' and Virtual Replace mode
1808 (see |gR|) count a <Tab> as two characters, instead of
1809 the normal behavior of a <Tab>.
1810 *cpo-m*
1811 m When included, a showmatch will always wait half a
1812 second. When not included, a showmatch will wait half
1813 a second or until a character is typed. |'showmatch'|
1814 *cpo-M*
1815 M When excluded, "%" matching will take backslashes into
1816 account. Thus in "( \( )" and "\( ( \)" the outer
1817 parenthesis match. When included "%" ignores
1818 backslashes, which is Vi compatible.
1819 *cpo-n*
1820 n When included, the column used for 'number' will also
1821 be used for text of wrapped lines.
1822 *cpo-o*
1823 o Line offset to search command is not remembered for
1824 next search.
1825 *cpo-O*
1826 O Don't complain if a file is being overwritten, even
1827 when it didn't exist when editing it. This is a
1828 protection against a file unexpectedly created by
1829 someone else. Vi didn't complain about this.
1830 *cpo-p*
1831 p Vi compatible Lisp indenting. When not present, a
1832 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001833 *cpo-P*
1834 P When included, a ":write" command that appends to a
1835 file will set the file name for the current buffer, if
1836 the current buffer doesn't have a file name yet and
1837 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001838 *cpo-q*
1839 q When joining multiple lines leave the cursor at the
1840 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 *cpo-r*
1842 r Redo ("." command) uses "/" to repeat a search
1843 command, instead of the actually used search string.
1844 *cpo-R*
1845 R Remove marks from filtered lines. Without this flag
1846 marks are kept like |:keepmarks| was used.
1847 *cpo-s*
1848 s Set buffer options when entering the buffer for the
1849 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001850 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 set when the buffer is created.
1852 *cpo-S*
1853 S Set buffer options always when entering a buffer
1854 (except 'readonly', 'fileformat', 'filetype' and
1855 'syntax'). This is the (most) Vi compatible setting.
1856 The options are set to the values in the current
1857 buffer. When you change an option and go to another
1858 buffer, the value is copied. Effectively makes the
1859 buffer options global to all buffers.
1860
1861 's' 'S' copy buffer options
1862 no no when buffer created
1863 yes no when buffer first entered (default)
1864 X yes each time when buffer entered (vi comp.)
1865 *cpo-t*
1866 t Search pattern for the tag command is remembered for
1867 "n" command. Otherwise Vim only puts the pattern in
1868 the history for search pattern, but doesn't change the
1869 last used search pattern.
1870 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001871 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 *cpo-v*
1873 v Backspaced characters remain visible on the screen in
1874 Insert mode. Without this flag the characters are
1875 erased from the screen right away. With this flag the
1876 screen newly typed text overwrites backspaced
1877 characters.
1878 *cpo-w*
1879 w When using "cw" on a blank character, only change one
1880 character and not all blanks until the start of the
1881 next word.
1882 *cpo-W*
1883 W Don't overwrite a readonly file. When omitted, ":w!"
1884 overwrites a readonly file, if possible.
1885 *cpo-x*
1886 x <Esc> on the command-line executes the command-line.
1887 The default in Vim is to abandon the command-line,
1888 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001889 *cpo-X*
1890 X When using a count with "R" the replaced text is
1891 deleted only once. Also when repeating "R" with "."
1892 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 *cpo-y*
1894 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001895 *cpo-Z*
1896 Z When using "w!" while the 'readonly' option is set,
1897 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898 *cpo-!*
1899 ! When redoing a filter command, use the last used
1900 external command, whatever it was. Otherwise the last
1901 used -filter- command is used.
1902 *cpo-$*
1903 $ When making a change to one line, don't redisplay the
1904 line, but put a '$' at the end of the changed text.
1905 The changed text will be overwritten when you type the
1906 new text. The line is redisplayed if you type any
1907 command that moves the cursor from the insertion
1908 point.
1909 *cpo-%*
1910 % Vi-compatible matching is done for the "%" command.
1911 Does not recognize "#if", "#endif", etc.
1912 Does not recognize "/*" and "*/".
1913 Parens inside single and double quotes are also
1914 counted, causing a string that contains a paren to
1915 disturb the matching. For example, in a line like
1916 "if (strcmp("foo(", s))" the first paren does not
1917 match the last one. When this flag is not included,
1918 parens inside single and double quotes are treated
1919 specially. When matching a paren outside of quotes,
1920 everything inside quotes is ignored. When matching a
1921 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001922 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001923 This flag is also used for other features, such as
1924 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001925 *cpo--*
1926 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001927 it would go above the first line or below the last
1928 line. Without it the cursor moves to the first or
1929 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001930 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001931 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001932 *cpo-+*
1933 + When included, a ":write file" command will reset the
1934 'modified' flag of the buffer, even though the buffer
1935 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001936 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 * Use ":*" in the same way as ":@". When not included,
1938 ":*" is an alias for ":'<,'>", select the Visual area.
1939 *cpo-<*
1940 < Disable the recognition of special key codes in |<>|
1941 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001942 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 ":map X <Tab>" results in X being mapped to:
1944 '<' included: "<Tab>" (5 characters)
1945 '<' excluded: "^I" (^I is a real <Tab>)
1946 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001947 *cpo->*
1948 > When appending to a register, put a line break before
1949 the appended text.
1950
1951 POSIX flags. These are not included in the Vi default value, except
1952 when $VIM_POSIX was set on startup. |posix|
1953
1954 contains behavior ~
1955 *cpo-#*
1956 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001957 *cpo-&*
1958 & When ":preserve" was used keep the swap file when
1959 exiting normally while this buffer is still loaded.
1960 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001961 *cpo-\*
1962 \ Backslash in a [] range in a search pattern is taken
1963 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001964 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1965 '\' excluded: "/[ \-]" finds <Space> and '-'
1966 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001967 *cpo-/*
1968 / When "%" is used as the replacement string in a |:s|
1969 command, use the previous replacement string. |:s%|
1970 *cpo-{*
1971 { The |{| and |}| commands also stop at a "{" character
1972 at the start of a line.
1973 *cpo-.*
1974 . The ":chdir" and ":cd" commands fail if the current
1975 buffer is modified, unless ! is used. Vim doesn't
1976 need this, since it remembers the full path of an
1977 opened file.
1978 *cpo-bar*
1979 | The value of the $LINES and $COLUMNS environment
1980 variables overrule the terminal size values obtained
1981 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001982
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983
1984 *'cscopepathcomp'* *'cspc'*
1985'cscopepathcomp' 'cspc' number (default 0)
1986 global
1987 {not available when compiled without the |+cscope|
1988 feature}
1989 {not in Vi}
1990 Determines how many components of the path to show in a list of tags.
1991 See |cscopepathcomp|.
1992
1993 *'cscopeprg'* *'csprg'*
1994'cscopeprg' 'csprg' string (default "cscope")
1995 global
1996 {not available when compiled without the |+cscope|
1997 feature}
1998 {not in Vi}
1999 Specifies the command to execute cscope. See |cscopeprg|.
2000 This option cannot be set from a |modeline| or in the |sandbox|, for
2001 security reasons.
2002
2003 *'cscopequickfix'* *'csqf'*
2004'cscopequickfix' 'csqf' string (default "")
2005 global
2006 {not available when compiled without the |+cscope|
2007 or |+quickfix| features}
2008 {not in Vi}
2009 Specifies whether to use quickfix window to show cscope results.
2010 See |cscopequickfix|.
2011
2012 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2013'cscopetag' 'cst' boolean (default off)
2014 global
2015 {not available when compiled without the |+cscope|
2016 feature}
2017 {not in Vi}
2018 Use cscope for tag commands. See |cscope-options|.
2019 NOTE: This option is reset when 'compatible' is set.
2020
2021 *'cscopetagorder'* *'csto'*
2022'cscopetagorder' 'csto' number (default 0)
2023 global
2024 {not available when compiled without the |+cscope|
2025 feature}
2026 {not in Vi}
2027 Determines the order in which ":cstag" performs a search. See
2028 |cscopetagorder|.
2029 NOTE: This option is set to 0 when 'compatible' is set.
2030
2031 *'cscopeverbose'* *'csverb'*
2032 *'nocscopeverbose'* *'nocsverb'*
2033'cscopeverbose' 'csverb' boolean (default off)
2034 global
2035 {not available when compiled without the |+cscope|
2036 feature}
2037 {not in Vi}
2038 Give messages when adding a cscope database. See |cscopeverbose|.
2039 NOTE: This option is reset when 'compatible' is set.
2040
2041 *'debug'*
2042'debug' string (default "")
2043 global
2044 {not in Vi}
2045 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002046 be given anyway. This is useful when debugging 'foldexpr',
2047 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002048 When set to "beep", a message will be given when otherwise only a beep
2049 would be produced.
2050 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
2052 *'define'* *'def'*
2053'define' 'def' string (default "^\s*#\s*define")
2054 global or local to buffer |global-local|
2055 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002056 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 pattern, just like for the "/" command. This option is used for the
2058 commands like "[i" and "[d" |include-search|. The 'isident' option is
2059 used to recognize the defined name after the match:
2060 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2061 See |option-backslash| about inserting backslashes to include a space
2062 or backslash.
2063 The default value is for C programs. For C++ this value would be
2064 useful, to include const type declarations: >
2065 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2066< When using the ":set" command, you need to double the backslashes!
2067
2068 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2069'delcombine' 'deco' boolean (default off)
2070 global
2071 {not in Vi}
2072 {only available when compiled with the |+multi_byte|
2073 feature}
2074 If editing Unicode and this option is set, backspace and Normal mode
2075 "x" delete each combining character on its own. When it is off (the
2076 default) the character along with its combining characters are
2077 deleted.
2078 Note: When 'delcombine' is set "xx" may work different from "2x"!
2079
2080 This is useful for Arabic, Hebrew and many other languages where one
2081 may have combining characters overtop of base characters, and want
2082 to remove only the combining ones.
2083
2084 *'dictionary'* *'dict'*
2085'dictionary' 'dict' string (default "")
2086 global or local to buffer |global-local|
2087 {not in Vi}
2088 List of file names, separated by commas, that are used to lookup words
2089 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2090 contain a list of words. This can be one word per line, or several
2091 words per line, separated by non-keyword characters (white space is
2092 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002093 When this option is empty, or an entry "spell" is present, spell
2094 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002095 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 after a comma are ignored, otherwise spaces are included in the file
2097 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002098 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 Where to find a list of words?
2100 - On FreeBSD, there is the file "/usr/share/dict/words".
2101 - In the Simtel archive, look in the "msdos/linguist" directory.
2102 - In "miscfiles" of the GNU collection.
2103 The use of |:set+=| and |:set-=| is preferred when adding or removing
2104 directories from the list. This avoids problems when a future version
2105 uses another default.
2106 Backticks cannot be used in this option for security reasons.
2107
2108 *'diff'* *'nodiff'*
2109'diff' boolean (default off)
2110 local to window
2111 {not in Vi}
2112 {not available when compiled without the |+diff|
2113 feature}
2114 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002115 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116
2117 *'dex'* *'diffexpr'*
2118'diffexpr' 'dex' string (default "")
2119 global
2120 {not in Vi}
2121 {not available when compiled without the |+diff|
2122 feature}
2123 Expression which is evaluated to obtain an ed-style diff file from two
2124 versions of a file. See |diff-diffexpr|.
2125 This option cannot be set from a |modeline| or in the |sandbox|, for
2126 security reasons.
2127
2128 *'dip'* *'diffopt'*
2129'diffopt' 'dip' string (default "filler")
2130 global
2131 {not in Vi}
2132 {not available when compiled without the |+diff|
2133 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002134 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 All are optional. Items must be separated by a comma.
2136
2137 filler Show filler lines, to keep the text
2138 synchronized with a window that has inserted
2139 lines at the same position. Mostly useful
2140 when windows are side-by-side and 'scrollbind'
2141 is set.
2142
2143 context:{n} Use a context of {n} lines between a change
2144 and a fold that contains unchanged lines.
2145 When omitted a context of six lines is used.
2146 See |fold-diff|.
2147
2148 icase Ignore changes in case of text. "a" and "A"
2149 are considered the same. Adds the "-i" flag
2150 to the "diff" command if 'diffexpr' is empty.
2151
2152 iwhite Ignore changes in amount of white space. Adds
2153 the "-b" flag to the "diff" command if
2154 'diffexpr' is empty. Check the documentation
2155 of the "diff" command for what this does
2156 exactly. It should ignore adding trailing
2157 white space, but not leading white space.
2158
2159 Examples: >
2160
2161 :set diffopt=filler,context:4
2162 :set diffopt=
2163 :set diffopt=filler
2164<
2165 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2166'digraph' 'dg' boolean (default off)
2167 global
2168 {not in Vi}
2169 {not available when compiled without the |+digraphs|
2170 feature}
2171 Enable the entering of digraphs in Insert mode with {char1} <BS>
2172 {char2}. See |digraphs|.
2173 NOTE: This option is reset when 'compatible' is set.
2174
2175 *'directory'* *'dir'*
2176'directory' 'dir' string (default for Amiga: ".,t:",
2177 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2178 for Unix: ".,~/tmp,/var/tmp,/tmp")
2179 global
2180 List of directory names for the swap file, separated with commas.
2181 - The swap file will be created in the first directory where this is
2182 possible.
2183 - Empty means that no swap file will be used (recovery is
2184 impossible!).
2185 - A directory "." means to put the swap file in the same directory as
2186 the edited file. On Unix, a dot is prepended to the file name, so
2187 it doesn't show in a directory listing. On MS-Windows the "hidden"
2188 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002189 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 put the swap file relative to where the edited file is. The leading
2191 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002192 - For Unix and Win32, if a directory ends in two path separators "//"
2193 or "\\", the swap file name will be built from the complete path to
2194 the file with all path separators substituted to percent '%' signs.
2195 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 - Spaces after the comma are ignored, other spaces are considered part
2197 of the directory name. To have a space at the start of a directory
2198 name, precede it with a backslash.
2199 - To include a comma in a directory name precede it with a backslash.
2200 - A directory name may end in an ':' or '/'.
2201 - Environment variables are expanded |:set_env|.
2202 - Careful with '\' characters, type one before a space, type two to
2203 get one in the option (see |option-backslash|), for example: >
2204 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2205< - For backwards compatibility with Vim version 3.0 a '>' at the start
2206 of the option is removed.
2207 Using "." first in the list is recommended. This means that editing
2208 the same file twice will result in a warning. Using "/tmp" on Unix is
2209 discouraged: When the system crashes you lose the swap file.
2210 "/var/tmp" is often not cleared when rebooting, thus is a better
2211 choice than "/tmp". But it can contain a lot of files, your swap
2212 files get lost in the crowd. That is why a "tmp" directory in your
2213 home directory is tried first.
2214 The use of |:set+=| and |:set-=| is preferred when adding or removing
2215 directories from the list. This avoids problems when a future version
2216 uses another default.
2217 This option cannot be set from a |modeline| or in the |sandbox|, for
2218 security reasons.
2219 {Vi: directory to put temp file in, defaults to "/tmp"}
2220
2221 *'display'* *'dy'*
2222'display' 'dy' string (default "")
2223 global
2224 {not in Vi}
2225 Change the way text is displayed. This is comma separated list of
2226 flags:
2227 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002228 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 last line that doesn't fit is replaced with "@" lines.
2230 uhex Show unprintable characters hexadecimal as <xx>
2231 instead of using ^C and ~C.
2232
2233 *'eadirection'* *'ead'*
2234'eadirection' 'ead' string (default "both")
2235 global
2236 {not in Vi}
2237 {not available when compiled without the +vertsplit
2238 feature}
2239 Tells when the 'equalalways' option applies:
2240 ver vertically, width of windows is not affected
2241 hor horizontally, height of windows is not affected
2242 both width and height of windows is affected
2243
2244 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2245'edcompatible' 'ed' boolean (default off)
2246 global
2247 Makes the 'g' and 'c' flags of the ":substitute" command to be
2248 toggled each time the flag is given. See |complex-change|. See
2249 also 'gdefault' option.
2250 Switching this option on is discouraged!
2251
2252 *'encoding'* *'enc'* *E543*
2253'encoding' 'enc' string (default: "latin1" or value from $LANG)
2254 global
2255 {only available when compiled with the |+multi_byte|
2256 feature}
2257 {not in Vi}
2258 Sets the character encoding used inside Vim. It applies to text in
2259 the buffers, registers, Strings in expressions, text stored in the
2260 viminfo file, etc. It sets the kind of characters which Vim can work
2261 with. See |encoding-names| for the possible values.
2262
2263 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002264 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 It should normally be kept at its default value, or set when Vim
2266 starts up. See |multibyte|.
2267
2268 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2269 "utf-8". Although care has been taken to allow different values of
2270 'encoding', "utf-8" is the natural choice for the environment and
2271 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002272 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 versions, and to avoid changing the encoding of newly created files
2274 without your knowledge (in case 'fileencodings' is empty).
2275
2276 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002277 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 iconv() or as specified with 'charconvert'.
2279
2280 Normally 'encoding' will be equal to your current locale. This will
2281 be the default if Vim recognizes your environment settings. If
2282 'encoding' is not set to the current locale, 'termencoding' must be
2283 set to convert typed and displayed text. See |encoding-table|.
2284
2285 When you set this option, it fires the |EncodingChanged| autocommand
2286 event so that you can set up fonts if necessary.
2287
2288 When the option is set, the value is converted to lowercase. Thus
2289 you can set it with uppercase values too. Underscores are translated
2290 to '-' signs.
2291 When the encoding is recognized, it is changed to the standard name.
2292 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2293 "iso-8859-2" and "utf8" becomes "utf-8".
2294
2295 Note: "latin1" is also used when the encoding could not be detected.
2296 This only works when editing files in the same encoding! When the
2297 actual character set is not latin1, make sure 'fileencoding' and
2298 'fileencodings' are empty. When conversion is needed, switch to using
2299 utf-8.
2300
2301 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2302 You don't notice this while editing, but it does matter for the
2303 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2304 setting 'encoding' to one of these values instead of utf-8 only has
2305 effect for encoding used for files when 'fileencoding' is empty.
2306
Bram Moolenaar661b1822005-07-28 22:36:45 +00002307 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2308 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309
2310 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2311'endofline' 'eol' boolean (default on)
2312 local to buffer
2313 {not in Vi}
2314 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002315 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 option is automatically set when starting to edit a new file, unless
2317 the file does not have an <EOL> for the last line in the file, in
2318 which case it is reset. Normally you don't have to set or reset this
2319 option. When 'binary' is off the value is not used when writing the
2320 file. When 'binary' is on it is used to remember the presence of a
2321 <EOL> for the last line in the file, so that when you write the file
2322 the situation from the original file can be kept. But you can change
2323 it if you want to.
2324
2325 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2326'equalalways' 'ea' boolean (default on)
2327 global
2328 {not in Vi}
2329 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002330 splitting or closing a window. This also happens the moment the
2331 option is switched on. When off, splitting a window will reduce the
2332 size of the current window and leave the other windows the same. When
2333 closing a window the extra lines are given to the window next to it
2334 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 When mixing vertically and horizontally split windows, a minimal size
2336 is computed and some windows may be larger if there is room. The
2337 'eadirection' option tells in which direction the size is affected.
2338 Changing the height of a window can be avoided by setting
2339 'winfixheight'.
2340
2341 *'equalprg'* *'ep'*
2342'equalprg' 'ep' string (default "")
2343 global or local to buffer |global-local|
2344 {not in Vi}
2345 External program to use for "=" command. When this option is empty
2346 the internal formatting functions are used ('lisp', 'cindent' or
2347 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002348 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 about including spaces and backslashes.
2350 This option cannot be set from a |modeline| or in the |sandbox|, for
2351 security reasons.
2352
2353 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2354'errorbells' 'eb' boolean (default off)
2355 global
2356 Ring the bell (beep or screen flash) for error messages. This only
2357 makes a difference for error messages, the bell will be used always
2358 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002359 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 screen flash or do nothing.
2361
2362 *'errorfile'* *'ef'*
2363'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2364 others: "errors.err")
2365 global
2366 {not in Vi}
2367 {not available when compiled without the |+quickfix|
2368 feature}
2369 Name of the errorfile for the QuickFix mode (see |:cf|).
2370 When the "-q" command-line argument is used, 'errorfile' is set to the
2371 following argument. See |-q|.
2372 NOT used for the ":make" command. See 'makeef' for that.
2373 Environment variables are expanded |:set_env|.
2374 See |option-backslash| about including spaces and backslashes.
2375 This option cannot be set from a |modeline| or in the |sandbox|, for
2376 security reasons.
2377
2378 *'errorformat'* *'efm'*
2379'errorformat' 'efm' string (default is very long)
2380 global or local to buffer |global-local|
2381 {not in Vi}
2382 {not available when compiled without the |+quickfix|
2383 feature}
2384 Scanf-like description of the format for the lines in the error file
2385 (see |errorformat|).
2386
2387 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2388'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2389 global
2390 {not in Vi}
2391 Function keys that start with an <Esc> are recognized in Insert
2392 mode. When this option is off, the cursor and function keys cannot be
2393 used in Insert mode if they start with an <Esc>. The advantage of
2394 this is that the single <Esc> is recognized immediately, instead of
2395 after one second. Instead of resetting this option, you might want to
2396 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2397 when 'esckeys' is off, you can still map anything, but the cursor keys
2398 won't work by default.
2399 NOTE: This option is set to the Vi default value when 'compatible' is
2400 set and to the Vim default value when 'compatible' is reset.
2401
2402 *'eventignore'* *'ei'*
2403'eventignore' 'ei' string (default "")
2404 global
2405 {not in Vi}
2406 {not available when compiled without the |+autocmd|
2407 feature}
2408 A list of autocommand event names, which are to be ignored.
2409 When set to "all", all autocommand events are ignored, autocommands
2410 will not be executed.
2411 Otherwise this is a comma separated list of event names. Example: >
2412 :set ei=WinEnter,WinLeave
2413<
2414 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2415'expandtab' 'et' boolean (default off)
2416 local to buffer
2417 {not in Vi}
2418 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002419 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2421 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2422 NOTE: This option is reset when 'compatible' is set.
2423
2424 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2425'exrc' 'ex' boolean (default off)
2426 global
2427 {not in Vi}
2428 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2429 directory. If you switch this option on you should also consider
2430 setting the 'secure' option (see |initialization|). Using a local
2431 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2432 also see |.vimrc| and |gui-init|.
2433 This option cannot be set from a |modeline| or in the |sandbox|, for
2434 security reasons.
2435
2436 *'fileencoding'* *'fenc'* *E213*
2437'fileencoding' 'fenc' string (default: "")
2438 local to buffer
2439 {only available when compiled with the |+multi_byte|
2440 feature}
2441 {not in Vi}
2442 Sets the character encoding for the file of this buffer.
2443 When 'fileencoding' is different from 'encoding', conversion will be
2444 done when reading and writing the file.
2445 When 'fileencoding' is empty, the same value as 'encoding' will be
2446 used (no conversion when reading or writing a file).
2447 WARNING: Conversion can cause loss of information! When
2448 'encoding' is "utf-8" conversion is most likely done in a way
2449 that the reverse conversion results in the same text. When
2450 'encoding' is not "utf-8" some characters may be lost!
2451 See 'encoding' for the possible values. Additionally, values may be
2452 specified that can be handled by the converter, see
2453 |mbyte-conversion|.
2454 When reading a file 'fileencoding' will be set from 'fileencodings'.
2455 To read a file in a certain encoding it won't work by setting
2456 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002457 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2459 When the option is set, the value is converted to lowercase. Thus
2460 you can set it with uppercase values too. '_' characters are
2461 replaced with '-'. If a name is recognized from the list for
2462 'encoding', it is replaced by the standard name. For example
2463 "ISO8859-2" becomes "iso-8859-2".
2464 When this option is set, after starting to edit a file, the 'modified'
2465 option is set, because the file would be different when written.
2466 If you do this in a modeline, you might want to set 'nomodified' to
2467 avoid this.
2468 This option can not be changed when 'modifiable' is off.
2469
2470 *'fe'*
2471 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002472 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 old short name was 'fe', which is no longer used.
2474
2475 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002476'fileencodings' 'fencs' string (default: "ucs-bom",
2477 "ucs-bom,utf-8,default,latin1" when
2478 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 global
2480 {only available when compiled with the |+multi_byte|
2481 feature}
2482 {not in Vi}
2483 This is a list of character encodings considered when starting to edit
2484 an existing file. When a file is read, Vim tries to use the first
2485 mentioned character encoding. If an error is detected, the next one
2486 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002487 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 an empty string, which means the value of 'encoding' is used.
2489 WARNING: Conversion can cause loss of information! When
2490 'encoding' is "utf-8" (or one of the other Unicode variants)
2491 conversion is most likely done in a way that the reverse
2492 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002493 "utf-8" some non-ASCII characters may be lost! You can use
2494 the |++bad| argument to specify what is done with characters
2495 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 For an empty file or a file with only ASCII characters most encodings
2497 will work and the first entry of 'fileencodings' will be used (except
2498 "ucs-bom", which requires the BOM to be present). If you prefer
2499 another encoding use an BufReadPost autocommand event to test if your
2500 preferred encoding is to be used. Example: >
2501 au BufReadPost * if search('\S', 'w') == 0 |
2502 \ set fenc=iso-2022-jp | endif
2503< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2504 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002505 When the |++enc| argument is used then the value of 'fileencodings' is
2506 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002507 Note that 'fileencodings' is not used for a new file, the global value
2508 of 'fileencoding' is used instead. You can set it with: >
2509 :setglobal fenc=iso-8859-2
2510< This means that a non-existing file may get a different encoding than
2511 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002512 The special value "ucs-bom" can be used to check for a Unicode BOM
2513 (Byte Order Mark) at the start of the file. It must not be preceded
2514 by "utf-8" or another Unicode encoding for this to work properly.
2515 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2516 because Vim cannot detect an error, thus the encoding is always
2517 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002518 The special value "default" can be used for the encoding from the
2519 environment. This is the default value for 'encoding'. It is useful
2520 when 'encoding' is set to "utf-8" and your environment uses a
2521 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 WRONG VALUES: WHAT'S WRONG:
2523 latin1,utf-8 "latin1" will always be used
2524 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2525 file
2526 cp1250,latin1 "cp1250" will always be used
2527 If 'fileencodings' is empty, 'fileencoding' is not modified.
2528 See 'fileencoding' for the possible values.
2529 Setting this option does not have an effect until the next time a file
2530 is read.
2531
2532 *'fileformat'* *'ff'*
2533'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2534 Unix default: "unix",
2535 Macintosh default: "mac")
2536 local to buffer
2537 {not in Vi}
2538 This gives the <EOL> of the current buffer, which is used for
2539 reading/writing the buffer from/to a file:
2540 dos <CR> <NL>
2541 unix <NL>
2542 mac <CR>
2543 When "dos" is used, CTRL-Z at the end of a file is ignored.
2544 See |file-formats| and |file-read|.
2545 For the character encoding of the file see 'fileencoding'.
2546 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2547 works like it was set to "unix'.
2548 This option is set automatically when starting to edit a file and
2549 'fileformats' is not empty and 'binary' is off.
2550 When this option is set, after starting to edit a file, the 'modified'
2551 option is set, because the file would be different when written.
2552 This option can not be changed when 'modifiable' is off.
2553 For backwards compatibility: When this option is set to "dos",
2554 'textmode' is set, otherwise 'textmode' is reset.
2555
2556 *'fileformats'* *'ffs'*
2557'fileformats' 'ffs' string (default:
2558 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2559 Vim Unix: "unix,dos",
2560 Vim Mac: "mac,unix,dos",
2561 Vi Cygwin: "unix,dos",
2562 Vi others: "")
2563 global
2564 {not in Vi}
2565 This gives the end-of-line (<EOL>) formats that will be tried when
2566 starting to edit a new buffer and when reading a file into an existing
2567 buffer:
2568 - When empty, the format defined with 'fileformat' will be used
2569 always. It is not set automatically.
2570 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002571 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 'fileformats' name will be used when a file is read into an existing
2573 buffer, no matter what 'fileformat' for that buffer is set to.
2574 - When more than one name is present, separated by commas, automatic
2575 <EOL> detection will be done when reading a file. When starting to
2576 edit a file, a check is done for the <EOL>:
2577 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2578 'fileformat' is set to "dos".
2579 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002580 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 preceding <CR>, "unix" is preferred over "dos".
2582 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2583 This means that "mac" is only chosen when "unix" is not present,
2584 or when no <NL> is found in the file, and when "dos" is not
2585 present, or no <CR><NL> is present in the file.
2586 Also if "unix" was first chosen, but the first <CR> is before
2587 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2588 the file, then 'fileformat' is set to "mac".
2589 4. If 'fileformat' is still not set, the first name from
2590 'fileformats' is used.
2591 When reading a file into an existing buffer, the same is done, but
2592 this happens like 'fileformat' has been set appropriately for that
2593 file only, the option is not changed.
2594 When 'binary' is set, the value of 'fileformats' is not used.
2595
2596 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2597 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2598 done:
2599 - When 'fileformats' is empty, there is no automatic detection. Dos
2600 format will be used.
2601 - When 'fileformats' is set to one or more names, automatic detection
2602 is done. This is based on the first <NL> in the file: If there is a
2603 <CR> in front of it, Dos format is used, otherwise Unix format is
2604 used.
2605 Also see |file-formats|.
2606 For backwards compatibility: When this option is set to an empty
2607 string or one format (no comma is included), 'textauto' is reset,
2608 otherwise 'textauto' is set.
2609 NOTE: This option is set to the Vi default value when 'compatible' is
2610 set and to the Vim default value when 'compatible' is reset.
2611
2612 *'filetype'* *'ft'*
2613'filetype' 'ft' string (default: "")
2614 local to buffer
2615 {not in Vi}
2616 {not available when compiled without the |+autocmd|
2617 feature}
2618 When this option is set, the FileType autocommand event is triggered.
2619 All autocommands that match with the value of this option will be
2620 executed. Thus the value of 'filetype' is used in place of the file
2621 name.
2622 Otherwise this option does not always reflect the current file type.
2623 This option is normally set when the file type is detected. To enable
2624 this use the ":filetype on" command. |:filetype|
2625 Setting this option to a different value is most useful in a modeline,
2626 for a file for which the file type is not automatically recognized.
2627 Example, for in an IDL file: >
2628 /* vim: set filetype=idl : */
2629< |FileType| |filetypes|
2630 Do not confuse this option with 'osfiletype', which is for the file
2631 type that is actually stored with the file.
2632 This option is not copied to another buffer, independent of the 's' or
2633 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002634 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635
2636 *'fillchars'* *'fcs'*
2637'fillchars' 'fcs' string (default "vert:|,fold:-")
2638 global
2639 {not in Vi}
2640 {not available when compiled without the |+windows|
2641 and |+folding| features}
2642 Characters to fill the statuslines and vertical separators.
2643 It is a comma separated list of items:
2644
2645 item default Used for ~
2646 stl:c ' ' or '^' statusline of the current window
2647 stlnc:c ' ' or '-' statusline of the non-current windows
2648 vert:c '|' vertical separators |:vsplit|
2649 fold:c '-' filling 'foldtext'
2650 diff:c '-' deleted lines of the 'diff' option
2651
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002652 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 "stlnc" the space will be used when there is highlighting, '^' or '-'
2654 otherwise.
2655
2656 Example: >
2657 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2658< This is similar to the default, except that these characters will also
2659 be used when there is highlighting.
2660
2661 The highlighting used for these items:
2662 item highlight group ~
2663 stl:c StatusLine |hl-StatusLine|
2664 stlnc:c StatusLineNC |hl-StatusLineNC|
2665 vert:c VertSplit |hl-VertSplit|
2666 fold:c Folded |hl-Folded|
2667 diff:c DiffDelete |hl-DiffDelete|
2668
2669 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2670'fkmap' 'fk' boolean (default off) *E198*
2671 global
2672 {not in Vi}
2673 {only available when compiled with the |+rightleft|
2674 feature}
2675 When on, the keyboard is mapped for the Farsi character set.
2676 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002677 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678
2679 *'foldclose'* *'fcl'*
2680'foldclose' 'fcl' string (default "")
2681 global
2682 {not in Vi}
2683 {not available when compiled without the |+folding|
2684 feature}
2685 When set to "all", a fold is closed when the cursor isn't in it and
2686 its level is higher than 'foldlevel'. Useful if you want folds to
2687 automatically close when moving out of them.
2688
2689 *'foldcolumn'* *'fdc'*
2690'foldcolumn' 'fdc' number (default 0)
2691 local to window
2692 {not in Vi}
2693 {not available when compiled without the |+folding|
2694 feature}
2695 When non-zero, a column with the specified width is shown at the side
2696 of the window which indicates open and closed folds. The maximum
2697 value is 12.
2698 See |folding|.
2699
2700 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2701'foldenable' 'fen' boolean (default on)
2702 local to window
2703 {not in Vi}
2704 {not available when compiled without the |+folding|
2705 feature}
2706 When off, all folds are open. This option can be used to quickly
2707 switch between showing all text unfolded and viewing the text with
2708 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002709 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 'foldenable' is off.
2711 This option is set by commands that create a new fold or close a fold.
2712 See |folding|.
2713
2714 *'foldexpr'* *'fde'*
2715'foldexpr' 'fde' string (default: "0")
2716 local to window
2717 {not in Vi}
2718 {not available when compiled without the |+folding|
2719 or |+eval| feature}
2720 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002721 for each line to obtain its fold level. See |fold-expr|.
2722
2723 The expression may be evaluated in the |sandbox|, see
2724 |sandbox-option|.
2725
2726 It is not allowed to change text or jump to another window while
2727 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728
2729 *'foldignore'* *'fdi'*
2730'foldignore' 'fdi' string (default: "#")
2731 local to window
2732 {not in Vi}
2733 {not available when compiled without the |+folding|
2734 feature}
2735 Used only when 'foldmethod' is "indent". Lines starting with
2736 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002737 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 The default "#" works well for C programs. See |fold-indent|.
2739
2740 *'foldlevel'* *'fdl'*
2741'foldlevel' 'fdl' number (default: 0)
2742 local to window
2743 {not in Vi}
2744 {not available when compiled without the |+folding|
2745 feature}
2746 Sets the fold level: Folds with a higher level will be closed.
2747 Setting this option to zero will close all folds. Higher numbers will
2748 close fewer folds.
2749 This option is set by commands like |zm|, |zM| and |zR|.
2750 See |fold-foldlevel|.
2751
2752 *'foldlevelstart'* *'fdls'*
2753'foldlevelstart' 'fdls' number (default: -1)
2754 global
2755 {not in Vi}
2756 {not available when compiled without the |+folding|
2757 feature}
2758 Sets 'foldlevel' when starting to edit another buffer in a window.
2759 Useful to always start editing with all folds closed (value zero),
2760 some folds closed (one) or no folds closed (99).
2761 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002762 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 ignores this option and closes all folds.
2764 It is also done before BufReadPre autocommands, to allow an autocmd to
2765 overrule the 'foldlevel' value for specific files.
2766 When the value is negative, it is not used.
2767
2768 *'foldmarker'* *'fmr'* *E536*
2769'foldmarker' 'fmr' string (default: "{{{,}}}")
2770 local to window
2771 {not in Vi}
2772 {not available when compiled without the |+folding|
2773 feature}
2774 The start and end marker used when 'foldmethod' is "marker". There
2775 must be one comma, which separates the start and end marker. The
2776 marker is a literal string (a regular expression would be too slow).
2777 See |fold-marker|.
2778
2779 *'foldmethod'* *'fdm'*
2780'foldmethod' 'fdm' string (default: "manual")
2781 local to window
2782 {not in Vi}
2783 {not available when compiled without the |+folding|
2784 feature}
2785 The kind of folding used for the current window. Possible values:
2786 |fold-manual| manual Folds are created manually.
2787 |fold-indent| indent Lines with equal indent form a fold.
2788 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2789 |fold-marker| marker Markers are used to specify folds.
2790 |fold-syntax| syntax Syntax highlighting items specify folds.
2791 |fold-diff| diff Fold text that is not changed.
2792
2793 *'foldminlines'* *'fml'*
2794'foldminlines' 'fml' number (default: 1)
2795 local to window
2796 {not in Vi}
2797 {not available when compiled without the |+folding|
2798 feature}
2799 Sets the minimum number of screen lines for a fold to be displayed
2800 closed. Also for manually closed folds.
2801 Note that this only has an effect of what is displayed. After using
2802 "zc" to close a fold, which is displayed open because it's smaller
2803 than 'foldminlines', a following "zc" may close a containing fold.
2804
2805 *'foldnestmax'* *'fdn'*
2806'foldnestmax' 'fdn' number (default: 20)
2807 local to window
2808 {not in Vi}
2809 {not available when compiled without the |+folding|
2810 feature}
2811 Sets the maximum nesting of folds for the "indent" and "syntax"
2812 methods. This avoids that too many folds will be created. Using more
2813 than 20 doesn't work, because the internal limit is 20.
2814
2815 *'foldopen'* *'fdo'*
2816'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2817 search,tag,undo")
2818 global
2819 {not in Vi}
2820 {not available when compiled without the |+folding|
2821 feature}
2822 Specifies for which type of commands folds will be opened, if the
2823 command moves the cursor into a closed fold. It is a comma separated
2824 list of items.
2825 item commands ~
2826 all any
2827 block "(", "{", "[[", "[{", etc.
2828 hor horizontal movements: "l", "w", "fx", etc.
2829 insert any command in Insert mode
2830 jump far jumps: "G", "gg", etc.
2831 mark jumping to a mark: "'m", CTRL-O, etc.
2832 percent "%"
2833 quickfix ":cn", ":crew", ":make", etc.
2834 search search for a pattern: "/", "n", "*", "gd", etc.
2835 (not for a search pattern in a ":" command)
2836 tag jumping to a tag: ":ta", CTRL-T, etc.
2837 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002838 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 the |zv| command to the mapping to get the same effect.
2840 When a movement command is used for an operator (e.g., "dl" or "y%")
2841 this option is not used. This means the operator will include the
2842 whole closed fold.
2843 Note that vertical movements are not here, because it would make it
2844 very difficult to move onto a closed fold.
2845 In insert mode the folds containing the cursor will always be open
2846 when text is inserted.
2847 To close folds you can re-apply 'foldlevel' with the |zx| command or
2848 set the 'foldclose' option to "all".
2849
2850 *'foldtext'* *'fdt'*
2851'foldtext' 'fdt' string (default: "foldtext()")
2852 local to window
2853 {not in Vi}
2854 {not available when compiled without the |+folding|
2855 feature}
2856 An expression which is used to specify the text displayed for a closed
2857 fold. See |fold-foldtext|.
2858
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002859 The expression may be evaluated in the |sandbox|, see
2860 |sandbox-option|.
2861
2862 It is not allowed to change text or jump to another window while
2863 evaluating 'foldtext' |textlock|.
2864
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 *'formatoptions'* *'fo'*
2866'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2867 local to buffer
2868 {not in Vi}
2869 This is a sequence of letters which describes how automatic
2870 formatting is to be done. See |fo-table|. When the 'paste' option is
2871 on, no formatting is done (like 'formatoptions' is empty). Commas can
2872 be inserted for readability.
2873 To avoid problems with flags that are added in the future, use the
2874 "+=" and "-=" feature of ":set" |add-option-flags|.
2875 NOTE: This option is set to the Vi default value when 'compatible' is
2876 set and to the Vim default value when 'compatible' is reset.
2877
Bram Moolenaar86b68352004-12-27 21:59:20 +00002878 *'formatlistpat'* *'flp'*
2879'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2880 local to buffer
2881 {not in Vi}
2882 A pattern that is used to recognize a list header. This is used for
2883 the "n" flag in 'formatoptions'.
2884 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002885 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002886 while still checking more characters. There must be a character
2887 following the pattern, when it matches the whole line it is handled
2888 like there is no match.
2889 The default recognizes a number, followed by an optional punctuation
2890 character and white space.
2891
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 *'formatprg'* *'fp'*
2893'formatprg' 'fp' string (default "")
2894 global
2895 {not in Vi}
2896 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002897 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002899 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002900 If the 'formatexpr' option is not empty it will be used instead.
2901 Otherwise, if 'formatprg' option is an empty string, the internal
2902 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002903 Environment variables are expanded |:set_env|. See |option-backslash|
2904 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002905 The expression may be evaluated in the |sandbox|, see
2906 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002908 *'formatexpr'* *'fex'*
2909'formatexpr' 'fex' string (default "")
2910 local to buffer
2911 {not in Vi}
2912 {not available when compiled without the |+eval|
2913 feature}
2914 Expression which is evaluated to format a range of lines for the |gq|
2915 operator. The |v:lnum| variable holds the first line to be formatted,
2916 |v:count| the number of lines to be formatted.
2917 When this option is empty 'formatprg' is used.
2918 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002919 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002920< This will invoke the mylang#Format() function in the
2921 autoload/mylang.vim file in 'runtimepath'. |autoload|
2922
2923 The expression is also evaluated when 'textwidth' is set and adding
2924 text beyond that limit. This happens under the same conditions as
2925 when internal formatting is used. Make sure the cursor is kept in the
2926 same spot relative to the text then! The |mode()| function will
2927 return "i" or "R" in this situation. When the function returns
2928 non-zero Vim will fall back to using the internal format mechanism.
2929
2930 The expression may be evaluated in the |sandbox|, see
2931 |sandbox-option|.
2932
2933 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002934'fsync' 'fs' boolean (default on)
2935 global
2936 {not in Vi}
2937 When on, the library function fsync() will be called after writing a
2938 file. This will flush a file to disk, ensuring that it is safely
2939 written even on filesystems which do metadata-only journaling. This
2940 will force the harddrive to spin up on Linux systems running in laptop
2941 mode, so it may be undesirable in some situations. Be warned that
2942 turning this off increases the chances of data loss after a crash. On
2943 systems without an fsync() implementation, this variable is always
2944 off.
2945 Also see 'swapsync' for controlling fsync() on swap files.
2946
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2948'gdefault' 'gd' boolean (default off)
2949 global
2950 {not in Vi}
2951 When on, the ":substitute" flag 'g' is default on. This means that
2952 all matches in a line are substituted instead of one. When a 'g' flag
2953 is given to a ":substitute" command, this will toggle the substitution
2954 of all or one match. See |complex-change|.
2955
2956 command 'gdefault' on 'gdefault' off ~
2957 :s/// subst. all subst. one
2958 :s///g subst. one subst. all
2959 :s///gg subst. all subst. one
2960
2961 NOTE: This option is reset when 'compatible' is set.
2962
2963 *'grepformat'* *'gfm'*
2964'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2965 global
2966 {not in Vi}
2967 Format to recognize for the ":grep" command output.
2968 This is a scanf-like string that uses the same format as the
2969 'errorformat' option: see |errorformat|.
2970
2971 *'grepprg'* *'gp'*
2972'grepprg' 'gp' string (default "grep -n ",
2973 Unix: "grep -n $* /dev/null",
2974 Win32: "findstr /n" or "grep -n",
2975 VMS: "SEARCH/NUMBERS ")
2976 global or local to buffer |global-local|
2977 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002978 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 and '#' characters, which are expanded like when used in a command-
2980 line. The placeholder "$*" is allowed to specify where the arguments
2981 will be included. Environment variables are expanded |:set_env|. See
2982 |option-backslash| about including spaces and backslashes.
2983 When your "grep" accepts the "-H" argument, use this to make ":grep"
2984 also work well with a single file: >
2985 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002986< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00002987 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
2988 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002989 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 apply equally to 'grepprg'.
2991 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2992 otherwise it's "grep -n".
2993 This option cannot be set from a |modeline| or in the |sandbox|, for
2994 security reasons.
2995
2996 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2997'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2998 ve:ver35-Cursor,
2999 o:hor50-Cursor,
3000 i-ci:ver25-Cursor/lCursor,
3001 r-cr:hor20-Cursor/lCursor,
3002 sm:block-Cursor
3003 -blinkwait175-blinkoff150-blinkon175",
3004 for MS-DOS and Win32 console:
3005 "n-v-c:block,o:hor50,i-ci:hor15,
3006 r-cr:hor30,sm:block")
3007 global
3008 {not in Vi}
3009 {only available when compiled with GUI enabled, and
3010 for MS-DOS and Win32 console}
3011 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003012 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 the height of the cursor can be changed. This can be done by
3014 specifying a block cursor, or a percentage for a vertical or
3015 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003016 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003018 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 mode-list and an argument-list:
3020 mode-list:argument-list,mode-list:argument-list,..
3021 The mode-list is a dash separated list of these modes:
3022 n Normal mode
3023 v Visual mode
3024 ve Visual mode with 'selection' "exclusive" (same as 'v',
3025 if not specified)
3026 o Operator-pending mode
3027 i Insert mode
3028 r Replace mode
3029 c Command-line Normal (append) mode
3030 ci Command-line Insert mode
3031 cr Command-line Replace mode
3032 sm showmatch in Insert mode
3033 a all modes
3034 The argument-list is a dash separated list of these arguments:
3035 hor{N} horizontal bar, {N} percent of the character height
3036 ver{N} vertical bar, {N} percent of the character width
3037 block block cursor, fills the whole character
3038 [only one of the above three should be present]
3039 blinkwait{N} *cursor-blinking*
3040 blinkon{N}
3041 blinkoff{N}
3042 blink times for cursor: blinkwait is the delay before
3043 the cursor starts blinking, blinkon is the time that
3044 the cursor is shown and blinkoff is the time that the
3045 cursor is not shown. The times are in msec. When one
3046 of the numbers is zero, there is no blinking. The
3047 default is: "blinkwait700-blinkon400-blinkoff250".
3048 These numbers are used for a missing entry. This
3049 means that blinking is enabled by default. To switch
3050 blinking off you can use "blinkon0". The cursor only
3051 blinks when Vim is waiting for input, not while
3052 executing a command.
3053 To make the cursor blink in an xterm, see
3054 |xterm-blink|.
3055 {group-name}
3056 a highlight group name, that sets the color and font
3057 for the cursor
3058 {group-name}/{group-name}
3059 Two highlight group names, the first is used when
3060 no language mappings are used, the other when they
3061 are. |language-mapping|
3062
3063 Examples of parts:
3064 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3065 block cursor with colors from the "nCursor"
3066 highlight group
3067 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3068 In Insert and Command-line Insert mode, use a
3069 30% vertical bar cursor with colors from the
3070 "iCursor" highlight group. Blink a bit
3071 faster.
3072
3073 The 'a' mode is different. It will set the given argument-list for
3074 all modes. It does not reset anything to defaults. This can be used
3075 to do a common setting for all modes. For example, to switch off
3076 blinking: "a:blinkon0"
3077
3078 Examples of cursor highlighting: >
3079 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3080 :highlight Cursor gui=NONE guifg=bg guibg=fg
3081<
3082 *'guifont'* *'gfn'*
3083 *E235* *E596* *E610* *E611*
3084'guifont' 'gfn' string (default "")
3085 global
3086 {not in Vi}
3087 {only available when compiled with GUI enabled}
3088 This is a list of fonts which will be used for the GUI version of Vim.
3089 In its simplest form the value is just one font name. When
3090 the font cannot be found you will get an error message. To try other
3091 font names a list can be specified, font names separated with commas.
3092 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003093
Bram Moolenaar05159a02005-02-26 23:04:13 +00003094 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3095 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003096
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 Spaces after a comma are ignored. To include a comma in a font name
3098 precede it with a backslash. Setting an option requires an extra
3099 backslash before a space and a backslash. See also
3100 |option-backslash|. For example: >
3101 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003102< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003104
3105 If none of the fonts can be loaded, Vim will keep the current setting.
3106 If an empty font list is given, Vim will try using other resource
3107 settings (for X, it will use the Vim.font resource), and finally it
3108 will try some builtin default which should always be there ("7x13" in
3109 the case of X). The font names given should be "normal" fonts. Vim
3110 will try to find the related bold and italic fonts.
3111
Bram Moolenaar05159a02005-02-26 23:04:13 +00003112 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003113 :set guifont=*
3114< will bring up a font requester, where you can pick the font you want.
3115
3116 The font name depends on the GUI used. See |setting-guifont| for a
3117 way to set 'guifont' for various systems.
3118
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 For the GTK+ 2 GUI the font name looks like this: >
3120 :set guifont=Andale\ Mono\ 11
3121< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003122
3123 For Mac OSX you can use something like this: >
3124 :set guifont=Monaco:h10
3125< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003127 width). An exception is GTK 2: all fonts are accepted, but
3128 mono-spaced fonts look best.
3129
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 To preview a font on X11, you might be able to use the "xfontsel"
3131 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003132
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 For the Win32 GUI *E244* *E245*
3134 - takes these options in the font name:
3135 hXX - height is XX (points, can be floating-point)
3136 wXX - width is XX (points, can be floating-point)
3137 b - bold
3138 i - italic
3139 u - underline
3140 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003141 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3143 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3144 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003145 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146
3147 Use a ':' to separate the options.
3148 - A '_' can be used in the place of a space, so you don't need to use
3149 backslashes to escape the spaces.
3150 - Examples: >
3151 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3152 :set guifont=Andale_Mono:h7.5:w4.5
3153< See also |font-sizes|.
3154
3155 *'guifontset'* *'gfs'*
3156 *E250* *E252* *E234* *E597* *E598*
3157'guifontset' 'gfs' string (default "")
3158 global
3159 {not in Vi}
3160 {only available when compiled with GUI enabled and
3161 with the |+xfontset| feature}
3162 {not available in the GTK+ 2 GUI}
3163 When not empty, specifies two (or more) fonts to be used. The first
3164 one for normal English, the second one for your special language. See
3165 |xfontset|.
3166 Setting this option also means that all font names will be handled as
3167 a fontset name. Also the ones used for the "font" argument of the
3168 |:highlight| command.
3169 The fonts must match with the current locale. If fonts for the
3170 character sets that the current locale uses are not included, setting
3171 'guifontset' will fail.
3172 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3173 the comma-separated names are alternative names, one of which will be
3174 used. In 'guifontset' the whole string is one fontset name,
3175 including the commas. It is not possible to specify alternative
3176 fontset names.
3177 This example works on many X11 systems: >
3178 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3179<
3180 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3181'guifontwide' 'gfw' string (default "")
3182 global
3183 {not in Vi}
3184 {only available when compiled with GUI enabled}
3185 When not empty, specifies a comma-separated list of fonts to be used
3186 for double-width characters. The first font that can be loaded is
3187 used.
3188 Note: The size of these fonts must be exactly twice as wide as the one
3189 specified with 'guifont' and the same height.
3190
3191 All GUI versions but GTK+ 2:
3192
3193 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3194 'guifontset' is empty or invalid.
3195 When 'guifont' is set and a valid font is found in it and
3196 'guifontwide' is empty Vim will attempt to find a matching
3197 double-width font and set 'guifontwide' to it.
3198
3199 GTK+ 2 GUI only: *guifontwide_gtk2*
3200
3201 If set and valid, 'guifontwide' is always used for double width
3202 characters, even if 'encoding' is not set to "utf-8".
3203 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003204 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 font for characters not available in 'guifont'. Thus you do not need
3206 to set 'guifontwide' at all unless you want to override the choice
3207 made by Pango/Xft.
3208
3209 *'guiheadroom'* *'ghr'*
3210'guiheadroom' 'ghr' number (default 50)
3211 global
3212 {not in Vi} {only for GTK and X11 GUI}
3213 The number of pixels subtracted from the screen height when fitting
3214 the GUI window on the screen. Set this before the GUI is started,
3215 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003216 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 lines will be left for window decorations and other items on the
3218 screen. Set it to a negative value to allow windows taller than the
3219 screen.
3220
3221 *'guioptions'* *'go'*
3222'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003223 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 global
3225 {not in Vi}
3226 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003227 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 sequence of letters which describes what components and options of the
3229 GUI should be used.
3230 To avoid problems with flags that are added in the future, use the
3231 "+=" and "-=" feature of ":set" |add-option-flags|.
3232
3233 Valid letters are as follows:
3234 *guioptions_a*
3235 'a' Autoselect: If present, then whenever VISUAL mode is started,
3236 or the Visual area extended, Vim tries to become the owner of
3237 the windowing system's global selection. This means that the
3238 Visually highlighted text is available for pasting into other
3239 applications as well as into Vim itself. When the Visual mode
3240 ends, possibly due to an operation on the text, or when an
3241 application wants to paste the selection, the highlighted text
3242 is automatically yanked into the "* selection register.
3243 Thus the selection is still available for pasting into other
3244 applications after the VISUAL mode has ended.
3245 If not present, then Vim won't become the owner of the
3246 windowing system's global selection unless explicitly told to
3247 by a yank or delete operation for the "* register.
3248 The same applies to the modeless selection.
3249
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003250 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 applies to the modeless selection.
3252
3253 'guioptions' autoselect Visual autoselect modeless ~
3254 "" - -
3255 "a" yes yes
3256 "A" - yes
3257 "aA" yes yes
3258
3259 'c' Use console dialogs instead of popup dialogs for simple
3260 choices.
3261
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003262 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003263 'guitablabel' can be used to change the text in the labels.
3264 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003265
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 'f' Foreground: Don't use fork() to detach the GUI from the shell
3267 where it was started. Use this for programs that wait for the
3268 editor to finish (e.g., an e-mail program). Alternatively you
3269 can use "gvim -f" or ":gui -f" to start the GUI in the
3270 foreground. |gui-fork|
3271 Note: Set this option in the vimrc file. The forking may have
3272 happened already when the gvimrc file is read.
3273
3274 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3275 corner of the window. It's black&white on non-GTK, because of
3276 limitations of X11. For a color icon, see |X11-icon|.
3277
3278 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003279 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 that this flag must be added in the .vimrc file, before
3281 switching on syntax or filetype recognition (when the .gvimrc
3282 file is sourced the system menu has already been loaded; the
3283 ":syntax on" and ":filetype on" commands load the menu too).
3284 'g' Grey menu items: Make menu items that are not active grey. If
3285 'g' is not included inactive menu items are not shown at all.
3286 Exception: Athena will always use grey menu items.
3287
3288 't' Include tearoff menu items. Currently only works for Win32,
3289 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003290 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3291 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292
3293 'r' Right-hand scrollbar is always present.
3294 'R' Right-hand scrollbar is present when there is a vertically
3295 split window.
3296 'l' Left-hand scrollbar is always present.
3297 'L' Left-hand scrollbar is present when there is a vertically
3298 split window.
3299 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3300 the longest visible line, or on the cursor line if the 'h'
3301 flag is included. |gui-horiz-scroll|
3302 'h' Limit horizontal scrollbar size to the length of the cursor
3303 line. Reduces computations. |gui-horiz-scroll|
3304
3305 And yes, you may even have scrollbars on the left AND the right if
3306 you really want to :-). See |gui-scrollbars| for more information.
3307
3308 'v' Use a vertical button layout for dialogs. When not included,
3309 a horizontal layout is preferred, but when it doesn't fit a
3310 vertical layout is used anyway.
3311 'p' Use Pointer callbacks for X11 GUI. This is required for some
3312 window managers. If the cursor is not blinking or hollow at
3313 the right moment, try adding this flag. This must be done
3314 before starting the GUI. Set it in your gvimrc. Adding or
3315 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003316 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317
3318 *'guipty'* *'noguipty'*
3319'guipty' boolean (default on)
3320 global
3321 {not in Vi}
3322 {only available when compiled with GUI enabled}
3323 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3324 I/O to/from shell commands. See |gui-pty|.
3325
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003326 *'guitablabel'* *'gtl'*
3327'guitablabel' 'gtl' string (default empty)
3328 global
3329 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003330 {only available when compiled with GUI enabled and
3331 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003332 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003333 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003334 |setting-guitablabel| for more info.
3335
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003336 The format of this option is like that of 'statusline'.
3337
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003338 Only used when the GUI tab pages line is displayed. 'e' must be
3339 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3340 used.
3341
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 *'helpfile'* *'hf'*
3343'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3344 (others) "$VIMRUNTIME/doc/help.txt")
3345 global
3346 {not in Vi}
3347 Name of the main help file. All distributed help files should be
3348 placed together in one directory. Additionally, all "doc" directories
3349 in 'runtimepath' will be used.
3350 Environment variables are expanded |:set_env|. For example:
3351 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003352 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 spaces and backslashes.
3354 This option cannot be set from a |modeline| or in the |sandbox|, for
3355 security reasons.
3356
3357 *'helpheight'* *'hh'*
3358'helpheight' 'hh' number (default 20)
3359 global
3360 {not in Vi}
3361 {not available when compiled without the +windows
3362 feature}
3363 Minimal initial height of the help window when it is opened with the
3364 ":help" command. The initial height of the help window is half of the
3365 current window, or (when the 'ea' option is on) the same as other
3366 windows. When the height is less than 'helpheight', the height is
3367 set to 'helpheight'. Set to zero to disable.
3368
3369 *'helplang'* *'hlg'*
3370'helplang' 'hlg' string (default: messages language or empty)
3371 global
3372 {only available when compiled with the |+multi_lang|
3373 feature}
3374 {not in Vi}
3375 Comma separated list of languages. Vim will use the first language
3376 for which the desired help can be found. The English help will always
3377 be used as a last resort. You can add "en" to prefer English over
3378 another language, but that will only find tags that exist in that
3379 language and not in the English help.
3380 Example: >
3381 :set helplang=de,it
3382< This will first search German, then Italian and finally English help
3383 files.
3384 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3385 try to find the tag in the current language before using this option.
3386 See |help-translated|.
3387
3388 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3389'hidden' 'hid' boolean (default off)
3390 global
3391 {not in Vi}
3392 When off a buffer is unloaded when it is |abandon|ed. When on a
3393 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3394 displayed in another window, it does not become hidden, of course.
3395 The commands that move through the buffer list sometimes make a buffer
3396 hidden although the 'hidden' option is off: When the buffer is
3397 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003398 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003399 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 This option is set for one command with ":hide {command}" |:hide|.
3401 WARNING: It's easy to forget that you have changes in hidden buffers.
3402 Think twice when using ":q!" or ":qa!".
3403
3404 *'highlight'* *'hl'*
3405'highlight' 'hl' string (default (as a single string):
3406 "8:SpecialKey,@:NonText,d:Directory,
3407 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3408 M:ModeMsg,n:LineNr,r:Question,
3409 s:StatusLine,S:StatusLineNC,c:VertSplit
3410 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3411 f:Folded,F:FoldColumn,A:DiffAdd,
3412 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003413 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003414 R:SpellRare,L:SpellLocal,
3415 +:Pmenu,=:PmenuSel,
3416 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 global
3418 {not in Vi}
3419 This option can be used to set highlighting mode for various
3420 occasions. It is a comma separated list of character pairs. The
3421 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003422 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3424 |hl-NonText| @ '~' and '@' at the end of the window and
3425 characters from 'showbreak'
3426 |hl-Directory| d directories in CTRL-D listing and other special
3427 things in listings
3428 |hl-ErrorMsg| e error messages
3429 h (obsolete, ignored)
3430 |hl-IncSearch| i 'incsearch' highlighting
3431 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3432 |hl-MoreMsg| m |more-prompt|
3433 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3434 |hl-LineNr| n line number for ":number" and ":#" commands
3435 |hl-Question| r |hit-enter| prompt and yes/no questions
3436 |hl-StatusLine| s status line of current window |status-line|
3437 |hl-StatusLineNC| S status lines of not-current windows
3438 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3439 |hl-VertSplit| c column used to separate vertically split windows
3440 |hl-Visual| v Visual mode
3441 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3442 Selection" Only X11 Gui's |gui-x11| and
3443 |xterm-clipboard|.
3444 |hl-WarningMsg| w warning messages
3445 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3446 |hl-Folded| f line used for closed folds
3447 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003448 |hl-DiffAdd| A added line in diff mode
3449 |hl-DiffChange| C changed line in diff mode
3450 |hl-DiffDelete| D deleted line in diff mode
3451 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003453 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003454 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003455 |hl-SpellRare| R rare word |spell|
3456 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003457 |hl-Pmenu| + popup menu normal line
3458 |hl-PmenuSel| = popup menu normal line
3459 |hl-PmenuSbar| x popup menu scrollbar
3460 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461
3462 The display modes are:
3463 r reverse (termcap entry "mr" and "me")
3464 i italic (termcap entry "ZH" and "ZR")
3465 b bold (termcap entry "md" and "me")
3466 s standout (termcap entry "so" and "se")
3467 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003468 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 n no highlighting
3470 - no highlighting
3471 : use a highlight group
3472 The default is used for occasions that are not included.
3473 If you want to change what the display modes do, see |dos-colors|
3474 for an example.
3475 When using the ':' display mode, this must be followed by the name of
3476 a highlight group. A highlight group can be used to define any type
3477 of highlighting, including using color. See |:highlight| on how to
3478 define one. The default uses a different group for each occasion.
3479 See |highlight-default| for the default highlight groups.
3480
3481 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3482'hlsearch' 'hls' boolean (default off)
3483 global
3484 {not in Vi}
3485 {not available when compiled without the
3486 |+extra_search| feature}
3487 When there is a previous search pattern, highlight all its matches.
3488 The type of highlighting used can be set with the 'l' occasion in the
3489 'highlight' option. This uses the "Search" highlight group by
3490 default. Note that only the matching text is highlighted, any offsets
3491 are not applied.
3492 See also: 'incsearch' and |:match|.
3493 When you get bored looking at the highlighted matches, you can turn it
3494 off with |:nohlsearch|. As soon as you use a search command, the
3495 highlighting comes back.
3496 When the search pattern can match an end-of-line, Vim will try to
3497 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003498 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 line below a closed fold. A match in a previous line which is not
3500 drawn may not continue in an newly drawn line.
3501 NOTE: This option is reset when 'compatible' is set.
3502
3503 *'history'* *'hi'*
3504'history' 'hi' number (Vim default: 20, Vi default: 0)
3505 global
3506 {not in Vi}
3507 A history of ":" commands, and a history of previous search patterns
3508 are remembered. This option decides how many entries may be stored in
3509 each of these histories (see |cmdline-editing|).
3510 NOTE: This option is set to the Vi default value when 'compatible' is
3511 set and to the Vim default value when 'compatible' is reset.
3512
3513 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3514'hkmap' 'hk' boolean (default off)
3515 global
3516 {not in Vi}
3517 {only available when compiled with the |+rightleft|
3518 feature}
3519 When on, the keyboard is mapped for the Hebrew character set.
3520 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3521 toggle this option. See |rileft.txt|.
3522 NOTE: This option is reset when 'compatible' is set.
3523
3524 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3525'hkmapp' 'hkp' boolean (default off)
3526 global
3527 {not in Vi}
3528 {only available when compiled with the |+rightleft|
3529 feature}
3530 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3531 This is useful if you have a non-Hebrew keyboard.
3532 See |rileft.txt|.
3533 NOTE: This option is reset when 'compatible' is set.
3534
3535 *'icon'* *'noicon'*
3536'icon' boolean (default off, on when title can be restored)
3537 global
3538 {not in Vi}
3539 {not available when compiled without the |+title|
3540 feature}
3541 When on, the icon text of the window will be set to the value of
3542 'iconstring' (if it is not empty), or to the name of the file
3543 currently being edited. Only the last part of the name is used.
3544 Overridden by the 'iconstring' option.
3545 Only works if the terminal supports setting window icons (currently
3546 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3547 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3548 builtin termcap).
3549 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003550 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 X11.
3552
3553 *'iconstring'*
3554'iconstring' string (default "")
3555 global
3556 {not in Vi}
3557 {not available when compiled without the |+title|
3558 feature}
3559 When this option is not empty, it will be used for the icon text of
3560 the window. This happens only when the 'icon' option is on.
3561 Only works if the terminal supports setting window icon text
3562 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3563 Does not work for MS Windows.
3564 When Vim was compiled with HAVE_X11 defined, the original icon will be
3565 restored if possible |X11|.
3566 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003567 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 'titlestring' for example settings.
3569 {not available when compiled without the |+statusline| feature}
3570
3571 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3572'ignorecase' 'ic' boolean (default off)
3573 global
3574 Ignore case in search patterns. Also used when searching in the tags
3575 file.
3576 Also see 'smartcase'.
3577 Can be overruled by using "\c" or "\C" in the pattern, see
3578 |/ignorecase|.
3579
3580 *'imactivatekey'* *'imak'*
3581'imactivatekey' 'imak' string (default "")
3582 global
3583 {not in Vi}
3584 {only available when compiled with |+xim| and
3585 |+GUI_GTK|}
3586 Specifies the key that your Input Method in X-Windows uses for
3587 activation. When this is specified correctly, vim can fully control
3588 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3589 You can't use this option to change the activation key, the option
3590 tells Vim what the key is.
3591 Format:
3592 [MODIFIER_FLAG-]KEY_STRING
3593
3594 These characters can be used for MODIFIER_FLAG (case is ignored):
3595 S Shift key
3596 L Lock key
3597 C Control key
3598 1 Mod1 key
3599 2 Mod2 key
3600 3 Mod3 key
3601 4 Mod4 key
3602 5 Mod5 key
3603 Combinations are allowed, for example "S-C-space" or "SC-space" are
3604 both shift+ctrl+space.
3605 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3606
3607 Example: >
3608 :set imactivatekey=S-space
3609< "S-space" means shift+space. This is the activation key for kinput2 +
3610 canna (Japanese), and ami (Korean).
3611
3612 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3613'imcmdline' 'imc' boolean (default off)
3614 global
3615 {not in Vi}
3616 {only available when compiled with the |+xim|
3617 |+multi_byte_ime| or |global-ime| feature}
3618 When set the Input Method is always on when starting to edit a command
3619 line, unless entering a search pattern (see 'imsearch' for that).
3620 Setting this option is useful when your input method allows entering
3621 English characters directly, e.g., when it's used to type accented
3622 characters with dead keys.
3623
3624 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3625'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3626 global
3627 {not in Vi}
3628 {only available when compiled with the |+xim|
3629 |+multi_byte_ime| or |global-ime| feature}
3630 When set the Input Method is never used. This is useful to disable
3631 the IM when it doesn't work properly.
3632 Currently this option is on by default for SGI/IRIX machines. This
3633 may change in later releases.
3634
3635 *'iminsert'* *'imi'*
3636'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3637 local to buffer
3638 {not in Vi}
3639 Specifies whether :lmap or an Input Method (IM) is to be used in
3640 Insert mode. Valid values:
3641 0 :lmap is off and IM is off
3642 1 :lmap is ON and IM is off
3643 2 :lmap is off and IM is ON
3644 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3645 or |global-ime|.
3646 To always reset the option to zero when leaving Insert mode with <Esc>
3647 this can be used: >
3648 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3649< This makes :lmap and IM turn off automatically when leaving Insert
3650 mode.
3651 Note that this option changes when using CTRL-^ in Insert mode
3652 |i_CTRL-^|.
3653 The value is set to 1 when setting 'keymap' to a valid keymap name.
3654 It is also used for the argument of commands like "r" and "f".
3655 The value 0 may not work correctly with Athena and Motif with some XIM
3656 methods. Use 'imdisable' to disable XIM then.
3657
3658 *'imsearch'* *'ims'*
3659'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3660 local to buffer
3661 {not in Vi}
3662 Specifies whether :lmap or an Input Method (IM) is to be used when
3663 entering a search pattern. Valid values:
3664 -1 the value of 'iminsert' is used, makes it look like
3665 'iminsert' is also used when typing a search pattern
3666 0 :lmap is off and IM is off
3667 1 :lmap is ON and IM is off
3668 2 :lmap is off and IM is ON
3669 Note that this option changes when using CTRL-^ in Command-line mode
3670 |c_CTRL-^|.
3671 The value is set to 1 when it is not -1 and setting the 'keymap'
3672 option to a valid keymap name.
3673 The value 0 may not work correctly with Athena and Motif with some XIM
3674 methods. Use 'imdisable' to disable XIM then.
3675
3676 *'include'* *'inc'*
3677'include' 'inc' string (default "^\s*#\s*include")
3678 global or local to buffer |global-local|
3679 {not in Vi}
3680 {not available when compiled without the
3681 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003682 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 pattern, just like for the "/" command (See |pattern|). The default
3684 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003685 "]I", "[d", etc.
3686 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003687 comes after the matched pattern. But if "\zs" appears in the pattern
3688 then the text matched from "\zs" to the end, or until "\ze" if it
3689 appears, is used as the file name. Use this to include characters
3690 that are not in 'isfname', such as a space. You can then use
3691 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003692 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693
3694 *'includeexpr'* *'inex'*
3695'includeexpr' 'inex' string (default "")
3696 local to buffer
3697 {not in Vi}
3698 {not available when compiled without the
3699 |+find_in_path| or |+eval| feature}
3700 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003701 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 :set includeexpr=substitute(v:fname,'\\.','/','g')
3703< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003704
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003706 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 Also used for |<cfile>|.
3708
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003709 The expression may be evaluated in the |sandbox|, see
3710 |sandbox-option|.
3711
3712 It is not allowed to change text or jump to another window while
3713 evaluating 'includeexpr' |textlock|.
3714
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3716'incsearch' 'is' boolean (default off)
3717 global
3718 {not in Vi}
3719 {not available when compiled without the
3720 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003721 While typing a search command, show where the pattern, as it was typed
3722 so far, matches. The matched string is highlighted. If the pattern
3723 is invalid or not found, nothing is shown. The screen will be updated
3724 often, this is only useful on fast terminals.
3725 Note that the match will be shown, but the cursor will return to its
3726 original position when no match is found and when pressing <Esc>. You
3727 still need to finish the search command with <Enter> to move the
3728 cursor to the match.
3729 The highlighting can be set with the 'i' flag in 'highlight'.
3730 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 NOTE: This option is reset when 'compatible' is set.
3732
3733 *'indentexpr'* *'inde'*
3734'indentexpr' 'inde' string (default "")
3735 local to buffer
3736 {not in Vi}
3737 {not available when compiled without the |+cindent|
3738 or |+eval| features}
3739 Expression which is evaluated to obtain the proper indent for a line.
3740 It is used when a new line is created, for the |=| operator and
3741 in Insert mode as specified with the 'indentkeys' option.
3742 When this option is not empty, it overrules the 'cindent' and
3743 'smartindent' indenting.
3744 When 'paste' is set this option is not used for indenting.
3745 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003746 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 when the expression is evaluated (but it may be moved around).
3748 The expression must return the number of spaces worth of indent. It
3749 can return "-1" to keep the current indent (this means 'autoindent' is
3750 used for the indent).
3751 Functions useful for computing the indent are |indent()|, |cindent()|
3752 and |lispindent()|.
3753 The evaluation of the expression must not have side effects! It must
3754 not change the text, jump to another window, etc. Afterwards the
3755 cursor position is always restored, thus the cursor may be moved.
3756 Normally this option would be set to call a function: >
3757 :set indentexpr=GetMyIndent()
3758< Error messages will be suppressed, unless the 'debug' option contains
3759 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003760 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 NOTE: This option is made empty when 'compatible' is set.
3762
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003763 The expression may be evaluated in the |sandbox|, see
3764 |sandbox-option|.
3765
3766 It is not allowed to change text or jump to another window while
3767 evaluating 'indentexpr' |textlock|.
3768
3769
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 *'indentkeys'* *'indk'*
3771'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3772 local to buffer
3773 {not in Vi}
3774 {not available when compiled without the |+cindent|
3775 feature}
3776 A list of keys that, when typed in Insert mode, cause reindenting of
3777 the current line. Only happens if 'indentexpr' isn't empty.
3778 The format is identical to 'cinkeys', see |indentkeys-format|.
3779 See |C-indenting| and |indent-expression|.
3780
3781 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3782'infercase' 'inf' boolean (default off)
3783 local to buffer
3784 {not in Vi}
3785 When doing keyword completion in insert mode |ins-completion|, and
3786 'ignorecase' is also on, the case of the match is adjusted. If the
3787 typed text contains a lowercase letter where the match has an upper
3788 case letter, the completed part is made lowercase. If the typed text
3789 has no lowercase letters and the match has a lowercase letter where
3790 the typed text has an uppercase letter, and there is a letter before
3791 it, the completed part is made uppercase.
3792
3793 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3794'insertmode' 'im' boolean (default off)
3795 global
3796 {not in Vi}
3797 Makes Vim work in a way that Insert mode is the default mode. Useful
3798 if you want to use Vim as a modeless editor. Used for |evim|.
3799 These Insert mode commands will be useful:
3800 - Use the cursor keys to move around.
3801 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3802 this is a mapping, it is executed as if 'insertmode' was off.
3803 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003805 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3806 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807
3808 These items change when 'insertmode' is set:
3809 - when starting to edit of a file, Vim goes to Insert mode.
3810 - <Esc> in Insert mode is a no-op and beeps.
3811 - <Esc> in Normal mode makes Vim go to Insert mode.
3812 - CTRL-L in Insert mode is a command, it is not inserted.
3813 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3814 However, when <Esc> is used inside a mapping, it behaves like
3815 'insertmode' was not set. This was done to be able to use the same
3816 mappings with 'insertmode' set or not set.
3817 When executing commands with |:normal| 'insertmode' is not used.
3818
3819 NOTE: This option is reset when 'compatible' is set.
3820
3821 *'isfname'* *'isf'*
3822'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3823 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3824 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3825 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3826 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3827 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3828 global
3829 {not in Vi}
3830 The characters specified by this option are included in file names and
3831 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003832 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 Multi-byte characters 256 and above are always included, only the
3834 characters up to 255 are specified with this option.
3835 For UTF-8 the characters 0xa0 to 0xff are included as well.
3836
3837 Note that on systems using a backslash as path separator, Vim tries to
3838 do its best to make it work as you would expect. That is a bit
3839 tricky, since Vi originally used the backslash to escape special
3840 characters. Vim will not remove a backslash in front of a normal file
3841 name character on these systems, but it will on Unix and alikes. The
3842 '&' and '^' are not included by default, because these are special for
3843 cmd.exe.
3844
3845 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003846 Each part can be a single character number or a range. A range is two
3847 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 decimal number between 0 and 255 or the ASCII character itself (does
3849 not work for digits). Example:
3850 "_,-,128-140,#-43" (include '_' and '-' and the range
3851 128 to 140 and '#' to 43)
3852 If a part starts with '^', the following character number or range
3853 will be excluded from the option. The option is interpreted from left
3854 to right. Put the excluded character after the range where it is
3855 included. To include '^' itself use it as the last character of the
3856 option or the end of a range. Example:
3857 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3858 If the character is '@', all characters where isalpha() returns TRUE
3859 are included. Normally these are the characters a to z and A to Z,
3860 plus accented characters. To include '@' itself use "@-@". Examples:
3861 "@,^a-z" All alphabetic characters, excluding lower
3862 case letters.
3863 "a-z,A-Z,@-@" All letters plus the '@' character.
3864 A comma can be included by using it where a character number is
3865 expected. Example:
3866 "48-57,,,_" Digits, comma and underscore.
3867 A comma can be excluded by prepending a '^'. Example:
3868 " -~,^,,9" All characters from space to '~', excluding
3869 comma, plus <Tab>.
3870 See |option-backslash| about including spaces and backslashes.
3871
3872 *'isident'* *'isi'*
3873'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3874 "@,48-57,_,128-167,224-235"
3875 otherwise: "@,48-57,_,192-255")
3876 global
3877 {not in Vi}
3878 The characters given by this option are included in identifiers.
3879 Identifiers are used in recognizing environment variables and after a
3880 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003881 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 option.
3883 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003884 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3886
3887 *'iskeyword'* *'isk'*
3888'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3889 "@,48-57,_,128-167,224-235"
3890 otherwise: "@,48-57,_,192-255"
3891 Vi default: "@,48-57,_")
3892 local to buffer
3893 {not in Vi}
3894 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003895 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 'isfname' for a description of the format of this option. For C
3897 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3898 For a help file it is set to all non-blank printable characters except
3899 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3900 command).
3901 When the 'lisp' option is on the '-' character is always included.
3902 NOTE: This option is set to the Vi default value when 'compatible' is
3903 set and to the Vim default value when 'compatible' is reset.
3904
3905 *'isprint'* *'isp'*
3906'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3907 "@,~-255"; otherwise: "@,161-255")
3908 global
3909 {not in Vi}
3910 The characters given by this option are displayed directly on the
3911 screen. It is also used for "\p" in a |pattern|. The characters from
3912 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3913 even when they are not included in 'isprint' or excluded. See
3914 'isfname' for a description of the format of this option.
3915
3916 Non-printable characters are displayed with two characters:
3917 0 - 31 "^@" - "^_"
3918 32 - 126 always single characters
3919 127 "^?"
3920 128 - 159 "~@" - "~_"
3921 160 - 254 "| " - "|~"
3922 255 "~?"
3923 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3924 displayed as <xx>, with the hexadecimal value of the byte.
3925 When 'display' contains "uhex" all unprintable characters are
3926 displayed as <xx>.
3927 The NonText highlighting will be used for unprintable characters.
3928 |hl-NonText|
3929
3930 Multi-byte characters 256 and above are always included, only the
3931 characters up to 255 are specified with this option. When a character
3932 is printable but it is not available in the current font, a
3933 replacement character will be shown.
3934 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3935 There is no option to specify these characters.
3936
3937 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3938'joinspaces' 'js' boolean (default on)
3939 global
3940 {not in Vi}
3941 Insert two spaces after a '.', '?' and '!' with a join command.
3942 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3943 Otherwise only one space is inserted.
3944 NOTE: This option is set when 'compatible' is set.
3945
3946 *'key'*
3947'key' string (default "")
3948 local to buffer
3949 {not in Vi}
3950 The key that is used for encrypting and decrypting the current buffer.
3951 See |encryption|.
3952 Careful: Do not set the key value by hand, someone might see the typed
3953 key. Use the |:X| command. But you can make 'key' empty: >
3954 :set key=
3955< It is not possible to get the value of this option with ":set key" or
3956 "echo &key". This is to avoid showing it to someone who shouldn't
3957 know. It also means you cannot see it yourself once you have set it,
3958 be careful not to make a typing error!
3959
3960 *'keymap'* *'kmp'* *E544*
3961'keymap' 'kmp' string (default "")
3962 local to buffer
3963 {not in Vi}
3964 {only available when compiled with the |+keymap|
3965 feature}
3966 Name of a keyboard mapping. See |mbyte-keymap|.
3967 Setting this option to a valid keymap name has the side effect of
3968 setting 'iminsert' to one, so that the keymap becomes effective.
3969 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003970 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971
3972 *'keymodel'* *'km'*
3973'keymodel' 'km' string (default "")
3974 global
3975 {not in Vi}
3976 List of comma separated words, which enable special things that keys
3977 can do. These values can be used:
3978 startsel Using a shifted special key starts selection (either
3979 Select mode or Visual mode, depending on "key" being
3980 present in 'selectmode').
3981 stopsel Using a not-shifted special key stops selection.
3982 Special keys in this context are the cursor keys, <End>, <Home>,
3983 <PageUp> and <PageDown>.
3984 The 'keymodel' option is set by the |:behave| command.
3985
3986 *'keywordprg'* *'kp'*
3987'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3988 OS/2: "view /", VMS: "help")
3989 global or local to buffer |global-local|
3990 {not in Vi}
3991 Program to use for the |K| command. Environment variables are
3992 expanded |:set_env|. ":help" may be used to access the Vim internal
3993 help. (Note that previously setting the global option to the empty
3994 value did this, which is now deprecated.)
3995 When "man" is used, Vim will automatically translate a count for the
3996 "K" command to a section number. Also for "man -s", in which case the
3997 "-s" is removed when there is no count.
3998 See |option-backslash| about including spaces and backslashes.
3999 Example: >
4000 :set keywordprg=man\ -s
4001< This option cannot be set from a |modeline| or in the |sandbox|, for
4002 security reasons.
4003
4004 *'langmap'* *'lmap'* *E357* *E358*
4005'langmap' 'lmap' string (default "")
4006 global
4007 {not in Vi}
4008 {only available when compiled with the |+langmap|
4009 feature}
4010 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004011 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 inserted directly. When in command mode the 'langmap' option takes
4013 care of translating these special characters to the original meaning
4014 of the key. This means you don't have to change the keyboard mode to
4015 be able to execute Normal mode commands.
4016 This is the opposite of the 'keymap' option, where characters are
4017 mapped in Insert mode.
4018 This only works for 8-bit characters. The value of 'langmap' may be
4019 specified with multi-byte characters (e.g., UTF-8), but only the lower
4020 8 bits of each character will be used.
4021
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004022 Example (for Greek, in UTF-8): *greek* >
4023 :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
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024< Example (exchanges meaning of z and y for commands): >
4025 :set langmap=zy,yz,ZY,YZ
4026<
4027 The 'langmap' option is a list of parts, separated with commas. Each
4028 part can be in one of two forms:
4029 1. A list of pairs. Each pair is a "from" character immediately
4030 followed by the "to" character. Examples: "aA", "aAbBcC".
4031 2. A list of "from" characters, a semi-colon and a list of "to"
4032 characters. Example: "abc;ABC"
4033 Example: "aA,fgh;FGH,cCdDeE"
4034 Special characters need to be preceded with a backslash. These are
4035 ";", ',' and backslash itself.
4036
4037 This will allow you to activate vim actions without having to switch
4038 back and forth between the languages. Your language characters will
4039 be understood as normal vim English characters (according to the
4040 langmap mappings) in the following cases:
4041 o Normal/Visual mode (commands, buffer/register names, user mappings)
4042 o Insert/Replace Mode: Register names after CTRL-R
4043 o Insert/Replace Mode: Mappings
4044 Characters entered in Command-line mode will NOT be affected by
4045 this option. Note that this option can be changed at any time
4046 allowing to switch between mappings for different languages/encodings.
4047 Use a mapping to avoid having to type it each time!
4048
4049 *'langmenu'* *'lm'*
4050'langmenu' 'lm' string (default "")
4051 global
4052 {not in Vi}
4053 {only available when compiled with the |+menu| and
4054 |+multi_lang| features}
4055 Language to use for menu translation. Tells which file is loaded
4056 from the "lang" directory in 'runtimepath': >
4057 "lang/menu_" . &langmenu . ".vim"
4058< (without the spaces). For example, to always use the Dutch menus, no
4059 matter what $LANG is set to: >
4060 :set langmenu=nl_NL.ISO_8859-1
4061< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004062 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 If your $LANG is set to a non-English language but you do want to use
4064 the English menus: >
4065 :set langmenu=none
4066< This option must be set before loading menus, switching on filetype
4067 detection or syntax highlighting. Once the menus are defined setting
4068 this option has no effect. But you could do this: >
4069 :source $VIMRUNTIME/delmenu.vim
4070 :set langmenu=de_DE.ISO_8859-1
4071 :source $VIMRUNTIME/menu.vim
4072< Warning: This deletes all menus that you defined yourself!
4073
4074 *'laststatus'* *'ls'*
4075'laststatus' 'ls' number (default 1)
4076 global
4077 {not in Vi}
4078 The value of this option influences when the last window will have a
4079 status line:
4080 0: never
4081 1: only if there are at least two windows
4082 2: always
4083 The screen looks nicer with a status line if you have several
4084 windows, but it takes another screen line. |status-line|
4085
4086 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4087'lazyredraw' 'lz' boolean (default off)
4088 global
4089 {not in Vi}
4090 When this option is set, the screen will not be redrawn while
4091 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004092 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 update use |:redraw|.
4094
4095 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4096'linebreak' 'lbr' boolean (default off)
4097 local to window
4098 {not in Vi}
4099 {not available when compiled without the |+linebreak|
4100 feature}
4101 If on Vim will wrap long lines at a character in 'breakat' rather
4102 than at the last character that fits on the screen. Unlike
4103 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4104 it only affects the way the file is displayed, not its contents. The
4105 value of 'showbreak' is used to put in front of wrapped lines.
4106 This option is not used when the 'wrap' option is off or 'list' is on.
4107 Note that <Tab> characters after an <EOL> are mostly not displayed
4108 with the right amount of white space.
4109
4110 *'lines'* *E593*
4111'lines' number (default 24 or terminal height)
4112 global
4113 Number of lines of the Vim window.
4114 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004115 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 When Vim is running in the GUI or in a resizable window, setting this
4117 option will cause the window size to be changed. When you only want
4118 to use the size for the GUI, put the command in your |gvimrc| file.
4119 Vim limits the number of lines to what fits on the screen. You can
4120 use this command to get the tallest window possible: >
4121 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004122< Minimum value is 2, maximum value is 1000.
4123 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 When you set this option and Vim is unable to change the physical
4125 number of lines of the display, the display may be messed up.
4126
4127 *'linespace'* *'lsp'*
4128'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4129 global
4130 {not in Vi}
4131 {only in the GUI}
4132 Number of pixel lines inserted between characters. Useful if the font
4133 uses the full character cell height, making lines touch each other.
4134 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004135 With some fonts there can be too much room between lines (to have
4136 space for ascents and descents). Then it makes sense to set
4137 'linespace' to a negative value. This may cause display problems
4138 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139
4140 *'lisp'* *'nolisp'*
4141'lisp' boolean (default off)
4142 local to buffer
4143 {not available when compiled without the |+lispindent|
4144 feature}
4145 Lisp mode: When <Enter> is typed in insert mode set the indent for
4146 the next line to Lisp standards (well, sort of). Also happens with
4147 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4148 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4149 better. Also see 'lispwords'.
4150 The '-' character is included in keyword characters. Redefines the
4151 "=" operator to use this same indentation algorithm rather than
4152 calling an external program if 'equalprg' is empty.
4153 This option is not used when 'paste' is set.
4154 {Vi: Does it a little bit differently}
4155
4156 *'lispwords'* *'lw'*
4157'lispwords' 'lw' string (default is very long)
4158 global
4159 {not in Vi}
4160 {not available when compiled without the |+lispindent|
4161 feature}
4162 Comma separated list of words that influence the Lisp indenting.
4163 |'lisp'|
4164
4165 *'list'* *'nolist'*
4166'list' boolean (default off)
4167 local to window
4168 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4169 see the difference between tabs and spaces and for trailing blanks.
4170 Note that this will also affect formatting (set with 'textwidth' or
4171 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4172 changing the way tabs are displayed.
4173
4174 *'listchars'* *'lcs'*
4175'listchars' 'lcs' string (default "eol:$")
4176 global
4177 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004178 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 settings.
4180 eol:c Character to show at the end of each line. When
4181 omitted, there is no extra character at the end of the
4182 line.
4183 tab:xy Two characters to be used to show a Tab. The first
4184 char is used once. The second char is repeated to
4185 fill the space that the Tab normally occupies.
4186 "tab:>-" will show a Tab that takes four spaces as
4187 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004188 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 trailing spaces are blank.
4190 extends:c Character to show in the last column, when 'wrap' is
4191 off and the line continues beyond the right of the
4192 screen.
4193 precedes:c Character to show in the first column, when 'wrap'
4194 is off and there is text preceding the character
4195 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004196 nbsp:c Character to show for a non-breakable space (character
4197 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004199 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 be used when 'encoding' is "utf-8", otherwise only printable
4201 characters are allowed.
4202
4203 Examples: >
4204 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004205 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 :set lcs=extends:>,precedes:<
4207< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004208 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209
4210 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4211'loadplugins' 'lpl' boolean (default on)
4212 global
4213 {not in Vi}
4214 When on the plugin scripts are loaded when starting up |load-plugins|.
4215 This option can be reset in your |vimrc| file to disable the loading
4216 of plugins.
4217 Note that using the "-u NONE" and "--noplugin" command line arguments
4218 reset this option. |-u| |--noplugin|
4219
4220 *'magic'* *'nomagic'*
4221'magic' boolean (default on)
4222 global
4223 Changes the special characters that can be used in search patterns.
4224 See |pattern|.
4225 NOTE: To avoid portability problems with using patterns, always keep
4226 this option at the default "on". Only switch it off when working with
4227 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004228 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229
4230 *'makeef'* *'mef'*
4231'makeef' 'mef' string (default: "")
4232 global
4233 {not in Vi}
4234 {not available when compiled without the |+quickfix|
4235 feature}
4236 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4237 and the |:grep| command.
4238 When it is empty, an internally generated temp file will be used.
4239 When "##" is included, it is replaced by a number to make the name
4240 unique. This makes sure that the ":make" command doesn't overwrite an
4241 existing file.
4242 NOT used for the ":cf" command. See 'errorfile' for that.
4243 Environment variables are expanded |:set_env|.
4244 See |option-backslash| about including spaces and backslashes.
4245 This option cannot be set from a |modeline| or in the |sandbox|, for
4246 security reasons.
4247
4248 *'makeprg'* *'mp'*
4249'makeprg' 'mp' string (default "make", VMS: "MMS")
4250 global or local to buffer |global-local|
4251 {not in Vi}
4252 Program to use for the ":make" command. See |:make_makeprg|. This
4253 option may contain '%' and '#' characters, which are expanded like
4254 when used in a command-line. Environment variables are expanded
4255 |:set_env|. See |option-backslash| about including spaces and
4256 backslashes. Note that a '|' must be escaped twice: once for ":set"
4257 and once for the interpretation of a command. When you use a filter
4258 called "myfilter" do it like this: >
4259 :set makeprg=gmake\ \\\|\ myfilter
4260< The placeholder "$*" can be given (even multiple times) to specify
4261 where the arguments will be included, for example: >
4262 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4263< This option cannot be set from a |modeline| or in the |sandbox|, for
4264 security reasons.
4265
4266 *'matchpairs'* *'mps'*
4267'matchpairs' 'mps' string (default "(:),{:},[:]")
4268 local to buffer
4269 {not in Vi}
4270 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004271 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 must be different. The characters must be separated by a colon. The
4273 pairs must be separated by a comma. Example for including '<' and '>'
4274 (HTML): >
4275 :set mps+=<:>
4276
4277< A more exotic example, to jump between the '=' and ';' in an
4278 assignment, useful for languages like C and Java: >
4279 :au FileType c,cpp,java set mps+==:;
4280
4281< For a more advanced way of using "%", see the matchit.vim plugin in
4282 the $VIMRUNTIME/macros directory. |add-local-help|
4283
4284 *'matchtime'* *'mat'*
4285'matchtime' 'mat' number (default 5)
4286 global
4287 {not in Vi}{in Nvi}
4288 Tenths of a second to show the matching paren, when 'showmatch' is
4289 set. Note that this is not in milliseconds, like other options that
4290 set a time. This is to be compatible with Nvi.
4291
4292 *'maxfuncdepth'* *'mfd'*
4293'maxfuncdepth' 'mfd' number (default 100)
4294 global
4295 {not in Vi}
4296 Maximum depth of function calls for user functions. This normally
4297 catches endless recursion. When using a recursive function with
4298 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4299 more memory, there is the danger of failing when memory is exhausted.
4300 See also |:function|.
4301
4302 *'maxmapdepth'* *'mmd'* *E223*
4303'maxmapdepth' 'mmd' number (default 1000)
4304 global
4305 {not in Vi}
4306 Maximum number of times a mapping is done without resulting in a
4307 character to be used. This normally catches endless mappings, like
4308 ":map x y" with ":map y x". It still does not catch ":map g wg",
4309 because the 'w' is used before the next mapping is done. See also
4310 |key-mapping|.
4311
4312 *'maxmem'* *'mm'*
4313'maxmem' 'mm' number (default between 256 to 5120 (system
4314 dependent) or half the amount of memory
4315 available)
4316 global
4317 {not in Vi}
4318 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4319 limit is reached allocating extra memory for a buffer will cause
4320 other memory to be freed. Maximum value 2000000. Use this to work
4321 without a limit. Also see 'maxmemtot'.
4322
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004323 *'maxmempattern'* *'mmp'*
4324'maxmempattern' 'mmp' number (default 1000)
4325 global
4326 {not in Vi}
4327 Maximum amount of memory (in Kbyte) to use for pattern matching.
4328 Maximum value 2000000. Use this to work without a limit.
4329 *E363*
4330 When Vim runs into the limit it gives an error message mostly behaves
4331 like CTRL-C was typed.
4332 Running into the limit often means that the pattern is very
4333 inefficient or too complex. This may already happen with the pattern
4334 "\(.\)*" on a very long line. ".*" works much better.
4335 Vim may run out of memory before hitting the 'maxmempattern' limit.
4336
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 *'maxmemtot'* *'mmt'*
4338'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4339 dependent) or half the amount of memory
4340 available)
4341 global
4342 {not in Vi}
4343 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004344 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 'maxmem'.
4346
4347 *'menuitems'* *'mis'*
4348'menuitems' 'mis' number (default 25)
4349 global
4350 {not in Vi}
4351 {not available when compiled without the |+menu|
4352 feature}
4353 Maximum number of items to use in a menu. Used for menus that are
4354 generated from a list of items, e.g., the Buffers menu. Changing this
4355 option has no direct effect, the menu must be refreshed first.
4356
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004357 *'mkspellmem'* *'msm'*
4358'mkspellmem' 'msm' string (default "460000,2000,500")
4359 global
4360 {not in Vi}
4361 {not available when compiled without the |+syntax|
4362 feature}
4363 Parameters for |:mkspell|. This tunes when to start compressing the
4364 word tree. Compression can be slow when there are many words, but
4365 it's needed to avoid running out of memory. The amount of memory used
4366 per word depends very much on how similar the words are, that's why
4367 this tuning is complicated.
4368
4369 There are three numbers, separated by commas:
4370 {start},{inc},{added}
4371
4372 For most languages the uncompressed word tree fits in memory. {start}
4373 gives the amount of memory in Kbyte that can be used before any
4374 compression is done. It should be a bit smaller than the amount of
4375 memory that is available to Vim.
4376
4377 When going over the {start} limit the {inc} number specifies the
4378 amount of memory in Kbyte that can be allocated before another
4379 compression is done. A low number means compression is done after
4380 less words are added, which is slow. A high number means more memory
4381 will be allocated.
4382
4383 After doing compression, {added} times 1024 words can be added before
4384 the {inc} limit is ignored and compression is done when any extra
4385 amount of memory is needed. A low number means there is a smaller
4386 chance of hitting the {inc} limit, less memory is used but it's
4387 slower.
4388
4389 The languages for which these numbers are important are Italian and
4390 Hungarian. The default works for when you have about 512 Mbyte. If
4391 you have 1 Gbyte you could use: >
4392 :set mkspellmem=900000,3000,800
4393< If you have less than 512 Mbyte |:mkspell| may fail for some
4394 languages, no matter what you set 'mkspellmem' to.
4395
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4397'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4398 local to buffer
4399 *'modelines'* *'mls'*
4400'modelines' 'mls' number (default 5)
4401 global
4402 {not in Vi}
4403 If 'modeline' is on 'modelines' gives the number of lines that is
4404 checked for set commands. If 'modeline' is off or 'modelines' is zero
4405 no lines are checked. See |modeline|.
4406 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4407 set and to the Vim default value when 'compatible' is reset.
4408
4409 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4410'modifiable' 'ma' boolean (default on)
4411 local to buffer
4412 {not in Vi} *E21*
4413 When off the buffer contents cannot be changed. The 'fileformat' and
4414 'fileencoding' options also can't be changed.
4415 Can be reset with the |-M| command line argument.
4416
4417 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4418'modified' 'mod' boolean (default off)
4419 local to buffer
4420 {not in Vi}
4421 When on, the buffer is considered to be modified. This option is set
4422 when:
4423 1. A change was made to the text since it was last written. Using the
4424 |undo| command to go back to the original text will reset the
4425 option. But undoing changes that were made before writing the
4426 buffer will set the option again, since the text is different from
4427 when it was written.
4428 2. 'fileformat' or 'fileencoding' is different from its original
4429 value. The original value is set when the buffer is read or
4430 written. A ":set nomodified" command also resets the original
4431 values to the current values and the 'modified' option will be
4432 reset.
4433 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4434 will be ignored.
4435
4436 *'more'* *'nomore'*
4437'more' boolean (Vim default: on, Vi default: off)
4438 global
4439 {not in Vi}
4440 When on, listings pause when the whole screen is filled. You will get
4441 the |more-prompt|. When this option is off there are no pauses, the
4442 listing continues until finished.
4443 NOTE: This option is set to the Vi default value when 'compatible' is
4444 set and to the Vim default value when 'compatible' is reset.
4445
4446 *'mouse'* *E538*
4447'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4448 global
4449 {not in Vi}
4450 Enable the use of the mouse. Only works for certain terminals
4451 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4452 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4453 The mouse can be enabled for different modes:
4454 n Normal mode
4455 v Visual mode
4456 i Insert mode
4457 c Command-line mode
4458 h all previous modes when editing a help file
4459 a all previous modes
4460 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 Normally you would enable the mouse in all four modes with: >
4462 :set mouse=a
4463< When the mouse is not enabled, the GUI will still use the mouse for
4464 modeless selection. This doesn't move the text cursor.
4465
4466 See |mouse-using|. Also see |'clipboard'|.
4467
4468 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004469 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 the mouse buttons can still be used by keeping the shift key pressed.
4471 Also see the 'clipboard' option.
4472
4473 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4474'mousefocus' 'mousef' boolean (default off)
4475 global
4476 {not in Vi}
4477 {only works in the GUI}
4478 The window that the mouse pointer is on is automatically activated.
4479 When changing the window layout or window focus in another way, the
4480 mouse pointer is moved to the window with keyboard focus. Off is the
4481 default because it makes using the pull down menus a little goofy, as
4482 a pointer transit may activate a window unintentionally.
4483
4484 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4485'mousehide' 'mh' boolean (default on)
4486 global
4487 {not in Vi}
4488 {only works in the GUI}
4489 When on, the mouse pointer is hidden when characters are typed.
4490 The mouse pointer is restored when the mouse is moved.
4491
4492 *'mousemodel'* *'mousem'*
4493'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4494 global
4495 {not in Vi}
4496 Sets the model to use for the mouse. The name mostly specifies what
4497 the right mouse button is used for:
4498 extend Right mouse button extends a selection. This works
4499 like in an xterm.
4500 popup Right mouse button pops up a menu. The shifted left
4501 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004502 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 popup_setpos Like "popup", but the cursor will be moved to the
4504 position where the mouse was clicked, and thus the
4505 selected operation will act upon the clicked object.
4506 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004507 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 course, that right clicking outside a selection will
4509 end Visual mode.
4510 Overview of what button does what for each model:
4511 mouse extend popup(_setpos) ~
4512 left click place cursor place cursor
4513 left drag start selection start selection
4514 shift-left search word extend selection
4515 right click extend selection popup menu (place cursor)
4516 right drag extend selection -
4517 middle click paste paste
4518
4519 In the "popup" model the right mouse button produces a pop-up menu.
4520 You need to define this first, see |popup-menu|.
4521
4522 Note that you can further refine the meaning of buttons with mappings.
4523 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4524 selection (because that's handled in the GUI code directly).
4525
4526 The 'mousemodel' option is set by the |:behave| command.
4527
4528 *'mouseshape'* *'mouses'* *E547*
4529'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004530 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 global
4532 {not in Vi}
4533 {only available when compiled with the |+mouseshape|
4534 feature}
4535 This option tells Vim what the mouse pointer should look like in
4536 different modes. The option is a comma separated list of parts, much
4537 like used for 'guicursor'. Each part consist of a mode/location-list
4538 and an argument-list:
4539 mode-list:shape,mode-list:shape,..
4540 The mode-list is a dash separated list of these modes/locations:
4541 In a normal window: ~
4542 n Normal mode
4543 v Visual mode
4544 ve Visual mode with 'selection' "exclusive" (same as 'v',
4545 if not specified)
4546 o Operator-pending mode
4547 i Insert mode
4548 r Replace mode
4549
4550 Others: ~
4551 c appending to the command-line
4552 ci inserting in the command-line
4553 cr replacing in the command-line
4554 m at the 'Hit ENTER' or 'More' prompts
4555 ml idem, but cursor in the last line
4556 e any mode, pointer below last window
4557 s any mode, pointer on a status line
4558 sd any mode, while dragging a status line
4559 vs any mode, pointer on a vertical separator line
4560 vd any mode, while dragging a vertical separator line
4561 a everywhere
4562
4563 The shape is one of the following:
4564 avail name looks like ~
4565 w x arrow Normal mouse pointer
4566 w x blank no pointer at all (use with care!)
4567 w x beam I-beam
4568 w x updown up-down sizing arrows
4569 w x leftright left-right sizing arrows
4570 w x busy The system's usual busy pointer
4571 w x no The system's usual 'no input' pointer
4572 x udsizing indicates up-down resizing
4573 x lrsizing indicates left-right resizing
4574 x crosshair like a big thin +
4575 x hand1 black hand
4576 x hand2 white hand
4577 x pencil what you write with
4578 x question big ?
4579 x rightup-arrow arrow pointing right-up
4580 w x up-arrow arrow pointing up
4581 x <number> any X11 pointer number (see X11/cursorfont.h)
4582
4583 The "avail" column contains a 'w' if the shape is available for Win32,
4584 x for X11.
4585 Any modes not specified or shapes not available use the normal mouse
4586 pointer.
4587
4588 Example: >
4589 :set mouseshape=s:udsizing,m:no
4590< will make the mouse turn to a sizing arrow over the status lines and
4591 indicate no input when the hit-enter prompt is displayed (since
4592 clicking the mouse has no effect in this state.)
4593
4594 *'mousetime'* *'mouset'*
4595'mousetime' 'mouset' number (default 500)
4596 global
4597 {not in Vi}
4598 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4599 time in msec between two mouse clicks for the second click to be
4600 recognized as a multi click.
4601
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004602 *'mzquantum'* *'mzq'*
4603'mzquantum' 'mzq' number (default 100)
4604 global
4605 {not in Vi}
4606 {not available when compiled without the |+mzscheme|
4607 feature}
4608 The number of milliseconds between polls for MzScheme threads.
4609 Negative or zero value means no thread scheduling.
4610
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 *'nrformats'* *'nf'*
4612'nrformats' 'nf' string (default "octal,hex")
4613 local to buffer
4614 {not in Vi}
4615 This defines what bases Vim will consider for numbers when using the
4616 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4617 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004618 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 incremented or decremented. This is useful for a list with a
4620 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004621 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004623 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 considered to be hexadecimal. Example: Using CTRL-X on
4625 "0x100" results in "0x0ff".
4626 Numbers which simply begin with a digit in the range 1-9 are always
4627 considered decimal. This also happens for numbers that are not
4628 recognized as octal or hex.
4629
4630 *'number'* *'nu'* *'nonumber'* *'nonu'*
4631'number' 'nu' boolean (default off)
4632 local to window
4633 Print the line number in front of each line. When the 'n' option is
4634 excluded from 'cpoptions' a wrapped line will not use the column of
4635 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004636 The 'numberwidth' option can be used to set the room used for the line
4637 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 When a long, wrapped line doesn't start with the first character, '-'
4639 characters are put before the number.
4640 See |hl-LineNr| for the highlighting used for the number.
4641
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004642 *'numberwidth'* *'nuw'*
4643'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4644 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004645 {not in Vi}
4646 {only available when compiled with the |+linebreak|
4647 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004648 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004649 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004650 Since one space is always between the number and the text, there is
4651 one less character for the number itself.
4652 The value is the minimum width. A bigger width is used when needed to
4653 fit the highest line number in the buffer. Thus with the Vim default
4654 of 4 there is room for a line number up to 999. When the buffer has
4655 1000 lines five columns will be used.
4656 The minimum value is 1, the maximum value is 10.
4657 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4658
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004659 *'omnifunc'* *'ofu'*
4660'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004661 local to buffer
4662 {not in Vi}
4663 {not available when compiled without the +eval
4664 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004665 This option specifies a function to be used for Insert mode omni
4666 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004667 See |complete-functions| for an explanation of how the function is
4668 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004669
4670
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004671 *'operatorfunc'* *'opfunc'*
4672'operatorfunc' 'opfunc' string (default: empty)
4673 global
4674 {not in Vi}
4675 This option specifies a function to be called by the |g@| operator.
4676 See |:map-operator| for more info and an example.
4677
4678 This option cannot be set from a |modeline| or in the |sandbox|, for
4679 security reasons.
4680
4681
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 *'osfiletype'* *'oft'* *E366*
4683'osfiletype' 'oft' string (RISC-OS default: "Text",
4684 others default: "")
4685 local to buffer
4686 {not in Vi}
4687 {only available when compiled with the |+osfiletype|
4688 feature}
4689 Some operating systems store extra information about files besides
4690 name, datestamp and permissions. This option contains the extra
4691 information, the nature of which will vary between systems.
4692 The value of this option is usually set when the file is loaded, and
4693 use to set the file type when file is written.
4694 It can affect the pattern matching of the automatic commands.
4695 |autocmd-osfiletypes|
4696
4697 *'paragraphs'* *'para'*
4698'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4699 global
4700 Specifies the nroff macros that separate paragraphs. These are pairs
4701 of two letters (see |object-motions|).
4702
4703 *'paste'* *'nopaste'*
4704'paste' boolean (default off)
4705 global
4706 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004707 Put Vim in Paste mode. This is useful if you want to cut or copy
4708 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 unexpected effects.
4710 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004711 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 knows about pasting and will mostly do the right thing without 'paste'
4713 being set. The same is true for a terminal where Vim handles the
4714 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004715 This option is reset when starting the GUI. Thus if you set it in
4716 your .vimrc it will work in a terminal, but not in the GUI. Setting
4717 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4718 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 When the 'paste' option is switched on (also when it was already on):
4720 - mapping in Insert mode and Command-line mode is disabled
4721 - abbreviations are disabled
4722 - 'textwidth' is set to 0
4723 - 'wrapmargin' is set to 0
4724 - 'autoindent' is reset
4725 - 'smartindent' is reset
4726 - 'softtabstop' is set to 0
4727 - 'revins' is reset
4728 - 'ruler' is reset
4729 - 'showmatch' is reset
4730 - 'formatoptions' is used like it is empty
4731 These options keep their value, but their effect is disabled:
4732 - 'lisp'
4733 - 'indentexpr'
4734 - 'cindent'
4735 NOTE: When you start editing another file while the 'paste' option is
4736 on, settings from the modelines or autocommands may change the
4737 settings again, causing trouble when pasting text. You might want to
4738 set the 'paste' option again.
4739 When the 'paste' option is reset the mentioned options are restored to
4740 the value before the moment 'paste' was switched from off to on.
4741 Resetting 'paste' before ever setting it does not have any effect.
4742 Since mapping doesn't work while 'paste' is active, you need to use
4743 the 'pastetoggle' option to toggle the 'paste' option with some key.
4744
4745 *'pastetoggle'* *'pt'*
4746'pastetoggle' 'pt' string (default "")
4747 global
4748 {not in Vi}
4749 When non-empty, specifies the key sequence that toggles the 'paste'
4750 option. This is like specifying a mapping: >
4751 :map {keys} :set invpaste<CR>
4752< Where {keys} is the value of 'pastetoggle'.
4753 The difference is that it will work even when 'paste' is set.
4754 'pastetoggle' works in Insert mode and Normal mode, but not in
4755 Command-line mode.
4756 Mappings are checked first, thus overrule 'pastetoggle'. However,
4757 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4758 this: >
4759 :map <F10> :set paste<CR>
4760 :map <F11> :set nopaste<CR>
4761 :imap <F10> <C-O>:set paste<CR>
4762 :imap <F11> <nop>
4763 :set pastetoggle=<F11>
4764< This will make <F10> start paste mode and <F11> stop paste mode.
4765 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4766 mode everything is inserted literally, except the 'pastetoggle' key
4767 sequence.
4768
4769 *'pex'* *'patchexpr'*
4770'patchexpr' 'pex' string (default "")
4771 global
4772 {not in Vi}
4773 {not available when compiled without the |+diff|
4774 feature}
4775 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004776 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777
4778 *'patchmode'* *'pm'* *E206*
4779'patchmode' 'pm' string (default "")
4780 global
4781 {not in Vi}
4782 When non-empty the oldest version of a file is kept. This can be used
4783 to keep the original version of a file if you are changing files in a
4784 source distribution. Only the first time that a file is written a
4785 copy of the original file will be kept. The name of the copy is the
4786 name of the original file with the string in the 'patchmode' option
4787 appended. This option should start with a dot. Use a string like
4788 ".org". 'backupdir' must not be empty for this to work (Detail: The
4789 backup file is renamed to the patchmode file after the new file has
4790 been successfully written, that's why it must be possible to write a
4791 backup file). If there was no file to be backed up, an empty file is
4792 created.
4793 When the 'backupskip' pattern matches, a patchmode file is not made.
4794 Using 'patchmode' for compressed files appends the extension at the
4795 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4796 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004797 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798
4799 *'path'* *'pa'* *E343* *E345* *E347*
4800'path' 'pa' string (default on Unix: ".,/usr/include,,"
4801 on OS/2: ".,/emx/include,,"
4802 other systems: ".,,")
4803 global or local to buffer |global-local|
4804 {not in Vi}
4805 This is a list of directories which will be searched when using the
4806 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4807 being searched for has a relative path (not starting with '/'). The
4808 directories in the 'path' option may be relative or absolute.
4809 - Use commas to separate directory names: >
4810 :set path=.,/usr/local/include,/usr/include
4811< - Spaces can also be used to separate directory names (for backwards
4812 compatibility with version 3.0). To have a space in a directory
4813 name, precede it with an extra backslash, and escape the space: >
4814 :set path=.,/dir/with\\\ space
4815< - To include a comma in a directory name precede it with an extra
4816 backslash: >
4817 :set path=.,/dir/with\\,comma
4818< - To search relative to the directory of the current file, use: >
4819 :set path=.
4820< - To search in the current directory use an empty string between two
4821 commas: >
4822 :set path=,,
4823< - A directory name may end in a ':' or '/'.
4824 - Environment variables are expanded |:set_env|.
4825 - When using |netrw.vim| URLs can be used. For example, adding
4826 "http://www.vim.org" will make ":find index.html" work.
4827 - Search upwards and downwards in a directory tree:
4828 1) "*" matches a sequence of characters, e.g.: >
4829 :set path=/usr/include/*
4830< means all subdirectories in /usr/include (but not /usr/include
4831 itself). >
4832 :set path=/usr/*c
4833< matches /usr/doc and /usr/src.
4834 2) "**" matches a subtree, up to 100 directories deep. Example: >
4835 :set path=/home/user_x/src/**
4836< means search in the whole subtree under "/home/usr_x/src".
4837 3) If the path ends with a ';', this path is the startpoint
4838 for upward search.
4839 See |file-searching| for more info and exact syntax.
4840 {not available when compiled without the |+path_extra| feature}
4841 - Careful with '\' characters, type two to get one in the option: >
4842 :set path=.,c:\\include
4843< Or just use '/' instead: >
4844 :set path=.,c:/include
4845< Don't forget "." or files won't even be found in the same directory as
4846 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004847 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 it is something like 256 or 1024 characters.
4849 You can check if all the include files are found, using the value of
4850 'path', see |:checkpath|.
4851 The use of |:set+=| and |:set-=| is preferred when adding or removing
4852 directories from the list. This avoids problems when a future version
4853 uses another default. To remove the current directory use: >
4854 :set path-=
4855< To add the current directory use: >
4856 :set path+=
4857< To use an environment variable, you probably need to replace the
4858 separator. Here is an example to append $INCL, in which directory
4859 names are separated with a semi-colon: >
4860 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4861< Replace the ';' with a ':' or whatever separator is used. Note that
4862 this doesn't work when $INCL contains a comma or white space.
4863
4864 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4865'preserveindent' 'pi' boolean (default off)
4866 local to buffer
4867 {not in Vi}
4868 When changing the indent of the current line, preserve as much of the
4869 indent structure as possible. Normally the indent is replaced by a
4870 series of tabs followed by spaces as required (unless |'expandtab'| is
4871 enabled, in which case only spaces are used). Enabling this option
4872 means the indent will preserve as many existing characters as possible
4873 for indenting, and only add additional tabs or spaces as required.
4874 NOTE: When using ">>" multiple times the resulting indent is a mix of
4875 tabs and spaces. You might not like this.
4876 NOTE: 'preserveindent' is reset when 'compatible' is set.
4877 Also see 'copyindent'.
4878 Use |:retab| to clean up white space.
4879
4880 *'previewheight'* *'pvh'*
4881'previewheight' 'pvh' number (default 12)
4882 global
4883 {not in Vi}
4884 {not available when compiled without the |+windows| or
4885 |+quickfix| feature}
4886 Default height for a preview window. Used for |:ptag| and associated
4887 commands. Used for |CTRL-W_}| when no count is given.
4888
4889 *'previewwindow'* *'nopreviewwindow'*
4890 *'pvw'* *'nopvw'* *E590*
4891'previewwindow' 'pvw' boolean (default off)
4892 local to window
4893 {not in Vi}
4894 {not available when compiled without the |+windows| or
4895 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004896 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 set. It's normally not set directly, but by using one of the commands
4898 |:ptag|, |:pedit|, etc.
4899
4900 *'printdevice'* *'pdev'*
4901'printdevice' 'pdev' string (default empty)
4902 global
4903 {not in Vi}
4904 {only available when compiled with the |+printer|
4905 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004906 The name of the printer to be used for |:hardcopy|.
4907 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004908 This option cannot be set from a |modeline| or in the |sandbox|, for
4909 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910
Bram Moolenaar8299df92004-07-10 09:47:34 +00004911 *'printencoding'* *'penc'*
4912'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 global
4914 {not in Vi}
4915 {only available when compiled with the |+printer|
4916 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004917 Sets the character encoding used when printing.
4918 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919
4920 *'printexpr'* *'pexpr'*
4921'printexpr' 'pexpr' String (default: see below)
4922 global
4923 {not in Vi}
4924 {only available when compiled with the |+printer|
4925 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004926 Expression used to print the PostScript produced with |:hardcopy|.
4927 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928
Bram Moolenaar8299df92004-07-10 09:47:34 +00004929 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930'printfont' 'pfn' string (default "courier")
4931 global
4932 {not in Vi}
4933 {only available when compiled with the |+printer|
4934 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004935 The name of the font that will be used for |:hardcopy|.
4936 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937
4938 *'printheader'* *'pheader'*
4939'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4940 global
4941 {not in Vi}
4942 {only available when compiled with the |+printer|
4943 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004944 The format of the header produced in |:hardcopy| output.
4945 See |pheader-option|.
4946
4947 *'printmbcharset'* *'pmbcs'*
4948'printmbcharset' 'pmbcs' string (default "")
4949 global
4950 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004951 {only available when compiled with the |+printer|,
4952 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004953 The CJK character set to be used for CJK output from |:hardcopy|.
4954 See |pmbcs-option|.
4955
4956 *'printmbfont'* *'pmbfn'*
4957'printmbfont' 'pmbfn' string (default "")
4958 global
4959 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004960 {only available when compiled with the |+printer|,
4961 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004962 List of font names to be used for CJK output from |:hardcopy|.
4963 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964
4965 *'printoptions'* *'popt'*
4966'printoptions' 'popt' string (default "")
4967 global
4968 {not in Vi}
4969 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004970 List of items that control the format of the output of |:hardcopy|.
4971 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004973 *'prompt'* *'noprompt'*
4974'prompt' boolean (default on)
4975 global
4976 When on a ":" prompt is used in Ex mode.
4977
Bram Moolenaar677ee682005-01-27 14:41:15 +00004978 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004979'quoteescape' 'qe' string (default "\")
4980 local to buffer
4981 {not in Vi}
4982 The characters that are used to escape quotes in a string. Used for
4983 objects like a', a" and a` |a'|.
4984 When one of the characters in this option is found inside a string,
4985 the following character will be skipped. The default value makes the
4986 text "foo\"bar\\" considered to be one string.
4987
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4989'readonly' 'ro' boolean (default off)
4990 local to buffer
4991 If on, writes fail unless you use a '!'. Protects you from
4992 accidentally overwriting a file. Default on when Vim is started
4993 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004994 When using ":w!" the 'readonly' option is reset for the current
4995 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004997 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998
4999 *'remap'* *'noremap'*
5000'remap' boolean (default on)
5001 global
5002 Allows for mappings to work recursively. If you do not want this for
5003 a single entry, use the :noremap[!] command.
5004
5005 *'report'*
5006'report' number (default 2)
5007 global
5008 Threshold for reporting number of lines changed. When the number of
5009 changed lines is more than 'report' a message will be given for most
5010 ":" commands. If you want it always, set 'report' to 0.
5011 For the ":substitute" command the number of substitutions is used
5012 instead of the number of lines.
5013
5014 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5015'restorescreen' 'rs' boolean (default on)
5016 global
5017 {not in Vi} {only in Windows 95/NT console version}
5018 When set, the screen contents is restored when exiting Vim. This also
5019 happens when executing external commands.
5020
5021 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5022 options in your .vimrc. To disable restoring:
5023 set t_ti= t_te=
5024 To enable restoring (for an xterm):
5025 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5026 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5027
5028 *'revins'* *'ri'* *'norevins'* *'nori'*
5029'revins' 'ri' boolean (default off)
5030 global
5031 {not in Vi}
5032 {only available when compiled with the |+rightleft|
5033 feature}
5034 Inserting characters in Insert mode will work backwards. See "typing
5035 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5036 command in Insert mode, when 'allowrevins' is set.
5037 NOTE: This option is reset when 'compatible' or 'paste' is set.
5038
5039 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5040'rightleft' 'rl' boolean (default off)
5041 local to window
5042 {not in Vi}
5043 {only available when compiled with the |+rightleft|
5044 feature}
5045 When on, display orientation becomes right-to-left, i.e., characters
5046 that are stored in the file appear from the right to the left.
5047 Using this option, it is possible to edit files for languages that
5048 are written from the right to the left such as Hebrew and Arabic.
5049 This option is per window, so it is possible to edit mixed files
5050 simultaneously, or to view the same file in both ways (this is
5051 useful whenever you have a mixed text file with both right-to-left
5052 and left-to-right strings so that both sets are displayed properly
5053 in different windows). Also see |rileft.txt|.
5054
5055 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5056'rightleftcmd' 'rlc' string (default "search")
5057 local to window
5058 {not in Vi}
5059 {only available when compiled with the |+rightleft|
5060 feature}
5061 Each word in this option enables the command line editing to work in
5062 right-to-left mode for a group of commands:
5063
5064 search "/" and "?" commands
5065
5066 This is useful for languages such as Hebrew, Arabic and Farsi.
5067 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5068
5069 *'ruler'* *'ru'* *'noruler'* *'noru'*
5070'ruler' 'ru' boolean (default off)
5071 global
5072 {not in Vi}
5073 {not available when compiled without the
5074 |+cmdline_info| feature}
5075 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005076 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 text in the file is shown on the far right:
5078 Top first line is visible
5079 Bot last line is visible
5080 All first and last line are visible
5081 45% relative position in the file
5082 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005083 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005085 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 this option takes precedence over 'ruler' and 'rulerformat'
5087 If the number of characters displayed is different from the number of
5088 bytes in the text (e.g., for a TAB or a multi-byte character), both
5089 the text column (byte number) and the screen column are shown,
5090 separated with a dash.
5091 For an empty line "0-1" is shown.
5092 For an empty buffer the line number will also be zero: "0,0-1".
5093 This option is reset when the 'paste' option is set.
5094 If you don't want to see the ruler all the time but want to know where
5095 you are, use "g CTRL-G" |g_CTRL-G|.
5096 NOTE: This option is reset when 'compatible' is set.
5097
5098 *'rulerformat'* *'ruf'*
5099'rulerformat' 'ruf' string (default empty)
5100 global
5101 {not in Vi}
5102 {not available when compiled without the |+statusline|
5103 feature}
5104 When this option is not empty, it determines the content of the ruler
5105 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005106 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 The default ruler width is 17 characters. To make the ruler 15
5108 characters wide, put "%15(" at the start and "%)" at the end.
5109 Example: >
5110 :set rulerformat=%15(%c%V\ %p%%%)
5111<
5112 *'runtimepath'* *'rtp'* *vimfiles*
5113'runtimepath' 'rtp' string (default:
5114 Unix: "$HOME/.vim,
5115 $VIM/vimfiles,
5116 $VIMRUNTIME,
5117 $VIM/vimfiles/after,
5118 $HOME/.vim/after"
5119 Amiga: "home:vimfiles,
5120 $VIM/vimfiles,
5121 $VIMRUNTIME,
5122 $VIM/vimfiles/after,
5123 home:vimfiles/after"
5124 PC, OS/2: "$HOME/vimfiles,
5125 $VIM/vimfiles,
5126 $VIMRUNTIME,
5127 $VIM/vimfiles/after,
5128 $HOME/vimfiles/after"
5129 Macintosh: "$VIM:vimfiles,
5130 $VIMRUNTIME,
5131 $VIM:vimfiles:after"
5132 RISC-OS: "Choices:vimfiles,
5133 $VIMRUNTIME,
5134 Choices:vimfiles/after"
5135 VMS: "sys$login:vimfiles,
5136 $VIM/vimfiles,
5137 $VIMRUNTIME,
5138 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005139 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 global
5141 {not in Vi}
5142 This is a list of directories which will be searched for runtime
5143 files:
5144 filetype.vim filetypes by file name |new-filetype|
5145 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005146 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 colors/ color scheme files |:colorscheme|
5148 compiler/ compiler files |:compiler|
5149 doc/ documentation |write-local-help|
5150 ftplugin/ filetype plugins |write-filetype-plugin|
5151 indent/ indent scripts |indent-expression|
5152 keymap/ key mapping files |mbyte-keymap|
5153 lang/ menu translations |:menutrans|
5154 menu.vim GUI menus |menu.vim|
5155 plugin/ plugin scripts |write-plugin|
5156 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005157 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 syntax/ syntax files |mysyntaxfile|
5159 tutor/ files for vimtutor |tutor|
5160
5161 And any other file searched for with the |:runtime| command.
5162
5163 The defaults for most systems are setup to search five locations:
5164 1. In your home directory, for your personal preferences.
5165 2. In a system-wide Vim directory, for preferences from the system
5166 administrator.
5167 3. In $VIMRUNTIME, for files distributed with Vim.
5168 *after-directory*
5169 4. In the "after" directory in the system-wide Vim directory. This is
5170 for the system administrator to overrule or add to the distributed
5171 defaults (rarely needed)
5172 5. In the "after" directory in your home directory. This is for
5173 personal preferences to overrule or add to the distributed defaults
5174 or system-wide settings (rarely needed).
5175
5176 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5177 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005178 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 wildcards.
5180 See |:runtime|.
5181 Example: >
5182 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5183< This will use the directory "~/vimruntime" first (containing your
5184 personal Vim runtime files), then "/mygroup/vim" (shared between a
5185 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5186 files).
5187 You probably should always include $VIMRUNTIME somewhere, to use the
5188 distributed runtime files. You can put a directory before $VIMRUNTIME
5189 to find files which replace a distributed runtime files. You can put
5190 a directory after $VIMRUNTIME to find files which add to distributed
5191 runtime files.
5192 This option cannot be set from a |modeline| or in the |sandbox|, for
5193 security reasons.
5194
5195 *'scroll'* *'scr'*
5196'scroll' 'scr' number (default: half the window height)
5197 local to window
5198 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5199 set to half the number of lines in the window when the window size
5200 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005201 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5203 the number of screen lines instead of file lines, makes a difference
5204 when lines wrap}
5205
5206 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5207'scrollbind' 'scb' boolean (default off)
5208 local to window
5209 {not in Vi}
5210 {not available when compiled without the |+scrollbind|
5211 feature}
5212 See also |scroll-binding|. When this option is set, the current
5213 window scrolls as other scrollbind windows (windows that also have
5214 this option set) scroll. This option is useful for viewing the
5215 differences between two versions of a file, see 'diff'.
5216 See |'scrollopt'| for options that determine how this option should be
5217 interpreted.
5218 This option is mostly reset when splitting a window to edit another
5219 file. This means that ":split | edit file" results in two windows
5220 with scroll-binding, but ":split file" does not.
5221
5222 *'scrolljump'* *'sj'*
5223'scrolljump' 'sj' number (default 1)
5224 global
5225 {not in Vi}
5226 Minimal number of lines to scroll when the cursor gets off the
5227 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5228 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005229 When set to a negative number from -1 to -100 this is used as the
5230 percentage of the window height. Thus -50 scrolls half the window
5231 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 NOTE: This option is set to 1 when 'compatible' is set.
5233
5234 *'scrolloff'* *'so'*
5235'scrolloff' 'so' number (default 0)
5236 global
5237 {not in Vi}
5238 Minimal number of screen lines to keep above and below the cursor.
5239 This will make some context visible around where you are working. If
5240 you set it to a very large value (999) the cursor line will always be
5241 in the middle of the window (except at the start or end of the file or
5242 when long lines wrap).
5243 For scrolling horizontally see 'sidescrolloff'.
5244 NOTE: This option is set to 0 when 'compatible' is set.
5245
5246 *'scrollopt'* *'sbo'*
5247'scrollopt' 'sbo' string (default "ver,jump")
5248 global
5249 {not available when compiled without the |+scrollbind|
5250 feature}
5251 {not in Vi}
5252 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005253 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5254 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 The following words are available:
5256 ver Bind vertical scrolling for 'scrollbind' windows
5257 hor Bind horizontal scrolling for 'scrollbind' windows
5258 jump Applies to the offset between two windows for vertical
5259 scrolling. This offset is the difference in the first
5260 displayed line of the bound windows. When moving
5261 around in a window, another 'scrollbind' window may
5262 reach a position before the start or after the end of
5263 the buffer. The offset is not changed though, when
5264 moving back the 'scrollbind' window will try to scroll
5265 to the desired position when possible.
5266 When now making that window the current one, two
5267 things can be done with the relative offset:
5268 1. When "jump" is not included, the relative offset is
5269 adjusted for the scroll position in the new current
5270 window. When going back to the other window, the
5271 the new relative offset will be used.
5272 2. When "jump" is included, the other windows are
5273 scrolled to keep the same relative offset. When
5274 going back to the other window, it still uses the
5275 same relative offset.
5276 Also see |scroll-binding|.
5277
5278 *'sections'* *'sect'*
5279'sections' 'sect' string (default "SHNHH HUnhsh")
5280 global
5281 Specifies the nroff macros that separate sections. These are pairs of
5282 two letters (See |object-motions|). The default makes a section start
5283 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5284
5285 *'secure'* *'nosecure'* *E523*
5286'secure' boolean (default off)
5287 global
5288 {not in Vi}
5289 When on, ":autocmd", shell and write commands are not allowed in
5290 ".vimrc" and ".exrc" in the current directory and map commands are
5291 displayed. Switch it off only if you know that you will not run into
5292 problems, or when the 'exrc' option is off. On Unix this option is
5293 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005294 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 'secure' at the end of your ~/.vimrc then.
5296 This option cannot be set from a |modeline| or in the |sandbox|, for
5297 security reasons.
5298
5299 *'selection'* *'sel'*
5300'selection' 'sel' string (default "inclusive")
5301 global
5302 {not in Vi}
5303 This option defines the behavior of the selection. It is only used
5304 in Visual and Select mode.
5305 Possible values:
5306 value past line inclusive ~
5307 old no yes
5308 inclusive yes yes
5309 exclusive yes no
5310 "past line" means that the cursor is allowed to be positioned one
5311 character past the line.
5312 "inclusive" means that the last character of the selection is included
5313 in an operation. For example, when "x" is used to delete the
5314 selection.
5315 Note that when "exclusive" is used and selecting from the end
5316 backwards, you cannot include the last character of a line, when
5317 starting in Normal mode and 'virtualedit' empty.
5318
5319 The 'selection' option is set by the |:behave| command.
5320
5321 *'selectmode'* *'slm'*
5322'selectmode' 'slm' string (default "")
5323 global
5324 {not in Vi}
5325 This is a comma separated list of words, which specifies when to start
5326 Select mode instead of Visual mode, when a selection is started.
5327 Possible values:
5328 mouse when using the mouse
5329 key when using shifted special keys
5330 cmd when using "v", "V" or CTRL-V
5331 See |Select-mode|.
5332 The 'selectmode' option is set by the |:behave| command.
5333
5334 *'sessionoptions'* *'ssop'*
5335'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5336 help,options,winsize")
5337 global
5338 {not in Vi}
5339 {not available when compiled without the +mksession
5340 feature}
5341 Changes the effect of the |:mksession| command. It is a comma
5342 separated list of words. Each word enables saving and restoring
5343 something:
5344 word save and restore ~
5345 blank empty windows
5346 buffers hidden and unloaded buffers, not just those in windows
5347 curdir the current directory
5348 folds manually created folds, opened/closed folds and local
5349 fold options
5350 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005351 and contain at least one lowercase letter. Only
5352 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 help the help window
5354 localoptions options and mappings local to a window or buffer (not
5355 global values for local options)
5356 options all options and mappings (also global values for local
5357 options)
5358 resize size of the Vim window: 'lines' and 'columns'
5359 sesdir the directory in which the session file is located
5360 will become the current directory (useful with
5361 projects accessed over a network from different
5362 systems)
5363 slash backslashes in file names replaced with forward
5364 slashes
5365 unix with Unix end-of-line format (single <NL>), even when
5366 on Windows or DOS
5367 winpos position of the whole Vim window
5368 winsize window sizes
5369
5370 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005371 There is no option to include tab pages yet, only the current tab page
5372 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 When "curdir" nor "sesdir" is included, file names are stored with
5374 absolute paths.
5375 "slash" and "unix" are useful on Windows when sharing session files
5376 with Unix. The Unix version of Vim cannot source dos format scripts,
5377 but the Windows version of Vim can source unix format scripts.
5378
5379 *'shell'* *'sh'* *E91*
5380'shell' 'sh' string (default $SHELL or "sh",
5381 MS-DOS and Win32: "command.com" or
5382 "cmd.exe", OS/2: "cmd")
5383 global
5384 Name of the shell to use for ! and :! commands. When changing the
5385 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5386 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005387 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 See |option-backslash| about including spaces and backslashes.
5389 Environment variables are expanded |:set_env|.
5390 If the name of the shell contains a space, you might need to enclose
5391 it in quotes. Example: >
5392 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5393< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005394 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 "-f" is not inside the quotes, because it is not part of the command
5396 name. And Vim automagically recognizes the backslashes that are path
5397 separators.
5398 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5399 variable to change the way external commands are executed. See the
5400 libc.inf file of DJGPP.
5401 Under MS-Windows, when the executable ends in ".com" it must be
5402 included. Thus setting the shell to "command.com" or "4dos.com"
5403 works, but "command" and "4dos" do not work for all commands (e.g.,
5404 filtering).
5405 For unknown reasons, when using "4dos.com" the current directory is
5406 changed to "C:\". To avoid this set 'shell' like this: >
5407 :set shell=command.com\ /c\ 4dos
5408< This option cannot be set from a |modeline| or in the |sandbox|, for
5409 security reasons.
5410
5411 *'shellcmdflag'* *'shcf'*
5412'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5413 does not contain "sh" somewhere: "/c")
5414 global
5415 {not in Vi}
5416 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5417 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5418 systems, the default is set according to the value of 'shell', to
5419 reduce the need to set this option by the user. It's not used for
5420 OS/2 (EMX figures this out itself). See |option-backslash| about
5421 including spaces and backslashes. See |dos-shell|.
5422 This option cannot be set from a |modeline| or in the |sandbox|, for
5423 security reasons.
5424
5425 *'shellpipe'* *'sp'*
5426'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5427 global
5428 {not in Vi}
5429 {not available when compiled without the |+quickfix|
5430 feature}
5431 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005432 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 including spaces and backslashes.
5434 The name of the temporary file can be represented by "%s" if necessary
5435 (the file name is appended automatically if no %s appears in the value
5436 of this option).
5437 For the Amiga and MS-DOS the default is ">". The output is directly
5438 saved in a file and not echoed to the screen.
5439 For Unix the default it "| tee". The stdout of the compiler is saved
5440 in a file and echoed to the screen. If the 'shell' option is "csh" or
5441 "tcsh" after initializations, the default becomes "|& tee". If the
5442 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5443 "2>&1| tee". This means that stderr is also included.
5444 The initialization of this option is done after reading the ".vimrc"
5445 and the other initializations, so that when the 'shell' option is set
5446 there, the 'shellpipe' option changes automatically, unless it was
5447 explicitly set before.
5448 When 'shellpipe' is set to an empty string, no redirection of the
5449 ":make" output will be done. This is useful if you use a 'makeprg'
5450 that writes to 'makeef' by itself. If you want no piping, but do
5451 want to include the 'makeef', set 'shellpipe' to a single space.
5452 Don't forget to precede the space with a backslash: ":set sp=\ ".
5453 In the future pipes may be used for filtering and this option will
5454 become obsolete (at least for Unix).
5455 This option cannot be set from a |modeline| or in the |sandbox|, for
5456 security reasons.
5457
5458 *'shellquote'* *'shq'*
5459'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5460 contains "sh" somewhere: "\"")
5461 global
5462 {not in Vi}
5463 Quoting character(s), put around the command passed to the shell, for
5464 the "!" and ":!" commands. The redirection is kept outside of the
5465 quoting. See 'shellxquote' to include the redirection. It's
5466 probably not useful to set both options.
5467 This is an empty string by default. Only known to be useful for
5468 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5469 or bash, where it should be "\"". The default is adjusted according
5470 the value of 'shell', to reduce the need to set this option by the
5471 user. See |dos-shell|.
5472 This option cannot be set from a |modeline| or in the |sandbox|, for
5473 security reasons.
5474
5475 *'shellredir'* *'srr'*
5476'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5477 global
5478 {not in Vi}
5479 String to be used to put the output of a filter command in a temporary
5480 file. See also |:!|. See |option-backslash| about including spaces
5481 and backslashes.
5482 The name of the temporary file can be represented by "%s" if necessary
5483 (the file name is appended automatically if no %s appears in the value
5484 of this option).
5485 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5486 or "zsh" during initializations, the default becomes ">&". If the
5487 'shell' option is "sh", "ksh" or "bash" the default becomes
5488 ">%s 2>&1". This means that stderr is also included.
5489 For Win32, the Unix checks are done and additionally "cmd" is checked
5490 for, which makes the default ">%s 2>&1". Also, the same names with
5491 ".exe" appended are checked for.
5492 The initialization of this option is done after reading the ".vimrc"
5493 and the other initializations, so that when the 'shell' option is set
5494 there, the 'shellredir' option changes automatically unless it was
5495 explicitly set before.
5496 In the future pipes may be used for filtering and this option will
5497 become obsolete (at least for Unix).
5498 This option cannot be set from a |modeline| or in the |sandbox|, for
5499 security reasons.
5500
5501 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5502'shellslash' 'ssl' boolean (default off)
5503 global
5504 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5505 When set, a forward slash is used when expanding file names. This is
5506 useful when a Unix-like shell is used instead of command.com or
5507 cmd.exe. Backward slashes can still be typed, but they are changed to
5508 forward slashes by Vim.
5509 Note that setting or resetting this option has no effect for some
5510 existing file names, thus this option needs to be set before opening
5511 any file for best results. This might change in the future.
5512 'shellslash' only works when a backslash can be used as a path
5513 separator. To test if this is so use: >
5514 if exists('+shellslash')
5515<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005516 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5517'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5518 global
5519 {not in Vi}
5520 When on, use temp files for shell commands. When off use a pipe.
5521 When using a pipe is not possible temp files are used anyway.
5522 Currently a pipe is only supported on Unix. You can check it with: >
5523 :if has("filterpipe")
5524< The advantage of using a pipe is that nobody can read the temp file
5525 and the 'shell' command does not need to support redirection.
5526 The advantage of using a temp file is that the file type and encoding
5527 can be detected.
5528 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5529 |FilterWritePost| autocommands event are not triggered when
5530 'shelltemp' is off.
5531
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 *'shelltype'* *'st'*
5533'shelltype' 'st' number (default 0)
5534 global
5535 {not in Vi} {only for the Amiga}
5536 On the Amiga this option influences the way how the commands work
5537 which use a shell.
5538 0 and 1: always use the shell
5539 2 and 3: use the shell only to filter lines
5540 4 and 5: use shell only for ':sh' command
5541 When not using the shell, the command is executed directly.
5542
5543 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5544 1 and 3: use "shell cmd" to start external commands
5545
5546 *'shellxquote'* *'sxq'*
5547'shellxquote' 'sxq' string (default: "";
5548 for Win32, when 'shell' contains "sh"
5549 somewhere: "\""
5550 for Unix, when using system(): "\"")
5551 global
5552 {not in Vi}
5553 Quoting character(s), put around the command passed to the shell, for
5554 the "!" and ":!" commands. Includes the redirection. See
5555 'shellquote' to exclude the redirection. It's probably not useful
5556 to set both options.
5557 This is an empty string by default. Known to be useful for
5558 third-party shells when using the Win32 version, such as the MKS Korn
5559 Shell or bash, where it should be "\"". The default is adjusted
5560 according the value of 'shell', to reduce the need to set this option
5561 by the user. See |dos-shell|.
5562 This option cannot be set from a |modeline| or in the |sandbox|, for
5563 security reasons.
5564
5565 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5566'shiftround' 'sr' boolean (default off)
5567 global
5568 {not in Vi}
5569 Round indent to multiple of 'shiftwidth'. Applies to > and <
5570 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5571 a multiple of 'shiftwidth' (this is Vi compatible).
5572 NOTE: This option is reset when 'compatible' is set.
5573
5574 *'shiftwidth'* *'sw'*
5575'shiftwidth' 'sw' number (default 8)
5576 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005577 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 |'cindent'|, |>>|, |<<|, etc.
5579
5580 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005581'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5582 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 global
5584 {not in Vi}
5585 This option helps to avoid all the |hit-enter| prompts caused by file
5586 messages, for example with CTRL-G, and to avoid some other messages.
5587 It is a list of flags:
5588 flag meaning when present ~
5589 f use "(3 of 5)" instead of "(file 3 of 5)"
5590 i use "[noeol]" instead of "[Incomplete last line]"
5591 l use "999L, 888C" instead of "999 lines, 888 characters"
5592 m use "[+]" instead of "[Modified]"
5593 n use "[New]" instead of "[New File]"
5594 r use "[RO]" instead of "[readonly]"
5595 w use "[w]" instead of "written" for file write message
5596 and "[a]" instead of "appended" for ':w >> file' command
5597 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5598 "[unix format]" and "[mac]" instead of "[mac format]".
5599 a all of the above abbreviations
5600
5601 o overwrite message for writing a file with subsequent message
5602 for reading a file (useful for ":wn" or when 'autowrite' on)
5603 O message for reading a file overwrites any previous message.
5604 Also for quickfix message (e.g., ":cn").
5605 s don't give "search hit BOTTOM, continuing at TOP" or "search
5606 hit TOP, continuing at BOTTOM" messages
5607 t truncate file message at the start if it is too long to fit
5608 on the command-line, "<" will appear in the left most column.
5609 Ignored in Ex mode.
5610 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005611 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 Ignored in Ex mode.
5613 W don't give "written" or "[w]" when writing a file
5614 A don't give the "ATTENTION" message when an existing swap file
5615 is found.
5616 I don't give the intro message when starting Vim |:intro|.
5617
5618 This gives you the opportunity to avoid that a change between buffers
5619 requires you to hit <Enter>, but still gives as useful a message as
5620 possible for the space available. To get the whole message that you
5621 would have got with 'shm' empty, use ":file!"
5622 Useful values:
5623 shm= No abbreviation of message.
5624 shm=a Abbreviation, but no loss of information.
5625 shm=at Abbreviation, and truncate message when necessary.
5626
5627 NOTE: This option is set to the Vi default value when 'compatible' is
5628 set and to the Vim default value when 'compatible' is reset.
5629
5630 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5631'shortname' 'sn' boolean (default off)
5632 local to buffer
5633 {not in Vi, not in MS-DOS versions}
5634 Filenames are assumed to be 8 characters plus one extension of 3
5635 characters. Multiple dots in file names are not allowed. When this
5636 option is on, dots in file names are replaced with underscores when
5637 adding an extension (".~" or ".swp"). This option is not available
5638 for MS-DOS, because then it would always be on. This option is useful
5639 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5640 or crossdos. When running the Win32 GUI version under Win32s, this
5641 option is always on by default.
5642
5643 *'showbreak'* *'sbr'* *E595*
5644'showbreak' 'sbr' string (default "")
5645 global
5646 {not in Vi}
5647 {not available when compiled without the |+linebreak|
5648 feature}
5649 String to put at the start of lines that have been wrapped. Useful
5650 values are "> " or "+++ ".
5651 Only printable single-cell characters are allowed, excluding <Tab> and
5652 comma (in a future version the comma might be used to separate the
5653 part that is shown at the end and at the start of a line).
5654 The characters are highlighted according to the '@' flag in
5655 'highlight'.
5656 Note that tabs after the showbreak will be displayed differently.
5657 If you want the 'showbreak' to appear in between line numbers, add the
5658 "n" flag to 'cpoptions'.
5659
5660 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5661'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5662 off)
5663 global
5664 {not in Vi}
5665 {not available when compiled without the
5666 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005667 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 terminal is slow.
5669 In Visual mode the size of the selected area is shown:
5670 - When selecting characters within a line, the number of characters.
5671 - When selecting more than one line, the number of lines.
5672 - When selecting a block, the size in screen characters: linesxcolumns.
5673 NOTE: This option is set to the Vi default value when 'compatible' is
5674 set and to the Vim default value when 'compatible' is reset.
5675
5676 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5677'showfulltag' 'sft' boolean (default off)
5678 global
5679 {not in Vi}
5680 When completing a word in insert mode (see |ins-completion|) from the
5681 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005682 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683 matched a C function, you can see a template for what arguments are
5684 required (coding style permitting).
5685
5686 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5687'showmatch' 'sm' boolean (default off)
5688 global
5689 When a bracket is inserted, briefly jump to the matching one. The
5690 jump is only done if the match can be seen on the screen. The time to
5691 show the match can be set with 'matchtime'.
5692 A Beep is given if there is no match (no matter if the match can be
5693 seen or not). This option is reset when the 'paste' option is set.
5694 When the 'm' flag is not included in 'cpoptions', typing a character
5695 will immediately move the cursor back to where it belongs.
5696 See the "sm" field in 'guicursor' for setting the cursor shape and
5697 blinking when showing the match.
5698 The 'matchpairs' option can be used to specify the characters to show
5699 matches for. 'rightleft' and 'revins' are used to look for opposite
5700 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005701 Also see the matchparen plugin for highlighting the match when moving
5702 around |pi_paren.txt|.
5703 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704
5705 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5706'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5707 global
5708 If in Insert, Replace or Visual mode put a message on the last line.
5709 Use the 'M' flag in 'highlight' to set the type of highlighting for
5710 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005711 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 doesn't mean XIM is really active, especially when 'imactivatekey' is
5713 not set.
5714 NOTE: This option is set to the Vi default value when 'compatible' is
5715 set and to the Vim default value when 'compatible' is reset.
5716
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005717 *'showtabline'* *'stal'*
5718'showtabline' 'stal' number (default 1)
5719 global
5720 {not in Vi}
5721 {not available when compiled without the +windows
5722 feature}
5723 The value of this option specifies when the line with tab page labels
5724 will be displayed:
5725 0: never
5726 1: only if there are at least two tab pages
5727 2: always
5728 This is both for the GUI and non-GUI implementation of the tab pages
5729 line.
5730 See |tab-page| for more information about tab pages.
5731
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 *'sidescroll'* *'ss'*
5733'sidescroll' 'ss' number (default 0)
5734 global
5735 {not in Vi}
5736 The minimal number of columns to scroll horizontally. Used only when
5737 the 'wrap' option is off and the cursor is moved off of the screen.
5738 When it is zero the cursor will be put in the middle of the screen.
5739 When using a slow terminal set it to a large number or 0. When using
5740 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5741 commands.
5742
5743 *'sidescrolloff'* *'siso'*
5744'sidescrolloff' 'siso' number (default 0)
5745 global
5746 {not in Vi}
5747 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005748 right of the cursor if 'nowrap' is set. Setting this option to a
5749 value greater than 0 while having |'sidescroll'| also at a non-zero
5750 value makes some context visible in the line you are scrolling in
5751 horizontally (except at beginning of the line). Setting this option
5752 to a large value (like 999) has the effect of keeping the cursor
5753 horizontally centered in the window, as long as one does not come too
5754 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 NOTE: This option is set to 0 when 'compatible' is set.
5756
5757 Example: Try this together with 'sidescroll' and 'listchars' as
5758 in the following example to never allow the cursor to move
5759 onto the "extends" character:
5760
5761 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5762 :set sidescrolloff=1
5763
5764
5765 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5766'smartcase' 'scs' boolean (default off)
5767 global
5768 {not in Vi}
5769 Override the 'ignorecase' option if the search pattern contains upper
5770 case characters. Only used when the search pattern is typed and
5771 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005772 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5774 recalling the search pattern from history and hitting <Enter>.
5775 NOTE: This option is reset when 'compatible' is set.
5776
5777 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5778'smartindent' 'si' boolean (default off)
5779 local to buffer
5780 {not in Vi}
5781 {not available when compiled without the
5782 |+smartindent| feature}
5783 Do smart autoindenting when starting a new line. Works for C-like
5784 programs, but can also be used for other languages. 'cindent' does
5785 something like this, works better in most cases, but is more strict,
5786 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5787 'indentexpr' is a more advanced alternative.
5788 Normally 'autoindent' should also be on when using 'smartindent'.
5789 An indent is automatically inserted:
5790 - After a line ending in '{'.
5791 - After a line starting with a keyword from 'cinwords'.
5792 - Before a line starting with '}' (only with the "O" command).
5793 When typing '}' as the first character in a new line, that line is
5794 given the same indent as the matching '{'.
5795 When typing '#' as the first character in a new line, the indent for
5796 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005797 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5799 When using the ">>" command, lines starting with '#' are not shifted
5800 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005801 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802 is set smart indenting is disabled.
5803
5804 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5805'smarttab' 'sta' boolean (default off)
5806 global
5807 {not in Vi}
5808 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005809 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5810 <BS> will delete a 'shiftwidth' worth of space at the start of the
5811 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005812 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005813 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5814 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5816 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005817 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 NOTE: This option is reset when 'compatible' is set.
5819
5820 *'softtabstop'* *'sts'*
5821'softtabstop' 'sts' number (default 0)
5822 local to buffer
5823 {not in Vi}
5824 Number of spaces that a <Tab> counts for while performing editing
5825 operations, like inserting a <Tab> or using <BS>. It "feels" like
5826 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5827 used. This is useful to keep the 'ts' setting at its standard value
5828 of 8, while being able to edit like it is set to 'sts'. However,
5829 commands like "x" still work on the actual characters.
5830 When 'sts' is zero, this feature is off.
5831 'softtabstop' is set to 0 when the 'paste' option is set.
5832 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5833 spaces is minimized by using <Tab>s.
5834 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5835 set.
5836 NOTE: This option is set to 0 when 'compatible' is set.
5837
Bram Moolenaar217ad922005-03-20 22:37:15 +00005838 *'spell'* *'nospell'*
5839'spell' boolean (default off)
5840 local to window
5841 {not in Vi}
5842 {not available when compiled without the |+syntax|
5843 feature}
5844 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005845 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005846
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005847 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005848'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005849 local to buffer
5850 {not in Vi}
5851 {not available when compiled without the |+syntax|
5852 feature}
5853 Pattern to locate the end of a sentence. The following word will be
5854 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005855 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005856 When this check is not wanted make this option empty.
5857 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005858 Be careful with special characters, see |option-backslash| about
5859 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005860 To set this option automatically depending on the language, see
5861 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005862
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005863 *'spellfile'* *'spf'*
5864'spellfile' 'spf' string (default empty)
5865 local to buffer
5866 {not in Vi}
5867 {not available when compiled without the |+syntax|
5868 feature}
5869 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005870 commands. It must end in ".{encoding}.add". You need to include the
5871 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005872 *E765*
5873 It may also be a comma separated list of names. A count before the
5874 |zg| and |zw| commands can be used to access each. This allows using
5875 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005876 When a word is added while this option is empty Vim will set it for
5877 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005878 writable and the first language name that appears in 'spelllang',
5879 ignoring the region.
5880 The resulting ".spl" file will be used for spell checking, it does not
5881 have to appear in 'spelllang'.
5882 Normally one file is used for all regions, but you can add the region
5883 name if you want to. However, it will then only be used when
5884 'spellfile' is set to it, for entries in 'spelllang' only files
5885 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005886 This option cannot be set from a |modeline| or in the |sandbox|, for
5887 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005888
Bram Moolenaar217ad922005-03-20 22:37:15 +00005889 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005890'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005891 local to buffer
5892 {not in Vi}
5893 {not available when compiled without the |+syntax|
5894 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005895 A comma separated list of word list names. When the 'spell' option is
5896 on spellchecking will be done for these languages. Example: >
5897 set spelllang=en_us,nl,medical
5898< This means US English, Dutch and medical words are recognized. Words
5899 that are not recognized will be highlighted.
5900 The word list name must not include a comma or dot. Using a dash is
5901 recommended to separate the two letter language name from a
5902 specification. Thus "en-rare" is used for rare English words.
5903 A region name must come last and have the form "_xx", where "xx" is
5904 the two-letter, lower case region name. You can use more than one
5905 region by listing them: "en_us,en_ca" supports both US and Canadian
5906 English, but not words specific for Australia, New Zealand or Great
5907 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005908 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005909 As a special case the name of a .spl file can be given as-is. The
5910 first "_xx" in the name is removed and used as the region name
5911 (_xx is an underscore, two letters and followed by a non-letter).
5912 This is mainly for testing purposes. You must make sure the correct
5913 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005914 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005915 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5916 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005917 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005918
Bram Moolenaar98692072006-02-04 00:57:42 +00005919 If the |spellfile.vim| plugin is active and you use a language name
5920 for which Vim cannot find the .spl file in 'runtimepath' the plugin
5921 will ask you if you want to download the file.
5922
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005923 After this option has been set successfully, Vim will source the files
5924 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005925 up to the first comma, dot or underscore.
5926 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005927
5928
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005929 *'spellsuggest'* *'sps'*
5930'spellsuggest' 'sps' string (default "best")
5931 global
5932 {not in Vi}
5933 {not available when compiled without the |+syntax|
5934 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005935 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005936 the |spellsuggest()| function. This is a comma-separated list of
5937 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005938
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005939 best Internal method that works best for English. Finds
5940 changes like "fast" and uses a bit of sound-a-like
5941 scoring to improve the ordering.
5942
5943 double Internal method that uses two methods and mixes the
5944 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005945 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005946 word. That only works when the language specifies
5947 sound folding. Can be slow and doesn't always give
5948 better results.
5949
5950 fast Internal method that only checks for simple changes:
5951 character inserts/deletes/swaps. Works well for
5952 simple typing mistakes.
5953
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005954 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005955 Not used for |spellsuggest()|. The number of
5956 suggestions is never more than the value of 'lines'
5957 minus two.
5958
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005959 file:{filename} Read file {filename}, which must have two columns,
5960 separated by a slash. The first column contains the
5961 bad word, the second column the suggested good word.
5962 Example:
5963 theribal/terrible ~
5964 Use this for common mistakes that do not appear at the
5965 top of the suggestion list with the internal methods.
5966 Lines without a slash are ignored, use this for
5967 comments.
5968 The file is used for all languages.
5969
5970 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5971 trouble with spaces. |v:val| holds the badly spelled
5972 word. The expression must evaluate to a List of
5973 Lists, each with a suggestion and a score.
5974 Example:
5975 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005976 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005977 internal methods use. A lower score is better.
5978 This may invoke |spellsuggest()| if you temporarily
5979 set 'spellsuggest' to exclude the "expr:" part.
5980 Errors are silently ignored, unless you set the
5981 'verbose' option to a non-zero value.
5982
5983 Only one of "best", "double" or "fast" may be used. The others may
5984 appear several times in any order. Example: >
5985 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5986<
5987 This option cannot be set from a |modeline| or in the |sandbox|, for
5988 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005989
5990
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5992'splitbelow' 'sb' boolean (default off)
5993 global
5994 {not in Vi}
5995 {not available when compiled without the +windows
5996 feature}
5997 When on, splitting a window will put the new window below the current
5998 one. |:split|
5999
6000 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6001'splitright' 'spr' boolean (default off)
6002 global
6003 {not in Vi}
6004 {not available when compiled without the +vertsplit
6005 feature}
6006 When on, splitting a window will put the new window right of the
6007 current one. |:vsplit|
6008
6009 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6010'startofline' 'sol' boolean (default on)
6011 global
6012 {not in Vi}
6013 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006014 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006015 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006016 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 with a linewise operator, with "%" with a count and to buffer changing
6018 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6019 only has a line number, e.g., ":25" or ":+".
6020 In case of buffer changing commands the cursor is placed at the column
6021 where it was the last time the buffer was edited.
6022 NOTE: This option is set when 'compatible' is set.
6023
6024 *'statusline'* *'stl'* *E540* *E541* *E542*
6025'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006026 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 {not in Vi}
6028 {not available when compiled without the |+statusline|
6029 feature}
6030 When nonempty, this option determines the content of the status line.
6031 Also see |status-line|.
6032
6033 The option consists of printf style '%' items interspersed with
6034 normal text. Each status line item is of the form:
6035 %-0{minwid}.{maxwid}{item}
6036 All fields except the {item} is optional. A single percent sign can
6037 be given as "%%". Up to 80 items can be specified.
6038
Bram Moolenaar238a5642006-02-21 22:12:05 +00006039 When the option starts with "%!" then it is used as an expression,
6040 evaluated and the result is used as the option value. Example: >
6041 :set statusline=%!MyStatusLine()
6042< The result can contain %{} items that will be evaluated too.
6043
6044 When there is error while evaluating the option then it will be made
6045 empty to avoid further errors. Otherwise screen updating would loop.
6046
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047 Note that the only effect of 'ruler' when this option is set (and
6048 'laststatus' is 2) is controlling the output of |CTRL-G|.
6049
6050 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006051 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006053 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 minwid Minimum width of the item, padding as set by '-' & '0'.
6055 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006056 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 on the left for text items. Numeric items will be
6058 shifted down to maxwid-2 digits followed by '>'number
6059 where number is the amount of missing digits, much like
6060 an exponential notation.
6061 item A one letter code as described below.
6062
6063 Following is a description of the possible statusline items. The
6064 second character in "item" is the type:
6065 N for number
6066 S for string
6067 F for flags as described below
6068 - not applicable
6069
6070 item meaning ~
6071 f S Path to the file in the buffer, relative to current directory.
6072 F S Full path to the file in the buffer.
6073 t S File name (tail) of file in the buffer.
6074 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6075 M F Modified flag, text is ",+" or ",-".
6076 r F Readonly flag, text is " [RO]".
6077 R F Readonly flag, text is ",RO".
6078 h F Help buffer flag, text is " [help]".
6079 H F Help buffer flag, text is ",HLP".
6080 w F Preview window flag, text is " [Preview]".
6081 W F Preview window flag, text is ",PRV".
6082 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6083 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6084 {not available when compiled without |+autocmd| feature}
6085 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6086 being used: "<keymap>"
6087 n N Buffer number.
6088 b N Value of byte under cursor.
6089 B N As above, in hexadecimal.
6090 o N Byte number in file of byte under cursor, first byte is 1.
6091 Mnemonic: Offset from start of file (with one added)
6092 {not available when compiled without |+byte_offset| feature}
6093 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006094 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 l N Line number.
6096 L N Number of lines in buffer.
6097 c N Column number.
6098 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006099 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 p N Percentage through file in lines as in |CTRL-G|.
6101 P S Percentage through file of displayed window. This is like the
6102 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006103 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006105 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006106 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 ( - Start of item group. Can be used for setting the width and
6108 alignment of a section. Must be followed by %) somewhere.
6109 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006110 T N For 'tabline': start of tab page N label. Use %T after the last
6111 label. This information is used for mouse clicks.
6112 X N For 'tabline': start of close tab N label. Use %X after the
6113 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6114 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 < - Where to truncate line if too long. Default is at the start.
6116 No width fields allowed.
6117 = - Separation point between left and right aligned items.
6118 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006119 # - Set highlight group. The name must follow and then a # again.
6120 Thus use %#HLname# for highlight group HLname. The same
6121 highlighting is used, also for the statusline of non-current
6122 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006124 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 The difference between User{N} and StatusLine will be applied
6126 to StatusLineNC for the statusline of non-current windows.
6127 The number N must be between 1 and 9. See |hl-User1..9|
6128
6129 Display of flags are controlled by the following heuristic:
6130 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006131 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 with a space it is assumed that it wants to separate itself from
6133 anything but other flags. That is: A leading comma is removed if the
6134 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006135 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 make a nice display when flags are used like in the examples below.
6137
Bram Moolenaar582fd852005-03-28 20:58:01 +00006138 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 not set) and a minwid is not set for the group, the whole group will
6140 become empty. This will make a group like the following disappear
6141 completely from the statusline when none of the flags are set. >
6142 :set statusline=...%(\ [%M%R%H]%)...
6143<
6144 Beware that an expression is evaluated each and every time the status
6145 line is displayed. The current buffer and current window will be set
6146 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006147 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006149 real current buffer.
6150
6151 The 'statusline' option may be evaluated in the |sandbox|, see
6152 |sandbox-option|.
6153
6154 It is not allowed to change text or jump to another window while
6155 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156
6157 If the statusline is not updated when you want it (e.g., after setting
6158 a variable that's used in an expression), you can force an update by
6159 setting an option without changing its value. Example: >
6160 :let &ro = &ro
6161
6162< A result of all digits is regarded a number for display purposes.
6163 Otherwise the result is taken as flag text and applied to the rules
6164 described above.
6165
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006166 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6168 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6169
6170 Examples:
6171 Emulate standard status line with 'ruler' set >
6172 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6173< Similar, but add ASCII value of char under the cursor (like "ga") >
6174 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6175< Display byte count and byte value, modified flag in red. >
6176 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6177 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6178< Display a ,GZ flag if a compressed file is loaded >
6179 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6180< In the |:autocmd|'s: >
6181 :let b:gzflag = 1
6182< And: >
6183 :unlet b:gzflag
6184< And define this function: >
6185 :function VarExists(var, val)
6186 : if exists(a:var) | return a:val | else | return '' | endif
6187 :endfunction
6188<
6189 *'suffixes'* *'su'*
6190'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6191 global
6192 {not in Vi}
6193 Files with these suffixes get a lower priority when multiple files
6194 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006195 suffixes. Spaces after the comma are ignored. A dot is also seen as
6196 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 separator, precede it with a backslash (see |option-backslash| about
6198 including spaces and backslashes).
6199 See 'wildignore' for completely ignoring files.
6200 The use of |:set+=| and |:set-=| is preferred when adding or removing
6201 suffixes from the list. This avoids problems when a future version
6202 uses another default.
6203
6204 *'suffixesadd'* *'sua'*
6205'suffixesadd' 'sua' string (default "")
6206 local to buffer
6207 {not in Vi}
6208 {not available when compiled without the
6209 |+file_in_path| feature}
6210 Comma separated list of suffixes, which are used when searching for a
6211 file for the "gf", "[I", etc. commands. Example: >
6212 :set suffixesadd=.java
6213<
6214 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6215'swapfile' 'swf' boolean (default on)
6216 local to buffer
6217 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006218 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 swapfile is not wanted for a specific buffer. For example, with
6220 confidential information that even root must not be able to access.
6221 Careful: All text will be in memory:
6222 - Don't use this for big files.
6223 - Recovery will be impossible!
6224 A swapfile will only be present when |'updatecount'| is non-zero and
6225 'swapfile' is set.
6226 When 'swapfile' is reset, the swap file for the current buffer is
6227 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6228 non-zero, a swap file is immediately created.
6229 Also see |swap-file| and |'swapsync'|.
6230
6231 This option is used together with 'bufhidden' and 'buftype' to
6232 specify special kinds of buffers. See |special-buffers|.
6233
6234 *'swapsync'* *'sws'*
6235'swapsync' 'sws' string (default "fsync")
6236 global
6237 {not in Vi}
6238 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006239 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 When this option is empty parts of the swap file may be in memory and
6241 not written to disk. When the system crashes you may lose more work.
6242 On Unix the system does a sync now and then without Vim asking for it,
6243 so the disadvantage of setting this option off is small. On some
6244 systems the swap file will not be written at all. For a unix system
6245 setting it to "sync" will use the sync() call instead of the default
6246 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006247 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248
6249 *'switchbuf'* *'swb'*
6250'switchbuf' 'swb' string (default "")
6251 global
6252 {not in Vi}
6253 This option controls the behavior when switching between buffers.
6254 Possible values (comma separated list):
6255 useopen If included, jump to the first open window that
6256 contains the specified buffer (if there is one).
6257 Otherwise: Do not examine other windows.
6258 This setting is checked with |quickfix| commands, when
6259 jumping to errors (":cc", ":cn", "cp", etc.). It is
6260 also used in all buffer related split commands, for
6261 example ":sbuffer", ":sbnext", or ":sbrewind".
6262 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006263 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 Supported in |quickfix| commands that display errors.
6265
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006266 *'synmaxcol'* *'smc'*
6267'synmaxcol' 'smc' number (default 3000)
6268 local to buffer
6269 {not in Vi}
6270 {not available when compiled without the |+syntax|
6271 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006272 Maximum column in which to search for syntax items. In long lines the
6273 text after this column is not highlighted and following lines may not
6274 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006275 This helps to avoid very slow redrawing for an XML file that is one
6276 long line.
6277 Set to zero to remove the limit.
6278
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 *'syntax'* *'syn'*
6280'syntax' 'syn' string (default empty)
6281 local to buffer
6282 {not in Vi}
6283 {not available when compiled without the |+syntax|
6284 feature}
6285 When this option is set, the syntax with this name is loaded, unless
6286 syntax highlighting has been switched off with ":syntax off".
6287 Otherwise this option does not always reflect the current syntax (the
6288 b:current_syntax variable does).
6289 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006290 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 /* vim: set syntax=idl : */
6292< To switch off syntax highlighting for the current file, use: >
6293 :set syntax=OFF
6294< To switch syntax highlighting on according to the current value of the
6295 'filetype' option: >
6296 :set syntax=ON
6297< What actually happens when setting the 'syntax' option is that the
6298 Syntax autocommand event is triggered with the value as argument.
6299 This option is not copied to another buffer, independent of the 's' or
6300 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006301 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006303 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006304'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006305 global
6306 {not in Vi}
6307 {not available when compiled without the +windows
6308 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006309 When nonempty, this option determines the content of the tab pages
6310 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006311 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006312
6313 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006314 option and only when there is no GUI tab line. When 'e' is in
6315 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6316 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006317
6318 The value is evaluated like with 'statusline'. You can use
6319 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006320 the text to be displayed. Use "%1T" for the first label, "%2T" for
6321 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006322
6323 Keep in mind that only one of the tab pages is the current one, others
6324 are invisible and you can't jump to their windows.
6325
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006326
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006327 *'tabpagemax'* *'tpm'*
6328'tabpagemax' 'tpm' number (default 10)
6329 global
6330 {not in Vi}
6331 {not available when compiled without the +windows
6332 feature}
6333 Maximum number of tab pages to be opened by the |-p| command line
6334 argument or the ":tab all" command. |tabpage|
6335
6336
6337 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338'tabstop' 'ts' number (default 8)
6339 local to buffer
6340 Number of spaces that a <Tab> in the file counts for. Also see
6341 |:retab| command, and 'softtabstop' option.
6342
6343 Note: Setting 'tabstop' to any other value than 8 can make your file
6344 appear wrong in many places (e.g., when printing it).
6345
6346 There are four main ways to use tabs in Vim:
6347 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6348 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6349 will use a mix of tabs and spaces, but typing Tab and BS will
6350 behave like a tab appears every 4 (or 3) characters.
6351 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6352 'expandtab'. This way you will always insert spaces. The
6353 formatting will never be messed up when 'tabstop' is changed.
6354 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006355 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 works when using Vim to edit the file.
6357 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6358 'noexpandtab'. This should then work (for initial indents only)
6359 for any tabstop setting that people use. It might be nice to have
6360 tabs after the first non-blank inserted as spaces if you do this
6361 though. Otherwise aligned comments will be wrong when 'tabstop' is
6362 changed.
6363
6364 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6365'tagbsearch' 'tbs' boolean (default on)
6366 global
6367 {not in Vi}
6368 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006369 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 searching makes searching for a tag a LOT faster, but a linear search
6371 will find more tags if the tags file wasn't properly sorted.
6372 Vim normally assumes that your tags files are sorted, or indicate that
6373 they are not sorted. Only when this is not the case does the
6374 'tagbsearch' option need to be switched off.
6375
6376 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006377 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 certain files, or retry all files with a linear search. When
6379 'tagbsearch' is off, only a linear search is done.
6380
6381 Linear searching is done anyway, for one file, when Vim finds a line
6382 at the start of the file indicating that it's not sorted: >
6383 !_TAG_FILE_SORTED 0 /some command/
6384< [The whitespace before and after the '0' must be a single <Tab>]
6385
6386 When a binary search was done and no match was found in any of the
6387 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6388 instead of a normal tag name, a retry is done with a linear search.
6389 Tags in unsorted tags files, and matches with different case will only
6390 be found in the retry.
6391
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006392 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 linear search can be avoided for the 'ignorecase' case. Use a value
6394 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6395 case-fold sorted with the -f switch to "sort" in most unices, as in
6396 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6397 5.3 or higher the -f or --fold-case-sort switch can be used for this
6398 as well. Note that case must be folded to uppercase for this to work.
6399
6400 When 'tagbsearch' is off, tags searching is slower when a full match
6401 exists, but faster when no full match exists. Tags in unsorted tags
6402 files may only be found with 'tagbsearch' off.
6403 When the tags file is not sorted, or sorted in a wrong way (not on
6404 ASCII byte value), 'tagbsearch' should be off, or the line given above
6405 must be included in the tags file.
6406 This option doesn't affect commands that find all matching tags (e.g.,
6407 command-line completion and ":help").
6408 {Vi: always uses binary search in some versions}
6409
6410 *'taglength'* *'tl'*
6411'taglength' 'tl' number (default 0)
6412 global
6413 If non-zero, tags are significant up to this number of characters.
6414
6415 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6416'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6417 global
6418 {not in Vi}
6419 If on and using a tag file in another directory, file names in that
6420 tag file are relative to the directory where the tag file is.
6421 NOTE: This option is set to the Vi default value when 'compatible' is
6422 set and to the Vim default value when 'compatible' is reset.
6423
6424 *'tags'* *'tag'* *E433*
6425'tags' 'tag' string (default "./tags,tags", when compiled with
6426 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6427 global or local to buffer |global-local|
6428 Filenames for the tag command, separated by spaces or commas. To
6429 include a space or comma in a file name, precede it with a backslash
6430 (see |option-backslash| about including spaces and backslashes).
6431 When a file name starts with "./", the '.' is replaced with the path
6432 of the current file. But only when the 'd' flag is not included in
6433 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6434 |tags-option|.
6435 "*", "**" and other wildcards can be used to search for tags files in
6436 a directory tree. See |file-searching|. {not available when compiled
6437 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006438 The |tagfiles()| function can be used to get a list of the file names
6439 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6441 files are also supported. They are automatically recognized. The
6442 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6443 differences are ignored (MS-Windows). |emacs-tags|
6444 The use of |:set+=| and |:set-=| is preferred when adding or removing
6445 file names from the list. This avoids problems when a future version
6446 uses another default.
6447 {Vi: default is "tags /usr/lib/tags"}
6448
6449 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6450'tagstack' 'tgst' boolean (default on)
6451 global
6452 {not in all versions of Vi}
6453 When on, the |tagstack| is used normally. When off, a ":tag" or
6454 ":tselect" command with an argument will not push the tag onto the
6455 tagstack. A following ":tag" without an argument, a ":pop" command or
6456 any other command that uses the tagstack will use the unmodified
6457 tagstack, but does change the pointer to the active entry.
6458 Resetting this option is useful when using a ":tag" command in a
6459 mapping which should not change the tagstack.
6460
6461 *'term'* *E529* *E530* *E531*
6462'term' string (default is $TERM, if that fails:
6463 in the GUI: "builtin_gui"
6464 on Amiga: "amiga"
6465 on BeOS: "beos-ansi"
6466 on Mac: "mac-ansi"
6467 on MiNT: "vt52"
6468 on MS-DOS: "pcterm"
6469 on OS/2: "os2ansi"
6470 on Unix: "ansi"
6471 on VMS: "ansi"
6472 on Win 32: "win32")
6473 global
6474 Name of the terminal. Used for choosing the terminal control
6475 characters. Environment variables are expanded |:set_env|.
6476 For example: >
6477 :set term=$TERM
6478< See |termcap|.
6479
6480 *'termbidi'* *'tbidi'*
6481 *'notermbidi'* *'notbidi'*
6482'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6483 global
6484 {not in Vi}
6485 {only available when compiled with the |+arabic|
6486 feature}
6487 The terminal is in charge of Bi-directionality of text (as specified
6488 by Unicode). The terminal is also expected to do the required shaping
6489 that some languages (such as Arabic) require.
6490 Setting this option implies that 'rightleft' will not be set when
6491 'arabic' is set and the value of 'arabicshape' will be ignored.
6492 Note that setting 'termbidi' has the immediate effect that
6493 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6494 This option is reset when the GUI is started.
6495 For further details see |arabic.txt|.
6496
6497 *'termencoding'* *'tenc'*
6498'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6499 Macintosh GUI: "macroman")
6500 global
6501 {only available when compiled with the |+multi_byte|
6502 feature}
6503 {not in Vi}
6504 Encoding used for the terminal. This specifies what character
6505 encoding the keyboard produces and the display will understand. For
6506 the GUI it only applies to the keyboard ('encoding' is used for the
6507 display).
6508 In the Win32 console version the default value is the console codepage
6509 when it differs from the ANSI codepage.
6510 *E617*
6511 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6512 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6513 Any attempts to set a different value will be rejected, and an error
6514 message is shown.
6515 For the Win32 GUI 'termencoding' is not used for typed characters,
6516 because the Win32 system always passes Unicode characters.
6517 When empty, the same encoding is used as for the 'encoding' option.
6518 This is the normal value.
6519 Not all combinations for 'termencoding' and 'encoding' are valid. See
6520 |encoding-table|.
6521 The value for this option must be supported by internal conversions or
6522 iconv(). When this is not possible no conversion will be done and you
6523 will probably experience problems with non-ASCII characters.
6524 Example: You are working with the locale set to euc-jp (Japanese) and
6525 want to edit a UTF-8 file: >
6526 :let &termencoding = &encoding
6527 :set encoding=utf-8
6528< You need to do this when your system has no locale support for UTF-8.
6529
6530 *'terse'* *'noterse'*
6531'terse' boolean (default off)
6532 global
6533 When set: Add 's' flag to 'shortmess' option (this makes the message
6534 for a search that hits the start or end of the file not being
6535 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6536 shortens a lot of messages}
6537
6538 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6539'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6540 global
6541 {not in Vi}
6542 This option is obsolete. Use 'fileformats'.
6543 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6544 set to the default value for the current system. When 'textauto' is
6545 reset, 'fileformats' is made empty.
6546 NOTE: This option is set to the Vi default value when 'compatible' is
6547 set and to the Vim default value when 'compatible' is reset.
6548
6549 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6550'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6551 others: default off)
6552 local to buffer
6553 {not in Vi}
6554 This option is obsolete. Use 'fileformat'.
6555 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6556 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6557 "unix".
6558
6559 *'textwidth'* *'tw'*
6560'textwidth' 'tw' number (default 0)
6561 local to buffer
6562 {not in Vi}
6563 Maximum width of text that is being inserted. A longer line will be
6564 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006565 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6566 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 'formatoptions' and |ins-textwidth|.
6568 NOTE: This option is set to 0 when 'compatible' is set.
6569
6570 *'thesaurus'* *'tsr'*
6571'thesaurus' 'tsr' string (default "")
6572 global or local to buffer |global-local|
6573 {not in Vi}
6574 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006575 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 the file should contain words with similar meaning, separated by
6577 non-keyword characters (white space is preferred). Maximum line
6578 length is 510 bytes.
6579 To obtain a file to be used here, check out the wordlist FAQ at
6580 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006581 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 after a comma are ignored, otherwise spaces are included in the file
6583 name. See |option-backslash| about using backslashes.
6584 The use of |:set+=| and |:set-=| is preferred when adding or removing
6585 directories from the list. This avoids problems when a future version
6586 uses another default.
6587 Backticks cannot be used in this option for security reasons.
6588
6589 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6590'tildeop' 'top' boolean (default off)
6591 global
6592 {not in Vi}
6593 When on: The tilde command "~" behaves like an operator.
6594 NOTE: This option is reset when 'compatible' is set.
6595
6596 *'timeout'* *'to'* *'notimeout'* *'noto'*
6597'timeout' 'to' boolean (default on)
6598 global
6599 *'ttimeout'* *'nottimeout'*
6600'ttimeout' boolean (default off)
6601 global
6602 {not in Vi}
6603 These two options together determine the behavior when part of a
6604 mapped key sequence or keyboard code has been received:
6605
6606 'timeout' 'ttimeout' action ~
6607 off off do not time out
6608 on on or off time out on :mappings and key codes
6609 off on time out on key codes
6610
6611 If both options are off, Vim will wait until either the complete
6612 mapping or key sequence has been received, or it is clear that there
6613 is no mapping or key sequence for the received characters. For
6614 example: if you have mapped "vl" and Vim has received 'v', the next
6615 character is needed to see if the 'v' is followed by an 'l'.
6616 When one of the options is on, Vim will wait for about 1 second for
6617 the next character to arrive. After that the already received
6618 characters are interpreted as single characters. The waiting time can
6619 be changed with the 'timeoutlen' option.
6620 On slow terminals or very busy systems timing out may cause
6621 malfunctioning cursor keys. If both options are off, Vim waits
6622 forever after an entered <Esc> if there are key codes that start
6623 with <Esc>. You will have to type <Esc> twice. If you do not have
6624 problems with key codes, but would like to have :mapped key
6625 sequences not timing out in 1 second, set the 'ttimeout' option and
6626 reset the 'timeout' option.
6627
6628 NOTE: 'ttimeout' is reset when 'compatible' is set.
6629
6630 *'timeoutlen'* *'tm'*
6631'timeoutlen' 'tm' number (default 1000)
6632 global
6633 {not in all versions of Vi}
6634 *'ttimeoutlen'* *'ttm'*
6635'ttimeoutlen' 'ttm' number (default -1)
6636 global
6637 {not in Vi}
6638 The time in milliseconds that is waited for a key code or mapped key
6639 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6640 when part of a command has been typed.
6641 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6642 different timeout value for key codes is desired set 'ttimeoutlen' to
6643 a non-negative number.
6644
6645 ttimeoutlen mapping delay key code delay ~
6646 < 0 'timeoutlen' 'timeoutlen'
6647 >= 0 'timeoutlen' 'ttimeoutlen'
6648
6649 The timeout only happens when the 'timeout' and 'ttimeout' options
6650 tell so. A useful setting would be >
6651 :set timeout timeoutlen=3000 ttimeoutlen=100
6652< (time out on mapping after three seconds, time out on key codes after
6653 a tenth of a second).
6654
6655 *'title'* *'notitle'*
6656'title' boolean (default off, on when title can be restored)
6657 global
6658 {not in Vi}
6659 {not available when compiled without the |+title|
6660 feature}
6661 When on, the title of the window will be set to the value of
6662 'titlestring' (if it is not empty), or to:
6663 filename [+=-] (path) - VIM
6664 Where:
6665 filename the name of the file being edited
6666 - indicates the file cannot be modified, 'ma' off
6667 + indicates the file was modified
6668 = indicates the file is read-only
6669 =+ indicates the file is read-only and modified
6670 (path) is the path of the file being edited
6671 - VIM the server name |v:servername| or "VIM"
6672 Only works if the terminal supports setting window titles
6673 (currently Amiga console, Win32 console, all GUI versions and
6674 terminals with a non- empty 't_ts' option - these are Unix xterm and
6675 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6676 *X11*
6677 When Vim was compiled with HAVE_X11 defined, the original title will
6678 be restored if possible. The output of ":version" will include "+X11"
6679 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6680 works for the icon name |'icon'|.
6681 But: When Vim was started with the |-X| argument, restoring the title
6682 will not work (except in the GUI).
6683 If the title cannot be restored, it is set to the value of 'titleold'.
6684 You might want to restore the title outside of Vim then.
6685 When using an xterm from a remote machine you can use this command:
6686 rsh machine_name xterm -display $DISPLAY &
6687 then the WINDOWID environment variable should be inherited and the
6688 title of the window should change back to what it should be after
6689 exiting Vim.
6690
6691 *'titlelen'*
6692'titlelen' number (default 85)
6693 global
6694 {not in Vi}
6695 {not available when compiled without the |+title|
6696 feature}
6697 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006698 title. When the title is longer, only the end of the path name is
6699 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 Using a percentage makes this adapt to the width of the window. But
6701 it won't work perfectly, because the actual number of characters
6702 available also depends on the font used and other things in the title
6703 bar. When 'titlelen' is zero the full path is used. Otherwise,
6704 values from 1 to 30000 percent can be used.
6705 'titlelen' is also used for the 'titlestring' option.
6706
6707 *'titleold'*
6708'titleold' string (default "Thanks for flying Vim")
6709 global
6710 {not in Vi}
6711 {only available when compiled with the |+title|
6712 feature}
6713 This option will be used for the window title when exiting Vim if the
6714 original title cannot be restored. Only happens if 'title' is on or
6715 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006716 This option cannot be set from a |modeline| or in the |sandbox|, for
6717 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 *'titlestring'*
6719'titlestring' string (default "")
6720 global
6721 {not in Vi}
6722 {not available when compiled without the |+title|
6723 feature}
6724 When this option is not empty, it will be used for the title of the
6725 window. This happens only when the 'title' option is on.
6726 Only works if the terminal supports setting window titles (currently
6727 Amiga console, Win32 console, all GUI versions and terminals with a
6728 non-empty 't_ts' option).
6729 When Vim was compiled with HAVE_X11 defined, the original title will
6730 be restored if possible |X11|.
6731 When this option contains printf-style '%' items, they will be
6732 expanded according to the rules used for 'statusline'.
6733 Example: >
6734 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6735 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6736< The value of 'titlelen' is used to align items in the middle or right
6737 of the available space.
6738 Some people prefer to have the file name first: >
6739 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6740< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006741 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 separating space only when needed.
6743 NOTE: Use of special characters in 'titlestring' may cause the display
6744 to be garbled (e.g., when it contains a CR or NL character).
6745 {not available when compiled without the |+statusline| feature}
6746
6747 *'toolbar'* *'tb'*
6748'toolbar' 'tb' string (default "icons,tooltips")
6749 global
6750 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6751 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006752 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 possible values are:
6754 icons Toolbar buttons are shown with icons.
6755 text Toolbar buttons shown with text.
6756 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006757 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 tooltips Tooltips are active for toolbar buttons.
6759 Tooltips refer to the popup help text which appears after the mouse
6760 cursor is placed over a toolbar button for a brief moment.
6761
6762 If you want the toolbar to be shown with icons as well as text, do the
6763 following: >
6764 :set tb=icons,text
6765< Motif and Athena cannot display icons and text at the same time. They
6766 will show icons if both are requested.
6767
6768 If none of the strings specified in 'toolbar' are valid or if
6769 'toolbar' is empty, this option is ignored. If you want to disable
6770 the toolbar, you need to set the 'guioptions' option. For example: >
6771 :set guioptions-=T
6772< Also see |gui-toolbar|.
6773
6774 *'toolbariconsize'* *'tbis'*
6775'toolbariconsize' 'tbis' string (default "small")
6776 global
6777 {not in Vi}
6778 {only in the GTK+ 2 GUI}
6779 Controls the size of toolbar icons. The possible values are:
6780 tiny Use tiny toolbar icons.
6781 small Use small toolbar icons (default).
6782 medium Use medium-sized toolbar icons.
6783 large Use large toolbar icons.
6784 The exact dimensions in pixels of the various icon sizes depend on
6785 the current theme. Common dimensions are large=32x32, medium=24x24,
6786 small=20x20 and tiny=16x16.
6787
6788 If 'toolbariconsize' is empty, the global default size as determined
6789 by user preferences or the current theme is used.
6790
6791 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6792'ttybuiltin' 'tbi' boolean (default on)
6793 global
6794 {not in Vi}
6795 When on, the builtin termcaps are searched before the external ones.
6796 When off the builtin termcaps are searched after the external ones.
6797 When this option is changed, you should set the 'term' option next for
6798 the change to take effect, for example: >
6799 :set notbi term=$TERM
6800< See also |termcap|.
6801 Rationale: The default for this option is "on", because the builtin
6802 termcap entries are generally better (many systems contain faulty
6803 xterm entries...).
6804
6805 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6806'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6807 sun-cmd, screen, rxvt, dtterm or
6808 iris-ansi; also on when running Vim in
6809 a DOS console)
6810 global
6811 {not in Vi}
6812 Indicates a fast terminal connection. More characters will be sent to
6813 the screen for redrawing, instead of using insert/delete line
6814 commands. Improves smoothness of redrawing when there are multiple
6815 windows and the terminal does not support a scrolling region.
6816 Also enables the extra writing of characters at the end of each screen
6817 line for lines that wrap. This helps when using copy/paste with the
6818 mouse in an xterm and other terminals.
6819
6820 *'ttymouse'* *'ttym'*
6821'ttymouse' 'ttym' string (default depends on 'term')
6822 global
6823 {not in Vi}
6824 {only in Unix and VMS, doesn't work in the GUI; not
6825 available when compiled without |+mouse|}
6826 Name of the terminal type for which mouse codes are to be recognized.
6827 Currently these three strings are valid:
6828 *xterm-mouse*
6829 xterm xterm-like mouse handling. The mouse generates
6830 "<Esc>[Mscr", where "scr" is three bytes:
6831 "s" = button state
6832 "c" = column plus 33
6833 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006834 This only works up to 223 columns! See "dec" for a
6835 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 xterm2 Works like "xterm", but with the xterm reporting the
6837 mouse position while the mouse is dragged. This works
6838 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006839 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 work. See below for how Vim detects this
6841 automatically.
6842 *netterm-mouse*
6843 netterm NetTerm mouse handling. The mouse generates
6844 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6845 for the row and column.
6846 *dec-mouse*
6847 dec DEC terminal mouse handling. The mouse generates a
6848 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006849 This is also available for an Xterm, if it was
6850 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 *jsbterm-mouse*
6852 jsbterm JSB term mouse handling.
6853 *pterm-mouse*
6854 pterm QNX pterm mouse handling.
6855
6856 The mouse handling must be enabled at compile time |+mouse_xterm|
6857 |+mouse_dec| |+mouse_netterm|.
6858 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6859 recognized, if enabled at compile time. DEC terminal mouse codes
6860 are recognized if enabled at compile time, and 'ttymouse' is not
6861 "xterm" (because the xterm and dec mouse codes conflict).
6862 This option is automatically set to "xterm", when the 'term' option is
6863 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6864 or "xterm2" already. The main use of this option is to set it to
6865 "xterm", when the terminal name doesn't start with "xterm", but it can
6866 handle xterm mouse codes.
6867 The "xterm2" value will be set if the xterm version is reported to be
6868 95 of higher. This only works when compiled with the |+termresponse|
6869 feature and if |t_RV| is set to the escape sequence to request the
6870 xterm version number. Otherwise "xterm2" must be set explicitly.
6871 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6872 t_RV to an empty string: >
6873 :set t_RV=
6874<
6875 *'ttyscroll'* *'tsl'*
6876'ttyscroll' 'tsl' number (default 999)
6877 global
6878 Maximum number of lines to scroll the screen. If there are more lines
6879 to scroll the window is redrawn. For terminals where scrolling is
6880 very slow and redrawing is not slow this can be set to a small number,
6881 e.g., 3, to speed up displaying.
6882
6883 *'ttytype'* *'tty'*
6884'ttytype' 'tty' string (default from $TERM)
6885 global
6886 Alias for 'term', see above.
6887
6888 *'undolevels'* *'ul'*
6889'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6890 Win32 and OS/2)
6891 global
6892 {not in Vi}
6893 Maximum number of changes that can be undone. Since undo information
6894 is kept in memory, higher numbers will cause more memory to be used
6895 (nevertheless, a single change can use an unlimited amount of memory).
6896 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6897 itself: >
6898 set ul=0
6899< But you can also get Vi compatibility by including the 'u' flag in
6900 'cpoptions', and still be able to use CTRL-R to repeat undo.
6901 Set to a negative number for no undo at all: >
6902 set ul=-1
6903< This helps when you run out of memory for a single change.
6904 Also see |undo-two-ways|.
6905
6906 *'updatecount'* *'uc'*
6907'updatecount' 'uc' number (default: 200)
6908 global
6909 {not in Vi}
6910 After typing this many characters the swap file will be written to
6911 disk. When zero, no swap file will be created at all (see chapter on
6912 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6913 Vim with the "-n" option, see |startup|. When editing in readonly
6914 mode this option will be initialized to 10000.
6915 The swapfile can be disabled per buffer with |'swapfile'|.
6916 When 'updatecount' is set from zero to non-zero, swap files are
6917 created for all buffers that have 'swapfile' set. When 'updatecount'
6918 is set to zero, existing swap files are not deleted.
6919 Also see |'swapsync'|.
6920 This option has no meaning in buffers where |'buftype'| is "nofile"
6921 or "nowrite".
6922
6923 *'updatetime'* *'ut'*
6924'updatetime' 'ut' number (default 4000)
6925 global
6926 {not in Vi}
6927 If this many milliseconds nothing is typed the swap file will be
6928 written to disk (see |crash-recovery|). Also used for the
6929 |CursorHold| autocommand event.
6930
6931 *'verbose'* *'vbs'*
6932'verbose' 'vbs' number (default 0)
6933 global
6934 {not in Vi, although some versions have a boolean
6935 verbose option}
6936 When bigger than zero, Vim will give messages about what it is doing.
6937 Currently, these messages are given:
6938 >= 1 When the viminfo file is read or written.
6939 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006940 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 >= 8 Files for which a group of autocommands is executed.
6942 >= 9 Every executed autocommand.
6943 >= 12 Every executed function.
6944 >= 13 When an exception is thrown, caught, finished, or discarded.
6945 >= 14 Anything pending in a ":finally" clause.
6946 >= 15 Every executed Ex command (truncated at 200 characters).
6947
6948 This option can also be set with the "-V" argument. See |-V|.
6949 This option is also set by the |:verbose| command.
6950
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006951 When the 'verbosefile' option is set then the verbose messages are not
6952 displayed.
6953
6954 *'verbosefile'* *'vfile'*
6955'verbosefile' 'vfile' string (default empty)
6956 global
6957 {not in Vi}
6958 When not empty all messages are written in a file with this name.
6959 When the file exists messages are appended.
6960 Writing to the file ends when Vim exits or when 'verbosefile' is made
6961 empty.
6962 Setting 'verbosefile' to a new value is like making it empty first.
6963 The difference with |:redir| is that verbose messages are not
6964 displayed when 'verbosefile' is set.
6965
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 *'viewdir'* *'vdir'*
6967'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6968 "$VIM/vimfiles/view",
6969 for Unix: "~/.vim/view",
6970 for Macintosh: "$VIM:vimfiles:view"
6971 for VMS: "sys$login:vimfiles/view"
6972 for RiscOS: "Choices:vimfiles/view")
6973 global
6974 {not in Vi}
6975 {not available when compiled without the +mksession
6976 feature}
6977 Name of the directory where to store files for |:mkview|.
6978 This option cannot be set from a |modeline| or in the |sandbox|, for
6979 security reasons.
6980
6981 *'viewoptions'* *'vop'*
6982'viewoptions' 'vop' string (default: "folds,options,cursor")
6983 global
6984 {not in Vi}
6985 {not available when compiled without the +mksession
6986 feature}
6987 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006988 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 word save and restore ~
6990 cursor cursor position in file and in window
6991 folds manually created folds, opened/closed folds and local
6992 fold options
6993 options options and mappings local to a window or buffer (not
6994 global values for local options)
6995 slash backslashes in file names replaced with forward
6996 slashes
6997 unix with Unix end-of-line format (single <NL>), even when
6998 on Windows or DOS
6999
7000 "slash" and "unix" are useful on Windows when sharing view files
7001 with Unix. The Unix version of Vim cannot source dos format scripts,
7002 but the Windows version of Vim can source unix format scripts.
7003
7004 *'viminfo'* *'vi'* *E526* *E527* *E528*
7005'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7006 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7007 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7008 for others: '20,<50,s10,h)
7009 global
7010 {not in Vi}
7011 {not available when compiled without the |+viminfo|
7012 feature}
7013 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007014 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 separated list of parameters, each consisting of a single character
7016 identifying the particular parameter, followed by a number or string
7017 which specifies the value of that parameter. If a particular
7018 character is left out, then the default value is used for that
7019 parameter. The following is a list of the identifying characters and
7020 the effect of their value.
7021 CHAR VALUE ~
7022 ! When included, save and restore global variables that start
7023 with an uppercase letter, and don't contain a lowercase
7024 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007025 and "_K_L_M" are not. Only String and Number types are
7026 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 " Maximum number of lines saved for each register. Old name of
7028 the '<' item, with the disadvantage that you need to put a
7029 backslash before the ", otherwise it will be recognized as the
7030 start of a comment!
7031 % When included, save and restore the buffer list. If Vim is
7032 started with a file name argument, the buffer list is not
7033 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007034 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 without a file name and buffers for help files are not written
7036 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007037 When followed by a number, the number specifies the maximum
7038 number of buffers that are stored. Without a number all
7039 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 ' Maximum number of previously edited files for which the marks
7041 are remembered. This parameter must always be included when
7042 'viminfo' is non-empty.
7043 Including this item also means that the |jumplist| and the
7044 |changelist| are stored in the viminfo file.
7045 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007046 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 patterns are also saved. When not included, the value of
7048 'history' is used.
7049 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007050 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 < Maximum number of lines saved for each register. If zero then
7052 registers are not saved. When not included, all lines are
7053 saved. '"' is the old name for this item.
7054 Also see the 's' item below: limit specified in Kbyte.
7055 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007056 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 c When included, convert the text in the viminfo file from the
7058 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007059 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 f Whether file marks need to be stored. If zero, file marks ('0
7061 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007062 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 cursor position (when exiting or when doing ":wviminfo").
7064 h Disable the effect of 'hlsearch' when loading the viminfo
7065 file. When not included, it depends on whether ":nohlsearch"
7066 has been used since the last search command.
7067 n Name of the viminfo file. The name must immediately follow
7068 the 'n'. Must be the last one! If the "-i" argument was
7069 given when starting Vim, that file name overrides the one
7070 given here with 'viminfo'. Environment variables are expanded
7071 when opening the file, not when setting the option.
7072 r Removable media. The argument is a string (up to the next
7073 ','). This parameter can be given several times. Each
7074 specifies the start of a path for which no marks will be
7075 stored. This is to avoid removable media. For MS-DOS you
7076 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7077 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7078 ignored. Maximum length of each 'r' argument is 50
7079 characters.
7080 s Maximum size of an item in Kbyte. If zero then registers are
7081 not saved. Currently only applies to registers. The default
7082 "s10" will exclude registers with more than 10 Kbyte of text.
7083 Also see the '<' item above: line count limit.
7084
7085 Example: >
7086 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7087<
7088 '50 Marks will be remembered for the last 50 files you
7089 edited.
7090 <1000 Contents of registers (up to 1000 lines each) will be
7091 remembered.
7092 s100 Registers with more than 100 Kbyte text are skipped.
7093 :0 Command-line history will not be saved.
7094 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7095 no / Since '/' is not specified, the default will be used,
7096 that is, save all of the search history, and also the
7097 previous search and substitute patterns.
7098 no % The buffer list will not be saved nor read back.
7099 no h 'hlsearch' highlighting will be restored.
7100
7101 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7102 load the contents of the file, this is not done automatically.
7103
7104 This option cannot be set from a |modeline| or in the |sandbox|, for
7105 security reasons.
7106
7107 *'virtualedit'* *'ve'*
7108'virtualedit' 've' string (default "")
7109 global
7110 {not in Vi}
7111 {not available when compiled without the
7112 |+virtualedit| feature}
7113 A comma separated list of these words:
7114 block Allow virtual editing in Visual block mode.
7115 insert Allow virtual editing in Insert mode.
7116 all Allow virtual editing in all modes.
7117 Virtual editing means that the cursor can be positioned where there is
7118 no actual character. This can be halfway into a Tab or beyond the end
7119 of the line. Useful for selecting a rectangle in Visual mode and
7120 editing a table.
7121
7122 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7123'visualbell' 'vb' boolean (default off)
7124 global
7125 {not in Vi}
7126 Use visual bell instead of beeping. The terminal code to display the
7127 visual bell is given with 't_vb'. When no beep or flash is wanted,
7128 use ":set vb t_vb=".
7129 Note: When the GUI starts, 't_vb' is reset to its default value. You
7130 might want to set it again in your |gvimrc|.
7131 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7132 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7133 where 40 is the time in msec.
7134 Does not work on the Amiga, you always get a screen flash.
7135 Also see 'errorbells'.
7136
7137 *'warn'* *'nowarn'*
7138'warn' boolean (default on)
7139 global
7140 Give a warning message when a shell command is used while the buffer
7141 has been changed.
7142
7143 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7144'weirdinvert' 'wiv' boolean (default off)
7145 global
7146 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007147 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 It is provided for backwards compatibility with version 4.x.
7149 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7150 vice versa. Has no effect when the GUI is running.
7151
7152 *'whichwrap'* *'ww'*
7153'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7154 global
7155 {not in Vi}
7156 Allow specified keys that move the cursor left/right to move to the
7157 previous/next line when the cursor is on the first/last character in
7158 the line. Concatenate characters to allow this for these keys:
7159 char key mode ~
7160 b <BS> Normal and Visual
7161 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007162 h "h" Normal and Visual (not recommended)
7163 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 < <Left> Normal and Visual
7165 > <Right> Normal and Visual
7166 ~ "~" Normal
7167 [ <Left> Insert and Replace
7168 ] <Right> Insert and Replace
7169 For example: >
7170 :set ww=<,>,[,]
7171< allows wrap only when cursor keys are used.
7172 When the movement keys are used in combination with a delete or change
7173 operator, the <EOL> also counts for a character. This makes "3h"
7174 different from "3dh" when the cursor crosses the end of a line. This
7175 is also true for "x" and "X", because they do the same as "dl" and
7176 "dh". If you use this, you may also want to use the mapping
7177 ":map <BS> X" to make backspace delete the character in front of the
7178 cursor.
7179 When 'l' is included, you get a side effect: "yl" on an empty line
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007180 will include the <EOL>, so that "p" will insert a new line. That's
7181 why including 'h' and 'l' are not recommended.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 NOTE: This option is set to the Vi default value when 'compatible' is
7183 set and to the Vim default value when 'compatible' is reset.
7184
7185 *'wildchar'* *'wc'*
7186'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7187 global
7188 {not in Vi}
7189 Character you have to type to start wildcard expansion in the
7190 command-line, as specified with 'wildmode'.
7191 The character is not recognized when used inside a macro. See
7192 'wildcharm' for that.
7193 Although 'wc' is a number option, you can set it to a special key: >
7194 :set wc=<Esc>
7195< NOTE: This option is set to the Vi default value when 'compatible' is
7196 set and to the Vim default value when 'compatible' is reset.
7197
7198 *'wildcharm'* *'wcm'*
7199'wildcharm' 'wcm' number (default: none (0))
7200 global
7201 {not in Vi}
7202 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007203 recognized when used inside a macro. You can find "spare" command-line
7204 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 you'll never actually type 'wildcharm', just use it in mappings that
7206 automatically invoke completion mode, e.g.: >
7207 :set wcm=<C-Z>
7208 :cmap ss so $vim/sessions/*.vim<C-Z>
7209< Then after typing :ss you can use CTRL-P & CTRL-N.
7210
7211 *'wildignore'* *'wig'*
7212'wildignore' 'wig' string (default "")
7213 global
7214 {not in Vi}
7215 {not available when compiled without the |+wildignore|
7216 feature}
7217 A list of file patterns. A file that matches with one of these
7218 patterns is ignored when completing file or directory names.
7219 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7220 Also see 'suffixes'.
7221 Example: >
7222 :set wildignore=*.o,*.obj
7223< The use of |:set+=| and |:set-=| is preferred when adding or removing
7224 a pattern from the list. This avoids problems when a future version
7225 uses another default.
7226
7227 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7228'wildmenu' 'wmnu' boolean (default off)
7229 global
7230 {not in Vi}
7231 {not available if compiled without the |+wildmenu|
7232 feature}
7233 When 'wildmenu' is on, command-line completion operates in an enhanced
7234 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7235 the possible matches are shown just above the command line, with the
7236 first match highlighted (overwriting the status line, if there is
7237 one). Keys that show the previous/next match, such as <Tab> or
7238 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7239 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7240 specified. "longest" and "list" do not start "wildmenu" mode.
7241 If there are more matches than can fit in the line, a ">" is shown on
7242 the right and/or a "<" is shown on the left. The status line scrolls
7243 as needed.
7244 The "wildmenu" mode is abandoned when a key is hit that is not used
7245 for selecting a completion.
7246 While the "wildmenu" is active the following keys have special
7247 meanings:
7248
7249 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7250 <Down> - in filename/menu name completion: move into a
7251 subdirectory or submenu.
7252 <CR> - in menu completion, when the cursor is just after a
7253 dot: move into a submenu.
7254 <Up> - in filename/menu name completion: move up into
7255 parent directory or parent menu.
7256
7257 This makes the menus accessible from the console |console-menus|.
7258
7259 If you prefer the <Left> and <Right> keys to move the cursor instead
7260 of selecting a different match, use this: >
7261 :cnoremap <Left> <Space><BS><Left>
7262 :cnoremap <Right> <Space><BS><Right>
7263<
7264 The "WildMenu" highlighting is used for displaying the current match
7265 |hl-WildMenu|.
7266
7267 *'wildmode'* *'wim'*
7268'wildmode' 'wim' string (Vim default: "full")
7269 global
7270 {not in Vi}
7271 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007272 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 part specifies what to do for each consecutive use of 'wildchar. The
7274 first part specifies the behavior for the first use of 'wildchar',
7275 The second part for the second use, etc.
7276 These are the possible values for each part:
7277 "" Complete only the first match.
7278 "full" Complete the next full match. After the last match,
7279 the original string is used and then the first match
7280 again.
7281 "longest" Complete till longest common string. If this doesn't
7282 result in a longer string, use the next part.
7283 "longest:full" Like "longest", but also start 'wildmenu' if it is
7284 enabled.
7285 "list" When more than one match, list all matches.
7286 "list:full" When more than one match, list all matches and
7287 complete first match.
7288 "list:longest" When more than one match, list all matches and
7289 complete till longest common string.
7290 When there is only a single match, it is fully completed in all cases.
7291
7292 Examples: >
7293 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007294< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 :set wildmode=longest,full
7296< Complete longest common string, then each full match >
7297 :set wildmode=list:full
7298< List all matches and complete each full match >
7299 :set wildmode=list,full
7300< List all matches without completing, then each full match >
7301 :set wildmode=longest,list
7302< Complete longest common string, then list alternatives.
7303
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007304 *'wildoptions'* *'wop'*
7305'wildoptions' 'wop' string (default "")
7306 global
7307 {not in Vi}
7308 {not available when compiled without the |+wildignore|
7309 feature}
7310 A list of words that change how command line completion is done.
7311 Currently only one word is allowed:
7312 tagfile When using CTRL-D to list matching tags, the kind of
7313 tag and the file of the tag is listed. Only one match
7314 is displayed per line. Often used tag kinds are:
7315 d #define
7316 f function
7317 Also see |cmdline-completion|.
7318
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 *'winaltkeys'* *'wak'*
7320'winaltkeys' 'wak' string (default "menu")
7321 global
7322 {not in Vi}
7323 {only used in Win32, Motif, GTK and Photon GUI}
7324 Some GUI versions allow the access to menu entries by using the ALT
7325 key in combination with a character that appears underlined in the
7326 menu. This conflicts with the use of the ALT key for mappings and
7327 entering special characters. This option tells what to do:
7328 no Don't use ALT keys for menus. ALT key combinations can be
7329 mapped, but there is no automatic handling. This can then be
7330 done with the |:simalt| command.
7331 yes ALT key handling is done by the windowing system. ALT key
7332 combinations cannot be mapped.
7333 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007334 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 keys can be mapped.
7336 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7337 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007338 This option is not used for <F10>; on Win32 and with GTK <F10> will
7339 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007341 *'window'* *'wi'*
7342'window' 'wi' number (default screen height - 1)
7343 global
7344 Window height. Do not confuse this with the height of the Vim window,
7345 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007346 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7347 value is smaller than 'lines' minus one. The screen will scroll
7348 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007349 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7350 in a much smarter way, taking care of wrapping lines.
7351 When resizing the Vim window, the value is smaller than 1 or more than
7352 or equal to 'lines' it will be set to 'lines' minus 1.
7353 {Vi also uses the option to specify the number of displayed lines}
7354
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 *'winheight'* *'wh'* *E591*
7356'winheight' 'wh' number (default 1)
7357 global
7358 {not in Vi}
7359 {not available when compiled without the +windows
7360 feature}
7361 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007362 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 current window is smaller, its size is increased, at the cost of the
7364 height of other windows. Set it to 999 to make the current window
7365 always fill the screen (although this has the drawback that ":all"
7366 will create only two windows). Set it to a small number for normal
7367 editing.
7368 Minimum value is 1.
7369 The height is not adjusted after one of the commands to change the
7370 height of the current window.
7371 'winheight' applies to the current window. Use 'winminheight' to set
7372 the minimal height for other windows.
7373
7374 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7375'winfixheight' 'wfh' boolean (default off)
7376 local to window
7377 {not in Vi}
7378 {not available when compiled without the +windows
7379 feature}
7380 Keep the window height when windows are opened or closed and
7381 'equalalways' is set. Set by default for the |preview-window| and
7382 |quickfix-window|.
7383 The height may be changed anyway when running out of room.
7384
7385 *'winminheight'* *'wmh'*
7386'winminheight' 'wmh' number (default 1)
7387 global
7388 {not in Vi}
7389 {not available when compiled without the +windows
7390 feature}
7391 The minimal height of a window, when it's not the current window.
7392 This is a hard minimum, windows will never become smaller.
7393 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7394 status bar) if necessary. They will return to at least one line when
7395 they become active (since the cursor has to have somewhere to go.)
7396 Use 'winheight' to set the minimal height of the current window.
7397 This option is only checked when making a window smaller. Don't use a
7398 large number, it will cause errors when opening more than a few
7399 windows. A value of 0 to 3 is reasonable.
7400
7401 *'winminwidth'* *'wmw'*
7402'winminwidth' 'wmw' number (default 1)
7403 global
7404 {not in Vi}
7405 {not available when compiled without the +vertsplit
7406 feature}
7407 The minimal width of a window, when it's not the current window.
7408 This is a hard minimum, windows will never become smaller.
7409 When set to zero, windows may be "squashed" to zero columns (i.e. just
7410 a vertical separator) if necessary. They will return to at least one
7411 line when they become active (since the cursor has to have somewhere
7412 to go.)
7413 Use 'winwidth' to set the minimal width of the current window.
7414 This option is only checked when making a window smaller. Don't use a
7415 large number, it will cause errors when opening more than a few
7416 windows. A value of 0 to 12 is reasonable.
7417
7418 *'winwidth'* *'wiw'* *E592*
7419'winwidth' 'wiw' number (default 20)
7420 global
7421 {not in Vi}
7422 {not available when compiled without the +vertsplit
7423 feature}
7424 Minimal number of columns for the current window. This is not a hard
7425 minimum, Vim will use fewer columns if there is not enough room. If
7426 the current window is smaller, its size is increased, at the cost of
7427 the width of other windows. Set it to 999 to make the current window
7428 always fill the screen. Set it to a small number for normal editing.
7429 The width is not adjusted after one of the commands to change the
7430 width of the current window.
7431 'winwidth' applies to the current window. Use 'winminwidth' to set
7432 the minimal width for other windows.
7433
7434 *'wrap'* *'nowrap'*
7435'wrap' boolean (default on)
7436 local to window
7437 {not in Vi}
7438 This option changes how text is displayed. It doesn't change the text
7439 in the buffer, see 'textwidth' for that.
7440 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007441 displaying continues on the next line. When off lines will not wrap
7442 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 moved to a part that is not shown, the screen will scroll
7444 horizontally.
7445 The line will be broken in the middle of a word if necessary. See
7446 'linebreak' to get the break at a word boundary.
7447 To make scrolling horizontally a bit more useful, try this: >
7448 :set sidescroll=5
7449 :set listchars+=precedes:<,extends:>
7450< See 'sidescroll', 'listchars' and |wrap-off|.
7451
7452 *'wrapmargin'* *'wm'*
7453'wrapmargin' 'wm' number (default 0)
7454 local to buffer
7455 Number of characters from the right window border where wrapping
7456 starts. When typing text beyond this limit, an <EOL> will be inserted
7457 and inserting continues on the next line.
7458 Options that add a margin, such as 'number' and 'foldcolumn', cause
7459 the text width to be further reduced. This is Vi compatible.
7460 When 'textwidth' is non-zero, this option is not used.
7461 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7462 and less usefully}
7463
7464 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7465'wrapscan' 'ws' boolean (default on) *E384* *E385*
7466 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007467 Searches wrap around the end of the file. Also applies to |]s| and
7468 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469
7470 *'write'* *'nowrite'*
7471'write' boolean (default on)
7472 global
7473 {not in Vi}
7474 Allows writing files. When not set, writing a file is not allowed.
7475 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007476 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 argument. Filtering text is still possible, even though this requires
7478 writing a temporary file.
7479
7480 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7481'writeany' 'wa' boolean (default off)
7482 global
7483 Allows writing to any file with no need for "!" override.
7484
7485 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7486'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7487 otherwise)
7488 global
7489 {not in Vi}
7490 Make a backup before overwriting a file. The backup is removed after
7491 the file was successfully written, unless the 'backup' option is
7492 also on. Reset this option if your file system is almost full. See
7493 |backup-table| for another explanation.
7494 When the 'backupskip' pattern matches, a backup is not made anyway.
7495 NOTE: This option is set to the default value when 'compatible' is
7496 set.
7497
7498 *'writedelay'* *'wd'*
7499'writedelay' 'wd' number (default 0)
7500 global
7501 {not in Vi}
7502 The number of microseconds to wait for each character sent to the
7503 screen. When non-zero, characters are sent to the terminal one by
7504 one. For MS-DOS pcterm this does not work. For debugging purposes.
7505
7506 vim:tw=78:ts=8:ft=help:norl: