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