blob: 52ae467b5833ad52c8b03e22914e25f7fa2bcaaf [file] [log] [blame]
Bram Moolenaar600dddc2006-03-12 22:05:10 +00001*options.txt* For Vim version 7.0aa. Last change: 2006 Mar 12
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")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001053< When they are supported "\n" characters will start a new line. If the
1054 expression evaluates to a |List| this is equal to using each List item
1055 as a string and putting "\n" in between them.
1056
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1058'binary' 'bin' boolean (default off)
1059 local to buffer
1060 {not in Vi}
1061 This option should be set before editing a binary file. You can also
1062 use the |-b| Vim argument. When this option is switched on a few
1063 options will be changed (also when it already was on):
1064 'textwidth' will be set to 0
1065 'wrapmargin' will be set to 0
1066 'modeline' will be off
1067 'expandtab' will be off
1068 Also, 'fileformat' and 'fileformats' options will not be used, the
1069 file is read and written like 'fileformat' was "unix" (a single <NL>
1070 separates lines).
1071 The 'fileencoding' and 'fileencodings' options will not be used, the
1072 file is read without conversion.
1073 NOTE: When you start editing a(nother) file while the 'bin' option is
1074 on, settings from autocommands may change the settings again (e.g.,
1075 'textwidth'), causing trouble when editing. You might want to set
1076 'bin' again when the file has been loaded.
1077 The previous values of these options are remembered and restored when
1078 'bin' is switched from on to off. Each buffer has its own set of
1079 saved option values.
1080 To edit a file with 'binary' set you can use the |++bin| argument.
1081 This avoids you have to do ":set bin", which would have effect for all
1082 files you edit.
1083 When writing a file the <EOL> for the last line is only written if
1084 there was one in the original file (normally Vim appends an <EOL> to
1085 the last line if there is none; this would make the file longer). See
1086 the 'endofline' option.
1087
1088 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1089'bioskey' 'biosk' boolean (default on)
1090 global
1091 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001092 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 better to detect CTRL-C, but only works for the console. When using a
1094 terminal over a serial port reset this option.
1095 Also see |'conskey'|.
1096
1097 *'bomb'* *'nobomb'*
1098'bomb' boolean (default off)
1099 local to buffer
1100 {not in Vi}
1101 {only available when compiled with the |+multi_byte|
1102 feature}
1103 When writing a file and the following conditions are met, a BOM (Byte
1104 Order Mark) is prepended to the file:
1105 - this option is on
1106 - the 'binary' option is off
1107 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1108 endian variants.
1109 Some applications use the BOM to recognize the encoding of the file.
1110 Often used for UCS-2 files on MS-Windows. For other applications it
1111 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1112 appear halfway the resulting file.
1113 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1114 check for the presence of the BOM is done and 'bomb' set accordingly.
1115 Unless 'binary' is set, it is removed from the first line, so that you
1116 don't see it when editing. When you don't change the options, the BOM
1117 will be restored when writing the file.
1118
1119 *'breakat'* *'brk'*
1120'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1121 global
1122 {not in Vi}
1123 {not available when compiled without the |+linebreak|
1124 feature}
1125 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001126 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1127 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128
1129 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001130'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 global
1132 {not in Vi} {only for Motif and Win32 GUI}
1133 Which directory to use for the file browser:
1134 last Use same directory as with last file browser.
1135 buffer Use the directory of the related buffer.
1136 current Use the current directory.
1137 {path} Use the specified directory
1138
1139 *'bufhidden'* *'bh'*
1140'bufhidden' 'bh' string (default: "")
1141 local to buffer
1142 {not in Vi}
1143 {not available when compiled without the |+quickfix|
1144 feature}
1145 This option specifies what happens when a buffer is no longer
1146 displayed in a window:
1147 <empty> follow the global 'hidden' option
1148 hide hide the buffer (don't unload it), also when 'hidden'
1149 is not set
1150 unload unload the buffer, also when 'hidden' is set or using
1151 |:hide|
1152 delete delete the buffer from the buffer list, also when
1153 'hidden' is set or using |:hide|, like using
1154 |:bdelete|
1155 wipe wipe out the buffer from the buffer list, also when
1156 'hidden' is set or using |:hide|, like using
1157 |:bwipeout|
1158
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001159 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1160 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 This option is used together with 'buftype' and 'swapfile' to specify
1162 special kinds of buffers. See |special-buffers|.
1163
1164 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1165'buflisted' 'bl' boolean (default: on)
1166 local to buffer
1167 {not in Vi}
1168 When this option is set, the buffer shows up in the buffer list. If
1169 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1170 This option is reset by Vim for buffers that are only used to remember
1171 a file name or marks. Vim sets it when starting to edit a buffer.
1172 But not when moving to a buffer with ":buffer".
1173
1174 *'buftype'* *'bt'* *E382*
1175'buftype' 'bt' string (default: "")
1176 local to buffer
1177 {not in Vi}
1178 {not available when compiled without the |+quickfix|
1179 feature}
1180 The value of this option specifies the type of a buffer:
1181 <empty> normal buffer
1182 nofile buffer which is not related to a file and will not be
1183 written
1184 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001185 acwrite buffer which will always be written with BufWriteCmd
1186 autocommands. {not available when compiled without the
1187 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001189 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 help help buffer (you are not supposed to set this
1191 manually)
1192
1193 This option is used together with 'bufhidden' and 'swapfile' to
1194 specify special kinds of buffers. See |special-buffers|.
1195
1196 Be careful with changing this option, it can have many side effects!
1197
Bram Moolenaar280f1262006-01-30 00:14:18 +00001198 A "quickfix" buffer is only used for the error list and the location
1199 list. This value is set by the |:cwindow| and |:lwindow| commands and
1200 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201
1202 "nofile" and "nowrite" buffers are similar:
1203 both: The buffer is not to be written to disk, ":w" doesn't
1204 work (":w filename" does work though).
1205 both: The buffer is never considered to be |'modified'|.
1206 There is no warning when the changes will be lost, for
1207 example when you quit Vim.
1208 both: A swap file is only created when using too much memory
1209 (when 'swapfile' has been reset there is never a swap
1210 file).
1211 nofile only: The buffer name is fixed, it is not handled like a
1212 file name. It is not modified in response to a |:cd|
1213 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001214 *E676*
1215 "acwrite" implies that the buffer name is not related to a file, like
1216 "nofile", but it will be written. Thus, in contrast to "nofile" and
1217 "nowrite", ":w" does work and a modified buffer can't be abandoned
1218 without saving. For writing there must be matching |BufWriteCmd|,
1219 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220
1221 *'casemap'* *'cmp'*
1222'casemap' 'cmp' string (default: "internal,keepascii")
1223 global
1224 {not in Vi}
1225 Specifies details about changing the case of letters. It may contain
1226 these words, separated by a comma:
1227 internal Use internal case mapping functions, the current
1228 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001229 matters when 'encoding' is a Unicode encoding,
1230 "latin1" or "iso-8859-15". When "internal" is
1231 omitted, the towupper() and towlower() system library
1232 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1234 case mapping, the current locale is not effective.
1235 This probably only matters for Turkish.
1236
1237 *'cdpath'* *'cd'* *E344* *E346*
1238'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1239 global
1240 {not in Vi}
1241 {not available when compiled without the
1242 |+file_in_path| feature}
1243 This is a list of directories which will be searched when using the
1244 |:cd| and |:lcd| commands, provided that the directory being searched
1245 for has a relative path (not starting with "/", "./" or "../").
1246 The 'cdpath' option's value has the same form and semantics as
1247 |'path'|. Also see |file-searching|.
1248 The default value is taken from $CDPATH, with a "," prepended to look
1249 in the current directory first.
1250 If the default value taken from $CDPATH is not what you want, include
1251 a modified version of the following command in your vimrc file to
1252 override it: >
1253 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1254< This option cannot be set from a |modeline| or in the |sandbox|, for
1255 security reasons.
1256 (parts of 'cdpath' can be passed to the shell to expand file names).
1257
1258 *'cedit'*
1259'cedit' string (Vi default: "", Vim default: CTRL-F)
1260 global
1261 {not in Vi}
1262 {not available when compiled without the |+vertsplit|
1263 feature}
1264 The key used in Command-line Mode to open the command-line window.
1265 The default is CTRL-F when 'compatible' is off.
1266 Only non-printable keys are allowed.
1267 The key can be specified as a single character, but it is difficult to
1268 type. The preferred way is to use the <> notation. Examples: >
1269 :set cedit=<C-Y>
1270 :set cedit=<Esc>
1271< |Nvi| also has this option, but it only uses the first character.
1272 See |cmdwin|.
1273
1274 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1275'charconvert' 'ccv' string (default "")
1276 global
1277 {only available when compiled with the |+multi_byte|
1278 feature and the |+eval| feature}
1279 {not in Vi}
1280 An expression that is used for character encoding conversion. It is
1281 evaluated when a file that is to be read or has been written has a
1282 different encoding from what is desired.
1283 'charconvert' is not used when the internal iconv() function is
1284 supported and is able to do the conversion. Using iconv() is
1285 preferred, because it is much faster.
1286 'charconvert' is not used when reading stdin |--|, because there is no
1287 file to convert from. You will have to save the text in a file first.
1288 The expression must return zero or an empty string for success,
1289 non-zero for failure.
1290 The possible encoding names encountered are in 'encoding'.
1291 Additionally, names given in 'fileencodings' and 'fileencoding' are
1292 used.
1293 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1294 is done internally by Vim, 'charconvert' is not used for this.
1295 'charconvert' is also used to convert the viminfo file, if the 'c'
1296 flag is present in 'viminfo'. Also used for Unicode conversion.
1297 Example: >
1298 set charconvert=CharConvert()
1299 fun CharConvert()
1300 system("recode "
1301 \ . v:charconvert_from . ".." . v:charconvert_to
1302 \ . " <" . v:fname_in . " >" v:fname_out)
1303 return v:shell_error
1304 endfun
1305< The related Vim variables are:
1306 v:charconvert_from name of the current encoding
1307 v:charconvert_to name of the desired encoding
1308 v:fname_in name of the input file
1309 v:fname_out name of the output file
1310 Note that v:fname_in and v:fname_out will never be the same.
1311 Note that v:charconvert_from and v:charconvert_to may be different
1312 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1313 Encryption is not done by Vim when using 'charconvert'. If you want
1314 to encrypt the file after conversion, 'charconvert' should take care
1315 of this.
1316 This option cannot be set from a |modeline| or in the |sandbox|, for
1317 security reasons.
1318
1319 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1320'cindent' 'cin' boolean (default off)
1321 local to buffer
1322 {not in Vi}
1323 {not available when compiled without the |+cindent|
1324 feature}
1325 Enables automatic C program indenting See 'cinkeys' to set the keys
1326 that trigger reindenting in insert mode and 'cinoptions' to set your
1327 preferred indent style.
1328 If 'indentexpr' is not empty, it overrules 'cindent'.
1329 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1330 the "=" operator indents using this algorithm rather than calling an
1331 external program.
1332 See |C-indenting|.
1333 When you don't like the way 'cindent' works, try the 'smartindent'
1334 option or 'indentexpr'.
1335 This option is not used when 'paste' is set.
1336 NOTE: This option is reset when 'compatible' is set.
1337
1338 *'cinkeys'* *'cink'*
1339'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1340 local to buffer
1341 {not in Vi}
1342 {not available when compiled without the |+cindent|
1343 feature}
1344 A list of keys that, when typed in Insert mode, cause reindenting of
1345 the current line. Only used if 'cindent' is on and 'indentexpr' is
1346 empty.
1347 For the format of this option see |cinkeys-format|.
1348 See |C-indenting|.
1349
1350 *'cinoptions'* *'cino'*
1351'cinoptions' 'cino' string (default "")
1352 local to buffer
1353 {not in Vi}
1354 {not available when compiled without the |+cindent|
1355 feature}
1356 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1357 program. See |cinoptions-values| for the values of this option, and
1358 |C-indenting| for info on C indenting in general.
1359
1360
1361 *'cinwords'* *'cinw'*
1362'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1363 local to buffer
1364 {not in Vi}
1365 {not available when compiled without both the
1366 |+cindent| and the |+smartindent| features}
1367 These keywords start an extra indent in the next line when
1368 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1369 an appropriate place (inside {}).
1370 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1371 matter, include the keyword both the uppercase and lowercase:
1372 "if,If,IF".
1373
1374 *'clipboard'* *'cb'*
1375'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1376 for X-windows, "" otherwise)
1377 global
1378 {not in Vi}
1379 {only in GUI versions or when the |+xterm_clipboard|
1380 feature is included}
1381 This option is a list of comma separated names.
1382 These names are recognized:
1383
1384 unnamed When included, Vim will use the clipboard register '*'
1385 for all yank, delete, change and put operations which
1386 would normally go to the unnamed register. When a
1387 register is explicitly specified, it will always be
1388 used regardless of whether "unnamed" is in 'clipboard'
1389 or not. The clipboard register can always be
1390 explicitly accessed using the "* notation. Also see
1391 |gui-clipboard|.
1392
1393 autoselect Works like the 'a' flag in 'guioptions': If present,
1394 then whenever Visual mode is started, or the Visual
1395 area extended, Vim tries to become the owner of the
1396 windowing system's global selection or put the
1397 selected text on the clipboard used by the selection
1398 register "*. See |guioptions_a| and |quotestar| for
1399 details. When the GUI is active, the 'a' flag in
1400 'guioptions' is used, when the GUI is not active, this
1401 "autoselect" flag is used.
1402 Also applies to the modeless selection.
1403
1404 autoselectml Like "autoselect", but for the modeless selection
1405 only. Compare to the 'A' flag in 'guioptions'.
1406
1407 exclude:{pattern}
1408 Defines a pattern that is matched against the name of
1409 the terminal 'term'. If there is a match, no
1410 connection will be made to the X server. This is
1411 useful in this situation:
1412 - Running Vim in a console.
1413 - $DISPLAY is set to start applications on another
1414 display.
1415 - You do not want to connect to the X server in the
1416 console, but do want this in a terminal emulator.
1417 To never connect to the X server use: >
1418 exclude:.*
1419< This has the same effect as using the |-X| argument.
1420 Note that when there is no connection to the X server
1421 the window title won't be restored and the clipboard
1422 cannot be accessed.
1423 The value of 'magic' is ignored, {pattern} is
1424 interpreted as if 'magic' was on.
1425 The rest of the option value will be used for
1426 {pattern}, this must be the last entry.
1427
1428 *'cmdheight'* *'ch'*
1429'cmdheight' 'ch' number (default 1)
1430 global
1431 {not in Vi}
1432 Number of screen lines to use for the command-line. Helps avoiding
1433 |hit-enter| prompts.
1434
1435 *'cmdwinheight'* *'cwh'*
1436'cmdwinheight' 'cwh' number (default 7)
1437 global
1438 {not in Vi}
1439 {not available when compiled without the |+vertsplit|
1440 feature}
1441 Number of screen lines to use for the command-line window. |cmdwin|
1442
1443 *'columns'* *'co'* *E594*
1444'columns' 'co' number (default 80 or terminal width)
1445 global
1446 {not in Vi}
1447 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001448 initialization and does not have to be set by hand. Also see
1449 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 When Vim is running in the GUI or in a resizable window, setting this
1451 option will cause the window size to be changed. When you only want
1452 to use the size for the GUI, put the command in your |gvimrc| file.
1453 When you set this option and Vim is unable to change the physical
1454 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001455 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456
1457 *'comments'* *'com'* *E524* *E525*
1458'comments' 'com' string (default
1459 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1460 local to buffer
1461 {not in Vi}
1462 {not available when compiled without the |+comments|
1463 feature}
1464 A comma separated list of strings that can start a comment line. See
1465 |format-comments|. See |option-backslash| about using backslashes to
1466 insert a space.
1467
1468 *'commentstring'* *'cms'* *E537*
1469'commentstring' 'cms' string (default "/*%s*/")
1470 local to buffer
1471 {not in Vi}
1472 {not available when compiled without the |+folding|
1473 feature}
1474 A template for a comment. The "%s" in the value is replaced with the
1475 comment text. Currently only used to add markers for folding, see
1476 |fold-marker|.
1477
1478 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001479'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1480 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 global
1482 {not in Vi}
1483 This option has the effect of making Vim either more Vi-compatible, or
1484 make Vim behave in a more useful way.
1485 This is a special kind of option, because when it's set or reset,
1486 other options are also changed as a side effect. CAREFUL: Setting or
1487 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001488 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 set this option in your vimrc file, you should probably put it at the
1490 very start.
1491 By default this option is on and the Vi defaults are used for the
1492 options. This default was chosen for those people who want to use Vim
1493 just like Vi, and don't even (want to) know about the 'compatible'
1494 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001495 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1496 this option is switched off, and all options that have not been
1497 modified will be set to the Vim defaults. Effectively, this means
1498 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1499 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1500 happen for the system-wide vimrc or gvimrc file). Also see
1501 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 You can also set this option with the "-C" argument, and reset it with
1503 "-N". See |-C| and |-N|.
1504 Switching this option off makes the Vim defaults be used for options
1505 that have a different Vi and Vim default value. See the options
1506 marked with a '+' below. Other options are not modified.
1507 At the moment this option is set, several other options will be set
1508 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001509 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 editing.
1511 See also 'cpoptions'.
1512
1513 option + set value effect ~
1514
1515 'allowrevins' off no CTRL-_ command
1516 'backupcopy' Unix: "yes" backup file is a copy
1517 others: "auto" copy or rename backup file
1518 'backspace' "" normal backspace
1519 'backup' off no backup file
1520 'cindent' off no C code indentation
1521 'cedit' + "" no key to open the |cmdwin|
1522 'cpoptions' + (all flags) Vi-compatible flags
1523 'cscopetag' off don't use cscope for ":tag"
1524 'cscopetagorder' 0 see |cscopetagorder|
1525 'cscopeverbose' off see |cscopeverbose|
1526 'digraph' off no digraphs
1527 'esckeys' + off no <Esc>-keys in Insert mode
1528 'expandtab' off tabs not expanded to spaces
1529 'fileformats' + "" no automatic file format detection,
1530 "dos,unix" except for DOS, Windows and OS/2
1531 'formatoptions' + "vt" Vi compatible formatting
1532 'gdefault' off no default 'g' flag for ":s"
1533 'history' + 0 no commandline history
1534 'hkmap' off no Hebrew keyboard mapping
1535 'hkmapp' off no phonetic Hebrew keyboard mapping
1536 'hlsearch' off no highlighting of search matches
1537 'incsearch' off no incremental searching
1538 'indentexpr' "" no indenting by expression
1539 'insertmode' off do not start in Insert mode
1540 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1541 characters and '_'
1542 'joinspaces' on insert 2 spaces after period
1543 'modeline' + off no modelines
1544 'more' + off no pauses in listings
1545 'revins' off no reverse insert
1546 'ruler' off no ruler
1547 'scrolljump' 1 no jump scroll
1548 'scrolloff' 0 no scroll offset
1549 'shiftround' off indent not rounded to shiftwidth
1550 'shortmess' + "" no shortening of messages
1551 'showcmd' + off command characters not shown
1552 'showmode' + off current mode not shown
1553 'smartcase' off no automatic ignore case switch
1554 'smartindent' off no smart indentation
1555 'smarttab' off no smart tab size
1556 'softtabstop' 0 tabs are always 'tabstop' positions
1557 'startofline' on goto startofline with some commands
1558 'tagrelative' + off tag file names are not relative
1559 'textauto' + off no automatic textmode detection
1560 'textwidth' 0 no automatic line wrap
1561 'tildeop' off tilde is not an operator
1562 'ttimeout' off no terminal timeout
1563 'whichwrap' + "" left-right movements don't wrap
1564 'wildchar' + CTRL-E only when the current value is <Tab>
1565 use CTRL-E for cmdline completion
1566 'writebackup' on or off depends on +writebackup feature
1567
1568 *'complete'* *'cpt'* *E535*
1569'complete' 'cpt' string (default: ".,w,b,u,t,i")
1570 local to buffer
1571 {not in Vi}
1572 This option specifies how keyword completion |ins-completion| works
1573 when CTRL-P or CTRL-N are used. It is also used for whole-line
1574 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1575 and the places to scan. It is a comma separated list of flags:
1576 . scan the current buffer ('wrapscan' is ignored)
1577 w scan buffers from other windows
1578 b scan other loaded buffers that are in the buffer list
1579 u scan the unloaded buffers that are in the buffer list
1580 U scan the buffers that are not in the buffer list
1581 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001582 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 k{dict} scan the file {dict}. Several "k" flags can be given,
1584 patterns are valid too. For example: >
1585 :set cpt=k/usr/dict/*,k~/spanish
1586< s scan the files given with the 'thesaurus' option
1587 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1588 are valid too.
1589 i scan current and included files
1590 d scan current and included files for defined name or macro
1591 |i_CTRL-X_CTRL-D|
1592 ] tag completion
1593 t same as "]"
1594
1595 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1596 not executed, this may lead to unexpected completions from some files
1597 (gzipped files for example). Unloaded buffers are not scanned for
1598 whole-line completion.
1599
1600 The default is ".,w,b,u,t,i", which means to scan:
1601 1. the current buffer
1602 2. buffers in other windows
1603 3. other loaded buffers
1604 4. unloaded buffers
1605 5. tags
1606 6. included files
1607
1608 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001609 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1610 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001612 *'completefunc'* *'cfu'*
1613'completefunc' 'cfu' string (default: empty)
1614 local to buffer
1615 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001616 {not available when compiled without the +eval
1617 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001618 This option specifies a function to be used for Insert mode completion
1619 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001620 See |complete-functions| for an explanation of how the function is
1621 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001622
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001623
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001624 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001625'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001626 global
1627 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001628 A comma separated list of options for Insert mode completion
1629 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001630
1631 menu Use a popup menu to show the possible completions. The
1632 menu is only shown when there is more than one match and
1633 sufficient colors are available. |ins-completion-menu|
1634
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001635 menuone Use the popup menu also when there is only one match.
1636 Useful when there is additional information about the
1637 match, e.g., what file it comes from.
1638
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001639 longest Only insert the longest common text of the matches. Use
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001640 CTRL-L to add more characters. Whether case is ignored
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001641 depends on the kind of completion. For buffer text the
1642 'ignorecase' option is used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001643
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001644 preview Show extra information about the currently selected
1645 completion in the preview window.
1646
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001647
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1649'confirm' 'cf' boolean (default off)
1650 global
1651 {not in Vi}
1652 When 'confirm' is on, certain operations that would normally
1653 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1654 instead raise a |dialog| asking if you wish to save the current
1655 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1656 If 'confirm' is off you can still activate confirmation for one
1657 command only (this is most useful in mappings) with the |:confirm|
1658 command.
1659 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1660
1661 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1662'conskey' 'consk' boolean (default off)
1663 global
1664 {not in Vi} {only for MS-DOS}
1665 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001666 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 three methods of console input are available:
1668 'conskey' 'bioskey' action ~
1669 on on or off direct console input
1670 off on BIOS
1671 off off STDIN
1672
1673 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1674'copyindent' 'ci' boolean (default off)
1675 local to buffer
1676 {not in Vi}
1677 Copy the structure of the existing lines indent when autoindenting a
1678 new line. Normally the new indent is reconstructed by a series of
1679 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1680 in which case only spaces are used). Enabling this option makes the
1681 new line copy whatever characters were used for indenting on the
1682 existing line. If the new indent is greater than on the existing
1683 line, the remaining space is filled in the normal manner.
1684 NOTE: 'copyindent' is reset when 'compatible' is set.
1685 Also see 'preserveindent'.
1686
1687 *'cpoptions'* *'cpo'*
1688'cpoptions' 'cpo' string (Vim default: "aABceFs",
1689 Vi default: all flags)
1690 global
1691 {not in Vi}
1692 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001693 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 not being vi-compatible is mostly or sometimes preferred.
1695 'cpoptions' stands for "compatible-options".
1696 Commas can be added for readability.
1697 To avoid problems with flags that are added in the future, use the
1698 "+=" and "-=" feature of ":set" |add-option-flags|.
1699 NOTE: This option is set to the Vi default value when 'compatible' is
1700 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001701 NOTE: This option is set to the POSIX default value at startup when
1702 the Vi default value would be used and the $VIM_POSIX environment
1703 variable exists |posix|. This means tries to behave like the POSIX
1704 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705
1706 contains behavior ~
1707 *cpo-a*
1708 a When included, a ":read" command with a file name
1709 argument will set the alternate file name for the
1710 current window.
1711 *cpo-A*
1712 A When included, a ":write" command with a file name
1713 argument will set the alternate file name for the
1714 current window.
1715 *cpo-b*
1716 b "\|" in a ":map" command is recognized as the end of
1717 the map command. The '\' is included in the mapping,
1718 the text after the '|' is interpreted as the next
1719 command. Use a CTRL-V instead of a backslash to
1720 include the '|' in the mapping. Applies to all
1721 mapping, abbreviation, menu and autocmd commands.
1722 See also |map_bar|.
1723 *cpo-B*
1724 B A backslash has no special meaning in mappings,
1725 abbreviations and the "to" part of the menu commands.
1726 Remove this flag to be able to use a backslash like a
1727 CTRL-V. For example, the command ":map X \<Esc>"
1728 results in X being mapped to:
1729 'B' included: "\^[" (^[ is a real <Esc>)
1730 'B' excluded: "<Esc>" (5 characters)
1731 ('<' excluded in both cases)
1732 *cpo-c*
1733 c Searching continues at the end of any match at the
1734 cursor position, but not further than the start of the
1735 next line. When not present searching continues
1736 one character from the cursor position. With 'c'
1737 "abababababab" only gets three matches when repeating
1738 "/abab", without 'c' there are five matches.
1739 *cpo-C*
1740 C Do not concatenate sourced lines that start with a
1741 backslash. See |line-continuation|.
1742 *cpo-d*
1743 d Using "./" in the 'tags' option doesn't mean to use
1744 the tags file relative to the current file, but the
1745 tags file in the current directory.
1746 *cpo-D*
1747 D Can't use CTRL-K to enter a digraph after Normal mode
1748 commands with a character argument, like |r|, |f| and
1749 |t|.
1750 *cpo-e*
1751 e When executing a register with ":@r", always add a
1752 <CR> to the last line, also when the register is not
1753 linewise. If this flag is not present, the register
1754 is not linewise and the last line does not end in a
1755 <CR>, then the last line is put on the command-line
1756 and can be edited before hitting <CR>.
1757 *cpo-E*
1758 E It is an error when using "y", "d", "c", "g~", "gu" or
1759 "gU" on an Empty region. The operators only work when
1760 at least one character is to be operate on. Example:
1761 This makes "y0" fail in the first column.
1762 *cpo-f*
1763 f When included, a ":read" command with a file name
1764 argument will set the file name for the current buffer,
1765 if the current buffer doesn't have a file name yet.
1766 *cpo-F*
1767 F When included, a ":write" command with a file name
1768 argument will set the file name for the current
1769 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001770 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771 *cpo-g*
1772 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001773 *cpo-H*
1774 H When using "I" on a line with only blanks, insert
1775 before the last blank. Without this flag insert after
1776 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 *cpo-i*
1778 i When included, interrupting the reading of a file will
1779 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001780 *cpo-I*
1781 I When moving the cursor up or down just after inserting
1782 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 *cpo-j*
1784 j When joining lines, only add two spaces after a '.',
1785 not after '!' or '?'. Also see 'joinspaces'.
1786 *cpo-J*
1787 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001788 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 white space.
1790 *cpo-k*
1791 k Disable the recognition of raw key codes in
1792 mappings, abbreviations, and the "to" part of menu
1793 commands. For example, if <Key> sends ^[OA (where ^[
1794 is <Esc>), the command ":map X ^[OA" results in X
1795 being mapped to:
1796 'k' included: "^[OA" (3 characters)
1797 'k' excluded: "<Key>" (one key code)
1798 Also see the '<' flag below.
1799 *cpo-K*
1800 K Don't wait for a key code to complete when it is
1801 halfway a mapping. This breaks mapping <F1><F1> when
1802 only part of the second <F1> has been read. It
1803 enables cancelling the mapping by typing <F1><Esc>.
1804 *cpo-l*
1805 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001806 literally, only "\]", "\^", "\-" and "\\" are special.
1807 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1809 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001810 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 *cpo-L*
1812 L When the 'list' option is set, 'wrapmargin',
1813 'textwidth', 'softtabstop' and Virtual Replace mode
1814 (see |gR|) count a <Tab> as two characters, instead of
1815 the normal behavior of a <Tab>.
1816 *cpo-m*
1817 m When included, a showmatch will always wait half a
1818 second. When not included, a showmatch will wait half
1819 a second or until a character is typed. |'showmatch'|
1820 *cpo-M*
1821 M When excluded, "%" matching will take backslashes into
1822 account. Thus in "( \( )" and "\( ( \)" the outer
1823 parenthesis match. When included "%" ignores
1824 backslashes, which is Vi compatible.
1825 *cpo-n*
1826 n When included, the column used for 'number' will also
1827 be used for text of wrapped lines.
1828 *cpo-o*
1829 o Line offset to search command is not remembered for
1830 next search.
1831 *cpo-O*
1832 O Don't complain if a file is being overwritten, even
1833 when it didn't exist when editing it. This is a
1834 protection against a file unexpectedly created by
1835 someone else. Vi didn't complain about this.
1836 *cpo-p*
1837 p Vi compatible Lisp indenting. When not present, a
1838 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001839 *cpo-P*
1840 P When included, a ":write" command that appends to a
1841 file will set the file name for the current buffer, if
1842 the current buffer doesn't have a file name yet and
1843 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001844 *cpo-q*
1845 q When joining multiple lines leave the cursor at the
1846 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 *cpo-r*
1848 r Redo ("." command) uses "/" to repeat a search
1849 command, instead of the actually used search string.
1850 *cpo-R*
1851 R Remove marks from filtered lines. Without this flag
1852 marks are kept like |:keepmarks| was used.
1853 *cpo-s*
1854 s Set buffer options when entering the buffer for the
1855 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001856 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 set when the buffer is created.
1858 *cpo-S*
1859 S Set buffer options always when entering a buffer
1860 (except 'readonly', 'fileformat', 'filetype' and
1861 'syntax'). This is the (most) Vi compatible setting.
1862 The options are set to the values in the current
1863 buffer. When you change an option and go to another
1864 buffer, the value is copied. Effectively makes the
1865 buffer options global to all buffers.
1866
1867 's' 'S' copy buffer options
1868 no no when buffer created
1869 yes no when buffer first entered (default)
1870 X yes each time when buffer entered (vi comp.)
1871 *cpo-t*
1872 t Search pattern for the tag command is remembered for
1873 "n" command. Otherwise Vim only puts the pattern in
1874 the history for search pattern, but doesn't change the
1875 last used search pattern.
1876 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001877 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 *cpo-v*
1879 v Backspaced characters remain visible on the screen in
1880 Insert mode. Without this flag the characters are
1881 erased from the screen right away. With this flag the
1882 screen newly typed text overwrites backspaced
1883 characters.
1884 *cpo-w*
1885 w When using "cw" on a blank character, only change one
1886 character and not all blanks until the start of the
1887 next word.
1888 *cpo-W*
1889 W Don't overwrite a readonly file. When omitted, ":w!"
1890 overwrites a readonly file, if possible.
1891 *cpo-x*
1892 x <Esc> on the command-line executes the command-line.
1893 The default in Vim is to abandon the command-line,
1894 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001895 *cpo-X*
1896 X When using a count with "R" the replaced text is
1897 deleted only once. Also when repeating "R" with "."
1898 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 *cpo-y*
1900 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001901 *cpo-Z*
1902 Z When using "w!" while the 'readonly' option is set,
1903 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904 *cpo-!*
1905 ! When redoing a filter command, use the last used
1906 external command, whatever it was. Otherwise the last
1907 used -filter- command is used.
1908 *cpo-$*
1909 $ When making a change to one line, don't redisplay the
1910 line, but put a '$' at the end of the changed text.
1911 The changed text will be overwritten when you type the
1912 new text. The line is redisplayed if you type any
1913 command that moves the cursor from the insertion
1914 point.
1915 *cpo-%*
1916 % Vi-compatible matching is done for the "%" command.
1917 Does not recognize "#if", "#endif", etc.
1918 Does not recognize "/*" and "*/".
1919 Parens inside single and double quotes are also
1920 counted, causing a string that contains a paren to
1921 disturb the matching. For example, in a line like
1922 "if (strcmp("foo(", s))" the first paren does not
1923 match the last one. When this flag is not included,
1924 parens inside single and double quotes are treated
1925 specially. When matching a paren outside of quotes,
1926 everything inside quotes is ignored. When matching a
1927 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001928 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001929 This flag is also used for other features, such as
1930 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001931 *cpo--*
1932 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001933 it would go above the first line or below the last
1934 line. Without it the cursor moves to the first or
1935 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001936 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001937 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001938 *cpo-+*
1939 + When included, a ":write file" command will reset the
1940 'modified' flag of the buffer, even though the buffer
1941 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001942 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 * Use ":*" in the same way as ":@". When not included,
1944 ":*" is an alias for ":'<,'>", select the Visual area.
1945 *cpo-<*
1946 < Disable the recognition of special key codes in |<>|
1947 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001948 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949 ":map X <Tab>" results in X being mapped to:
1950 '<' included: "<Tab>" (5 characters)
1951 '<' excluded: "^I" (^I is a real <Tab>)
1952 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001953 *cpo->*
1954 > When appending to a register, put a line break before
1955 the appended text.
1956
1957 POSIX flags. These are not included in the Vi default value, except
1958 when $VIM_POSIX was set on startup. |posix|
1959
1960 contains behavior ~
1961 *cpo-#*
1962 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001963 *cpo-&*
1964 & When ":preserve" was used keep the swap file when
1965 exiting normally while this buffer is still loaded.
1966 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001967 *cpo-\*
1968 \ Backslash in a [] range in a search pattern is taken
1969 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001970 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1971 '\' excluded: "/[ \-]" finds <Space> and '-'
1972 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001973 *cpo-/*
1974 / When "%" is used as the replacement string in a |:s|
1975 command, use the previous replacement string. |:s%|
1976 *cpo-{*
1977 { The |{| and |}| commands also stop at a "{" character
1978 at the start of a line.
1979 *cpo-.*
1980 . The ":chdir" and ":cd" commands fail if the current
1981 buffer is modified, unless ! is used. Vim doesn't
1982 need this, since it remembers the full path of an
1983 opened file.
1984 *cpo-bar*
1985 | The value of the $LINES and $COLUMNS environment
1986 variables overrule the terminal size values obtained
1987 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001988
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989
1990 *'cscopepathcomp'* *'cspc'*
1991'cscopepathcomp' 'cspc' number (default 0)
1992 global
1993 {not available when compiled without the |+cscope|
1994 feature}
1995 {not in Vi}
1996 Determines how many components of the path to show in a list of tags.
1997 See |cscopepathcomp|.
1998
1999 *'cscopeprg'* *'csprg'*
2000'cscopeprg' 'csprg' string (default "cscope")
2001 global
2002 {not available when compiled without the |+cscope|
2003 feature}
2004 {not in Vi}
2005 Specifies the command to execute cscope. See |cscopeprg|.
2006 This option cannot be set from a |modeline| or in the |sandbox|, for
2007 security reasons.
2008
2009 *'cscopequickfix'* *'csqf'*
2010'cscopequickfix' 'csqf' string (default "")
2011 global
2012 {not available when compiled without the |+cscope|
2013 or |+quickfix| features}
2014 {not in Vi}
2015 Specifies whether to use quickfix window to show cscope results.
2016 See |cscopequickfix|.
2017
2018 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2019'cscopetag' 'cst' boolean (default off)
2020 global
2021 {not available when compiled without the |+cscope|
2022 feature}
2023 {not in Vi}
2024 Use cscope for tag commands. See |cscope-options|.
2025 NOTE: This option is reset when 'compatible' is set.
2026
2027 *'cscopetagorder'* *'csto'*
2028'cscopetagorder' 'csto' number (default 0)
2029 global
2030 {not available when compiled without the |+cscope|
2031 feature}
2032 {not in Vi}
2033 Determines the order in which ":cstag" performs a search. See
2034 |cscopetagorder|.
2035 NOTE: This option is set to 0 when 'compatible' is set.
2036
2037 *'cscopeverbose'* *'csverb'*
2038 *'nocscopeverbose'* *'nocsverb'*
2039'cscopeverbose' 'csverb' boolean (default off)
2040 global
2041 {not available when compiled without the |+cscope|
2042 feature}
2043 {not in Vi}
2044 Give messages when adding a cscope database. See |cscopeverbose|.
2045 NOTE: This option is reset when 'compatible' is set.
2046
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002047
2048 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2049'cursorcolumn' 'cuc' boolean (default off)
2050 local to window
2051 {not in Vi}
2052 {not available when compiled without the |+syntax|
2053 feature}
2054 Highlight the screen column of the cursor with CursorColumn
2055 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2056 slower.
2057
2058 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2059'cursorline' 'cul' boolean (default off)
2060 local to window
2061 {not in Vi}
2062 {not available when compiled without the |+syntax|
2063 feature}
2064 Highlight the screen line of the cursor with CursorLine
2065 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2066 redrawing slower.
2067
2068
Bram Moolenaar071d4272004-06-13 20:20:40 +00002069 *'debug'*
2070'debug' string (default "")
2071 global
2072 {not in Vi}
2073 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002074 be given anyway. This is useful when debugging 'foldexpr',
2075 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002076 When set to "beep", a message will be given when otherwise only a beep
2077 would be produced.
2078 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079
2080 *'define'* *'def'*
2081'define' 'def' string (default "^\s*#\s*define")
2082 global or local to buffer |global-local|
2083 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002084 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 pattern, just like for the "/" command. This option is used for the
2086 commands like "[i" and "[d" |include-search|. The 'isident' option is
2087 used to recognize the defined name after the match:
2088 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2089 See |option-backslash| about inserting backslashes to include a space
2090 or backslash.
2091 The default value is for C programs. For C++ this value would be
2092 useful, to include const type declarations: >
2093 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2094< When using the ":set" command, you need to double the backslashes!
2095
2096 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2097'delcombine' 'deco' boolean (default off)
2098 global
2099 {not in Vi}
2100 {only available when compiled with the |+multi_byte|
2101 feature}
2102 If editing Unicode and this option is set, backspace and Normal mode
2103 "x" delete each combining character on its own. When it is off (the
2104 default) the character along with its combining characters are
2105 deleted.
2106 Note: When 'delcombine' is set "xx" may work different from "2x"!
2107
2108 This is useful for Arabic, Hebrew and many other languages where one
2109 may have combining characters overtop of base characters, and want
2110 to remove only the combining ones.
2111
2112 *'dictionary'* *'dict'*
2113'dictionary' 'dict' string (default "")
2114 global or local to buffer |global-local|
2115 {not in Vi}
2116 List of file names, separated by commas, that are used to lookup words
2117 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2118 contain a list of words. This can be one word per line, or several
2119 words per line, separated by non-keyword characters (white space is
2120 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002121 When this option is empty, or an entry "spell" is present, spell
2122 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002123 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 after a comma are ignored, otherwise spaces are included in the file
2125 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002126 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 Where to find a list of words?
2128 - On FreeBSD, there is the file "/usr/share/dict/words".
2129 - In the Simtel archive, look in the "msdos/linguist" directory.
2130 - In "miscfiles" of the GNU collection.
2131 The use of |:set+=| and |:set-=| is preferred when adding or removing
2132 directories from the list. This avoids problems when a future version
2133 uses another default.
2134 Backticks cannot be used in this option for security reasons.
2135
2136 *'diff'* *'nodiff'*
2137'diff' boolean (default off)
2138 local to window
2139 {not in Vi}
2140 {not available when compiled without the |+diff|
2141 feature}
2142 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002143 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144
2145 *'dex'* *'diffexpr'*
2146'diffexpr' 'dex' string (default "")
2147 global
2148 {not in Vi}
2149 {not available when compiled without the |+diff|
2150 feature}
2151 Expression which is evaluated to obtain an ed-style diff file from two
2152 versions of a file. See |diff-diffexpr|.
2153 This option cannot be set from a |modeline| or in the |sandbox|, for
2154 security reasons.
2155
2156 *'dip'* *'diffopt'*
2157'diffopt' 'dip' string (default "filler")
2158 global
2159 {not in Vi}
2160 {not available when compiled without the |+diff|
2161 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002162 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 All are optional. Items must be separated by a comma.
2164
2165 filler Show filler lines, to keep the text
2166 synchronized with a window that has inserted
2167 lines at the same position. Mostly useful
2168 when windows are side-by-side and 'scrollbind'
2169 is set.
2170
2171 context:{n} Use a context of {n} lines between a change
2172 and a fold that contains unchanged lines.
2173 When omitted a context of six lines is used.
2174 See |fold-diff|.
2175
2176 icase Ignore changes in case of text. "a" and "A"
2177 are considered the same. Adds the "-i" flag
2178 to the "diff" command if 'diffexpr' is empty.
2179
2180 iwhite Ignore changes in amount of white space. Adds
2181 the "-b" flag to the "diff" command if
2182 'diffexpr' is empty. Check the documentation
2183 of the "diff" command for what this does
2184 exactly. It should ignore adding trailing
2185 white space, but not leading white space.
2186
2187 Examples: >
2188
2189 :set diffopt=filler,context:4
2190 :set diffopt=
2191 :set diffopt=filler
2192<
2193 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2194'digraph' 'dg' boolean (default off)
2195 global
2196 {not in Vi}
2197 {not available when compiled without the |+digraphs|
2198 feature}
2199 Enable the entering of digraphs in Insert mode with {char1} <BS>
2200 {char2}. See |digraphs|.
2201 NOTE: This option is reset when 'compatible' is set.
2202
2203 *'directory'* *'dir'*
2204'directory' 'dir' string (default for Amiga: ".,t:",
2205 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2206 for Unix: ".,~/tmp,/var/tmp,/tmp")
2207 global
2208 List of directory names for the swap file, separated with commas.
2209 - The swap file will be created in the first directory where this is
2210 possible.
2211 - Empty means that no swap file will be used (recovery is
2212 impossible!).
2213 - A directory "." means to put the swap file in the same directory as
2214 the edited file. On Unix, a dot is prepended to the file name, so
2215 it doesn't show in a directory listing. On MS-Windows the "hidden"
2216 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002217 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 put the swap file relative to where the edited file is. The leading
2219 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002220 - For Unix and Win32, if a directory ends in two path separators "//"
2221 or "\\", the swap file name will be built from the complete path to
2222 the file with all path separators substituted to percent '%' signs.
2223 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 - Spaces after the comma are ignored, other spaces are considered part
2225 of the directory name. To have a space at the start of a directory
2226 name, precede it with a backslash.
2227 - To include a comma in a directory name precede it with a backslash.
2228 - A directory name may end in an ':' or '/'.
2229 - Environment variables are expanded |:set_env|.
2230 - Careful with '\' characters, type one before a space, type two to
2231 get one in the option (see |option-backslash|), for example: >
2232 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2233< - For backwards compatibility with Vim version 3.0 a '>' at the start
2234 of the option is removed.
2235 Using "." first in the list is recommended. This means that editing
2236 the same file twice will result in a warning. Using "/tmp" on Unix is
2237 discouraged: When the system crashes you lose the swap file.
2238 "/var/tmp" is often not cleared when rebooting, thus is a better
2239 choice than "/tmp". But it can contain a lot of files, your swap
2240 files get lost in the crowd. That is why a "tmp" directory in your
2241 home directory is tried first.
2242 The use of |:set+=| and |:set-=| is preferred when adding or removing
2243 directories from the list. This avoids problems when a future version
2244 uses another default.
2245 This option cannot be set from a |modeline| or in the |sandbox|, for
2246 security reasons.
2247 {Vi: directory to put temp file in, defaults to "/tmp"}
2248
2249 *'display'* *'dy'*
2250'display' 'dy' string (default "")
2251 global
2252 {not in Vi}
2253 Change the way text is displayed. This is comma separated list of
2254 flags:
2255 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002256 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 last line that doesn't fit is replaced with "@" lines.
2258 uhex Show unprintable characters hexadecimal as <xx>
2259 instead of using ^C and ~C.
2260
2261 *'eadirection'* *'ead'*
2262'eadirection' 'ead' string (default "both")
2263 global
2264 {not in Vi}
2265 {not available when compiled without the +vertsplit
2266 feature}
2267 Tells when the 'equalalways' option applies:
2268 ver vertically, width of windows is not affected
2269 hor horizontally, height of windows is not affected
2270 both width and height of windows is affected
2271
2272 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2273'edcompatible' 'ed' boolean (default off)
2274 global
2275 Makes the 'g' and 'c' flags of the ":substitute" command to be
2276 toggled each time the flag is given. See |complex-change|. See
2277 also 'gdefault' option.
2278 Switching this option on is discouraged!
2279
2280 *'encoding'* *'enc'* *E543*
2281'encoding' 'enc' string (default: "latin1" or value from $LANG)
2282 global
2283 {only available when compiled with the |+multi_byte|
2284 feature}
2285 {not in Vi}
2286 Sets the character encoding used inside Vim. It applies to text in
2287 the buffers, registers, Strings in expressions, text stored in the
2288 viminfo file, etc. It sets the kind of characters which Vim can work
2289 with. See |encoding-names| for the possible values.
2290
2291 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002292 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 It should normally be kept at its default value, or set when Vim
2294 starts up. See |multibyte|.
2295
2296 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2297 "utf-8". Although care has been taken to allow different values of
2298 'encoding', "utf-8" is the natural choice for the environment and
2299 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002300 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301 versions, and to avoid changing the encoding of newly created files
2302 without your knowledge (in case 'fileencodings' is empty).
2303
2304 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002305 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 iconv() or as specified with 'charconvert'.
2307
2308 Normally 'encoding' will be equal to your current locale. This will
2309 be the default if Vim recognizes your environment settings. If
2310 'encoding' is not set to the current locale, 'termencoding' must be
2311 set to convert typed and displayed text. See |encoding-table|.
2312
2313 When you set this option, it fires the |EncodingChanged| autocommand
2314 event so that you can set up fonts if necessary.
2315
2316 When the option is set, the value is converted to lowercase. Thus
2317 you can set it with uppercase values too. Underscores are translated
2318 to '-' signs.
2319 When the encoding is recognized, it is changed to the standard name.
2320 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2321 "iso-8859-2" and "utf8" becomes "utf-8".
2322
2323 Note: "latin1" is also used when the encoding could not be detected.
2324 This only works when editing files in the same encoding! When the
2325 actual character set is not latin1, make sure 'fileencoding' and
2326 'fileencodings' are empty. When conversion is needed, switch to using
2327 utf-8.
2328
2329 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2330 You don't notice this while editing, but it does matter for the
2331 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2332 setting 'encoding' to one of these values instead of utf-8 only has
2333 effect for encoding used for files when 'fileencoding' is empty.
2334
Bram Moolenaar661b1822005-07-28 22:36:45 +00002335 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2336 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337
2338 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2339'endofline' 'eol' boolean (default on)
2340 local to buffer
2341 {not in Vi}
2342 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002343 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344 option is automatically set when starting to edit a new file, unless
2345 the file does not have an <EOL> for the last line in the file, in
2346 which case it is reset. Normally you don't have to set or reset this
2347 option. When 'binary' is off the value is not used when writing the
2348 file. When 'binary' is on it is used to remember the presence of a
2349 <EOL> for the last line in the file, so that when you write the file
2350 the situation from the original file can be kept. But you can change
2351 it if you want to.
2352
2353 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2354'equalalways' 'ea' boolean (default on)
2355 global
2356 {not in Vi}
2357 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002358 splitting or closing a window. This also happens the moment the
2359 option is switched on. When off, splitting a window will reduce the
2360 size of the current window and leave the other windows the same. When
2361 closing a window the extra lines are given to the window next to it
2362 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 When mixing vertically and horizontally split windows, a minimal size
2364 is computed and some windows may be larger if there is room. The
2365 'eadirection' option tells in which direction the size is affected.
2366 Changing the height of a window can be avoided by setting
2367 'winfixheight'.
2368
2369 *'equalprg'* *'ep'*
2370'equalprg' 'ep' string (default "")
2371 global or local to buffer |global-local|
2372 {not in Vi}
2373 External program to use for "=" command. When this option is empty
2374 the internal formatting functions are used ('lisp', 'cindent' or
2375 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002376 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377 about including spaces and backslashes.
2378 This option cannot be set from a |modeline| or in the |sandbox|, for
2379 security reasons.
2380
2381 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2382'errorbells' 'eb' boolean (default off)
2383 global
2384 Ring the bell (beep or screen flash) for error messages. This only
2385 makes a difference for error messages, the bell will be used always
2386 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002387 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 screen flash or do nothing.
2389
2390 *'errorfile'* *'ef'*
2391'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2392 others: "errors.err")
2393 global
2394 {not in Vi}
2395 {not available when compiled without the |+quickfix|
2396 feature}
2397 Name of the errorfile for the QuickFix mode (see |:cf|).
2398 When the "-q" command-line argument is used, 'errorfile' is set to the
2399 following argument. See |-q|.
2400 NOT used for the ":make" command. See 'makeef' for that.
2401 Environment variables are expanded |:set_env|.
2402 See |option-backslash| about including spaces and backslashes.
2403 This option cannot be set from a |modeline| or in the |sandbox|, for
2404 security reasons.
2405
2406 *'errorformat'* *'efm'*
2407'errorformat' 'efm' string (default is very long)
2408 global or local to buffer |global-local|
2409 {not in Vi}
2410 {not available when compiled without the |+quickfix|
2411 feature}
2412 Scanf-like description of the format for the lines in the error file
2413 (see |errorformat|).
2414
2415 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2416'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2417 global
2418 {not in Vi}
2419 Function keys that start with an <Esc> are recognized in Insert
2420 mode. When this option is off, the cursor and function keys cannot be
2421 used in Insert mode if they start with an <Esc>. The advantage of
2422 this is that the single <Esc> is recognized immediately, instead of
2423 after one second. Instead of resetting this option, you might want to
2424 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2425 when 'esckeys' is off, you can still map anything, but the cursor keys
2426 won't work by default.
2427 NOTE: This option is set to the Vi default value when 'compatible' is
2428 set and to the Vim default value when 'compatible' is reset.
2429
2430 *'eventignore'* *'ei'*
2431'eventignore' 'ei' string (default "")
2432 global
2433 {not in Vi}
2434 {not available when compiled without the |+autocmd|
2435 feature}
2436 A list of autocommand event names, which are to be ignored.
2437 When set to "all", all autocommand events are ignored, autocommands
2438 will not be executed.
2439 Otherwise this is a comma separated list of event names. Example: >
2440 :set ei=WinEnter,WinLeave
2441<
2442 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2443'expandtab' 'et' boolean (default off)
2444 local to buffer
2445 {not in Vi}
2446 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002447 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2449 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2450 NOTE: This option is reset when 'compatible' is set.
2451
2452 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2453'exrc' 'ex' boolean (default off)
2454 global
2455 {not in Vi}
2456 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2457 directory. If you switch this option on you should also consider
2458 setting the 'secure' option (see |initialization|). Using a local
2459 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2460 also see |.vimrc| and |gui-init|.
2461 This option cannot be set from a |modeline| or in the |sandbox|, for
2462 security reasons.
2463
2464 *'fileencoding'* *'fenc'* *E213*
2465'fileencoding' 'fenc' string (default: "")
2466 local to buffer
2467 {only available when compiled with the |+multi_byte|
2468 feature}
2469 {not in Vi}
2470 Sets the character encoding for the file of this buffer.
2471 When 'fileencoding' is different from 'encoding', conversion will be
2472 done when reading and writing the file.
2473 When 'fileencoding' is empty, the same value as 'encoding' will be
2474 used (no conversion when reading or writing a file).
2475 WARNING: Conversion can cause loss of information! When
2476 'encoding' is "utf-8" conversion is most likely done in a way
2477 that the reverse conversion results in the same text. When
2478 'encoding' is not "utf-8" some characters may be lost!
2479 See 'encoding' for the possible values. Additionally, values may be
2480 specified that can be handled by the converter, see
2481 |mbyte-conversion|.
2482 When reading a file 'fileencoding' will be set from 'fileencodings'.
2483 To read a file in a certain encoding it won't work by setting
2484 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002485 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2487 When the option is set, the value is converted to lowercase. Thus
2488 you can set it with uppercase values too. '_' characters are
2489 replaced with '-'. If a name is recognized from the list for
2490 'encoding', it is replaced by the standard name. For example
2491 "ISO8859-2" becomes "iso-8859-2".
2492 When this option is set, after starting to edit a file, the 'modified'
2493 option is set, because the file would be different when written.
2494 If you do this in a modeline, you might want to set 'nomodified' to
2495 avoid this.
2496 This option can not be changed when 'modifiable' is off.
2497
2498 *'fe'*
2499 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002500 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 old short name was 'fe', which is no longer used.
2502
2503 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002504'fileencodings' 'fencs' string (default: "ucs-bom",
2505 "ucs-bom,utf-8,default,latin1" when
2506 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 global
2508 {only available when compiled with the |+multi_byte|
2509 feature}
2510 {not in Vi}
2511 This is a list of character encodings considered when starting to edit
2512 an existing file. When a file is read, Vim tries to use the first
2513 mentioned character encoding. If an error is detected, the next one
2514 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002515 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 an empty string, which means the value of 'encoding' is used.
2517 WARNING: Conversion can cause loss of information! When
2518 'encoding' is "utf-8" (or one of the other Unicode variants)
2519 conversion is most likely done in a way that the reverse
2520 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002521 "utf-8" some non-ASCII characters may be lost! You can use
2522 the |++bad| argument to specify what is done with characters
2523 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 For an empty file or a file with only ASCII characters most encodings
2525 will work and the first entry of 'fileencodings' will be used (except
2526 "ucs-bom", which requires the BOM to be present). If you prefer
2527 another encoding use an BufReadPost autocommand event to test if your
2528 preferred encoding is to be used. Example: >
2529 au BufReadPost * if search('\S', 'w') == 0 |
2530 \ set fenc=iso-2022-jp | endif
2531< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2532 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002533 When the |++enc| argument is used then the value of 'fileencodings' is
2534 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002535 Note that 'fileencodings' is not used for a new file, the global value
2536 of 'fileencoding' is used instead. You can set it with: >
2537 :setglobal fenc=iso-8859-2
2538< This means that a non-existing file may get a different encoding than
2539 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 The special value "ucs-bom" can be used to check for a Unicode BOM
2541 (Byte Order Mark) at the start of the file. It must not be preceded
2542 by "utf-8" or another Unicode encoding for this to work properly.
2543 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2544 because Vim cannot detect an error, thus the encoding is always
2545 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002546 The special value "default" can be used for the encoding from the
2547 environment. This is the default value for 'encoding'. It is useful
2548 when 'encoding' is set to "utf-8" and your environment uses a
2549 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 WRONG VALUES: WHAT'S WRONG:
2551 latin1,utf-8 "latin1" will always be used
2552 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2553 file
2554 cp1250,latin1 "cp1250" will always be used
2555 If 'fileencodings' is empty, 'fileencoding' is not modified.
2556 See 'fileencoding' for the possible values.
2557 Setting this option does not have an effect until the next time a file
2558 is read.
2559
2560 *'fileformat'* *'ff'*
2561'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2562 Unix default: "unix",
2563 Macintosh default: "mac")
2564 local to buffer
2565 {not in Vi}
2566 This gives the <EOL> of the current buffer, which is used for
2567 reading/writing the buffer from/to a file:
2568 dos <CR> <NL>
2569 unix <NL>
2570 mac <CR>
2571 When "dos" is used, CTRL-Z at the end of a file is ignored.
2572 See |file-formats| and |file-read|.
2573 For the character encoding of the file see 'fileencoding'.
2574 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2575 works like it was set to "unix'.
2576 This option is set automatically when starting to edit a file and
2577 'fileformats' is not empty and 'binary' is off.
2578 When this option is set, after starting to edit a file, the 'modified'
2579 option is set, because the file would be different when written.
2580 This option can not be changed when 'modifiable' is off.
2581 For backwards compatibility: When this option is set to "dos",
2582 'textmode' is set, otherwise 'textmode' is reset.
2583
2584 *'fileformats'* *'ffs'*
2585'fileformats' 'ffs' string (default:
2586 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2587 Vim Unix: "unix,dos",
2588 Vim Mac: "mac,unix,dos",
2589 Vi Cygwin: "unix,dos",
2590 Vi others: "")
2591 global
2592 {not in Vi}
2593 This gives the end-of-line (<EOL>) formats that will be tried when
2594 starting to edit a new buffer and when reading a file into an existing
2595 buffer:
2596 - When empty, the format defined with 'fileformat' will be used
2597 always. It is not set automatically.
2598 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002599 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 'fileformats' name will be used when a file is read into an existing
2601 buffer, no matter what 'fileformat' for that buffer is set to.
2602 - When more than one name is present, separated by commas, automatic
2603 <EOL> detection will be done when reading a file. When starting to
2604 edit a file, a check is done for the <EOL>:
2605 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2606 'fileformat' is set to "dos".
2607 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002608 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 preceding <CR>, "unix" is preferred over "dos".
2610 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2611 This means that "mac" is only chosen when "unix" is not present,
2612 or when no <NL> is found in the file, and when "dos" is not
2613 present, or no <CR><NL> is present in the file.
2614 Also if "unix" was first chosen, but the first <CR> is before
2615 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2616 the file, then 'fileformat' is set to "mac".
2617 4. If 'fileformat' is still not set, the first name from
2618 'fileformats' is used.
2619 When reading a file into an existing buffer, the same is done, but
2620 this happens like 'fileformat' has been set appropriately for that
2621 file only, the option is not changed.
2622 When 'binary' is set, the value of 'fileformats' is not used.
2623
2624 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2625 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2626 done:
2627 - When 'fileformats' is empty, there is no automatic detection. Dos
2628 format will be used.
2629 - When 'fileformats' is set to one or more names, automatic detection
2630 is done. This is based on the first <NL> in the file: If there is a
2631 <CR> in front of it, Dos format is used, otherwise Unix format is
2632 used.
2633 Also see |file-formats|.
2634 For backwards compatibility: When this option is set to an empty
2635 string or one format (no comma is included), 'textauto' is reset,
2636 otherwise 'textauto' is set.
2637 NOTE: This option is set to the Vi default value when 'compatible' is
2638 set and to the Vim default value when 'compatible' is reset.
2639
2640 *'filetype'* *'ft'*
2641'filetype' 'ft' string (default: "")
2642 local to buffer
2643 {not in Vi}
2644 {not available when compiled without the |+autocmd|
2645 feature}
2646 When this option is set, the FileType autocommand event is triggered.
2647 All autocommands that match with the value of this option will be
2648 executed. Thus the value of 'filetype' is used in place of the file
2649 name.
2650 Otherwise this option does not always reflect the current file type.
2651 This option is normally set when the file type is detected. To enable
2652 this use the ":filetype on" command. |:filetype|
2653 Setting this option to a different value is most useful in a modeline,
2654 for a file for which the file type is not automatically recognized.
2655 Example, for in an IDL file: >
2656 /* vim: set filetype=idl : */
2657< |FileType| |filetypes|
2658 Do not confuse this option with 'osfiletype', which is for the file
2659 type that is actually stored with the file.
2660 This option is not copied to another buffer, independent of the 's' or
2661 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002662 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663
2664 *'fillchars'* *'fcs'*
2665'fillchars' 'fcs' string (default "vert:|,fold:-")
2666 global
2667 {not in Vi}
2668 {not available when compiled without the |+windows|
2669 and |+folding| features}
2670 Characters to fill the statuslines and vertical separators.
2671 It is a comma separated list of items:
2672
2673 item default Used for ~
2674 stl:c ' ' or '^' statusline of the current window
2675 stlnc:c ' ' or '-' statusline of the non-current windows
2676 vert:c '|' vertical separators |:vsplit|
2677 fold:c '-' filling 'foldtext'
2678 diff:c '-' deleted lines of the 'diff' option
2679
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002680 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 "stlnc" the space will be used when there is highlighting, '^' or '-'
2682 otherwise.
2683
2684 Example: >
2685 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2686< This is similar to the default, except that these characters will also
2687 be used when there is highlighting.
2688
2689 The highlighting used for these items:
2690 item highlight group ~
2691 stl:c StatusLine |hl-StatusLine|
2692 stlnc:c StatusLineNC |hl-StatusLineNC|
2693 vert:c VertSplit |hl-VertSplit|
2694 fold:c Folded |hl-Folded|
2695 diff:c DiffDelete |hl-DiffDelete|
2696
2697 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2698'fkmap' 'fk' boolean (default off) *E198*
2699 global
2700 {not in Vi}
2701 {only available when compiled with the |+rightleft|
2702 feature}
2703 When on, the keyboard is mapped for the Farsi character set.
2704 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002705 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706
2707 *'foldclose'* *'fcl'*
2708'foldclose' 'fcl' string (default "")
2709 global
2710 {not in Vi}
2711 {not available when compiled without the |+folding|
2712 feature}
2713 When set to "all", a fold is closed when the cursor isn't in it and
2714 its level is higher than 'foldlevel'. Useful if you want folds to
2715 automatically close when moving out of them.
2716
2717 *'foldcolumn'* *'fdc'*
2718'foldcolumn' 'fdc' number (default 0)
2719 local to window
2720 {not in Vi}
2721 {not available when compiled without the |+folding|
2722 feature}
2723 When non-zero, a column with the specified width is shown at the side
2724 of the window which indicates open and closed folds. The maximum
2725 value is 12.
2726 See |folding|.
2727
2728 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2729'foldenable' 'fen' boolean (default on)
2730 local to window
2731 {not in Vi}
2732 {not available when compiled without the |+folding|
2733 feature}
2734 When off, all folds are open. This option can be used to quickly
2735 switch between showing all text unfolded and viewing the text with
2736 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002737 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 'foldenable' is off.
2739 This option is set by commands that create a new fold or close a fold.
2740 See |folding|.
2741
2742 *'foldexpr'* *'fde'*
2743'foldexpr' 'fde' string (default: "0")
2744 local to window
2745 {not in Vi}
2746 {not available when compiled without the |+folding|
2747 or |+eval| feature}
2748 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002749 for each line to obtain its fold level. See |fold-expr|.
2750
2751 The expression may be evaluated in the |sandbox|, see
2752 |sandbox-option|.
2753
2754 It is not allowed to change text or jump to another window while
2755 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756
2757 *'foldignore'* *'fdi'*
2758'foldignore' 'fdi' string (default: "#")
2759 local to window
2760 {not in Vi}
2761 {not available when compiled without the |+folding|
2762 feature}
2763 Used only when 'foldmethod' is "indent". Lines starting with
2764 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002765 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 The default "#" works well for C programs. See |fold-indent|.
2767
2768 *'foldlevel'* *'fdl'*
2769'foldlevel' 'fdl' number (default: 0)
2770 local to window
2771 {not in Vi}
2772 {not available when compiled without the |+folding|
2773 feature}
2774 Sets the fold level: Folds with a higher level will be closed.
2775 Setting this option to zero will close all folds. Higher numbers will
2776 close fewer folds.
2777 This option is set by commands like |zm|, |zM| and |zR|.
2778 See |fold-foldlevel|.
2779
2780 *'foldlevelstart'* *'fdls'*
2781'foldlevelstart' 'fdls' number (default: -1)
2782 global
2783 {not in Vi}
2784 {not available when compiled without the |+folding|
2785 feature}
2786 Sets 'foldlevel' when starting to edit another buffer in a window.
2787 Useful to always start editing with all folds closed (value zero),
2788 some folds closed (one) or no folds closed (99).
2789 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002790 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 ignores this option and closes all folds.
2792 It is also done before BufReadPre autocommands, to allow an autocmd to
2793 overrule the 'foldlevel' value for specific files.
2794 When the value is negative, it is not used.
2795
2796 *'foldmarker'* *'fmr'* *E536*
2797'foldmarker' 'fmr' string (default: "{{{,}}}")
2798 local to window
2799 {not in Vi}
2800 {not available when compiled without the |+folding|
2801 feature}
2802 The start and end marker used when 'foldmethod' is "marker". There
2803 must be one comma, which separates the start and end marker. The
2804 marker is a literal string (a regular expression would be too slow).
2805 See |fold-marker|.
2806
2807 *'foldmethod'* *'fdm'*
2808'foldmethod' 'fdm' string (default: "manual")
2809 local to window
2810 {not in Vi}
2811 {not available when compiled without the |+folding|
2812 feature}
2813 The kind of folding used for the current window. Possible values:
2814 |fold-manual| manual Folds are created manually.
2815 |fold-indent| indent Lines with equal indent form a fold.
2816 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2817 |fold-marker| marker Markers are used to specify folds.
2818 |fold-syntax| syntax Syntax highlighting items specify folds.
2819 |fold-diff| diff Fold text that is not changed.
2820
2821 *'foldminlines'* *'fml'*
2822'foldminlines' 'fml' number (default: 1)
2823 local to window
2824 {not in Vi}
2825 {not available when compiled without the |+folding|
2826 feature}
2827 Sets the minimum number of screen lines for a fold to be displayed
2828 closed. Also for manually closed folds.
2829 Note that this only has an effect of what is displayed. After using
2830 "zc" to close a fold, which is displayed open because it's smaller
2831 than 'foldminlines', a following "zc" may close a containing fold.
2832
2833 *'foldnestmax'* *'fdn'*
2834'foldnestmax' 'fdn' number (default: 20)
2835 local to window
2836 {not in Vi}
2837 {not available when compiled without the |+folding|
2838 feature}
2839 Sets the maximum nesting of folds for the "indent" and "syntax"
2840 methods. This avoids that too many folds will be created. Using more
2841 than 20 doesn't work, because the internal limit is 20.
2842
2843 *'foldopen'* *'fdo'*
2844'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2845 search,tag,undo")
2846 global
2847 {not in Vi}
2848 {not available when compiled without the |+folding|
2849 feature}
2850 Specifies for which type of commands folds will be opened, if the
2851 command moves the cursor into a closed fold. It is a comma separated
2852 list of items.
2853 item commands ~
2854 all any
2855 block "(", "{", "[[", "[{", etc.
2856 hor horizontal movements: "l", "w", "fx", etc.
2857 insert any command in Insert mode
2858 jump far jumps: "G", "gg", etc.
2859 mark jumping to a mark: "'m", CTRL-O, etc.
2860 percent "%"
2861 quickfix ":cn", ":crew", ":make", etc.
2862 search search for a pattern: "/", "n", "*", "gd", etc.
2863 (not for a search pattern in a ":" command)
2864 tag jumping to a tag: ":ta", CTRL-T, etc.
2865 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002866 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 the |zv| command to the mapping to get the same effect.
2868 When a movement command is used for an operator (e.g., "dl" or "y%")
2869 this option is not used. This means the operator will include the
2870 whole closed fold.
2871 Note that vertical movements are not here, because it would make it
2872 very difficult to move onto a closed fold.
2873 In insert mode the folds containing the cursor will always be open
2874 when text is inserted.
2875 To close folds you can re-apply 'foldlevel' with the |zx| command or
2876 set the 'foldclose' option to "all".
2877
2878 *'foldtext'* *'fdt'*
2879'foldtext' 'fdt' string (default: "foldtext()")
2880 local to window
2881 {not in Vi}
2882 {not available when compiled without the |+folding|
2883 feature}
2884 An expression which is used to specify the text displayed for a closed
2885 fold. See |fold-foldtext|.
2886
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002887 The expression may be evaluated in the |sandbox|, see
2888 |sandbox-option|.
2889
2890 It is not allowed to change text or jump to another window while
2891 evaluating 'foldtext' |textlock|.
2892
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 *'formatoptions'* *'fo'*
2894'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2895 local to buffer
2896 {not in Vi}
2897 This is a sequence of letters which describes how automatic
2898 formatting is to be done. See |fo-table|. When the 'paste' option is
2899 on, no formatting is done (like 'formatoptions' is empty). Commas can
2900 be inserted for readability.
2901 To avoid problems with flags that are added in the future, use the
2902 "+=" and "-=" feature of ":set" |add-option-flags|.
2903 NOTE: This option is set to the Vi default value when 'compatible' is
2904 set and to the Vim default value when 'compatible' is reset.
2905
Bram Moolenaar86b68352004-12-27 21:59:20 +00002906 *'formatlistpat'* *'flp'*
2907'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2908 local to buffer
2909 {not in Vi}
2910 A pattern that is used to recognize a list header. This is used for
2911 the "n" flag in 'formatoptions'.
2912 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002913 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002914 while still checking more characters. There must be a character
2915 following the pattern, when it matches the whole line it is handled
2916 like there is no match.
2917 The default recognizes a number, followed by an optional punctuation
2918 character and white space.
2919
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 *'formatprg'* *'fp'*
2921'formatprg' 'fp' string (default "")
2922 global
2923 {not in Vi}
2924 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002925 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002927 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002928 If the 'formatexpr' option is not empty it will be used instead.
2929 Otherwise, if 'formatprg' option is an empty string, the internal
2930 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002931 Environment variables are expanded |:set_env|. See |option-backslash|
2932 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002933 The expression may be evaluated in the |sandbox|, see
2934 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002936 *'formatexpr'* *'fex'*
2937'formatexpr' 'fex' string (default "")
2938 local to buffer
2939 {not in Vi}
2940 {not available when compiled without the |+eval|
2941 feature}
2942 Expression which is evaluated to format a range of lines for the |gq|
2943 operator. The |v:lnum| variable holds the first line to be formatted,
2944 |v:count| the number of lines to be formatted.
2945 When this option is empty 'formatprg' is used.
2946 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002947 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002948< This will invoke the mylang#Format() function in the
2949 autoload/mylang.vim file in 'runtimepath'. |autoload|
2950
2951 The expression is also evaluated when 'textwidth' is set and adding
2952 text beyond that limit. This happens under the same conditions as
2953 when internal formatting is used. Make sure the cursor is kept in the
2954 same spot relative to the text then! The |mode()| function will
2955 return "i" or "R" in this situation. When the function returns
2956 non-zero Vim will fall back to using the internal format mechanism.
2957
2958 The expression may be evaluated in the |sandbox|, see
2959 |sandbox-option|.
2960
2961 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002962'fsync' 'fs' boolean (default on)
2963 global
2964 {not in Vi}
2965 When on, the library function fsync() will be called after writing a
2966 file. This will flush a file to disk, ensuring that it is safely
2967 written even on filesystems which do metadata-only journaling. This
2968 will force the harddrive to spin up on Linux systems running in laptop
2969 mode, so it may be undesirable in some situations. Be warned that
2970 turning this off increases the chances of data loss after a crash. On
2971 systems without an fsync() implementation, this variable is always
2972 off.
2973 Also see 'swapsync' for controlling fsync() on swap files.
2974
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2976'gdefault' 'gd' boolean (default off)
2977 global
2978 {not in Vi}
2979 When on, the ":substitute" flag 'g' is default on. This means that
2980 all matches in a line are substituted instead of one. When a 'g' flag
2981 is given to a ":substitute" command, this will toggle the substitution
2982 of all or one match. See |complex-change|.
2983
2984 command 'gdefault' on 'gdefault' off ~
2985 :s/// subst. all subst. one
2986 :s///g subst. one subst. all
2987 :s///gg subst. all subst. one
2988
2989 NOTE: This option is reset when 'compatible' is set.
2990
2991 *'grepformat'* *'gfm'*
2992'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2993 global
2994 {not in Vi}
2995 Format to recognize for the ":grep" command output.
2996 This is a scanf-like string that uses the same format as the
2997 'errorformat' option: see |errorformat|.
2998
2999 *'grepprg'* *'gp'*
3000'grepprg' 'gp' string (default "grep -n ",
3001 Unix: "grep -n $* /dev/null",
3002 Win32: "findstr /n" or "grep -n",
3003 VMS: "SEARCH/NUMBERS ")
3004 global or local to buffer |global-local|
3005 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003006 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 and '#' characters, which are expanded like when used in a command-
3008 line. The placeholder "$*" is allowed to specify where the arguments
3009 will be included. Environment variables are expanded |:set_env|. See
3010 |option-backslash| about including spaces and backslashes.
3011 When your "grep" accepts the "-H" argument, use this to make ":grep"
3012 also work well with a single file: >
3013 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003014< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003015 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3016 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003017 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 apply equally to 'grepprg'.
3019 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3020 otherwise it's "grep -n".
3021 This option cannot be set from a |modeline| or in the |sandbox|, for
3022 security reasons.
3023
3024 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3025'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3026 ve:ver35-Cursor,
3027 o:hor50-Cursor,
3028 i-ci:ver25-Cursor/lCursor,
3029 r-cr:hor20-Cursor/lCursor,
3030 sm:block-Cursor
3031 -blinkwait175-blinkoff150-blinkon175",
3032 for MS-DOS and Win32 console:
3033 "n-v-c:block,o:hor50,i-ci:hor15,
3034 r-cr:hor30,sm:block")
3035 global
3036 {not in Vi}
3037 {only available when compiled with GUI enabled, and
3038 for MS-DOS and Win32 console}
3039 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003040 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 the height of the cursor can be changed. This can be done by
3042 specifying a block cursor, or a percentage for a vertical or
3043 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003044 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003046 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 mode-list and an argument-list:
3048 mode-list:argument-list,mode-list:argument-list,..
3049 The mode-list is a dash separated list of these modes:
3050 n Normal mode
3051 v Visual mode
3052 ve Visual mode with 'selection' "exclusive" (same as 'v',
3053 if not specified)
3054 o Operator-pending mode
3055 i Insert mode
3056 r Replace mode
3057 c Command-line Normal (append) mode
3058 ci Command-line Insert mode
3059 cr Command-line Replace mode
3060 sm showmatch in Insert mode
3061 a all modes
3062 The argument-list is a dash separated list of these arguments:
3063 hor{N} horizontal bar, {N} percent of the character height
3064 ver{N} vertical bar, {N} percent of the character width
3065 block block cursor, fills the whole character
3066 [only one of the above three should be present]
3067 blinkwait{N} *cursor-blinking*
3068 blinkon{N}
3069 blinkoff{N}
3070 blink times for cursor: blinkwait is the delay before
3071 the cursor starts blinking, blinkon is the time that
3072 the cursor is shown and blinkoff is the time that the
3073 cursor is not shown. The times are in msec. When one
3074 of the numbers is zero, there is no blinking. The
3075 default is: "blinkwait700-blinkon400-blinkoff250".
3076 These numbers are used for a missing entry. This
3077 means that blinking is enabled by default. To switch
3078 blinking off you can use "blinkon0". The cursor only
3079 blinks when Vim is waiting for input, not while
3080 executing a command.
3081 To make the cursor blink in an xterm, see
3082 |xterm-blink|.
3083 {group-name}
3084 a highlight group name, that sets the color and font
3085 for the cursor
3086 {group-name}/{group-name}
3087 Two highlight group names, the first is used when
3088 no language mappings are used, the other when they
3089 are. |language-mapping|
3090
3091 Examples of parts:
3092 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3093 block cursor with colors from the "nCursor"
3094 highlight group
3095 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3096 In Insert and Command-line Insert mode, use a
3097 30% vertical bar cursor with colors from the
3098 "iCursor" highlight group. Blink a bit
3099 faster.
3100
3101 The 'a' mode is different. It will set the given argument-list for
3102 all modes. It does not reset anything to defaults. This can be used
3103 to do a common setting for all modes. For example, to switch off
3104 blinking: "a:blinkon0"
3105
3106 Examples of cursor highlighting: >
3107 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3108 :highlight Cursor gui=NONE guifg=bg guibg=fg
3109<
3110 *'guifont'* *'gfn'*
3111 *E235* *E596* *E610* *E611*
3112'guifont' 'gfn' string (default "")
3113 global
3114 {not in Vi}
3115 {only available when compiled with GUI enabled}
3116 This is a list of fonts which will be used for the GUI version of Vim.
3117 In its simplest form the value is just one font name. When
3118 the font cannot be found you will get an error message. To try other
3119 font names a list can be specified, font names separated with commas.
3120 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003121
Bram Moolenaar05159a02005-02-26 23:04:13 +00003122 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3123 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003124
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 Spaces after a comma are ignored. To include a comma in a font name
3126 precede it with a backslash. Setting an option requires an extra
3127 backslash before a space and a backslash. See also
3128 |option-backslash|. For example: >
3129 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003130< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003132
3133 If none of the fonts can be loaded, Vim will keep the current setting.
3134 If an empty font list is given, Vim will try using other resource
3135 settings (for X, it will use the Vim.font resource), and finally it
3136 will try some builtin default which should always be there ("7x13" in
3137 the case of X). The font names given should be "normal" fonts. Vim
3138 will try to find the related bold and italic fonts.
3139
Bram Moolenaar05159a02005-02-26 23:04:13 +00003140 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003141 :set guifont=*
3142< will bring up a font requester, where you can pick the font you want.
3143
3144 The font name depends on the GUI used. See |setting-guifont| for a
3145 way to set 'guifont' for various systems.
3146
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 For the GTK+ 2 GUI the font name looks like this: >
3148 :set guifont=Andale\ Mono\ 11
3149< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003150
3151 For Mac OSX you can use something like this: >
3152 :set guifont=Monaco:h10
3153< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003155 width). An exception is GTK 2: all fonts are accepted, but
3156 mono-spaced fonts look best.
3157
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 To preview a font on X11, you might be able to use the "xfontsel"
3159 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003160
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 For the Win32 GUI *E244* *E245*
3162 - takes these options in the font name:
3163 hXX - height is XX (points, can be floating-point)
3164 wXX - width is XX (points, can be floating-point)
3165 b - bold
3166 i - italic
3167 u - underline
3168 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003169 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3171 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3172 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003173 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174
3175 Use a ':' to separate the options.
3176 - A '_' can be used in the place of a space, so you don't need to use
3177 backslashes to escape the spaces.
3178 - Examples: >
3179 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3180 :set guifont=Andale_Mono:h7.5:w4.5
3181< See also |font-sizes|.
3182
3183 *'guifontset'* *'gfs'*
3184 *E250* *E252* *E234* *E597* *E598*
3185'guifontset' 'gfs' string (default "")
3186 global
3187 {not in Vi}
3188 {only available when compiled with GUI enabled and
3189 with the |+xfontset| feature}
3190 {not available in the GTK+ 2 GUI}
3191 When not empty, specifies two (or more) fonts to be used. The first
3192 one for normal English, the second one for your special language. See
3193 |xfontset|.
3194 Setting this option also means that all font names will be handled as
3195 a fontset name. Also the ones used for the "font" argument of the
3196 |:highlight| command.
3197 The fonts must match with the current locale. If fonts for the
3198 character sets that the current locale uses are not included, setting
3199 'guifontset' will fail.
3200 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3201 the comma-separated names are alternative names, one of which will be
3202 used. In 'guifontset' the whole string is one fontset name,
3203 including the commas. It is not possible to specify alternative
3204 fontset names.
3205 This example works on many X11 systems: >
3206 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3207<
3208 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3209'guifontwide' 'gfw' string (default "")
3210 global
3211 {not in Vi}
3212 {only available when compiled with GUI enabled}
3213 When not empty, specifies a comma-separated list of fonts to be used
3214 for double-width characters. The first font that can be loaded is
3215 used.
3216 Note: The size of these fonts must be exactly twice as wide as the one
3217 specified with 'guifont' and the same height.
3218
3219 All GUI versions but GTK+ 2:
3220
3221 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3222 'guifontset' is empty or invalid.
3223 When 'guifont' is set and a valid font is found in it and
3224 'guifontwide' is empty Vim will attempt to find a matching
3225 double-width font and set 'guifontwide' to it.
3226
3227 GTK+ 2 GUI only: *guifontwide_gtk2*
3228
3229 If set and valid, 'guifontwide' is always used for double width
3230 characters, even if 'encoding' is not set to "utf-8".
3231 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003232 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 font for characters not available in 'guifont'. Thus you do not need
3234 to set 'guifontwide' at all unless you want to override the choice
3235 made by Pango/Xft.
3236
3237 *'guiheadroom'* *'ghr'*
3238'guiheadroom' 'ghr' number (default 50)
3239 global
3240 {not in Vi} {only for GTK and X11 GUI}
3241 The number of pixels subtracted from the screen height when fitting
3242 the GUI window on the screen. Set this before the GUI is started,
3243 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003244 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 lines will be left for window decorations and other items on the
3246 screen. Set it to a negative value to allow windows taller than the
3247 screen.
3248
3249 *'guioptions'* *'go'*
3250'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003251 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 global
3253 {not in Vi}
3254 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003255 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 sequence of letters which describes what components and options of the
3257 GUI should be used.
3258 To avoid problems with flags that are added in the future, use the
3259 "+=" and "-=" feature of ":set" |add-option-flags|.
3260
3261 Valid letters are as follows:
3262 *guioptions_a*
3263 'a' Autoselect: If present, then whenever VISUAL mode is started,
3264 or the Visual area extended, Vim tries to become the owner of
3265 the windowing system's global selection. This means that the
3266 Visually highlighted text is available for pasting into other
3267 applications as well as into Vim itself. When the Visual mode
3268 ends, possibly due to an operation on the text, or when an
3269 application wants to paste the selection, the highlighted text
3270 is automatically yanked into the "* selection register.
3271 Thus the selection is still available for pasting into other
3272 applications after the VISUAL mode has ended.
3273 If not present, then Vim won't become the owner of the
3274 windowing system's global selection unless explicitly told to
3275 by a yank or delete operation for the "* register.
3276 The same applies to the modeless selection.
3277
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003278 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 applies to the modeless selection.
3280
3281 'guioptions' autoselect Visual autoselect modeless ~
3282 "" - -
3283 "a" yes yes
3284 "A" - yes
3285 "aA" yes yes
3286
3287 'c' Use console dialogs instead of popup dialogs for simple
3288 choices.
3289
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003290 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003291 'guitablabel' can be used to change the text in the labels.
3292 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003293 The GUI tabs are only supported on some systens, currently
3294 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003295
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 'f' Foreground: Don't use fork() to detach the GUI from the shell
3297 where it was started. Use this for programs that wait for the
3298 editor to finish (e.g., an e-mail program). Alternatively you
3299 can use "gvim -f" or ":gui -f" to start the GUI in the
3300 foreground. |gui-fork|
3301 Note: Set this option in the vimrc file. The forking may have
3302 happened already when the gvimrc file is read.
3303
3304 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3305 corner of the window. It's black&white on non-GTK, because of
3306 limitations of X11. For a color icon, see |X11-icon|.
3307
3308 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003309 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 that this flag must be added in the .vimrc file, before
3311 switching on syntax or filetype recognition (when the .gvimrc
3312 file is sourced the system menu has already been loaded; the
3313 ":syntax on" and ":filetype on" commands load the menu too).
3314 'g' Grey menu items: Make menu items that are not active grey. If
3315 'g' is not included inactive menu items are not shown at all.
3316 Exception: Athena will always use grey menu items.
3317
3318 't' Include tearoff menu items. Currently only works for Win32,
3319 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003320 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3321 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322
3323 'r' Right-hand scrollbar is always present.
3324 'R' Right-hand scrollbar is present when there is a vertically
3325 split window.
3326 'l' Left-hand scrollbar is always present.
3327 'L' Left-hand scrollbar is present when there is a vertically
3328 split window.
3329 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3330 the longest visible line, or on the cursor line if the 'h'
3331 flag is included. |gui-horiz-scroll|
3332 'h' Limit horizontal scrollbar size to the length of the cursor
3333 line. Reduces computations. |gui-horiz-scroll|
3334
3335 And yes, you may even have scrollbars on the left AND the right if
3336 you really want to :-). See |gui-scrollbars| for more information.
3337
3338 'v' Use a vertical button layout for dialogs. When not included,
3339 a horizontal layout is preferred, but when it doesn't fit a
3340 vertical layout is used anyway.
3341 'p' Use Pointer callbacks for X11 GUI. This is required for some
3342 window managers. If the cursor is not blinking or hollow at
3343 the right moment, try adding this flag. This must be done
3344 before starting the GUI. Set it in your gvimrc. Adding or
3345 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003346 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347
3348 *'guipty'* *'noguipty'*
3349'guipty' boolean (default on)
3350 global
3351 {not in Vi}
3352 {only available when compiled with GUI enabled}
3353 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3354 I/O to/from shell commands. See |gui-pty|.
3355
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003356 *'guitablabel'* *'gtl'*
3357'guitablabel' 'gtl' string (default empty)
3358 global
3359 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003360 {only available when compiled with GUI enabled and
3361 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003362 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003363 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003364 |setting-guitablabel| for more info.
3365
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003366 The format of this option is like that of 'statusline'.
3367
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003368 Only used when the GUI tab pages line is displayed. 'e' must be
3369 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3370 used.
3371
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 *'helpfile'* *'hf'*
3373'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3374 (others) "$VIMRUNTIME/doc/help.txt")
3375 global
3376 {not in Vi}
3377 Name of the main help file. All distributed help files should be
3378 placed together in one directory. Additionally, all "doc" directories
3379 in 'runtimepath' will be used.
3380 Environment variables are expanded |:set_env|. For example:
3381 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003382 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 spaces and backslashes.
3384 This option cannot be set from a |modeline| or in the |sandbox|, for
3385 security reasons.
3386
3387 *'helpheight'* *'hh'*
3388'helpheight' 'hh' number (default 20)
3389 global
3390 {not in Vi}
3391 {not available when compiled without the +windows
3392 feature}
3393 Minimal initial height of the help window when it is opened with the
3394 ":help" command. The initial height of the help window is half of the
3395 current window, or (when the 'ea' option is on) the same as other
3396 windows. When the height is less than 'helpheight', the height is
3397 set to 'helpheight'. Set to zero to disable.
3398
3399 *'helplang'* *'hlg'*
3400'helplang' 'hlg' string (default: messages language or empty)
3401 global
3402 {only available when compiled with the |+multi_lang|
3403 feature}
3404 {not in Vi}
3405 Comma separated list of languages. Vim will use the first language
3406 for which the desired help can be found. The English help will always
3407 be used as a last resort. You can add "en" to prefer English over
3408 another language, but that will only find tags that exist in that
3409 language and not in the English help.
3410 Example: >
3411 :set helplang=de,it
3412< This will first search German, then Italian and finally English help
3413 files.
3414 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3415 try to find the tag in the current language before using this option.
3416 See |help-translated|.
3417
3418 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3419'hidden' 'hid' boolean (default off)
3420 global
3421 {not in Vi}
3422 When off a buffer is unloaded when it is |abandon|ed. When on a
3423 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3424 displayed in another window, it does not become hidden, of course.
3425 The commands that move through the buffer list sometimes make a buffer
3426 hidden although the 'hidden' option is off: When the buffer is
3427 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003428 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003429 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 This option is set for one command with ":hide {command}" |:hide|.
3431 WARNING: It's easy to forget that you have changes in hidden buffers.
3432 Think twice when using ":q!" or ":qa!".
3433
3434 *'highlight'* *'hl'*
3435'highlight' 'hl' string (default (as a single string):
3436 "8:SpecialKey,@:NonText,d:Directory,
3437 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3438 M:ModeMsg,n:LineNr,r:Question,
3439 s:StatusLine,S:StatusLineNC,c:VertSplit
3440 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3441 f:Folded,F:FoldColumn,A:DiffAdd,
3442 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003443 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003444 R:SpellRare,L:SpellLocal,
3445 +:Pmenu,=:PmenuSel,
3446 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 global
3448 {not in Vi}
3449 This option can be used to set highlighting mode for various
3450 occasions. It is a comma separated list of character pairs. The
3451 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003452 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3454 |hl-NonText| @ '~' and '@' at the end of the window and
3455 characters from 'showbreak'
3456 |hl-Directory| d directories in CTRL-D listing and other special
3457 things in listings
3458 |hl-ErrorMsg| e error messages
3459 h (obsolete, ignored)
3460 |hl-IncSearch| i 'incsearch' highlighting
3461 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3462 |hl-MoreMsg| m |more-prompt|
3463 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3464 |hl-LineNr| n line number for ":number" and ":#" commands
3465 |hl-Question| r |hit-enter| prompt and yes/no questions
3466 |hl-StatusLine| s status line of current window |status-line|
3467 |hl-StatusLineNC| S status lines of not-current windows
3468 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3469 |hl-VertSplit| c column used to separate vertically split windows
3470 |hl-Visual| v Visual mode
3471 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3472 Selection" Only X11 Gui's |gui-x11| and
3473 |xterm-clipboard|.
3474 |hl-WarningMsg| w warning messages
3475 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3476 |hl-Folded| f line used for closed folds
3477 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003478 |hl-DiffAdd| A added line in diff mode
3479 |hl-DiffChange| C changed line in diff mode
3480 |hl-DiffDelete| D deleted line in diff mode
3481 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003483 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003484 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003485 |hl-SpellRare| R rare word |spell|
3486 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003487 |hl-Pmenu| + popup menu normal line
3488 |hl-PmenuSel| = popup menu normal line
3489 |hl-PmenuSbar| x popup menu scrollbar
3490 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491
3492 The display modes are:
3493 r reverse (termcap entry "mr" and "me")
3494 i italic (termcap entry "ZH" and "ZR")
3495 b bold (termcap entry "md" and "me")
3496 s standout (termcap entry "so" and "se")
3497 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003498 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 n no highlighting
3500 - no highlighting
3501 : use a highlight group
3502 The default is used for occasions that are not included.
3503 If you want to change what the display modes do, see |dos-colors|
3504 for an example.
3505 When using the ':' display mode, this must be followed by the name of
3506 a highlight group. A highlight group can be used to define any type
3507 of highlighting, including using color. See |:highlight| on how to
3508 define one. The default uses a different group for each occasion.
3509 See |highlight-default| for the default highlight groups.
3510
3511 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3512'hlsearch' 'hls' boolean (default off)
3513 global
3514 {not in Vi}
3515 {not available when compiled without the
3516 |+extra_search| feature}
3517 When there is a previous search pattern, highlight all its matches.
3518 The type of highlighting used can be set with the 'l' occasion in the
3519 'highlight' option. This uses the "Search" highlight group by
3520 default. Note that only the matching text is highlighted, any offsets
3521 are not applied.
3522 See also: 'incsearch' and |:match|.
3523 When you get bored looking at the highlighted matches, you can turn it
3524 off with |:nohlsearch|. As soon as you use a search command, the
3525 highlighting comes back.
3526 When the search pattern can match an end-of-line, Vim will try to
3527 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003528 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 line below a closed fold. A match in a previous line which is not
3530 drawn may not continue in an newly drawn line.
3531 NOTE: This option is reset when 'compatible' is set.
3532
3533 *'history'* *'hi'*
3534'history' 'hi' number (Vim default: 20, Vi default: 0)
3535 global
3536 {not in Vi}
3537 A history of ":" commands, and a history of previous search patterns
3538 are remembered. This option decides how many entries may be stored in
3539 each of these histories (see |cmdline-editing|).
3540 NOTE: This option is set to the Vi default value when 'compatible' is
3541 set and to the Vim default value when 'compatible' is reset.
3542
3543 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3544'hkmap' 'hk' boolean (default off)
3545 global
3546 {not in Vi}
3547 {only available when compiled with the |+rightleft|
3548 feature}
3549 When on, the keyboard is mapped for the Hebrew character set.
3550 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3551 toggle this option. See |rileft.txt|.
3552 NOTE: This option is reset when 'compatible' is set.
3553
3554 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3555'hkmapp' 'hkp' boolean (default off)
3556 global
3557 {not in Vi}
3558 {only available when compiled with the |+rightleft|
3559 feature}
3560 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3561 This is useful if you have a non-Hebrew keyboard.
3562 See |rileft.txt|.
3563 NOTE: This option is reset when 'compatible' is set.
3564
3565 *'icon'* *'noicon'*
3566'icon' boolean (default off, on when title can be restored)
3567 global
3568 {not in Vi}
3569 {not available when compiled without the |+title|
3570 feature}
3571 When on, the icon text of the window will be set to the value of
3572 'iconstring' (if it is not empty), or to the name of the file
3573 currently being edited. Only the last part of the name is used.
3574 Overridden by the 'iconstring' option.
3575 Only works if the terminal supports setting window icons (currently
3576 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3577 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3578 builtin termcap).
3579 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003580 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 X11.
3582
3583 *'iconstring'*
3584'iconstring' string (default "")
3585 global
3586 {not in Vi}
3587 {not available when compiled without the |+title|
3588 feature}
3589 When this option is not empty, it will be used for the icon text of
3590 the window. This happens only when the 'icon' option is on.
3591 Only works if the terminal supports setting window icon text
3592 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3593 Does not work for MS Windows.
3594 When Vim was compiled with HAVE_X11 defined, the original icon will be
3595 restored if possible |X11|.
3596 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003597 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 'titlestring' for example settings.
3599 {not available when compiled without the |+statusline| feature}
3600
3601 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3602'ignorecase' 'ic' boolean (default off)
3603 global
3604 Ignore case in search patterns. Also used when searching in the tags
3605 file.
3606 Also see 'smartcase'.
3607 Can be overruled by using "\c" or "\C" in the pattern, see
3608 |/ignorecase|.
3609
3610 *'imactivatekey'* *'imak'*
3611'imactivatekey' 'imak' string (default "")
3612 global
3613 {not in Vi}
3614 {only available when compiled with |+xim| and
3615 |+GUI_GTK|}
3616 Specifies the key that your Input Method in X-Windows uses for
3617 activation. When this is specified correctly, vim can fully control
3618 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3619 You can't use this option to change the activation key, the option
3620 tells Vim what the key is.
3621 Format:
3622 [MODIFIER_FLAG-]KEY_STRING
3623
3624 These characters can be used for MODIFIER_FLAG (case is ignored):
3625 S Shift key
3626 L Lock key
3627 C Control key
3628 1 Mod1 key
3629 2 Mod2 key
3630 3 Mod3 key
3631 4 Mod4 key
3632 5 Mod5 key
3633 Combinations are allowed, for example "S-C-space" or "SC-space" are
3634 both shift+ctrl+space.
3635 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3636
3637 Example: >
3638 :set imactivatekey=S-space
3639< "S-space" means shift+space. This is the activation key for kinput2 +
3640 canna (Japanese), and ami (Korean).
3641
3642 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3643'imcmdline' 'imc' boolean (default off)
3644 global
3645 {not in Vi}
3646 {only available when compiled with the |+xim|
3647 |+multi_byte_ime| or |global-ime| feature}
3648 When set the Input Method is always on when starting to edit a command
3649 line, unless entering a search pattern (see 'imsearch' for that).
3650 Setting this option is useful when your input method allows entering
3651 English characters directly, e.g., when it's used to type accented
3652 characters with dead keys.
3653
3654 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3655'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3656 global
3657 {not in Vi}
3658 {only available when compiled with the |+xim|
3659 |+multi_byte_ime| or |global-ime| feature}
3660 When set the Input Method is never used. This is useful to disable
3661 the IM when it doesn't work properly.
3662 Currently this option is on by default for SGI/IRIX machines. This
3663 may change in later releases.
3664
3665 *'iminsert'* *'imi'*
3666'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3667 local to buffer
3668 {not in Vi}
3669 Specifies whether :lmap or an Input Method (IM) is to be used in
3670 Insert mode. Valid values:
3671 0 :lmap is off and IM is off
3672 1 :lmap is ON and IM is off
3673 2 :lmap is off and IM is ON
3674 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3675 or |global-ime|.
3676 To always reset the option to zero when leaving Insert mode with <Esc>
3677 this can be used: >
3678 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3679< This makes :lmap and IM turn off automatically when leaving Insert
3680 mode.
3681 Note that this option changes when using CTRL-^ in Insert mode
3682 |i_CTRL-^|.
3683 The value is set to 1 when setting 'keymap' to a valid keymap name.
3684 It is also used for the argument of commands like "r" and "f".
3685 The value 0 may not work correctly with Athena and Motif with some XIM
3686 methods. Use 'imdisable' to disable XIM then.
3687
3688 *'imsearch'* *'ims'*
3689'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3690 local to buffer
3691 {not in Vi}
3692 Specifies whether :lmap or an Input Method (IM) is to be used when
3693 entering a search pattern. Valid values:
3694 -1 the value of 'iminsert' is used, makes it look like
3695 'iminsert' is also used when typing a search pattern
3696 0 :lmap is off and IM is off
3697 1 :lmap is ON and IM is off
3698 2 :lmap is off and IM is ON
3699 Note that this option changes when using CTRL-^ in Command-line mode
3700 |c_CTRL-^|.
3701 The value is set to 1 when it is not -1 and setting the 'keymap'
3702 option to a valid keymap name.
3703 The value 0 may not work correctly with Athena and Motif with some XIM
3704 methods. Use 'imdisable' to disable XIM then.
3705
3706 *'include'* *'inc'*
3707'include' 'inc' string (default "^\s*#\s*include")
3708 global or local to buffer |global-local|
3709 {not in Vi}
3710 {not available when compiled without the
3711 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003712 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 pattern, just like for the "/" command (See |pattern|). The default
3714 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003715 "]I", "[d", etc.
3716 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003717 comes after the matched pattern. But if "\zs" appears in the pattern
3718 then the text matched from "\zs" to the end, or until "\ze" if it
3719 appears, is used as the file name. Use this to include characters
3720 that are not in 'isfname', such as a space. You can then use
3721 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003722 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723
3724 *'includeexpr'* *'inex'*
3725'includeexpr' 'inex' string (default "")
3726 local to buffer
3727 {not in Vi}
3728 {not available when compiled without the
3729 |+find_in_path| or |+eval| feature}
3730 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003731 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 :set includeexpr=substitute(v:fname,'\\.','/','g')
3733< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003734
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003736 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 Also used for |<cfile>|.
3738
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003739 The expression may be evaluated in the |sandbox|, see
3740 |sandbox-option|.
3741
3742 It is not allowed to change text or jump to another window while
3743 evaluating 'includeexpr' |textlock|.
3744
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3746'incsearch' 'is' boolean (default off)
3747 global
3748 {not in Vi}
3749 {not available when compiled without the
3750 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003751 While typing a search command, show where the pattern, as it was typed
3752 so far, matches. The matched string is highlighted. If the pattern
3753 is invalid or not found, nothing is shown. The screen will be updated
3754 often, this is only useful on fast terminals.
3755 Note that the match will be shown, but the cursor will return to its
3756 original position when no match is found and when pressing <Esc>. You
3757 still need to finish the search command with <Enter> to move the
3758 cursor to the match.
3759 The highlighting can be set with the 'i' flag in 'highlight'.
3760 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 NOTE: This option is reset when 'compatible' is set.
3762
3763 *'indentexpr'* *'inde'*
3764'indentexpr' 'inde' string (default "")
3765 local to buffer
3766 {not in Vi}
3767 {not available when compiled without the |+cindent|
3768 or |+eval| features}
3769 Expression which is evaluated to obtain the proper indent for a line.
3770 It is used when a new line is created, for the |=| operator and
3771 in Insert mode as specified with the 'indentkeys' option.
3772 When this option is not empty, it overrules the 'cindent' and
3773 'smartindent' indenting.
3774 When 'paste' is set this option is not used for indenting.
3775 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003776 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 when the expression is evaluated (but it may be moved around).
3778 The expression must return the number of spaces worth of indent. It
3779 can return "-1" to keep the current indent (this means 'autoindent' is
3780 used for the indent).
3781 Functions useful for computing the indent are |indent()|, |cindent()|
3782 and |lispindent()|.
3783 The evaluation of the expression must not have side effects! It must
3784 not change the text, jump to another window, etc. Afterwards the
3785 cursor position is always restored, thus the cursor may be moved.
3786 Normally this option would be set to call a function: >
3787 :set indentexpr=GetMyIndent()
3788< Error messages will be suppressed, unless the 'debug' option contains
3789 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003790 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 NOTE: This option is made empty when 'compatible' is set.
3792
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003793 The expression may be evaluated in the |sandbox|, see
3794 |sandbox-option|.
3795
3796 It is not allowed to change text or jump to another window while
3797 evaluating 'indentexpr' |textlock|.
3798
3799
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 *'indentkeys'* *'indk'*
3801'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3802 local to buffer
3803 {not in Vi}
3804 {not available when compiled without the |+cindent|
3805 feature}
3806 A list of keys that, when typed in Insert mode, cause reindenting of
3807 the current line. Only happens if 'indentexpr' isn't empty.
3808 The format is identical to 'cinkeys', see |indentkeys-format|.
3809 See |C-indenting| and |indent-expression|.
3810
3811 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3812'infercase' 'inf' boolean (default off)
3813 local to buffer
3814 {not in Vi}
3815 When doing keyword completion in insert mode |ins-completion|, and
3816 'ignorecase' is also on, the case of the match is adjusted. If the
3817 typed text contains a lowercase letter where the match has an upper
3818 case letter, the completed part is made lowercase. If the typed text
3819 has no lowercase letters and the match has a lowercase letter where
3820 the typed text has an uppercase letter, and there is a letter before
3821 it, the completed part is made uppercase.
3822
3823 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3824'insertmode' 'im' boolean (default off)
3825 global
3826 {not in Vi}
3827 Makes Vim work in a way that Insert mode is the default mode. Useful
3828 if you want to use Vim as a modeless editor. Used for |evim|.
3829 These Insert mode commands will be useful:
3830 - Use the cursor keys to move around.
3831 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3832 this is a mapping, it is executed as if 'insertmode' was off.
3833 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003835 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3836 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837
3838 These items change when 'insertmode' is set:
3839 - when starting to edit of a file, Vim goes to Insert mode.
3840 - <Esc> in Insert mode is a no-op and beeps.
3841 - <Esc> in Normal mode makes Vim go to Insert mode.
3842 - CTRL-L in Insert mode is a command, it is not inserted.
3843 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3844 However, when <Esc> is used inside a mapping, it behaves like
3845 'insertmode' was not set. This was done to be able to use the same
3846 mappings with 'insertmode' set or not set.
3847 When executing commands with |:normal| 'insertmode' is not used.
3848
3849 NOTE: This option is reset when 'compatible' is set.
3850
3851 *'isfname'* *'isf'*
3852'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3853 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3854 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3855 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3856 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3857 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3858 global
3859 {not in Vi}
3860 The characters specified by this option are included in file names and
3861 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003862 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 Multi-byte characters 256 and above are always included, only the
3864 characters up to 255 are specified with this option.
3865 For UTF-8 the characters 0xa0 to 0xff are included as well.
3866
3867 Note that on systems using a backslash as path separator, Vim tries to
3868 do its best to make it work as you would expect. That is a bit
3869 tricky, since Vi originally used the backslash to escape special
3870 characters. Vim will not remove a backslash in front of a normal file
3871 name character on these systems, but it will on Unix and alikes. The
3872 '&' and '^' are not included by default, because these are special for
3873 cmd.exe.
3874
3875 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003876 Each part can be a single character number or a range. A range is two
3877 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 decimal number between 0 and 255 or the ASCII character itself (does
3879 not work for digits). Example:
3880 "_,-,128-140,#-43" (include '_' and '-' and the range
3881 128 to 140 and '#' to 43)
3882 If a part starts with '^', the following character number or range
3883 will be excluded from the option. The option is interpreted from left
3884 to right. Put the excluded character after the range where it is
3885 included. To include '^' itself use it as the last character of the
3886 option or the end of a range. Example:
3887 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3888 If the character is '@', all characters where isalpha() returns TRUE
3889 are included. Normally these are the characters a to z and A to Z,
3890 plus accented characters. To include '@' itself use "@-@". Examples:
3891 "@,^a-z" All alphabetic characters, excluding lower
3892 case letters.
3893 "a-z,A-Z,@-@" All letters plus the '@' character.
3894 A comma can be included by using it where a character number is
3895 expected. Example:
3896 "48-57,,,_" Digits, comma and underscore.
3897 A comma can be excluded by prepending a '^'. Example:
3898 " -~,^,,9" All characters from space to '~', excluding
3899 comma, plus <Tab>.
3900 See |option-backslash| about including spaces and backslashes.
3901
3902 *'isident'* *'isi'*
3903'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3904 "@,48-57,_,128-167,224-235"
3905 otherwise: "@,48-57,_,192-255")
3906 global
3907 {not in Vi}
3908 The characters given by this option are included in identifiers.
3909 Identifiers are used in recognizing environment variables and after a
3910 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003911 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 option.
3913 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003914 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3916
3917 *'iskeyword'* *'isk'*
3918'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3919 "@,48-57,_,128-167,224-235"
3920 otherwise: "@,48-57,_,192-255"
3921 Vi default: "@,48-57,_")
3922 local to buffer
3923 {not in Vi}
3924 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003925 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 'isfname' for a description of the format of this option. For C
3927 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3928 For a help file it is set to all non-blank printable characters except
3929 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3930 command).
3931 When the 'lisp' option is on the '-' character is always included.
3932 NOTE: This option is set to the Vi default value when 'compatible' is
3933 set and to the Vim default value when 'compatible' is reset.
3934
3935 *'isprint'* *'isp'*
3936'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3937 "@,~-255"; otherwise: "@,161-255")
3938 global
3939 {not in Vi}
3940 The characters given by this option are displayed directly on the
3941 screen. It is also used for "\p" in a |pattern|. The characters from
3942 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3943 even when they are not included in 'isprint' or excluded. See
3944 'isfname' for a description of the format of this option.
3945
3946 Non-printable characters are displayed with two characters:
3947 0 - 31 "^@" - "^_"
3948 32 - 126 always single characters
3949 127 "^?"
3950 128 - 159 "~@" - "~_"
3951 160 - 254 "| " - "|~"
3952 255 "~?"
3953 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3954 displayed as <xx>, with the hexadecimal value of the byte.
3955 When 'display' contains "uhex" all unprintable characters are
3956 displayed as <xx>.
3957 The NonText highlighting will be used for unprintable characters.
3958 |hl-NonText|
3959
3960 Multi-byte characters 256 and above are always included, only the
3961 characters up to 255 are specified with this option. When a character
3962 is printable but it is not available in the current font, a
3963 replacement character will be shown.
3964 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3965 There is no option to specify these characters.
3966
3967 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3968'joinspaces' 'js' boolean (default on)
3969 global
3970 {not in Vi}
3971 Insert two spaces after a '.', '?' and '!' with a join command.
3972 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3973 Otherwise only one space is inserted.
3974 NOTE: This option is set when 'compatible' is set.
3975
3976 *'key'*
3977'key' string (default "")
3978 local to buffer
3979 {not in Vi}
3980 The key that is used for encrypting and decrypting the current buffer.
3981 See |encryption|.
3982 Careful: Do not set the key value by hand, someone might see the typed
3983 key. Use the |:X| command. But you can make 'key' empty: >
3984 :set key=
3985< It is not possible to get the value of this option with ":set key" or
3986 "echo &key". This is to avoid showing it to someone who shouldn't
3987 know. It also means you cannot see it yourself once you have set it,
3988 be careful not to make a typing error!
3989
3990 *'keymap'* *'kmp'* *E544*
3991'keymap' 'kmp' string (default "")
3992 local to buffer
3993 {not in Vi}
3994 {only available when compiled with the |+keymap|
3995 feature}
3996 Name of a keyboard mapping. See |mbyte-keymap|.
3997 Setting this option to a valid keymap name has the side effect of
3998 setting 'iminsert' to one, so that the keymap becomes effective.
3999 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004000 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001
4002 *'keymodel'* *'km'*
4003'keymodel' 'km' string (default "")
4004 global
4005 {not in Vi}
4006 List of comma separated words, which enable special things that keys
4007 can do. These values can be used:
4008 startsel Using a shifted special key starts selection (either
4009 Select mode or Visual mode, depending on "key" being
4010 present in 'selectmode').
4011 stopsel Using a not-shifted special key stops selection.
4012 Special keys in this context are the cursor keys, <End>, <Home>,
4013 <PageUp> and <PageDown>.
4014 The 'keymodel' option is set by the |:behave| command.
4015
4016 *'keywordprg'* *'kp'*
4017'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4018 OS/2: "view /", VMS: "help")
4019 global or local to buffer |global-local|
4020 {not in Vi}
4021 Program to use for the |K| command. Environment variables are
4022 expanded |:set_env|. ":help" may be used to access the Vim internal
4023 help. (Note that previously setting the global option to the empty
4024 value did this, which is now deprecated.)
4025 When "man" is used, Vim will automatically translate a count for the
4026 "K" command to a section number. Also for "man -s", in which case the
4027 "-s" is removed when there is no count.
4028 See |option-backslash| about including spaces and backslashes.
4029 Example: >
4030 :set keywordprg=man\ -s
4031< This option cannot be set from a |modeline| or in the |sandbox|, for
4032 security reasons.
4033
4034 *'langmap'* *'lmap'* *E357* *E358*
4035'langmap' 'lmap' string (default "")
4036 global
4037 {not in Vi}
4038 {only available when compiled with the |+langmap|
4039 feature}
4040 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004041 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 inserted directly. When in command mode the 'langmap' option takes
4043 care of translating these special characters to the original meaning
4044 of the key. This means you don't have to change the keyboard mode to
4045 be able to execute Normal mode commands.
4046 This is the opposite of the 'keymap' option, where characters are
4047 mapped in Insert mode.
4048 This only works for 8-bit characters. The value of 'langmap' may be
4049 specified with multi-byte characters (e.g., UTF-8), but only the lower
4050 8 bits of each character will be used.
4051
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004052 Example (for Greek, in UTF-8): *greek* >
4053 :set langmap=ΑA,ΒB,ΨC,ΔD,ΕE,ΦF,ΓG,ΗH,ΙI,ΞJ,ΚK,ΛL,ΜM,ΝN,ΟO,ΠP,QQ,ΡR,ΣS,ΤT,ΘU,ΩV,WW,ΧX,ΥY,ΖZ,αa,βb,ψc,δd,εe,φf,γg,ηh,ιi,ξj,κk,λl,μm,νn,οo,πp,qq,ρr,σs,τt,θu,ωv,ςw,χx,υy,ζz
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054< Example (exchanges meaning of z and y for commands): >
4055 :set langmap=zy,yz,ZY,YZ
4056<
4057 The 'langmap' option is a list of parts, separated with commas. Each
4058 part can be in one of two forms:
4059 1. A list of pairs. Each pair is a "from" character immediately
4060 followed by the "to" character. Examples: "aA", "aAbBcC".
4061 2. A list of "from" characters, a semi-colon and a list of "to"
4062 characters. Example: "abc;ABC"
4063 Example: "aA,fgh;FGH,cCdDeE"
4064 Special characters need to be preceded with a backslash. These are
4065 ";", ',' and backslash itself.
4066
4067 This will allow you to activate vim actions without having to switch
4068 back and forth between the languages. Your language characters will
4069 be understood as normal vim English characters (according to the
4070 langmap mappings) in the following cases:
4071 o Normal/Visual mode (commands, buffer/register names, user mappings)
4072 o Insert/Replace Mode: Register names after CTRL-R
4073 o Insert/Replace Mode: Mappings
4074 Characters entered in Command-line mode will NOT be affected by
4075 this option. Note that this option can be changed at any time
4076 allowing to switch between mappings for different languages/encodings.
4077 Use a mapping to avoid having to type it each time!
4078
4079 *'langmenu'* *'lm'*
4080'langmenu' 'lm' string (default "")
4081 global
4082 {not in Vi}
4083 {only available when compiled with the |+menu| and
4084 |+multi_lang| features}
4085 Language to use for menu translation. Tells which file is loaded
4086 from the "lang" directory in 'runtimepath': >
4087 "lang/menu_" . &langmenu . ".vim"
4088< (without the spaces). For example, to always use the Dutch menus, no
4089 matter what $LANG is set to: >
4090 :set langmenu=nl_NL.ISO_8859-1
4091< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004092 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 If your $LANG is set to a non-English language but you do want to use
4094 the English menus: >
4095 :set langmenu=none
4096< This option must be set before loading menus, switching on filetype
4097 detection or syntax highlighting. Once the menus are defined setting
4098 this option has no effect. But you could do this: >
4099 :source $VIMRUNTIME/delmenu.vim
4100 :set langmenu=de_DE.ISO_8859-1
4101 :source $VIMRUNTIME/menu.vim
4102< Warning: This deletes all menus that you defined yourself!
4103
4104 *'laststatus'* *'ls'*
4105'laststatus' 'ls' number (default 1)
4106 global
4107 {not in Vi}
4108 The value of this option influences when the last window will have a
4109 status line:
4110 0: never
4111 1: only if there are at least two windows
4112 2: always
4113 The screen looks nicer with a status line if you have several
4114 windows, but it takes another screen line. |status-line|
4115
4116 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4117'lazyredraw' 'lz' boolean (default off)
4118 global
4119 {not in Vi}
4120 When this option is set, the screen will not be redrawn while
4121 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004122 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 update use |:redraw|.
4124
4125 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4126'linebreak' 'lbr' boolean (default off)
4127 local to window
4128 {not in Vi}
4129 {not available when compiled without the |+linebreak|
4130 feature}
4131 If on Vim will wrap long lines at a character in 'breakat' rather
4132 than at the last character that fits on the screen. Unlike
4133 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4134 it only affects the way the file is displayed, not its contents. The
4135 value of 'showbreak' is used to put in front of wrapped lines.
4136 This option is not used when the 'wrap' option is off or 'list' is on.
4137 Note that <Tab> characters after an <EOL> are mostly not displayed
4138 with the right amount of white space.
4139
4140 *'lines'* *E593*
4141'lines' number (default 24 or terminal height)
4142 global
4143 Number of lines of the Vim window.
4144 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004145 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 When Vim is running in the GUI or in a resizable window, setting this
4147 option will cause the window size to be changed. When you only want
4148 to use the size for the GUI, put the command in your |gvimrc| file.
4149 Vim limits the number of lines to what fits on the screen. You can
4150 use this command to get the tallest window possible: >
4151 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004152< Minimum value is 2, maximum value is 1000.
4153 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 When you set this option and Vim is unable to change the physical
4155 number of lines of the display, the display may be messed up.
4156
4157 *'linespace'* *'lsp'*
4158'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4159 global
4160 {not in Vi}
4161 {only in the GUI}
4162 Number of pixel lines inserted between characters. Useful if the font
4163 uses the full character cell height, making lines touch each other.
4164 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004165 With some fonts there can be too much room between lines (to have
4166 space for ascents and descents). Then it makes sense to set
4167 'linespace' to a negative value. This may cause display problems
4168 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169
4170 *'lisp'* *'nolisp'*
4171'lisp' boolean (default off)
4172 local to buffer
4173 {not available when compiled without the |+lispindent|
4174 feature}
4175 Lisp mode: When <Enter> is typed in insert mode set the indent for
4176 the next line to Lisp standards (well, sort of). Also happens with
4177 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4178 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4179 better. Also see 'lispwords'.
4180 The '-' character is included in keyword characters. Redefines the
4181 "=" operator to use this same indentation algorithm rather than
4182 calling an external program if 'equalprg' is empty.
4183 This option is not used when 'paste' is set.
4184 {Vi: Does it a little bit differently}
4185
4186 *'lispwords'* *'lw'*
4187'lispwords' 'lw' string (default is very long)
4188 global
4189 {not in Vi}
4190 {not available when compiled without the |+lispindent|
4191 feature}
4192 Comma separated list of words that influence the Lisp indenting.
4193 |'lisp'|
4194
4195 *'list'* *'nolist'*
4196'list' boolean (default off)
4197 local to window
4198 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4199 see the difference between tabs and spaces and for trailing blanks.
4200 Note that this will also affect formatting (set with 'textwidth' or
4201 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4202 changing the way tabs are displayed.
4203
4204 *'listchars'* *'lcs'*
4205'listchars' 'lcs' string (default "eol:$")
4206 global
4207 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004208 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 settings.
4210 eol:c Character to show at the end of each line. When
4211 omitted, there is no extra character at the end of the
4212 line.
4213 tab:xy Two characters to be used to show a Tab. The first
4214 char is used once. The second char is repeated to
4215 fill the space that the Tab normally occupies.
4216 "tab:>-" will show a Tab that takes four spaces as
4217 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004218 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 trailing spaces are blank.
4220 extends:c Character to show in the last column, when 'wrap' is
4221 off and the line continues beyond the right of the
4222 screen.
4223 precedes:c Character to show in the first column, when 'wrap'
4224 is off and there is text preceding the character
4225 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004226 nbsp:c Character to show for a non-breakable space (character
4227 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004229 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 be used when 'encoding' is "utf-8", otherwise only printable
4231 characters are allowed.
4232
4233 Examples: >
4234 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004235 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 :set lcs=extends:>,precedes:<
4237< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004238 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239
4240 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4241'loadplugins' 'lpl' boolean (default on)
4242 global
4243 {not in Vi}
4244 When on the plugin scripts are loaded when starting up |load-plugins|.
4245 This option can be reset in your |vimrc| file to disable the loading
4246 of plugins.
4247 Note that using the "-u NONE" and "--noplugin" command line arguments
4248 reset this option. |-u| |--noplugin|
4249
4250 *'magic'* *'nomagic'*
4251'magic' boolean (default on)
4252 global
4253 Changes the special characters that can be used in search patterns.
4254 See |pattern|.
4255 NOTE: To avoid portability problems with using patterns, always keep
4256 this option at the default "on". Only switch it off when working with
4257 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004258 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259
4260 *'makeef'* *'mef'*
4261'makeef' 'mef' string (default: "")
4262 global
4263 {not in Vi}
4264 {not available when compiled without the |+quickfix|
4265 feature}
4266 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4267 and the |:grep| command.
4268 When it is empty, an internally generated temp file will be used.
4269 When "##" is included, it is replaced by a number to make the name
4270 unique. This makes sure that the ":make" command doesn't overwrite an
4271 existing file.
4272 NOT used for the ":cf" command. See 'errorfile' for that.
4273 Environment variables are expanded |:set_env|.
4274 See |option-backslash| about including spaces and backslashes.
4275 This option cannot be set from a |modeline| or in the |sandbox|, for
4276 security reasons.
4277
4278 *'makeprg'* *'mp'*
4279'makeprg' 'mp' string (default "make", VMS: "MMS")
4280 global or local to buffer |global-local|
4281 {not in Vi}
4282 Program to use for the ":make" command. See |:make_makeprg|. This
4283 option may contain '%' and '#' characters, which are expanded like
4284 when used in a command-line. Environment variables are expanded
4285 |:set_env|. See |option-backslash| about including spaces and
4286 backslashes. Note that a '|' must be escaped twice: once for ":set"
4287 and once for the interpretation of a command. When you use a filter
4288 called "myfilter" do it like this: >
4289 :set makeprg=gmake\ \\\|\ myfilter
4290< The placeholder "$*" can be given (even multiple times) to specify
4291 where the arguments will be included, for example: >
4292 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4293< This option cannot be set from a |modeline| or in the |sandbox|, for
4294 security reasons.
4295
4296 *'matchpairs'* *'mps'*
4297'matchpairs' 'mps' string (default "(:),{:},[:]")
4298 local to buffer
4299 {not in Vi}
4300 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004301 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 must be different. The characters must be separated by a colon. The
4303 pairs must be separated by a comma. Example for including '<' and '>'
4304 (HTML): >
4305 :set mps+=<:>
4306
4307< A more exotic example, to jump between the '=' and ';' in an
4308 assignment, useful for languages like C and Java: >
4309 :au FileType c,cpp,java set mps+==:;
4310
4311< For a more advanced way of using "%", see the matchit.vim plugin in
4312 the $VIMRUNTIME/macros directory. |add-local-help|
4313
4314 *'matchtime'* *'mat'*
4315'matchtime' 'mat' number (default 5)
4316 global
4317 {not in Vi}{in Nvi}
4318 Tenths of a second to show the matching paren, when 'showmatch' is
4319 set. Note that this is not in milliseconds, like other options that
4320 set a time. This is to be compatible with Nvi.
4321
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004322 *'maxcombine'* *'mco'*
4323'maxcombine' 'mco' number (default 2)
4324 global
4325 {not in Vi}
4326 {only available when compiled with the |+multi_byte|
4327 feature}
4328 The maximum number of combining characters supported for displaying.
4329 Only used when 'encoding' is "utf-8".
4330 The default is OK for most languages. Hebrew may require 4.
4331 Maximum value is 6.
4332 Even when this option is set to 2 you can still edit text with more
4333 combining characters, you just can't see them. Use |g8| or |ga|.
4334 See |mbyte-combining|.
4335
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 *'maxfuncdepth'* *'mfd'*
4337'maxfuncdepth' 'mfd' number (default 100)
4338 global
4339 {not in Vi}
4340 Maximum depth of function calls for user functions. This normally
4341 catches endless recursion. When using a recursive function with
4342 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4343 more memory, there is the danger of failing when memory is exhausted.
4344 See also |:function|.
4345
4346 *'maxmapdepth'* *'mmd'* *E223*
4347'maxmapdepth' 'mmd' number (default 1000)
4348 global
4349 {not in Vi}
4350 Maximum number of times a mapping is done without resulting in a
4351 character to be used. This normally catches endless mappings, like
4352 ":map x y" with ":map y x". It still does not catch ":map g wg",
4353 because the 'w' is used before the next mapping is done. See also
4354 |key-mapping|.
4355
4356 *'maxmem'* *'mm'*
4357'maxmem' 'mm' number (default between 256 to 5120 (system
4358 dependent) or half the amount of memory
4359 available)
4360 global
4361 {not in Vi}
4362 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4363 limit is reached allocating extra memory for a buffer will cause
4364 other memory to be freed. Maximum value 2000000. Use this to work
4365 without a limit. Also see 'maxmemtot'.
4366
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004367 *'maxmempattern'* *'mmp'*
4368'maxmempattern' 'mmp' number (default 1000)
4369 global
4370 {not in Vi}
4371 Maximum amount of memory (in Kbyte) to use for pattern matching.
4372 Maximum value 2000000. Use this to work without a limit.
4373 *E363*
4374 When Vim runs into the limit it gives an error message mostly behaves
4375 like CTRL-C was typed.
4376 Running into the limit often means that the pattern is very
4377 inefficient or too complex. This may already happen with the pattern
4378 "\(.\)*" on a very long line. ".*" works much better.
4379 Vim may run out of memory before hitting the 'maxmempattern' limit.
4380
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 *'maxmemtot'* *'mmt'*
4382'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4383 dependent) or half the amount of memory
4384 available)
4385 global
4386 {not in Vi}
4387 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004388 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 'maxmem'.
4390
4391 *'menuitems'* *'mis'*
4392'menuitems' 'mis' number (default 25)
4393 global
4394 {not in Vi}
4395 {not available when compiled without the |+menu|
4396 feature}
4397 Maximum number of items to use in a menu. Used for menus that are
4398 generated from a list of items, e.g., the Buffers menu. Changing this
4399 option has no direct effect, the menu must be refreshed first.
4400
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004401 *'mkspellmem'* *'msm'*
4402'mkspellmem' 'msm' string (default "460000,2000,500")
4403 global
4404 {not in Vi}
4405 {not available when compiled without the |+syntax|
4406 feature}
4407 Parameters for |:mkspell|. This tunes when to start compressing the
4408 word tree. Compression can be slow when there are many words, but
4409 it's needed to avoid running out of memory. The amount of memory used
4410 per word depends very much on how similar the words are, that's why
4411 this tuning is complicated.
4412
4413 There are three numbers, separated by commas:
4414 {start},{inc},{added}
4415
4416 For most languages the uncompressed word tree fits in memory. {start}
4417 gives the amount of memory in Kbyte that can be used before any
4418 compression is done. It should be a bit smaller than the amount of
4419 memory that is available to Vim.
4420
4421 When going over the {start} limit the {inc} number specifies the
4422 amount of memory in Kbyte that can be allocated before another
4423 compression is done. A low number means compression is done after
4424 less words are added, which is slow. A high number means more memory
4425 will be allocated.
4426
4427 After doing compression, {added} times 1024 words can be added before
4428 the {inc} limit is ignored and compression is done when any extra
4429 amount of memory is needed. A low number means there is a smaller
4430 chance of hitting the {inc} limit, less memory is used but it's
4431 slower.
4432
4433 The languages for which these numbers are important are Italian and
4434 Hungarian. The default works for when you have about 512 Mbyte. If
4435 you have 1 Gbyte you could use: >
4436 :set mkspellmem=900000,3000,800
4437< If you have less than 512 Mbyte |:mkspell| may fail for some
4438 languages, no matter what you set 'mkspellmem' to.
4439
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4441'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4442 local to buffer
4443 *'modelines'* *'mls'*
4444'modelines' 'mls' number (default 5)
4445 global
4446 {not in Vi}
4447 If 'modeline' is on 'modelines' gives the number of lines that is
4448 checked for set commands. If 'modeline' is off or 'modelines' is zero
4449 no lines are checked. See |modeline|.
4450 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4451 set and to the Vim default value when 'compatible' is reset.
4452
4453 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4454'modifiable' 'ma' boolean (default on)
4455 local to buffer
4456 {not in Vi} *E21*
4457 When off the buffer contents cannot be changed. The 'fileformat' and
4458 'fileencoding' options also can't be changed.
4459 Can be reset with the |-M| command line argument.
4460
4461 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4462'modified' 'mod' boolean (default off)
4463 local to buffer
4464 {not in Vi}
4465 When on, the buffer is considered to be modified. This option is set
4466 when:
4467 1. A change was made to the text since it was last written. Using the
4468 |undo| command to go back to the original text will reset the
4469 option. But undoing changes that were made before writing the
4470 buffer will set the option again, since the text is different from
4471 when it was written.
4472 2. 'fileformat' or 'fileencoding' is different from its original
4473 value. The original value is set when the buffer is read or
4474 written. A ":set nomodified" command also resets the original
4475 values to the current values and the 'modified' option will be
4476 reset.
4477 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4478 will be ignored.
4479
4480 *'more'* *'nomore'*
4481'more' boolean (Vim default: on, Vi default: off)
4482 global
4483 {not in Vi}
4484 When on, listings pause when the whole screen is filled. You will get
4485 the |more-prompt|. When this option is off there are no pauses, the
4486 listing continues until finished.
4487 NOTE: This option is set to the Vi default value when 'compatible' is
4488 set and to the Vim default value when 'compatible' is reset.
4489
4490 *'mouse'* *E538*
4491'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4492 global
4493 {not in Vi}
4494 Enable the use of the mouse. Only works for certain terminals
4495 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4496 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4497 The mouse can be enabled for different modes:
4498 n Normal mode
4499 v Visual mode
4500 i Insert mode
4501 c Command-line mode
4502 h all previous modes when editing a help file
4503 a all previous modes
4504 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 Normally you would enable the mouse in all four modes with: >
4506 :set mouse=a
4507< When the mouse is not enabled, the GUI will still use the mouse for
4508 modeless selection. This doesn't move the text cursor.
4509
4510 See |mouse-using|. Also see |'clipboard'|.
4511
4512 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004513 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 the mouse buttons can still be used by keeping the shift key pressed.
4515 Also see the 'clipboard' option.
4516
4517 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4518'mousefocus' 'mousef' boolean (default off)
4519 global
4520 {not in Vi}
4521 {only works in the GUI}
4522 The window that the mouse pointer is on is automatically activated.
4523 When changing the window layout or window focus in another way, the
4524 mouse pointer is moved to the window with keyboard focus. Off is the
4525 default because it makes using the pull down menus a little goofy, as
4526 a pointer transit may activate a window unintentionally.
4527
4528 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4529'mousehide' 'mh' boolean (default on)
4530 global
4531 {not in Vi}
4532 {only works in the GUI}
4533 When on, the mouse pointer is hidden when characters are typed.
4534 The mouse pointer is restored when the mouse is moved.
4535
4536 *'mousemodel'* *'mousem'*
4537'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4538 global
4539 {not in Vi}
4540 Sets the model to use for the mouse. The name mostly specifies what
4541 the right mouse button is used for:
4542 extend Right mouse button extends a selection. This works
4543 like in an xterm.
4544 popup Right mouse button pops up a menu. The shifted left
4545 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004546 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 popup_setpos Like "popup", but the cursor will be moved to the
4548 position where the mouse was clicked, and thus the
4549 selected operation will act upon the clicked object.
4550 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004551 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 course, that right clicking outside a selection will
4553 end Visual mode.
4554 Overview of what button does what for each model:
4555 mouse extend popup(_setpos) ~
4556 left click place cursor place cursor
4557 left drag start selection start selection
4558 shift-left search word extend selection
4559 right click extend selection popup menu (place cursor)
4560 right drag extend selection -
4561 middle click paste paste
4562
4563 In the "popup" model the right mouse button produces a pop-up menu.
4564 You need to define this first, see |popup-menu|.
4565
4566 Note that you can further refine the meaning of buttons with mappings.
4567 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4568 selection (because that's handled in the GUI code directly).
4569
4570 The 'mousemodel' option is set by the |:behave| command.
4571
4572 *'mouseshape'* *'mouses'* *E547*
4573'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004574 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 global
4576 {not in Vi}
4577 {only available when compiled with the |+mouseshape|
4578 feature}
4579 This option tells Vim what the mouse pointer should look like in
4580 different modes. The option is a comma separated list of parts, much
4581 like used for 'guicursor'. Each part consist of a mode/location-list
4582 and an argument-list:
4583 mode-list:shape,mode-list:shape,..
4584 The mode-list is a dash separated list of these modes/locations:
4585 In a normal window: ~
4586 n Normal mode
4587 v Visual mode
4588 ve Visual mode with 'selection' "exclusive" (same as 'v',
4589 if not specified)
4590 o Operator-pending mode
4591 i Insert mode
4592 r Replace mode
4593
4594 Others: ~
4595 c appending to the command-line
4596 ci inserting in the command-line
4597 cr replacing in the command-line
4598 m at the 'Hit ENTER' or 'More' prompts
4599 ml idem, but cursor in the last line
4600 e any mode, pointer below last window
4601 s any mode, pointer on a status line
4602 sd any mode, while dragging a status line
4603 vs any mode, pointer on a vertical separator line
4604 vd any mode, while dragging a vertical separator line
4605 a everywhere
4606
4607 The shape is one of the following:
4608 avail name looks like ~
4609 w x arrow Normal mouse pointer
4610 w x blank no pointer at all (use with care!)
4611 w x beam I-beam
4612 w x updown up-down sizing arrows
4613 w x leftright left-right sizing arrows
4614 w x busy The system's usual busy pointer
4615 w x no The system's usual 'no input' pointer
4616 x udsizing indicates up-down resizing
4617 x lrsizing indicates left-right resizing
4618 x crosshair like a big thin +
4619 x hand1 black hand
4620 x hand2 white hand
4621 x pencil what you write with
4622 x question big ?
4623 x rightup-arrow arrow pointing right-up
4624 w x up-arrow arrow pointing up
4625 x <number> any X11 pointer number (see X11/cursorfont.h)
4626
4627 The "avail" column contains a 'w' if the shape is available for Win32,
4628 x for X11.
4629 Any modes not specified or shapes not available use the normal mouse
4630 pointer.
4631
4632 Example: >
4633 :set mouseshape=s:udsizing,m:no
4634< will make the mouse turn to a sizing arrow over the status lines and
4635 indicate no input when the hit-enter prompt is displayed (since
4636 clicking the mouse has no effect in this state.)
4637
4638 *'mousetime'* *'mouset'*
4639'mousetime' 'mouset' number (default 500)
4640 global
4641 {not in Vi}
4642 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4643 time in msec between two mouse clicks for the second click to be
4644 recognized as a multi click.
4645
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004646 *'mzquantum'* *'mzq'*
4647'mzquantum' 'mzq' number (default 100)
4648 global
4649 {not in Vi}
4650 {not available when compiled without the |+mzscheme|
4651 feature}
4652 The number of milliseconds between polls for MzScheme threads.
4653 Negative or zero value means no thread scheduling.
4654
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 *'nrformats'* *'nf'*
4656'nrformats' 'nf' string (default "octal,hex")
4657 local to buffer
4658 {not in Vi}
4659 This defines what bases Vim will consider for numbers when using the
4660 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4661 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004662 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 incremented or decremented. This is useful for a list with a
4664 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004665 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004667 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 considered to be hexadecimal. Example: Using CTRL-X on
4669 "0x100" results in "0x0ff".
4670 Numbers which simply begin with a digit in the range 1-9 are always
4671 considered decimal. This also happens for numbers that are not
4672 recognized as octal or hex.
4673
4674 *'number'* *'nu'* *'nonumber'* *'nonu'*
4675'number' 'nu' boolean (default off)
4676 local to window
4677 Print the line number in front of each line. When the 'n' option is
4678 excluded from 'cpoptions' a wrapped line will not use the column of
4679 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004680 The 'numberwidth' option can be used to set the room used for the line
4681 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 When a long, wrapped line doesn't start with the first character, '-'
4683 characters are put before the number.
4684 See |hl-LineNr| for the highlighting used for the number.
4685
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004686 *'numberwidth'* *'nuw'*
4687'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4688 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004689 {not in Vi}
4690 {only available when compiled with the |+linebreak|
4691 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004692 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004693 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004694 Since one space is always between the number and the text, there is
4695 one less character for the number itself.
4696 The value is the minimum width. A bigger width is used when needed to
4697 fit the highest line number in the buffer. Thus with the Vim default
4698 of 4 there is room for a line number up to 999. When the buffer has
4699 1000 lines five columns will be used.
4700 The minimum value is 1, the maximum value is 10.
4701 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4702
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004703 *'omnifunc'* *'ofu'*
4704'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004705 local to buffer
4706 {not in Vi}
4707 {not available when compiled without the +eval
4708 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004709 This option specifies a function to be used for Insert mode omni
4710 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004711 See |complete-functions| for an explanation of how the function is
4712 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004713
4714
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004715 *'operatorfunc'* *'opfunc'*
4716'operatorfunc' 'opfunc' string (default: empty)
4717 global
4718 {not in Vi}
4719 This option specifies a function to be called by the |g@| operator.
4720 See |:map-operator| for more info and an example.
4721
4722 This option cannot be set from a |modeline| or in the |sandbox|, for
4723 security reasons.
4724
4725
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 *'osfiletype'* *'oft'* *E366*
4727'osfiletype' 'oft' string (RISC-OS default: "Text",
4728 others default: "")
4729 local to buffer
4730 {not in Vi}
4731 {only available when compiled with the |+osfiletype|
4732 feature}
4733 Some operating systems store extra information about files besides
4734 name, datestamp and permissions. This option contains the extra
4735 information, the nature of which will vary between systems.
4736 The value of this option is usually set when the file is loaded, and
4737 use to set the file type when file is written.
4738 It can affect the pattern matching of the automatic commands.
4739 |autocmd-osfiletypes|
4740
4741 *'paragraphs'* *'para'*
4742'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4743 global
4744 Specifies the nroff macros that separate paragraphs. These are pairs
4745 of two letters (see |object-motions|).
4746
4747 *'paste'* *'nopaste'*
4748'paste' boolean (default off)
4749 global
4750 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004751 Put Vim in Paste mode. This is useful if you want to cut or copy
4752 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 unexpected effects.
4754 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004755 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 knows about pasting and will mostly do the right thing without 'paste'
4757 being set. The same is true for a terminal where Vim handles the
4758 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004759 This option is reset when starting the GUI. Thus if you set it in
4760 your .vimrc it will work in a terminal, but not in the GUI. Setting
4761 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4762 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 When the 'paste' option is switched on (also when it was already on):
4764 - mapping in Insert mode and Command-line mode is disabled
4765 - abbreviations are disabled
4766 - 'textwidth' is set to 0
4767 - 'wrapmargin' is set to 0
4768 - 'autoindent' is reset
4769 - 'smartindent' is reset
4770 - 'softtabstop' is set to 0
4771 - 'revins' is reset
4772 - 'ruler' is reset
4773 - 'showmatch' is reset
4774 - 'formatoptions' is used like it is empty
4775 These options keep their value, but their effect is disabled:
4776 - 'lisp'
4777 - 'indentexpr'
4778 - 'cindent'
4779 NOTE: When you start editing another file while the 'paste' option is
4780 on, settings from the modelines or autocommands may change the
4781 settings again, causing trouble when pasting text. You might want to
4782 set the 'paste' option again.
4783 When the 'paste' option is reset the mentioned options are restored to
4784 the value before the moment 'paste' was switched from off to on.
4785 Resetting 'paste' before ever setting it does not have any effect.
4786 Since mapping doesn't work while 'paste' is active, you need to use
4787 the 'pastetoggle' option to toggle the 'paste' option with some key.
4788
4789 *'pastetoggle'* *'pt'*
4790'pastetoggle' 'pt' string (default "")
4791 global
4792 {not in Vi}
4793 When non-empty, specifies the key sequence that toggles the 'paste'
4794 option. This is like specifying a mapping: >
4795 :map {keys} :set invpaste<CR>
4796< Where {keys} is the value of 'pastetoggle'.
4797 The difference is that it will work even when 'paste' is set.
4798 'pastetoggle' works in Insert mode and Normal mode, but not in
4799 Command-line mode.
4800 Mappings are checked first, thus overrule 'pastetoggle'. However,
4801 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4802 this: >
4803 :map <F10> :set paste<CR>
4804 :map <F11> :set nopaste<CR>
4805 :imap <F10> <C-O>:set paste<CR>
4806 :imap <F11> <nop>
4807 :set pastetoggle=<F11>
4808< This will make <F10> start paste mode and <F11> stop paste mode.
4809 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4810 mode everything is inserted literally, except the 'pastetoggle' key
4811 sequence.
4812
4813 *'pex'* *'patchexpr'*
4814'patchexpr' 'pex' string (default "")
4815 global
4816 {not in Vi}
4817 {not available when compiled without the |+diff|
4818 feature}
4819 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004820 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821
4822 *'patchmode'* *'pm'* *E206*
4823'patchmode' 'pm' string (default "")
4824 global
4825 {not in Vi}
4826 When non-empty the oldest version of a file is kept. This can be used
4827 to keep the original version of a file if you are changing files in a
4828 source distribution. Only the first time that a file is written a
4829 copy of the original file will be kept. The name of the copy is the
4830 name of the original file with the string in the 'patchmode' option
4831 appended. This option should start with a dot. Use a string like
4832 ".org". 'backupdir' must not be empty for this to work (Detail: The
4833 backup file is renamed to the patchmode file after the new file has
4834 been successfully written, that's why it must be possible to write a
4835 backup file). If there was no file to be backed up, an empty file is
4836 created.
4837 When the 'backupskip' pattern matches, a patchmode file is not made.
4838 Using 'patchmode' for compressed files appends the extension at the
4839 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4840 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004841 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842
4843 *'path'* *'pa'* *E343* *E345* *E347*
4844'path' 'pa' string (default on Unix: ".,/usr/include,,"
4845 on OS/2: ".,/emx/include,,"
4846 other systems: ".,,")
4847 global or local to buffer |global-local|
4848 {not in Vi}
4849 This is a list of directories which will be searched when using the
4850 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4851 being searched for has a relative path (not starting with '/'). The
4852 directories in the 'path' option may be relative or absolute.
4853 - Use commas to separate directory names: >
4854 :set path=.,/usr/local/include,/usr/include
4855< - Spaces can also be used to separate directory names (for backwards
4856 compatibility with version 3.0). To have a space in a directory
4857 name, precede it with an extra backslash, and escape the space: >
4858 :set path=.,/dir/with\\\ space
4859< - To include a comma in a directory name precede it with an extra
4860 backslash: >
4861 :set path=.,/dir/with\\,comma
4862< - To search relative to the directory of the current file, use: >
4863 :set path=.
4864< - To search in the current directory use an empty string between two
4865 commas: >
4866 :set path=,,
4867< - A directory name may end in a ':' or '/'.
4868 - Environment variables are expanded |:set_env|.
4869 - When using |netrw.vim| URLs can be used. For example, adding
4870 "http://www.vim.org" will make ":find index.html" work.
4871 - Search upwards and downwards in a directory tree:
4872 1) "*" matches a sequence of characters, e.g.: >
4873 :set path=/usr/include/*
4874< means all subdirectories in /usr/include (but not /usr/include
4875 itself). >
4876 :set path=/usr/*c
4877< matches /usr/doc and /usr/src.
4878 2) "**" matches a subtree, up to 100 directories deep. Example: >
4879 :set path=/home/user_x/src/**
4880< means search in the whole subtree under "/home/usr_x/src".
4881 3) If the path ends with a ';', this path is the startpoint
4882 for upward search.
4883 See |file-searching| for more info and exact syntax.
4884 {not available when compiled without the |+path_extra| feature}
4885 - Careful with '\' characters, type two to get one in the option: >
4886 :set path=.,c:\\include
4887< Or just use '/' instead: >
4888 :set path=.,c:/include
4889< Don't forget "." or files won't even be found in the same directory as
4890 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004891 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 it is something like 256 or 1024 characters.
4893 You can check if all the include files are found, using the value of
4894 'path', see |:checkpath|.
4895 The use of |:set+=| and |:set-=| is preferred when adding or removing
4896 directories from the list. This avoids problems when a future version
4897 uses another default. To remove the current directory use: >
4898 :set path-=
4899< To add the current directory use: >
4900 :set path+=
4901< To use an environment variable, you probably need to replace the
4902 separator. Here is an example to append $INCL, in which directory
4903 names are separated with a semi-colon: >
4904 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4905< Replace the ';' with a ':' or whatever separator is used. Note that
4906 this doesn't work when $INCL contains a comma or white space.
4907
4908 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4909'preserveindent' 'pi' boolean (default off)
4910 local to buffer
4911 {not in Vi}
4912 When changing the indent of the current line, preserve as much of the
4913 indent structure as possible. Normally the indent is replaced by a
4914 series of tabs followed by spaces as required (unless |'expandtab'| is
4915 enabled, in which case only spaces are used). Enabling this option
4916 means the indent will preserve as many existing characters as possible
4917 for indenting, and only add additional tabs or spaces as required.
4918 NOTE: When using ">>" multiple times the resulting indent is a mix of
4919 tabs and spaces. You might not like this.
4920 NOTE: 'preserveindent' is reset when 'compatible' is set.
4921 Also see 'copyindent'.
4922 Use |:retab| to clean up white space.
4923
4924 *'previewheight'* *'pvh'*
4925'previewheight' 'pvh' number (default 12)
4926 global
4927 {not in Vi}
4928 {not available when compiled without the |+windows| or
4929 |+quickfix| feature}
4930 Default height for a preview window. Used for |:ptag| and associated
4931 commands. Used for |CTRL-W_}| when no count is given.
4932
4933 *'previewwindow'* *'nopreviewwindow'*
4934 *'pvw'* *'nopvw'* *E590*
4935'previewwindow' 'pvw' boolean (default off)
4936 local to window
4937 {not in Vi}
4938 {not available when compiled without the |+windows| or
4939 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004940 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941 set. It's normally not set directly, but by using one of the commands
4942 |:ptag|, |:pedit|, etc.
4943
4944 *'printdevice'* *'pdev'*
4945'printdevice' 'pdev' string (default empty)
4946 global
4947 {not in Vi}
4948 {only available when compiled with the |+printer|
4949 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004950 The name of the printer to be used for |:hardcopy|.
4951 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004952 This option cannot be set from a |modeline| or in the |sandbox|, for
4953 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954
Bram Moolenaar8299df92004-07-10 09:47:34 +00004955 *'printencoding'* *'penc'*
4956'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 global
4958 {not in Vi}
4959 {only available when compiled with the |+printer|
4960 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004961 Sets the character encoding used when printing.
4962 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963
4964 *'printexpr'* *'pexpr'*
4965'printexpr' 'pexpr' String (default: see below)
4966 global
4967 {not in Vi}
4968 {only available when compiled with the |+printer|
4969 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004970 Expression used to print the PostScript produced with |:hardcopy|.
4971 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972
Bram Moolenaar8299df92004-07-10 09:47:34 +00004973 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974'printfont' 'pfn' string (default "courier")
4975 global
4976 {not in Vi}
4977 {only available when compiled with the |+printer|
4978 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004979 The name of the font that will be used for |:hardcopy|.
4980 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981
4982 *'printheader'* *'pheader'*
4983'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4984 global
4985 {not in Vi}
4986 {only available when compiled with the |+printer|
4987 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004988 The format of the header produced in |:hardcopy| output.
4989 See |pheader-option|.
4990
4991 *'printmbcharset'* *'pmbcs'*
4992'printmbcharset' 'pmbcs' string (default "")
4993 global
4994 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004995 {only available when compiled with the |+printer|,
4996 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004997 The CJK character set to be used for CJK output from |:hardcopy|.
4998 See |pmbcs-option|.
4999
5000 *'printmbfont'* *'pmbfn'*
5001'printmbfont' 'pmbfn' string (default "")
5002 global
5003 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005004 {only available when compiled with the |+printer|,
5005 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005006 List of font names to be used for CJK output from |:hardcopy|.
5007 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008
5009 *'printoptions'* *'popt'*
5010'printoptions' 'popt' string (default "")
5011 global
5012 {not in Vi}
5013 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005014 List of items that control the format of the output of |:hardcopy|.
5015 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005017 *'prompt'* *'noprompt'*
5018'prompt' boolean (default on)
5019 global
5020 When on a ":" prompt is used in Ex mode.
5021
Bram Moolenaar677ee682005-01-27 14:41:15 +00005022 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005023'quoteescape' 'qe' string (default "\")
5024 local to buffer
5025 {not in Vi}
5026 The characters that are used to escape quotes in a string. Used for
5027 objects like a', a" and a` |a'|.
5028 When one of the characters in this option is found inside a string,
5029 the following character will be skipped. The default value makes the
5030 text "foo\"bar\\" considered to be one string.
5031
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5033'readonly' 'ro' boolean (default off)
5034 local to buffer
5035 If on, writes fail unless you use a '!'. Protects you from
5036 accidentally overwriting a file. Default on when Vim is started
5037 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005038 When using ":w!" the 'readonly' option is reset for the current
5039 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005041 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042
5043 *'remap'* *'noremap'*
5044'remap' boolean (default on)
5045 global
5046 Allows for mappings to work recursively. If you do not want this for
5047 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005048 NOTE: To avoid portability problems with Vim scripts, always keep
5049 this option at the default "on". Only switch it off when working with
5050 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051
5052 *'report'*
5053'report' number (default 2)
5054 global
5055 Threshold for reporting number of lines changed. When the number of
5056 changed lines is more than 'report' a message will be given for most
5057 ":" commands. If you want it always, set 'report' to 0.
5058 For the ":substitute" command the number of substitutions is used
5059 instead of the number of lines.
5060
5061 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5062'restorescreen' 'rs' boolean (default on)
5063 global
5064 {not in Vi} {only in Windows 95/NT console version}
5065 When set, the screen contents is restored when exiting Vim. This also
5066 happens when executing external commands.
5067
5068 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5069 options in your .vimrc. To disable restoring:
5070 set t_ti= t_te=
5071 To enable restoring (for an xterm):
5072 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5073 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5074
5075 *'revins'* *'ri'* *'norevins'* *'nori'*
5076'revins' 'ri' boolean (default off)
5077 global
5078 {not in Vi}
5079 {only available when compiled with the |+rightleft|
5080 feature}
5081 Inserting characters in Insert mode will work backwards. See "typing
5082 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5083 command in Insert mode, when 'allowrevins' is set.
5084 NOTE: This option is reset when 'compatible' or 'paste' is set.
5085
5086 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5087'rightleft' 'rl' boolean (default off)
5088 local to window
5089 {not in Vi}
5090 {only available when compiled with the |+rightleft|
5091 feature}
5092 When on, display orientation becomes right-to-left, i.e., characters
5093 that are stored in the file appear from the right to the left.
5094 Using this option, it is possible to edit files for languages that
5095 are written from the right to the left such as Hebrew and Arabic.
5096 This option is per window, so it is possible to edit mixed files
5097 simultaneously, or to view the same file in both ways (this is
5098 useful whenever you have a mixed text file with both right-to-left
5099 and left-to-right strings so that both sets are displayed properly
5100 in different windows). Also see |rileft.txt|.
5101
5102 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5103'rightleftcmd' 'rlc' string (default "search")
5104 local to window
5105 {not in Vi}
5106 {only available when compiled with the |+rightleft|
5107 feature}
5108 Each word in this option enables the command line editing to work in
5109 right-to-left mode for a group of commands:
5110
5111 search "/" and "?" commands
5112
5113 This is useful for languages such as Hebrew, Arabic and Farsi.
5114 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5115
5116 *'ruler'* *'ru'* *'noruler'* *'noru'*
5117'ruler' 'ru' boolean (default off)
5118 global
5119 {not in Vi}
5120 {not available when compiled without the
5121 |+cmdline_info| feature}
5122 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005123 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 text in the file is shown on the far right:
5125 Top first line is visible
5126 Bot last line is visible
5127 All first and last line are visible
5128 45% relative position in the file
5129 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005130 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005132 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 this option takes precedence over 'ruler' and 'rulerformat'
5134 If the number of characters displayed is different from the number of
5135 bytes in the text (e.g., for a TAB or a multi-byte character), both
5136 the text column (byte number) and the screen column are shown,
5137 separated with a dash.
5138 For an empty line "0-1" is shown.
5139 For an empty buffer the line number will also be zero: "0,0-1".
5140 This option is reset when the 'paste' option is set.
5141 If you don't want to see the ruler all the time but want to know where
5142 you are, use "g CTRL-G" |g_CTRL-G|.
5143 NOTE: This option is reset when 'compatible' is set.
5144
5145 *'rulerformat'* *'ruf'*
5146'rulerformat' 'ruf' string (default empty)
5147 global
5148 {not in Vi}
5149 {not available when compiled without the |+statusline|
5150 feature}
5151 When this option is not empty, it determines the content of the ruler
5152 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005153 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 The default ruler width is 17 characters. To make the ruler 15
5155 characters wide, put "%15(" at the start and "%)" at the end.
5156 Example: >
5157 :set rulerformat=%15(%c%V\ %p%%%)
5158<
5159 *'runtimepath'* *'rtp'* *vimfiles*
5160'runtimepath' 'rtp' string (default:
5161 Unix: "$HOME/.vim,
5162 $VIM/vimfiles,
5163 $VIMRUNTIME,
5164 $VIM/vimfiles/after,
5165 $HOME/.vim/after"
5166 Amiga: "home:vimfiles,
5167 $VIM/vimfiles,
5168 $VIMRUNTIME,
5169 $VIM/vimfiles/after,
5170 home:vimfiles/after"
5171 PC, OS/2: "$HOME/vimfiles,
5172 $VIM/vimfiles,
5173 $VIMRUNTIME,
5174 $VIM/vimfiles/after,
5175 $HOME/vimfiles/after"
5176 Macintosh: "$VIM:vimfiles,
5177 $VIMRUNTIME,
5178 $VIM:vimfiles:after"
5179 RISC-OS: "Choices:vimfiles,
5180 $VIMRUNTIME,
5181 Choices:vimfiles/after"
5182 VMS: "sys$login:vimfiles,
5183 $VIM/vimfiles,
5184 $VIMRUNTIME,
5185 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005186 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 global
5188 {not in Vi}
5189 This is a list of directories which will be searched for runtime
5190 files:
5191 filetype.vim filetypes by file name |new-filetype|
5192 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005193 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 colors/ color scheme files |:colorscheme|
5195 compiler/ compiler files |:compiler|
5196 doc/ documentation |write-local-help|
5197 ftplugin/ filetype plugins |write-filetype-plugin|
5198 indent/ indent scripts |indent-expression|
5199 keymap/ key mapping files |mbyte-keymap|
5200 lang/ menu translations |:menutrans|
5201 menu.vim GUI menus |menu.vim|
5202 plugin/ plugin scripts |write-plugin|
5203 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005204 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 syntax/ syntax files |mysyntaxfile|
5206 tutor/ files for vimtutor |tutor|
5207
5208 And any other file searched for with the |:runtime| command.
5209
5210 The defaults for most systems are setup to search five locations:
5211 1. In your home directory, for your personal preferences.
5212 2. In a system-wide Vim directory, for preferences from the system
5213 administrator.
5214 3. In $VIMRUNTIME, for files distributed with Vim.
5215 *after-directory*
5216 4. In the "after" directory in the system-wide Vim directory. This is
5217 for the system administrator to overrule or add to the distributed
5218 defaults (rarely needed)
5219 5. In the "after" directory in your home directory. This is for
5220 personal preferences to overrule or add to the distributed defaults
5221 or system-wide settings (rarely needed).
5222
5223 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5224 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005225 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 wildcards.
5227 See |:runtime|.
5228 Example: >
5229 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5230< This will use the directory "~/vimruntime" first (containing your
5231 personal Vim runtime files), then "/mygroup/vim" (shared between a
5232 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5233 files).
5234 You probably should always include $VIMRUNTIME somewhere, to use the
5235 distributed runtime files. You can put a directory before $VIMRUNTIME
5236 to find files which replace a distributed runtime files. You can put
5237 a directory after $VIMRUNTIME to find files which add to distributed
5238 runtime files.
5239 This option cannot be set from a |modeline| or in the |sandbox|, for
5240 security reasons.
5241
5242 *'scroll'* *'scr'*
5243'scroll' 'scr' number (default: half the window height)
5244 local to window
5245 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5246 set to half the number of lines in the window when the window size
5247 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005248 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5250 the number of screen lines instead of file lines, makes a difference
5251 when lines wrap}
5252
5253 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5254'scrollbind' 'scb' boolean (default off)
5255 local to window
5256 {not in Vi}
5257 {not available when compiled without the |+scrollbind|
5258 feature}
5259 See also |scroll-binding|. When this option is set, the current
5260 window scrolls as other scrollbind windows (windows that also have
5261 this option set) scroll. This option is useful for viewing the
5262 differences between two versions of a file, see 'diff'.
5263 See |'scrollopt'| for options that determine how this option should be
5264 interpreted.
5265 This option is mostly reset when splitting a window to edit another
5266 file. This means that ":split | edit file" results in two windows
5267 with scroll-binding, but ":split file" does not.
5268
5269 *'scrolljump'* *'sj'*
5270'scrolljump' 'sj' number (default 1)
5271 global
5272 {not in Vi}
5273 Minimal number of lines to scroll when the cursor gets off the
5274 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5275 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005276 When set to a negative number from -1 to -100 this is used as the
5277 percentage of the window height. Thus -50 scrolls half the window
5278 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 NOTE: This option is set to 1 when 'compatible' is set.
5280
5281 *'scrolloff'* *'so'*
5282'scrolloff' 'so' number (default 0)
5283 global
5284 {not in Vi}
5285 Minimal number of screen lines to keep above and below the cursor.
5286 This will make some context visible around where you are working. If
5287 you set it to a very large value (999) the cursor line will always be
5288 in the middle of the window (except at the start or end of the file or
5289 when long lines wrap).
5290 For scrolling horizontally see 'sidescrolloff'.
5291 NOTE: This option is set to 0 when 'compatible' is set.
5292
5293 *'scrollopt'* *'sbo'*
5294'scrollopt' 'sbo' string (default "ver,jump")
5295 global
5296 {not available when compiled without the |+scrollbind|
5297 feature}
5298 {not in Vi}
5299 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005300 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5301 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302 The following words are available:
5303 ver Bind vertical scrolling for 'scrollbind' windows
5304 hor Bind horizontal scrolling for 'scrollbind' windows
5305 jump Applies to the offset between two windows for vertical
5306 scrolling. This offset is the difference in the first
5307 displayed line of the bound windows. When moving
5308 around in a window, another 'scrollbind' window may
5309 reach a position before the start or after the end of
5310 the buffer. The offset is not changed though, when
5311 moving back the 'scrollbind' window will try to scroll
5312 to the desired position when possible.
5313 When now making that window the current one, two
5314 things can be done with the relative offset:
5315 1. When "jump" is not included, the relative offset is
5316 adjusted for the scroll position in the new current
5317 window. When going back to the other window, the
5318 the new relative offset will be used.
5319 2. When "jump" is included, the other windows are
5320 scrolled to keep the same relative offset. When
5321 going back to the other window, it still uses the
5322 same relative offset.
5323 Also see |scroll-binding|.
5324
5325 *'sections'* *'sect'*
5326'sections' 'sect' string (default "SHNHH HUnhsh")
5327 global
5328 Specifies the nroff macros that separate sections. These are pairs of
5329 two letters (See |object-motions|). The default makes a section start
5330 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5331
5332 *'secure'* *'nosecure'* *E523*
5333'secure' boolean (default off)
5334 global
5335 {not in Vi}
5336 When on, ":autocmd", shell and write commands are not allowed in
5337 ".vimrc" and ".exrc" in the current directory and map commands are
5338 displayed. Switch it off only if you know that you will not run into
5339 problems, or when the 'exrc' option is off. On Unix this option is
5340 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005341 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 'secure' at the end of your ~/.vimrc then.
5343 This option cannot be set from a |modeline| or in the |sandbox|, for
5344 security reasons.
5345
5346 *'selection'* *'sel'*
5347'selection' 'sel' string (default "inclusive")
5348 global
5349 {not in Vi}
5350 This option defines the behavior of the selection. It is only used
5351 in Visual and Select mode.
5352 Possible values:
5353 value past line inclusive ~
5354 old no yes
5355 inclusive yes yes
5356 exclusive yes no
5357 "past line" means that the cursor is allowed to be positioned one
5358 character past the line.
5359 "inclusive" means that the last character of the selection is included
5360 in an operation. For example, when "x" is used to delete the
5361 selection.
5362 Note that when "exclusive" is used and selecting from the end
5363 backwards, you cannot include the last character of a line, when
5364 starting in Normal mode and 'virtualedit' empty.
5365
5366 The 'selection' option is set by the |:behave| command.
5367
5368 *'selectmode'* *'slm'*
5369'selectmode' 'slm' string (default "")
5370 global
5371 {not in Vi}
5372 This is a comma separated list of words, which specifies when to start
5373 Select mode instead of Visual mode, when a selection is started.
5374 Possible values:
5375 mouse when using the mouse
5376 key when using shifted special keys
5377 cmd when using "v", "V" or CTRL-V
5378 See |Select-mode|.
5379 The 'selectmode' option is set by the |:behave| command.
5380
5381 *'sessionoptions'* *'ssop'*
5382'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5383 help,options,winsize")
5384 global
5385 {not in Vi}
5386 {not available when compiled without the +mksession
5387 feature}
5388 Changes the effect of the |:mksession| command. It is a comma
5389 separated list of words. Each word enables saving and restoring
5390 something:
5391 word save and restore ~
5392 blank empty windows
5393 buffers hidden and unloaded buffers, not just those in windows
5394 curdir the current directory
5395 folds manually created folds, opened/closed folds and local
5396 fold options
5397 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005398 and contain at least one lowercase letter. Only
5399 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400 help the help window
5401 localoptions options and mappings local to a window or buffer (not
5402 global values for local options)
5403 options all options and mappings (also global values for local
5404 options)
5405 resize size of the Vim window: 'lines' and 'columns'
5406 sesdir the directory in which the session file is located
5407 will become the current directory (useful with
5408 projects accessed over a network from different
5409 systems)
5410 slash backslashes in file names replaced with forward
5411 slashes
5412 unix with Unix end-of-line format (single <NL>), even when
5413 on Windows or DOS
5414 winpos position of the whole Vim window
5415 winsize window sizes
5416
5417 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005418 There is no option to include tab pages yet, only the current tab page
5419 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 When "curdir" nor "sesdir" is included, file names are stored with
5421 absolute paths.
5422 "slash" and "unix" are useful on Windows when sharing session files
5423 with Unix. The Unix version of Vim cannot source dos format scripts,
5424 but the Windows version of Vim can source unix format scripts.
5425
5426 *'shell'* *'sh'* *E91*
5427'shell' 'sh' string (default $SHELL or "sh",
5428 MS-DOS and Win32: "command.com" or
5429 "cmd.exe", OS/2: "cmd")
5430 global
5431 Name of the shell to use for ! and :! commands. When changing the
5432 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5433 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005434 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 See |option-backslash| about including spaces and backslashes.
5436 Environment variables are expanded |:set_env|.
5437 If the name of the shell contains a space, you might need to enclose
5438 it in quotes. Example: >
5439 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5440< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005441 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 "-f" is not inside the quotes, because it is not part of the command
5443 name. And Vim automagically recognizes the backslashes that are path
5444 separators.
5445 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5446 variable to change the way external commands are executed. See the
5447 libc.inf file of DJGPP.
5448 Under MS-Windows, when the executable ends in ".com" it must be
5449 included. Thus setting the shell to "command.com" or "4dos.com"
5450 works, but "command" and "4dos" do not work for all commands (e.g.,
5451 filtering).
5452 For unknown reasons, when using "4dos.com" the current directory is
5453 changed to "C:\". To avoid this set 'shell' like this: >
5454 :set shell=command.com\ /c\ 4dos
5455< This option cannot be set from a |modeline| or in the |sandbox|, for
5456 security reasons.
5457
5458 *'shellcmdflag'* *'shcf'*
5459'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5460 does not contain "sh" somewhere: "/c")
5461 global
5462 {not in Vi}
5463 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5464 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5465 systems, the default is set according to the value of 'shell', to
5466 reduce the need to set this option by the user. It's not used for
5467 OS/2 (EMX figures this out itself). See |option-backslash| about
5468 including spaces and backslashes. See |dos-shell|.
5469 This option cannot be set from a |modeline| or in the |sandbox|, for
5470 security reasons.
5471
5472 *'shellpipe'* *'sp'*
5473'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5474 global
5475 {not in Vi}
5476 {not available when compiled without the |+quickfix|
5477 feature}
5478 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005479 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 including spaces and backslashes.
5481 The name of the temporary file can be represented by "%s" if necessary
5482 (the file name is appended automatically if no %s appears in the value
5483 of this option).
5484 For the Amiga and MS-DOS the default is ">". The output is directly
5485 saved in a file and not echoed to the screen.
5486 For Unix the default it "| tee". The stdout of the compiler is saved
5487 in a file and echoed to the screen. If the 'shell' option is "csh" or
5488 "tcsh" after initializations, the default becomes "|& tee". If the
5489 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5490 "2>&1| tee". This means that stderr is also included.
5491 The initialization of this option is done after reading the ".vimrc"
5492 and the other initializations, so that when the 'shell' option is set
5493 there, the 'shellpipe' option changes automatically, unless it was
5494 explicitly set before.
5495 When 'shellpipe' is set to an empty string, no redirection of the
5496 ":make" output will be done. This is useful if you use a 'makeprg'
5497 that writes to 'makeef' by itself. If you want no piping, but do
5498 want to include the 'makeef', set 'shellpipe' to a single space.
5499 Don't forget to precede the space with a backslash: ":set sp=\ ".
5500 In the future pipes may be used for filtering and this option will
5501 become obsolete (at least for Unix).
5502 This option cannot be set from a |modeline| or in the |sandbox|, for
5503 security reasons.
5504
5505 *'shellquote'* *'shq'*
5506'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5507 contains "sh" somewhere: "\"")
5508 global
5509 {not in Vi}
5510 Quoting character(s), put around the command passed to the shell, for
5511 the "!" and ":!" commands. The redirection is kept outside of the
5512 quoting. See 'shellxquote' to include the redirection. It's
5513 probably not useful to set both options.
5514 This is an empty string by default. Only known to be useful for
5515 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5516 or bash, where it should be "\"". The default is adjusted according
5517 the value of 'shell', to reduce the need to set this option by the
5518 user. See |dos-shell|.
5519 This option cannot be set from a |modeline| or in the |sandbox|, for
5520 security reasons.
5521
5522 *'shellredir'* *'srr'*
5523'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5524 global
5525 {not in Vi}
5526 String to be used to put the output of a filter command in a temporary
5527 file. See also |:!|. See |option-backslash| about including spaces
5528 and backslashes.
5529 The name of the temporary file can be represented by "%s" if necessary
5530 (the file name is appended automatically if no %s appears in the value
5531 of this option).
5532 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5533 or "zsh" during initializations, the default becomes ">&". If the
5534 'shell' option is "sh", "ksh" or "bash" the default becomes
5535 ">%s 2>&1". This means that stderr is also included.
5536 For Win32, the Unix checks are done and additionally "cmd" is checked
5537 for, which makes the default ">%s 2>&1". Also, the same names with
5538 ".exe" appended are checked for.
5539 The initialization of this option is done after reading the ".vimrc"
5540 and the other initializations, so that when the 'shell' option is set
5541 there, the 'shellredir' option changes automatically unless it was
5542 explicitly set before.
5543 In the future pipes may be used for filtering and this option will
5544 become obsolete (at least for Unix).
5545 This option cannot be set from a |modeline| or in the |sandbox|, for
5546 security reasons.
5547
5548 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5549'shellslash' 'ssl' boolean (default off)
5550 global
5551 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5552 When set, a forward slash is used when expanding file names. This is
5553 useful when a Unix-like shell is used instead of command.com or
5554 cmd.exe. Backward slashes can still be typed, but they are changed to
5555 forward slashes by Vim.
5556 Note that setting or resetting this option has no effect for some
5557 existing file names, thus this option needs to be set before opening
5558 any file for best results. This might change in the future.
5559 'shellslash' only works when a backslash can be used as a path
5560 separator. To test if this is so use: >
5561 if exists('+shellslash')
5562<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005563 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5564'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5565 global
5566 {not in Vi}
5567 When on, use temp files for shell commands. When off use a pipe.
5568 When using a pipe is not possible temp files are used anyway.
5569 Currently a pipe is only supported on Unix. You can check it with: >
5570 :if has("filterpipe")
5571< The advantage of using a pipe is that nobody can read the temp file
5572 and the 'shell' command does not need to support redirection.
5573 The advantage of using a temp file is that the file type and encoding
5574 can be detected.
5575 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5576 |FilterWritePost| autocommands event are not triggered when
5577 'shelltemp' is off.
5578
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 *'shelltype'* *'st'*
5580'shelltype' 'st' number (default 0)
5581 global
5582 {not in Vi} {only for the Amiga}
5583 On the Amiga this option influences the way how the commands work
5584 which use a shell.
5585 0 and 1: always use the shell
5586 2 and 3: use the shell only to filter lines
5587 4 and 5: use shell only for ':sh' command
5588 When not using the shell, the command is executed directly.
5589
5590 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5591 1 and 3: use "shell cmd" to start external commands
5592
5593 *'shellxquote'* *'sxq'*
5594'shellxquote' 'sxq' string (default: "";
5595 for Win32, when 'shell' contains "sh"
5596 somewhere: "\""
5597 for Unix, when using system(): "\"")
5598 global
5599 {not in Vi}
5600 Quoting character(s), put around the command passed to the shell, for
5601 the "!" and ":!" commands. Includes the redirection. See
5602 'shellquote' to exclude the redirection. It's probably not useful
5603 to set both options.
5604 This is an empty string by default. Known to be useful for
5605 third-party shells when using the Win32 version, such as the MKS Korn
5606 Shell or bash, where it should be "\"". The default is adjusted
5607 according the value of 'shell', to reduce the need to set this option
5608 by the user. See |dos-shell|.
5609 This option cannot be set from a |modeline| or in the |sandbox|, for
5610 security reasons.
5611
5612 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5613'shiftround' 'sr' boolean (default off)
5614 global
5615 {not in Vi}
5616 Round indent to multiple of 'shiftwidth'. Applies to > and <
5617 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5618 a multiple of 'shiftwidth' (this is Vi compatible).
5619 NOTE: This option is reset when 'compatible' is set.
5620
5621 *'shiftwidth'* *'sw'*
5622'shiftwidth' 'sw' number (default 8)
5623 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005624 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 |'cindent'|, |>>|, |<<|, etc.
5626
5627 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005628'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5629 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 global
5631 {not in Vi}
5632 This option helps to avoid all the |hit-enter| prompts caused by file
5633 messages, for example with CTRL-G, and to avoid some other messages.
5634 It is a list of flags:
5635 flag meaning when present ~
5636 f use "(3 of 5)" instead of "(file 3 of 5)"
5637 i use "[noeol]" instead of "[Incomplete last line]"
5638 l use "999L, 888C" instead of "999 lines, 888 characters"
5639 m use "[+]" instead of "[Modified]"
5640 n use "[New]" instead of "[New File]"
5641 r use "[RO]" instead of "[readonly]"
5642 w use "[w]" instead of "written" for file write message
5643 and "[a]" instead of "appended" for ':w >> file' command
5644 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5645 "[unix format]" and "[mac]" instead of "[mac format]".
5646 a all of the above abbreviations
5647
5648 o overwrite message for writing a file with subsequent message
5649 for reading a file (useful for ":wn" or when 'autowrite' on)
5650 O message for reading a file overwrites any previous message.
5651 Also for quickfix message (e.g., ":cn").
5652 s don't give "search hit BOTTOM, continuing at TOP" or "search
5653 hit TOP, continuing at BOTTOM" messages
5654 t truncate file message at the start if it is too long to fit
5655 on the command-line, "<" will appear in the left most column.
5656 Ignored in Ex mode.
5657 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005658 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 Ignored in Ex mode.
5660 W don't give "written" or "[w]" when writing a file
5661 A don't give the "ATTENTION" message when an existing swap file
5662 is found.
5663 I don't give the intro message when starting Vim |:intro|.
5664
5665 This gives you the opportunity to avoid that a change between buffers
5666 requires you to hit <Enter>, but still gives as useful a message as
5667 possible for the space available. To get the whole message that you
5668 would have got with 'shm' empty, use ":file!"
5669 Useful values:
5670 shm= No abbreviation of message.
5671 shm=a Abbreviation, but no loss of information.
5672 shm=at Abbreviation, and truncate message when necessary.
5673
5674 NOTE: This option is set to the Vi default value when 'compatible' is
5675 set and to the Vim default value when 'compatible' is reset.
5676
5677 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5678'shortname' 'sn' boolean (default off)
5679 local to buffer
5680 {not in Vi, not in MS-DOS versions}
5681 Filenames are assumed to be 8 characters plus one extension of 3
5682 characters. Multiple dots in file names are not allowed. When this
5683 option is on, dots in file names are replaced with underscores when
5684 adding an extension (".~" or ".swp"). This option is not available
5685 for MS-DOS, because then it would always be on. This option is useful
5686 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5687 or crossdos. When running the Win32 GUI version under Win32s, this
5688 option is always on by default.
5689
5690 *'showbreak'* *'sbr'* *E595*
5691'showbreak' 'sbr' string (default "")
5692 global
5693 {not in Vi}
5694 {not available when compiled without the |+linebreak|
5695 feature}
5696 String to put at the start of lines that have been wrapped. Useful
5697 values are "> " or "+++ ".
5698 Only printable single-cell characters are allowed, excluding <Tab> and
5699 comma (in a future version the comma might be used to separate the
5700 part that is shown at the end and at the start of a line).
5701 The characters are highlighted according to the '@' flag in
5702 'highlight'.
5703 Note that tabs after the showbreak will be displayed differently.
5704 If you want the 'showbreak' to appear in between line numbers, add the
5705 "n" flag to 'cpoptions'.
5706
5707 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5708'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5709 off)
5710 global
5711 {not in Vi}
5712 {not available when compiled without the
5713 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005714 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 terminal is slow.
5716 In Visual mode the size of the selected area is shown:
5717 - When selecting characters within a line, the number of characters.
5718 - When selecting more than one line, the number of lines.
5719 - When selecting a block, the size in screen characters: linesxcolumns.
5720 NOTE: This option is set to the Vi default value when 'compatible' is
5721 set and to the Vim default value when 'compatible' is reset.
5722
5723 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5724'showfulltag' 'sft' boolean (default off)
5725 global
5726 {not in Vi}
5727 When completing a word in insert mode (see |ins-completion|) from the
5728 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005729 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 matched a C function, you can see a template for what arguments are
5731 required (coding style permitting).
5732
5733 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5734'showmatch' 'sm' boolean (default off)
5735 global
5736 When a bracket is inserted, briefly jump to the matching one. The
5737 jump is only done if the match can be seen on the screen. The time to
5738 show the match can be set with 'matchtime'.
5739 A Beep is given if there is no match (no matter if the match can be
5740 seen or not). This option is reset when the 'paste' option is set.
5741 When the 'm' flag is not included in 'cpoptions', typing a character
5742 will immediately move the cursor back to where it belongs.
5743 See the "sm" field in 'guicursor' for setting the cursor shape and
5744 blinking when showing the match.
5745 The 'matchpairs' option can be used to specify the characters to show
5746 matches for. 'rightleft' and 'revins' are used to look for opposite
5747 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005748 Also see the matchparen plugin for highlighting the match when moving
5749 around |pi_paren.txt|.
5750 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751
5752 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5753'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5754 global
5755 If in Insert, Replace or Visual mode put a message on the last line.
5756 Use the 'M' flag in 'highlight' to set the type of highlighting for
5757 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005758 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 doesn't mean XIM is really active, especially when 'imactivatekey' is
5760 not set.
5761 NOTE: This option is set to the Vi default value when 'compatible' is
5762 set and to the Vim default value when 'compatible' is reset.
5763
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005764 *'showtabline'* *'stal'*
5765'showtabline' 'stal' number (default 1)
5766 global
5767 {not in Vi}
5768 {not available when compiled without the +windows
5769 feature}
5770 The value of this option specifies when the line with tab page labels
5771 will be displayed:
5772 0: never
5773 1: only if there are at least two tab pages
5774 2: always
5775 This is both for the GUI and non-GUI implementation of the tab pages
5776 line.
5777 See |tab-page| for more information about tab pages.
5778
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 *'sidescroll'* *'ss'*
5780'sidescroll' 'ss' number (default 0)
5781 global
5782 {not in Vi}
5783 The minimal number of columns to scroll horizontally. Used only when
5784 the 'wrap' option is off and the cursor is moved off of the screen.
5785 When it is zero the cursor will be put in the middle of the screen.
5786 When using a slow terminal set it to a large number or 0. When using
5787 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5788 commands.
5789
5790 *'sidescrolloff'* *'siso'*
5791'sidescrolloff' 'siso' number (default 0)
5792 global
5793 {not in Vi}
5794 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005795 right of the cursor if 'nowrap' is set. Setting this option to a
5796 value greater than 0 while having |'sidescroll'| also at a non-zero
5797 value makes some context visible in the line you are scrolling in
5798 horizontally (except at beginning of the line). Setting this option
5799 to a large value (like 999) has the effect of keeping the cursor
5800 horizontally centered in the window, as long as one does not come too
5801 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802 NOTE: This option is set to 0 when 'compatible' is set.
5803
5804 Example: Try this together with 'sidescroll' and 'listchars' as
5805 in the following example to never allow the cursor to move
5806 onto the "extends" character:
5807
5808 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5809 :set sidescrolloff=1
5810
5811
5812 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5813'smartcase' 'scs' boolean (default off)
5814 global
5815 {not in Vi}
5816 Override the 'ignorecase' option if the search pattern contains upper
5817 case characters. Only used when the search pattern is typed and
5818 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005819 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5821 recalling the search pattern from history and hitting <Enter>.
5822 NOTE: This option is reset when 'compatible' is set.
5823
5824 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5825'smartindent' 'si' boolean (default off)
5826 local to buffer
5827 {not in Vi}
5828 {not available when compiled without the
5829 |+smartindent| feature}
5830 Do smart autoindenting when starting a new line. Works for C-like
5831 programs, but can also be used for other languages. 'cindent' does
5832 something like this, works better in most cases, but is more strict,
5833 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5834 'indentexpr' is a more advanced alternative.
5835 Normally 'autoindent' should also be on when using 'smartindent'.
5836 An indent is automatically inserted:
5837 - After a line ending in '{'.
5838 - After a line starting with a keyword from 'cinwords'.
5839 - Before a line starting with '}' (only with the "O" command).
5840 When typing '}' as the first character in a new line, that line is
5841 given the same indent as the matching '{'.
5842 When typing '#' as the first character in a new line, the indent for
5843 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005844 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5846 When using the ">>" command, lines starting with '#' are not shifted
5847 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005848 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 is set smart indenting is disabled.
5850
5851 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5852'smarttab' 'sta' boolean (default off)
5853 global
5854 {not in Vi}
5855 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005856 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5857 <BS> will delete a 'shiftwidth' worth of space at the start of the
5858 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005859 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005860 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5861 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005862 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5863 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005864 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 NOTE: This option is reset when 'compatible' is set.
5866
5867 *'softtabstop'* *'sts'*
5868'softtabstop' 'sts' number (default 0)
5869 local to buffer
5870 {not in Vi}
5871 Number of spaces that a <Tab> counts for while performing editing
5872 operations, like inserting a <Tab> or using <BS>. It "feels" like
5873 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5874 used. This is useful to keep the 'ts' setting at its standard value
5875 of 8, while being able to edit like it is set to 'sts'. However,
5876 commands like "x" still work on the actual characters.
5877 When 'sts' is zero, this feature is off.
5878 'softtabstop' is set to 0 when the 'paste' option is set.
5879 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5880 spaces is minimized by using <Tab>s.
5881 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5882 set.
5883 NOTE: This option is set to 0 when 'compatible' is set.
5884
Bram Moolenaar217ad922005-03-20 22:37:15 +00005885 *'spell'* *'nospell'*
5886'spell' boolean (default off)
5887 local to window
5888 {not in Vi}
5889 {not available when compiled without the |+syntax|
5890 feature}
5891 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005892 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005893
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005894 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005895'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005896 local to buffer
5897 {not in Vi}
5898 {not available when compiled without the |+syntax|
5899 feature}
5900 Pattern to locate the end of a sentence. The following word will be
5901 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005902 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005903 When this check is not wanted make this option empty.
5904 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005905 Be careful with special characters, see |option-backslash| about
5906 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005907 To set this option automatically depending on the language, see
5908 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005909
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005910 *'spellfile'* *'spf'*
5911'spellfile' 'spf' string (default empty)
5912 local to buffer
5913 {not in Vi}
5914 {not available when compiled without the |+syntax|
5915 feature}
5916 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005917 commands. It must end in ".{encoding}.add". You need to include the
5918 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005919 *E765*
5920 It may also be a comma separated list of names. A count before the
5921 |zg| and |zw| commands can be used to access each. This allows using
5922 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005923 When a word is added while this option is empty Vim will set it for
5924 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005925 writable and the first language name that appears in 'spelllang',
5926 ignoring the region.
5927 The resulting ".spl" file will be used for spell checking, it does not
5928 have to appear in 'spelllang'.
5929 Normally one file is used for all regions, but you can add the region
5930 name if you want to. However, it will then only be used when
5931 'spellfile' is set to it, for entries in 'spelllang' only files
5932 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005933 This option cannot be set from a |modeline| or in the |sandbox|, for
5934 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005935
Bram Moolenaar217ad922005-03-20 22:37:15 +00005936 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005937'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005938 local to buffer
5939 {not in Vi}
5940 {not available when compiled without the |+syntax|
5941 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005942 A comma separated list of word list names. When the 'spell' option is
5943 on spellchecking will be done for these languages. Example: >
5944 set spelllang=en_us,nl,medical
5945< This means US English, Dutch and medical words are recognized. Words
5946 that are not recognized will be highlighted.
5947 The word list name must not include a comma or dot. Using a dash is
5948 recommended to separate the two letter language name from a
5949 specification. Thus "en-rare" is used for rare English words.
5950 A region name must come last and have the form "_xx", where "xx" is
5951 the two-letter, lower case region name. You can use more than one
5952 region by listing them: "en_us,en_ca" supports both US and Canadian
5953 English, but not words specific for Australia, New Zealand or Great
5954 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005955 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005956 As a special case the name of a .spl file can be given as-is. The
5957 first "_xx" in the name is removed and used as the region name
5958 (_xx is an underscore, two letters and followed by a non-letter).
5959 This is mainly for testing purposes. You must make sure the correct
5960 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005961 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005962 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5963 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005964 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005965
Bram Moolenaar98692072006-02-04 00:57:42 +00005966 If the |spellfile.vim| plugin is active and you use a language name
5967 for which Vim cannot find the .spl file in 'runtimepath' the plugin
5968 will ask you if you want to download the file.
5969
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005970 After this option has been set successfully, Vim will source the files
5971 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005972 up to the first comma, dot or underscore.
5973 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005974
5975
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005976 *'spellsuggest'* *'sps'*
5977'spellsuggest' 'sps' string (default "best")
5978 global
5979 {not in Vi}
5980 {not available when compiled without the |+syntax|
5981 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005982 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005983 the |spellsuggest()| function. This is a comma-separated list of
5984 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005985
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005986 best Internal method that works best for English. Finds
5987 changes like "fast" and uses a bit of sound-a-like
5988 scoring to improve the ordering.
5989
5990 double Internal method that uses two methods and mixes the
5991 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005992 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005993 word. That only works when the language specifies
5994 sound folding. Can be slow and doesn't always give
5995 better results.
5996
5997 fast Internal method that only checks for simple changes:
5998 character inserts/deletes/swaps. Works well for
5999 simple typing mistakes.
6000
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006001 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006002 Not used for |spellsuggest()|. The number of
6003 suggestions is never more than the value of 'lines'
6004 minus two.
6005
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006006 file:{filename} Read file {filename}, which must have two columns,
6007 separated by a slash. The first column contains the
6008 bad word, the second column the suggested good word.
6009 Example:
6010 theribal/terrible ~
6011 Use this for common mistakes that do not appear at the
6012 top of the suggestion list with the internal methods.
6013 Lines without a slash are ignored, use this for
6014 comments.
6015 The file is used for all languages.
6016
6017 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6018 trouble with spaces. |v:val| holds the badly spelled
6019 word. The expression must evaluate to a List of
6020 Lists, each with a suggestion and a score.
6021 Example:
6022 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006023 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006024 internal methods use. A lower score is better.
6025 This may invoke |spellsuggest()| if you temporarily
6026 set 'spellsuggest' to exclude the "expr:" part.
6027 Errors are silently ignored, unless you set the
6028 'verbose' option to a non-zero value.
6029
6030 Only one of "best", "double" or "fast" may be used. The others may
6031 appear several times in any order. Example: >
6032 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6033<
6034 This option cannot be set from a |modeline| or in the |sandbox|, for
6035 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006036
6037
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6039'splitbelow' 'sb' boolean (default off)
6040 global
6041 {not in Vi}
6042 {not available when compiled without the +windows
6043 feature}
6044 When on, splitting a window will put the new window below the current
6045 one. |:split|
6046
6047 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6048'splitright' 'spr' boolean (default off)
6049 global
6050 {not in Vi}
6051 {not available when compiled without the +vertsplit
6052 feature}
6053 When on, splitting a window will put the new window right of the
6054 current one. |:vsplit|
6055
6056 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6057'startofline' 'sol' boolean (default on)
6058 global
6059 {not in Vi}
6060 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006061 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006062 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006063 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064 with a linewise operator, with "%" with a count and to buffer changing
6065 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6066 only has a line number, e.g., ":25" or ":+".
6067 In case of buffer changing commands the cursor is placed at the column
6068 where it was the last time the buffer was edited.
6069 NOTE: This option is set when 'compatible' is set.
6070
6071 *'statusline'* *'stl'* *E540* *E541* *E542*
6072'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006073 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 {not in Vi}
6075 {not available when compiled without the |+statusline|
6076 feature}
6077 When nonempty, this option determines the content of the status line.
6078 Also see |status-line|.
6079
6080 The option consists of printf style '%' items interspersed with
6081 normal text. Each status line item is of the form:
6082 %-0{minwid}.{maxwid}{item}
6083 All fields except the {item} is optional. A single percent sign can
6084 be given as "%%". Up to 80 items can be specified.
6085
Bram Moolenaar238a5642006-02-21 22:12:05 +00006086 When the option starts with "%!" then it is used as an expression,
6087 evaluated and the result is used as the option value. Example: >
6088 :set statusline=%!MyStatusLine()
6089< The result can contain %{} items that will be evaluated too.
6090
6091 When there is error while evaluating the option then it will be made
6092 empty to avoid further errors. Otherwise screen updating would loop.
6093
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 Note that the only effect of 'ruler' when this option is set (and
6095 'laststatus' is 2) is controlling the output of |CTRL-G|.
6096
6097 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006098 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006100 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 minwid Minimum width of the item, padding as set by '-' & '0'.
6102 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006103 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 on the left for text items. Numeric items will be
6105 shifted down to maxwid-2 digits followed by '>'number
6106 where number is the amount of missing digits, much like
6107 an exponential notation.
6108 item A one letter code as described below.
6109
6110 Following is a description of the possible statusline items. The
6111 second character in "item" is the type:
6112 N for number
6113 S for string
6114 F for flags as described below
6115 - not applicable
6116
6117 item meaning ~
6118 f S Path to the file in the buffer, relative to current directory.
6119 F S Full path to the file in the buffer.
6120 t S File name (tail) of file in the buffer.
6121 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6122 M F Modified flag, text is ",+" or ",-".
6123 r F Readonly flag, text is " [RO]".
6124 R F Readonly flag, text is ",RO".
6125 h F Help buffer flag, text is " [help]".
6126 H F Help buffer flag, text is ",HLP".
6127 w F Preview window flag, text is " [Preview]".
6128 W F Preview window flag, text is ",PRV".
6129 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6130 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6131 {not available when compiled without |+autocmd| feature}
6132 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6133 being used: "<keymap>"
6134 n N Buffer number.
6135 b N Value of byte under cursor.
6136 B N As above, in hexadecimal.
6137 o N Byte number in file of byte under cursor, first byte is 1.
6138 Mnemonic: Offset from start of file (with one added)
6139 {not available when compiled without |+byte_offset| feature}
6140 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006141 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 l N Line number.
6143 L N Number of lines in buffer.
6144 c N Column number.
6145 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006146 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 p N Percentage through file in lines as in |CTRL-G|.
6148 P S Percentage through file of displayed window. This is like the
6149 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006150 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006152 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006153 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 ( - Start of item group. Can be used for setting the width and
6155 alignment of a section. Must be followed by %) somewhere.
6156 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006157 T N For 'tabline': start of tab page N label. Use %T after the last
6158 label. This information is used for mouse clicks.
6159 X N For 'tabline': start of close tab N label. Use %X after the
6160 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6161 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 < - Where to truncate line if too long. Default is at the start.
6163 No width fields allowed.
6164 = - Separation point between left and right aligned items.
6165 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006166 # - Set highlight group. The name must follow and then a # again.
6167 Thus use %#HLname# for highlight group HLname. The same
6168 highlighting is used, also for the statusline of non-current
6169 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006171 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 The difference between User{N} and StatusLine will be applied
6173 to StatusLineNC for the statusline of non-current windows.
6174 The number N must be between 1 and 9. See |hl-User1..9|
6175
6176 Display of flags are controlled by the following heuristic:
6177 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006178 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 with a space it is assumed that it wants to separate itself from
6180 anything but other flags. That is: A leading comma is removed if the
6181 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006182 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 make a nice display when flags are used like in the examples below.
6184
Bram Moolenaar582fd852005-03-28 20:58:01 +00006185 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 not set) and a minwid is not set for the group, the whole group will
6187 become empty. This will make a group like the following disappear
6188 completely from the statusline when none of the flags are set. >
6189 :set statusline=...%(\ [%M%R%H]%)...
6190<
6191 Beware that an expression is evaluated each and every time the status
6192 line is displayed. The current buffer and current window will be set
6193 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006194 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006196 real current buffer.
6197
6198 The 'statusline' option may be evaluated in the |sandbox|, see
6199 |sandbox-option|.
6200
6201 It is not allowed to change text or jump to another window while
6202 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203
6204 If the statusline is not updated when you want it (e.g., after setting
6205 a variable that's used in an expression), you can force an update by
6206 setting an option without changing its value. Example: >
6207 :let &ro = &ro
6208
6209< A result of all digits is regarded a number for display purposes.
6210 Otherwise the result is taken as flag text and applied to the rules
6211 described above.
6212
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006213 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6215 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6216
6217 Examples:
6218 Emulate standard status line with 'ruler' set >
6219 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6220< Similar, but add ASCII value of char under the cursor (like "ga") >
6221 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6222< Display byte count and byte value, modified flag in red. >
6223 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6224 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6225< Display a ,GZ flag if a compressed file is loaded >
6226 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6227< In the |:autocmd|'s: >
6228 :let b:gzflag = 1
6229< And: >
6230 :unlet b:gzflag
6231< And define this function: >
6232 :function VarExists(var, val)
6233 : if exists(a:var) | return a:val | else | return '' | endif
6234 :endfunction
6235<
6236 *'suffixes'* *'su'*
6237'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6238 global
6239 {not in Vi}
6240 Files with these suffixes get a lower priority when multiple files
6241 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006242 suffixes. Spaces after the comma are ignored. A dot is also seen as
6243 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 separator, precede it with a backslash (see |option-backslash| about
6245 including spaces and backslashes).
6246 See 'wildignore' for completely ignoring files.
6247 The use of |:set+=| and |:set-=| is preferred when adding or removing
6248 suffixes from the list. This avoids problems when a future version
6249 uses another default.
6250
6251 *'suffixesadd'* *'sua'*
6252'suffixesadd' 'sua' string (default "")
6253 local to buffer
6254 {not in Vi}
6255 {not available when compiled without the
6256 |+file_in_path| feature}
6257 Comma separated list of suffixes, which are used when searching for a
6258 file for the "gf", "[I", etc. commands. Example: >
6259 :set suffixesadd=.java
6260<
6261 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6262'swapfile' 'swf' boolean (default on)
6263 local to buffer
6264 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006265 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 swapfile is not wanted for a specific buffer. For example, with
6267 confidential information that even root must not be able to access.
6268 Careful: All text will be in memory:
6269 - Don't use this for big files.
6270 - Recovery will be impossible!
6271 A swapfile will only be present when |'updatecount'| is non-zero and
6272 'swapfile' is set.
6273 When 'swapfile' is reset, the swap file for the current buffer is
6274 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6275 non-zero, a swap file is immediately created.
6276 Also see |swap-file| and |'swapsync'|.
6277
6278 This option is used together with 'bufhidden' and 'buftype' to
6279 specify special kinds of buffers. See |special-buffers|.
6280
6281 *'swapsync'* *'sws'*
6282'swapsync' 'sws' string (default "fsync")
6283 global
6284 {not in Vi}
6285 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006286 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287 When this option is empty parts of the swap file may be in memory and
6288 not written to disk. When the system crashes you may lose more work.
6289 On Unix the system does a sync now and then without Vim asking for it,
6290 so the disadvantage of setting this option off is small. On some
6291 systems the swap file will not be written at all. For a unix system
6292 setting it to "sync" will use the sync() call instead of the default
6293 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006294 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295
6296 *'switchbuf'* *'swb'*
6297'switchbuf' 'swb' string (default "")
6298 global
6299 {not in Vi}
6300 This option controls the behavior when switching between buffers.
6301 Possible values (comma separated list):
6302 useopen If included, jump to the first open window that
6303 contains the specified buffer (if there is one).
6304 Otherwise: Do not examine other windows.
6305 This setting is checked with |quickfix| commands, when
6306 jumping to errors (":cc", ":cn", "cp", etc.). It is
6307 also used in all buffer related split commands, for
6308 example ":sbuffer", ":sbnext", or ":sbrewind".
6309 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006310 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311 Supported in |quickfix| commands that display errors.
6312
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006313 *'synmaxcol'* *'smc'*
6314'synmaxcol' 'smc' number (default 3000)
6315 local to buffer
6316 {not in Vi}
6317 {not available when compiled without the |+syntax|
6318 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006319 Maximum column in which to search for syntax items. In long lines the
6320 text after this column is not highlighted and following lines may not
6321 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006322 This helps to avoid very slow redrawing for an XML file that is one
6323 long line.
6324 Set to zero to remove the limit.
6325
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326 *'syntax'* *'syn'*
6327'syntax' 'syn' string (default empty)
6328 local to buffer
6329 {not in Vi}
6330 {not available when compiled without the |+syntax|
6331 feature}
6332 When this option is set, the syntax with this name is loaded, unless
6333 syntax highlighting has been switched off with ":syntax off".
6334 Otherwise this option does not always reflect the current syntax (the
6335 b:current_syntax variable does).
6336 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006337 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 /* vim: set syntax=idl : */
6339< To switch off syntax highlighting for the current file, use: >
6340 :set syntax=OFF
6341< To switch syntax highlighting on according to the current value of the
6342 'filetype' option: >
6343 :set syntax=ON
6344< What actually happens when setting the 'syntax' option is that the
6345 Syntax autocommand event is triggered with the value as argument.
6346 This option is not copied to another buffer, independent of the 's' or
6347 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006348 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006350 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006351'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006352 global
6353 {not in Vi}
6354 {not available when compiled without the +windows
6355 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006356 When nonempty, this option determines the content of the tab pages
6357 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006358 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006359
6360 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006361 option and only when there is no GUI tab line. When 'e' is in
6362 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6363 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006364
6365 The value is evaluated like with 'statusline'. You can use
6366 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006367 the text to be displayed. Use "%1T" for the first label, "%2T" for
6368 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006369
6370 Keep in mind that only one of the tab pages is the current one, others
6371 are invisible and you can't jump to their windows.
6372
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006373
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006374 *'tabpagemax'* *'tpm'*
6375'tabpagemax' 'tpm' number (default 10)
6376 global
6377 {not in Vi}
6378 {not available when compiled without the +windows
6379 feature}
6380 Maximum number of tab pages to be opened by the |-p| command line
6381 argument or the ":tab all" command. |tabpage|
6382
6383
6384 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385'tabstop' 'ts' number (default 8)
6386 local to buffer
6387 Number of spaces that a <Tab> in the file counts for. Also see
6388 |:retab| command, and 'softtabstop' option.
6389
6390 Note: Setting 'tabstop' to any other value than 8 can make your file
6391 appear wrong in many places (e.g., when printing it).
6392
6393 There are four main ways to use tabs in Vim:
6394 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6395 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6396 will use a mix of tabs and spaces, but typing Tab and BS will
6397 behave like a tab appears every 4 (or 3) characters.
6398 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6399 'expandtab'. This way you will always insert spaces. The
6400 formatting will never be messed up when 'tabstop' is changed.
6401 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006402 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 works when using Vim to edit the file.
6404 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6405 'noexpandtab'. This should then work (for initial indents only)
6406 for any tabstop setting that people use. It might be nice to have
6407 tabs after the first non-blank inserted as spaces if you do this
6408 though. Otherwise aligned comments will be wrong when 'tabstop' is
6409 changed.
6410
6411 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6412'tagbsearch' 'tbs' boolean (default on)
6413 global
6414 {not in Vi}
6415 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006416 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 searching makes searching for a tag a LOT faster, but a linear search
6418 will find more tags if the tags file wasn't properly sorted.
6419 Vim normally assumes that your tags files are sorted, or indicate that
6420 they are not sorted. Only when this is not the case does the
6421 'tagbsearch' option need to be switched off.
6422
6423 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006424 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 certain files, or retry all files with a linear search. When
6426 'tagbsearch' is off, only a linear search is done.
6427
6428 Linear searching is done anyway, for one file, when Vim finds a line
6429 at the start of the file indicating that it's not sorted: >
6430 !_TAG_FILE_SORTED 0 /some command/
6431< [The whitespace before and after the '0' must be a single <Tab>]
6432
6433 When a binary search was done and no match was found in any of the
6434 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6435 instead of a normal tag name, a retry is done with a linear search.
6436 Tags in unsorted tags files, and matches with different case will only
6437 be found in the retry.
6438
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006439 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 linear search can be avoided for the 'ignorecase' case. Use a value
6441 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6442 case-fold sorted with the -f switch to "sort" in most unices, as in
6443 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6444 5.3 or higher the -f or --fold-case-sort switch can be used for this
6445 as well. Note that case must be folded to uppercase for this to work.
6446
6447 When 'tagbsearch' is off, tags searching is slower when a full match
6448 exists, but faster when no full match exists. Tags in unsorted tags
6449 files may only be found with 'tagbsearch' off.
6450 When the tags file is not sorted, or sorted in a wrong way (not on
6451 ASCII byte value), 'tagbsearch' should be off, or the line given above
6452 must be included in the tags file.
6453 This option doesn't affect commands that find all matching tags (e.g.,
6454 command-line completion and ":help").
6455 {Vi: always uses binary search in some versions}
6456
6457 *'taglength'* *'tl'*
6458'taglength' 'tl' number (default 0)
6459 global
6460 If non-zero, tags are significant up to this number of characters.
6461
6462 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6463'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6464 global
6465 {not in Vi}
6466 If on and using a tag file in another directory, file names in that
6467 tag file are relative to the directory where the tag file is.
6468 NOTE: This option is set to the Vi default value when 'compatible' is
6469 set and to the Vim default value when 'compatible' is reset.
6470
6471 *'tags'* *'tag'* *E433*
6472'tags' 'tag' string (default "./tags,tags", when compiled with
6473 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6474 global or local to buffer |global-local|
6475 Filenames for the tag command, separated by spaces or commas. To
6476 include a space or comma in a file name, precede it with a backslash
6477 (see |option-backslash| about including spaces and backslashes).
6478 When a file name starts with "./", the '.' is replaced with the path
6479 of the current file. But only when the 'd' flag is not included in
6480 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6481 |tags-option|.
6482 "*", "**" and other wildcards can be used to search for tags files in
6483 a directory tree. See |file-searching|. {not available when compiled
6484 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006485 The |tagfiles()| function can be used to get a list of the file names
6486 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6488 files are also supported. They are automatically recognized. The
6489 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6490 differences are ignored (MS-Windows). |emacs-tags|
6491 The use of |:set+=| and |:set-=| is preferred when adding or removing
6492 file names from the list. This avoids problems when a future version
6493 uses another default.
6494 {Vi: default is "tags /usr/lib/tags"}
6495
6496 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6497'tagstack' 'tgst' boolean (default on)
6498 global
6499 {not in all versions of Vi}
6500 When on, the |tagstack| is used normally. When off, a ":tag" or
6501 ":tselect" command with an argument will not push the tag onto the
6502 tagstack. A following ":tag" without an argument, a ":pop" command or
6503 any other command that uses the tagstack will use the unmodified
6504 tagstack, but does change the pointer to the active entry.
6505 Resetting this option is useful when using a ":tag" command in a
6506 mapping which should not change the tagstack.
6507
6508 *'term'* *E529* *E530* *E531*
6509'term' string (default is $TERM, if that fails:
6510 in the GUI: "builtin_gui"
6511 on Amiga: "amiga"
6512 on BeOS: "beos-ansi"
6513 on Mac: "mac-ansi"
6514 on MiNT: "vt52"
6515 on MS-DOS: "pcterm"
6516 on OS/2: "os2ansi"
6517 on Unix: "ansi"
6518 on VMS: "ansi"
6519 on Win 32: "win32")
6520 global
6521 Name of the terminal. Used for choosing the terminal control
6522 characters. Environment variables are expanded |:set_env|.
6523 For example: >
6524 :set term=$TERM
6525< See |termcap|.
6526
6527 *'termbidi'* *'tbidi'*
6528 *'notermbidi'* *'notbidi'*
6529'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6530 global
6531 {not in Vi}
6532 {only available when compiled with the |+arabic|
6533 feature}
6534 The terminal is in charge of Bi-directionality of text (as specified
6535 by Unicode). The terminal is also expected to do the required shaping
6536 that some languages (such as Arabic) require.
6537 Setting this option implies that 'rightleft' will not be set when
6538 'arabic' is set and the value of 'arabicshape' will be ignored.
6539 Note that setting 'termbidi' has the immediate effect that
6540 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6541 This option is reset when the GUI is started.
6542 For further details see |arabic.txt|.
6543
6544 *'termencoding'* *'tenc'*
6545'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6546 Macintosh GUI: "macroman")
6547 global
6548 {only available when compiled with the |+multi_byte|
6549 feature}
6550 {not in Vi}
6551 Encoding used for the terminal. This specifies what character
6552 encoding the keyboard produces and the display will understand. For
6553 the GUI it only applies to the keyboard ('encoding' is used for the
6554 display).
6555 In the Win32 console version the default value is the console codepage
6556 when it differs from the ANSI codepage.
6557 *E617*
6558 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6559 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6560 Any attempts to set a different value will be rejected, and an error
6561 message is shown.
6562 For the Win32 GUI 'termencoding' is not used for typed characters,
6563 because the Win32 system always passes Unicode characters.
6564 When empty, the same encoding is used as for the 'encoding' option.
6565 This is the normal value.
6566 Not all combinations for 'termencoding' and 'encoding' are valid. See
6567 |encoding-table|.
6568 The value for this option must be supported by internal conversions or
6569 iconv(). When this is not possible no conversion will be done and you
6570 will probably experience problems with non-ASCII characters.
6571 Example: You are working with the locale set to euc-jp (Japanese) and
6572 want to edit a UTF-8 file: >
6573 :let &termencoding = &encoding
6574 :set encoding=utf-8
6575< You need to do this when your system has no locale support for UTF-8.
6576
6577 *'terse'* *'noterse'*
6578'terse' boolean (default off)
6579 global
6580 When set: Add 's' flag to 'shortmess' option (this makes the message
6581 for a search that hits the start or end of the file not being
6582 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6583 shortens a lot of messages}
6584
6585 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6586'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6587 global
6588 {not in Vi}
6589 This option is obsolete. Use 'fileformats'.
6590 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6591 set to the default value for the current system. When 'textauto' is
6592 reset, 'fileformats' is made empty.
6593 NOTE: This option is set to the Vi default value when 'compatible' is
6594 set and to the Vim default value when 'compatible' is reset.
6595
6596 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6597'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6598 others: default off)
6599 local to buffer
6600 {not in Vi}
6601 This option is obsolete. Use 'fileformat'.
6602 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6603 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6604 "unix".
6605
6606 *'textwidth'* *'tw'*
6607'textwidth' 'tw' number (default 0)
6608 local to buffer
6609 {not in Vi}
6610 Maximum width of text that is being inserted. A longer line will be
6611 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006612 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6613 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 'formatoptions' and |ins-textwidth|.
6615 NOTE: This option is set to 0 when 'compatible' is set.
6616
6617 *'thesaurus'* *'tsr'*
6618'thesaurus' 'tsr' string (default "")
6619 global or local to buffer |global-local|
6620 {not in Vi}
6621 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006622 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 the file should contain words with similar meaning, separated by
6624 non-keyword characters (white space is preferred). Maximum line
6625 length is 510 bytes.
6626 To obtain a file to be used here, check out the wordlist FAQ at
6627 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006628 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 after a comma are ignored, otherwise spaces are included in the file
6630 name. See |option-backslash| about using backslashes.
6631 The use of |:set+=| and |:set-=| is preferred when adding or removing
6632 directories from the list. This avoids problems when a future version
6633 uses another default.
6634 Backticks cannot be used in this option for security reasons.
6635
6636 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6637'tildeop' 'top' boolean (default off)
6638 global
6639 {not in Vi}
6640 When on: The tilde command "~" behaves like an operator.
6641 NOTE: This option is reset when 'compatible' is set.
6642
6643 *'timeout'* *'to'* *'notimeout'* *'noto'*
6644'timeout' 'to' boolean (default on)
6645 global
6646 *'ttimeout'* *'nottimeout'*
6647'ttimeout' boolean (default off)
6648 global
6649 {not in Vi}
6650 These two options together determine the behavior when part of a
6651 mapped key sequence or keyboard code has been received:
6652
6653 'timeout' 'ttimeout' action ~
6654 off off do not time out
6655 on on or off time out on :mappings and key codes
6656 off on time out on key codes
6657
6658 If both options are off, Vim will wait until either the complete
6659 mapping or key sequence has been received, or it is clear that there
6660 is no mapping or key sequence for the received characters. For
6661 example: if you have mapped "vl" and Vim has received 'v', the next
6662 character is needed to see if the 'v' is followed by an 'l'.
6663 When one of the options is on, Vim will wait for about 1 second for
6664 the next character to arrive. After that the already received
6665 characters are interpreted as single characters. The waiting time can
6666 be changed with the 'timeoutlen' option.
6667 On slow terminals or very busy systems timing out may cause
6668 malfunctioning cursor keys. If both options are off, Vim waits
6669 forever after an entered <Esc> if there are key codes that start
6670 with <Esc>. You will have to type <Esc> twice. If you do not have
6671 problems with key codes, but would like to have :mapped key
6672 sequences not timing out in 1 second, set the 'ttimeout' option and
6673 reset the 'timeout' option.
6674
6675 NOTE: 'ttimeout' is reset when 'compatible' is set.
6676
6677 *'timeoutlen'* *'tm'*
6678'timeoutlen' 'tm' number (default 1000)
6679 global
6680 {not in all versions of Vi}
6681 *'ttimeoutlen'* *'ttm'*
6682'ttimeoutlen' 'ttm' number (default -1)
6683 global
6684 {not in Vi}
6685 The time in milliseconds that is waited for a key code or mapped key
6686 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6687 when part of a command has been typed.
6688 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6689 different timeout value for key codes is desired set 'ttimeoutlen' to
6690 a non-negative number.
6691
6692 ttimeoutlen mapping delay key code delay ~
6693 < 0 'timeoutlen' 'timeoutlen'
6694 >= 0 'timeoutlen' 'ttimeoutlen'
6695
6696 The timeout only happens when the 'timeout' and 'ttimeout' options
6697 tell so. A useful setting would be >
6698 :set timeout timeoutlen=3000 ttimeoutlen=100
6699< (time out on mapping after three seconds, time out on key codes after
6700 a tenth of a second).
6701
6702 *'title'* *'notitle'*
6703'title' boolean (default off, on when title can be restored)
6704 global
6705 {not in Vi}
6706 {not available when compiled without the |+title|
6707 feature}
6708 When on, the title of the window will be set to the value of
6709 'titlestring' (if it is not empty), or to:
6710 filename [+=-] (path) - VIM
6711 Where:
6712 filename the name of the file being edited
6713 - indicates the file cannot be modified, 'ma' off
6714 + indicates the file was modified
6715 = indicates the file is read-only
6716 =+ indicates the file is read-only and modified
6717 (path) is the path of the file being edited
6718 - VIM the server name |v:servername| or "VIM"
6719 Only works if the terminal supports setting window titles
6720 (currently Amiga console, Win32 console, all GUI versions and
6721 terminals with a non- empty 't_ts' option - these are Unix xterm and
6722 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6723 *X11*
6724 When Vim was compiled with HAVE_X11 defined, the original title will
6725 be restored if possible. The output of ":version" will include "+X11"
6726 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6727 works for the icon name |'icon'|.
6728 But: When Vim was started with the |-X| argument, restoring the title
6729 will not work (except in the GUI).
6730 If the title cannot be restored, it is set to the value of 'titleold'.
6731 You might want to restore the title outside of Vim then.
6732 When using an xterm from a remote machine you can use this command:
6733 rsh machine_name xterm -display $DISPLAY &
6734 then the WINDOWID environment variable should be inherited and the
6735 title of the window should change back to what it should be after
6736 exiting Vim.
6737
6738 *'titlelen'*
6739'titlelen' number (default 85)
6740 global
6741 {not in Vi}
6742 {not available when compiled without the |+title|
6743 feature}
6744 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006745 title. When the title is longer, only the end of the path name is
6746 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 Using a percentage makes this adapt to the width of the window. But
6748 it won't work perfectly, because the actual number of characters
6749 available also depends on the font used and other things in the title
6750 bar. When 'titlelen' is zero the full path is used. Otherwise,
6751 values from 1 to 30000 percent can be used.
6752 'titlelen' is also used for the 'titlestring' option.
6753
6754 *'titleold'*
6755'titleold' string (default "Thanks for flying Vim")
6756 global
6757 {not in Vi}
6758 {only available when compiled with the |+title|
6759 feature}
6760 This option will be used for the window title when exiting Vim if the
6761 original title cannot be restored. Only happens if 'title' is on or
6762 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006763 This option cannot be set from a |modeline| or in the |sandbox|, for
6764 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 *'titlestring'*
6766'titlestring' string (default "")
6767 global
6768 {not in Vi}
6769 {not available when compiled without the |+title|
6770 feature}
6771 When this option is not empty, it will be used for the title of the
6772 window. This happens only when the 'title' option is on.
6773 Only works if the terminal supports setting window titles (currently
6774 Amiga console, Win32 console, all GUI versions and terminals with a
6775 non-empty 't_ts' option).
6776 When Vim was compiled with HAVE_X11 defined, the original title will
6777 be restored if possible |X11|.
6778 When this option contains printf-style '%' items, they will be
6779 expanded according to the rules used for 'statusline'.
6780 Example: >
6781 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6782 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6783< The value of 'titlelen' is used to align items in the middle or right
6784 of the available space.
6785 Some people prefer to have the file name first: >
6786 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6787< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006788 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 separating space only when needed.
6790 NOTE: Use of special characters in 'titlestring' may cause the display
6791 to be garbled (e.g., when it contains a CR or NL character).
6792 {not available when compiled without the |+statusline| feature}
6793
6794 *'toolbar'* *'tb'*
6795'toolbar' 'tb' string (default "icons,tooltips")
6796 global
6797 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6798 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006799 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 possible values are:
6801 icons Toolbar buttons are shown with icons.
6802 text Toolbar buttons shown with text.
6803 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006804 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 tooltips Tooltips are active for toolbar buttons.
6806 Tooltips refer to the popup help text which appears after the mouse
6807 cursor is placed over a toolbar button for a brief moment.
6808
6809 If you want the toolbar to be shown with icons as well as text, do the
6810 following: >
6811 :set tb=icons,text
6812< Motif and Athena cannot display icons and text at the same time. They
6813 will show icons if both are requested.
6814
6815 If none of the strings specified in 'toolbar' are valid or if
6816 'toolbar' is empty, this option is ignored. If you want to disable
6817 the toolbar, you need to set the 'guioptions' option. For example: >
6818 :set guioptions-=T
6819< Also see |gui-toolbar|.
6820
6821 *'toolbariconsize'* *'tbis'*
6822'toolbariconsize' 'tbis' string (default "small")
6823 global
6824 {not in Vi}
6825 {only in the GTK+ 2 GUI}
6826 Controls the size of toolbar icons. The possible values are:
6827 tiny Use tiny toolbar icons.
6828 small Use small toolbar icons (default).
6829 medium Use medium-sized toolbar icons.
6830 large Use large toolbar icons.
6831 The exact dimensions in pixels of the various icon sizes depend on
6832 the current theme. Common dimensions are large=32x32, medium=24x24,
6833 small=20x20 and tiny=16x16.
6834
6835 If 'toolbariconsize' is empty, the global default size as determined
6836 by user preferences or the current theme is used.
6837
6838 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6839'ttybuiltin' 'tbi' boolean (default on)
6840 global
6841 {not in Vi}
6842 When on, the builtin termcaps are searched before the external ones.
6843 When off the builtin termcaps are searched after the external ones.
6844 When this option is changed, you should set the 'term' option next for
6845 the change to take effect, for example: >
6846 :set notbi term=$TERM
6847< See also |termcap|.
6848 Rationale: The default for this option is "on", because the builtin
6849 termcap entries are generally better (many systems contain faulty
6850 xterm entries...).
6851
6852 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6853'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6854 sun-cmd, screen, rxvt, dtterm or
6855 iris-ansi; also on when running Vim in
6856 a DOS console)
6857 global
6858 {not in Vi}
6859 Indicates a fast terminal connection. More characters will be sent to
6860 the screen for redrawing, instead of using insert/delete line
6861 commands. Improves smoothness of redrawing when there are multiple
6862 windows and the terminal does not support a scrolling region.
6863 Also enables the extra writing of characters at the end of each screen
6864 line for lines that wrap. This helps when using copy/paste with the
6865 mouse in an xterm and other terminals.
6866
6867 *'ttymouse'* *'ttym'*
6868'ttymouse' 'ttym' string (default depends on 'term')
6869 global
6870 {not in Vi}
6871 {only in Unix and VMS, doesn't work in the GUI; not
6872 available when compiled without |+mouse|}
6873 Name of the terminal type for which mouse codes are to be recognized.
6874 Currently these three strings are valid:
6875 *xterm-mouse*
6876 xterm xterm-like mouse handling. The mouse generates
6877 "<Esc>[Mscr", where "scr" is three bytes:
6878 "s" = button state
6879 "c" = column plus 33
6880 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006881 This only works up to 223 columns! See "dec" for a
6882 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 xterm2 Works like "xterm", but with the xterm reporting the
6884 mouse position while the mouse is dragged. This works
6885 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006886 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 work. See below for how Vim detects this
6888 automatically.
6889 *netterm-mouse*
6890 netterm NetTerm mouse handling. The mouse generates
6891 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6892 for the row and column.
6893 *dec-mouse*
6894 dec DEC terminal mouse handling. The mouse generates a
6895 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006896 This is also available for an Xterm, if it was
6897 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 *jsbterm-mouse*
6899 jsbterm JSB term mouse handling.
6900 *pterm-mouse*
6901 pterm QNX pterm mouse handling.
6902
6903 The mouse handling must be enabled at compile time |+mouse_xterm|
6904 |+mouse_dec| |+mouse_netterm|.
6905 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6906 recognized, if enabled at compile time. DEC terminal mouse codes
6907 are recognized if enabled at compile time, and 'ttymouse' is not
6908 "xterm" (because the xterm and dec mouse codes conflict).
6909 This option is automatically set to "xterm", when the 'term' option is
6910 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6911 or "xterm2" already. The main use of this option is to set it to
6912 "xterm", when the terminal name doesn't start with "xterm", but it can
6913 handle xterm mouse codes.
6914 The "xterm2" value will be set if the xterm version is reported to be
6915 95 of higher. This only works when compiled with the |+termresponse|
6916 feature and if |t_RV| is set to the escape sequence to request the
6917 xterm version number. Otherwise "xterm2" must be set explicitly.
6918 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6919 t_RV to an empty string: >
6920 :set t_RV=
6921<
6922 *'ttyscroll'* *'tsl'*
6923'ttyscroll' 'tsl' number (default 999)
6924 global
6925 Maximum number of lines to scroll the screen. If there are more lines
6926 to scroll the window is redrawn. For terminals where scrolling is
6927 very slow and redrawing is not slow this can be set to a small number,
6928 e.g., 3, to speed up displaying.
6929
6930 *'ttytype'* *'tty'*
6931'ttytype' 'tty' string (default from $TERM)
6932 global
6933 Alias for 'term', see above.
6934
6935 *'undolevels'* *'ul'*
6936'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6937 Win32 and OS/2)
6938 global
6939 {not in Vi}
6940 Maximum number of changes that can be undone. Since undo information
6941 is kept in memory, higher numbers will cause more memory to be used
6942 (nevertheless, a single change can use an unlimited amount of memory).
6943 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6944 itself: >
6945 set ul=0
6946< But you can also get Vi compatibility by including the 'u' flag in
6947 'cpoptions', and still be able to use CTRL-R to repeat undo.
6948 Set to a negative number for no undo at all: >
6949 set ul=-1
6950< This helps when you run out of memory for a single change.
6951 Also see |undo-two-ways|.
6952
6953 *'updatecount'* *'uc'*
6954'updatecount' 'uc' number (default: 200)
6955 global
6956 {not in Vi}
6957 After typing this many characters the swap file will be written to
6958 disk. When zero, no swap file will be created at all (see chapter on
6959 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6960 Vim with the "-n" option, see |startup|. When editing in readonly
6961 mode this option will be initialized to 10000.
6962 The swapfile can be disabled per buffer with |'swapfile'|.
6963 When 'updatecount' is set from zero to non-zero, swap files are
6964 created for all buffers that have 'swapfile' set. When 'updatecount'
6965 is set to zero, existing swap files are not deleted.
6966 Also see |'swapsync'|.
6967 This option has no meaning in buffers where |'buftype'| is "nofile"
6968 or "nowrite".
6969
6970 *'updatetime'* *'ut'*
6971'updatetime' 'ut' number (default 4000)
6972 global
6973 {not in Vi}
6974 If this many milliseconds nothing is typed the swap file will be
6975 written to disk (see |crash-recovery|). Also used for the
6976 |CursorHold| autocommand event.
6977
6978 *'verbose'* *'vbs'*
6979'verbose' 'vbs' number (default 0)
6980 global
6981 {not in Vi, although some versions have a boolean
6982 verbose option}
6983 When bigger than zero, Vim will give messages about what it is doing.
6984 Currently, these messages are given:
6985 >= 1 When the viminfo file is read or written.
6986 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00006987 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 >= 8 Files for which a group of autocommands is executed.
6989 >= 9 Every executed autocommand.
6990 >= 12 Every executed function.
6991 >= 13 When an exception is thrown, caught, finished, or discarded.
6992 >= 14 Anything pending in a ":finally" clause.
6993 >= 15 Every executed Ex command (truncated at 200 characters).
6994
6995 This option can also be set with the "-V" argument. See |-V|.
6996 This option is also set by the |:verbose| command.
6997
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006998 When the 'verbosefile' option is set then the verbose messages are not
6999 displayed.
7000
7001 *'verbosefile'* *'vfile'*
7002'verbosefile' 'vfile' string (default empty)
7003 global
7004 {not in Vi}
7005 When not empty all messages are written in a file with this name.
7006 When the file exists messages are appended.
7007 Writing to the file ends when Vim exits or when 'verbosefile' is made
7008 empty.
7009 Setting 'verbosefile' to a new value is like making it empty first.
7010 The difference with |:redir| is that verbose messages are not
7011 displayed when 'verbosefile' is set.
7012
Bram Moolenaar071d4272004-06-13 20:20:40 +00007013 *'viewdir'* *'vdir'*
7014'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7015 "$VIM/vimfiles/view",
7016 for Unix: "~/.vim/view",
7017 for Macintosh: "$VIM:vimfiles:view"
7018 for VMS: "sys$login:vimfiles/view"
7019 for RiscOS: "Choices:vimfiles/view")
7020 global
7021 {not in Vi}
7022 {not available when compiled without the +mksession
7023 feature}
7024 Name of the directory where to store files for |:mkview|.
7025 This option cannot be set from a |modeline| or in the |sandbox|, for
7026 security reasons.
7027
7028 *'viewoptions'* *'vop'*
7029'viewoptions' 'vop' string (default: "folds,options,cursor")
7030 global
7031 {not in Vi}
7032 {not available when compiled without the +mksession
7033 feature}
7034 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007035 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 word save and restore ~
7037 cursor cursor position in file and in window
7038 folds manually created folds, opened/closed folds and local
7039 fold options
7040 options options and mappings local to a window or buffer (not
7041 global values for local options)
7042 slash backslashes in file names replaced with forward
7043 slashes
7044 unix with Unix end-of-line format (single <NL>), even when
7045 on Windows or DOS
7046
7047 "slash" and "unix" are useful on Windows when sharing view files
7048 with Unix. The Unix version of Vim cannot source dos format scripts,
7049 but the Windows version of Vim can source unix format scripts.
7050
7051 *'viminfo'* *'vi'* *E526* *E527* *E528*
7052'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7053 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7054 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7055 for others: '20,<50,s10,h)
7056 global
7057 {not in Vi}
7058 {not available when compiled without the |+viminfo|
7059 feature}
7060 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007061 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 separated list of parameters, each consisting of a single character
7063 identifying the particular parameter, followed by a number or string
7064 which specifies the value of that parameter. If a particular
7065 character is left out, then the default value is used for that
7066 parameter. The following is a list of the identifying characters and
7067 the effect of their value.
7068 CHAR VALUE ~
7069 ! When included, save and restore global variables that start
7070 with an uppercase letter, and don't contain a lowercase
7071 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007072 and "_K_L_M" are not. Only String and Number types are
7073 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 " Maximum number of lines saved for each register. Old name of
7075 the '<' item, with the disadvantage that you need to put a
7076 backslash before the ", otherwise it will be recognized as the
7077 start of a comment!
7078 % When included, save and restore the buffer list. If Vim is
7079 started with a file name argument, the buffer list is not
7080 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007081 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 without a file name and buffers for help files are not written
7083 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007084 When followed by a number, the number specifies the maximum
7085 number of buffers that are stored. Without a number all
7086 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 ' Maximum number of previously edited files for which the marks
7088 are remembered. This parameter must always be included when
7089 'viminfo' is non-empty.
7090 Including this item also means that the |jumplist| and the
7091 |changelist| are stored in the viminfo file.
7092 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007093 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 patterns are also saved. When not included, the value of
7095 'history' is used.
7096 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007097 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 < Maximum number of lines saved for each register. If zero then
7099 registers are not saved. When not included, all lines are
7100 saved. '"' is the old name for this item.
7101 Also see the 's' item below: limit specified in Kbyte.
7102 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007103 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 c When included, convert the text in the viminfo file from the
7105 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007106 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 f Whether file marks need to be stored. If zero, file marks ('0
7108 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007109 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 cursor position (when exiting or when doing ":wviminfo").
7111 h Disable the effect of 'hlsearch' when loading the viminfo
7112 file. When not included, it depends on whether ":nohlsearch"
7113 has been used since the last search command.
7114 n Name of the viminfo file. The name must immediately follow
7115 the 'n'. Must be the last one! If the "-i" argument was
7116 given when starting Vim, that file name overrides the one
7117 given here with 'viminfo'. Environment variables are expanded
7118 when opening the file, not when setting the option.
7119 r Removable media. The argument is a string (up to the next
7120 ','). This parameter can be given several times. Each
7121 specifies the start of a path for which no marks will be
7122 stored. This is to avoid removable media. For MS-DOS you
7123 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7124 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7125 ignored. Maximum length of each 'r' argument is 50
7126 characters.
7127 s Maximum size of an item in Kbyte. If zero then registers are
7128 not saved. Currently only applies to registers. The default
7129 "s10" will exclude registers with more than 10 Kbyte of text.
7130 Also see the '<' item above: line count limit.
7131
7132 Example: >
7133 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7134<
7135 '50 Marks will be remembered for the last 50 files you
7136 edited.
7137 <1000 Contents of registers (up to 1000 lines each) will be
7138 remembered.
7139 s100 Registers with more than 100 Kbyte text are skipped.
7140 :0 Command-line history will not be saved.
7141 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7142 no / Since '/' is not specified, the default will be used,
7143 that is, save all of the search history, and also the
7144 previous search and substitute patterns.
7145 no % The buffer list will not be saved nor read back.
7146 no h 'hlsearch' highlighting will be restored.
7147
7148 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7149 load the contents of the file, this is not done automatically.
7150
7151 This option cannot be set from a |modeline| or in the |sandbox|, for
7152 security reasons.
7153
7154 *'virtualedit'* *'ve'*
7155'virtualedit' 've' string (default "")
7156 global
7157 {not in Vi}
7158 {not available when compiled without the
7159 |+virtualedit| feature}
7160 A comma separated list of these words:
7161 block Allow virtual editing in Visual block mode.
7162 insert Allow virtual editing in Insert mode.
7163 all Allow virtual editing in all modes.
7164 Virtual editing means that the cursor can be positioned where there is
7165 no actual character. This can be halfway into a Tab or beyond the end
7166 of the line. Useful for selecting a rectangle in Visual mode and
7167 editing a table.
7168
7169 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7170'visualbell' 'vb' boolean (default off)
7171 global
7172 {not in Vi}
7173 Use visual bell instead of beeping. The terminal code to display the
7174 visual bell is given with 't_vb'. When no beep or flash is wanted,
7175 use ":set vb t_vb=".
7176 Note: When the GUI starts, 't_vb' is reset to its default value. You
7177 might want to set it again in your |gvimrc|.
7178 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7179 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7180 where 40 is the time in msec.
7181 Does not work on the Amiga, you always get a screen flash.
7182 Also see 'errorbells'.
7183
7184 *'warn'* *'nowarn'*
7185'warn' boolean (default on)
7186 global
7187 Give a warning message when a shell command is used while the buffer
7188 has been changed.
7189
7190 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7191'weirdinvert' 'wiv' boolean (default off)
7192 global
7193 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007194 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 It is provided for backwards compatibility with version 4.x.
7196 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7197 vice versa. Has no effect when the GUI is running.
7198
7199 *'whichwrap'* *'ww'*
7200'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7201 global
7202 {not in Vi}
7203 Allow specified keys that move the cursor left/right to move to the
7204 previous/next line when the cursor is on the first/last character in
7205 the line. Concatenate characters to allow this for these keys:
7206 char key mode ~
7207 b <BS> Normal and Visual
7208 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007209 h "h" Normal and Visual (not recommended)
7210 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211 < <Left> Normal and Visual
7212 > <Right> Normal and Visual
7213 ~ "~" Normal
7214 [ <Left> Insert and Replace
7215 ] <Right> Insert and Replace
7216 For example: >
7217 :set ww=<,>,[,]
7218< allows wrap only when cursor keys are used.
7219 When the movement keys are used in combination with a delete or change
7220 operator, the <EOL> also counts for a character. This makes "3h"
7221 different from "3dh" when the cursor crosses the end of a line. This
7222 is also true for "x" and "X", because they do the same as "dl" and
7223 "dh". If you use this, you may also want to use the mapping
7224 ":map <BS> X" to make backspace delete the character in front of the
7225 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007226 When 'l' is included and it is used after an operator at the end of a
7227 line then it will not move to the next line. This makes "dl", "cl",
7228 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229 NOTE: This option is set to the Vi default value when 'compatible' is
7230 set and to the Vim default value when 'compatible' is reset.
7231
7232 *'wildchar'* *'wc'*
7233'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7234 global
7235 {not in Vi}
7236 Character you have to type to start wildcard expansion in the
7237 command-line, as specified with 'wildmode'.
7238 The character is not recognized when used inside a macro. See
7239 'wildcharm' for that.
7240 Although 'wc' is a number option, you can set it to a special key: >
7241 :set wc=<Esc>
7242< NOTE: This option is set to the Vi default value when 'compatible' is
7243 set and to the Vim default value when 'compatible' is reset.
7244
7245 *'wildcharm'* *'wcm'*
7246'wildcharm' 'wcm' number (default: none (0))
7247 global
7248 {not in Vi}
7249 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007250 recognized when used inside a macro. You can find "spare" command-line
7251 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 you'll never actually type 'wildcharm', just use it in mappings that
7253 automatically invoke completion mode, e.g.: >
7254 :set wcm=<C-Z>
7255 :cmap ss so $vim/sessions/*.vim<C-Z>
7256< Then after typing :ss you can use CTRL-P & CTRL-N.
7257
7258 *'wildignore'* *'wig'*
7259'wildignore' 'wig' string (default "")
7260 global
7261 {not in Vi}
7262 {not available when compiled without the |+wildignore|
7263 feature}
7264 A list of file patterns. A file that matches with one of these
7265 patterns is ignored when completing file or directory names.
7266 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7267 Also see 'suffixes'.
7268 Example: >
7269 :set wildignore=*.o,*.obj
7270< The use of |:set+=| and |:set-=| is preferred when adding or removing
7271 a pattern from the list. This avoids problems when a future version
7272 uses another default.
7273
7274 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7275'wildmenu' 'wmnu' boolean (default off)
7276 global
7277 {not in Vi}
7278 {not available if compiled without the |+wildmenu|
7279 feature}
7280 When 'wildmenu' is on, command-line completion operates in an enhanced
7281 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7282 the possible matches are shown just above the command line, with the
7283 first match highlighted (overwriting the status line, if there is
7284 one). Keys that show the previous/next match, such as <Tab> or
7285 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7286 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7287 specified. "longest" and "list" do not start "wildmenu" mode.
7288 If there are more matches than can fit in the line, a ">" is shown on
7289 the right and/or a "<" is shown on the left. The status line scrolls
7290 as needed.
7291 The "wildmenu" mode is abandoned when a key is hit that is not used
7292 for selecting a completion.
7293 While the "wildmenu" is active the following keys have special
7294 meanings:
7295
7296 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7297 <Down> - in filename/menu name completion: move into a
7298 subdirectory or submenu.
7299 <CR> - in menu completion, when the cursor is just after a
7300 dot: move into a submenu.
7301 <Up> - in filename/menu name completion: move up into
7302 parent directory or parent menu.
7303
7304 This makes the menus accessible from the console |console-menus|.
7305
7306 If you prefer the <Left> and <Right> keys to move the cursor instead
7307 of selecting a different match, use this: >
7308 :cnoremap <Left> <Space><BS><Left>
7309 :cnoremap <Right> <Space><BS><Right>
7310<
7311 The "WildMenu" highlighting is used for displaying the current match
7312 |hl-WildMenu|.
7313
7314 *'wildmode'* *'wim'*
7315'wildmode' 'wim' string (Vim default: "full")
7316 global
7317 {not in Vi}
7318 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007319 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 part specifies what to do for each consecutive use of 'wildchar. The
7321 first part specifies the behavior for the first use of 'wildchar',
7322 The second part for the second use, etc.
7323 These are the possible values for each part:
7324 "" Complete only the first match.
7325 "full" Complete the next full match. After the last match,
7326 the original string is used and then the first match
7327 again.
7328 "longest" Complete till longest common string. If this doesn't
7329 result in a longer string, use the next part.
7330 "longest:full" Like "longest", but also start 'wildmenu' if it is
7331 enabled.
7332 "list" When more than one match, list all matches.
7333 "list:full" When more than one match, list all matches and
7334 complete first match.
7335 "list:longest" When more than one match, list all matches and
7336 complete till longest common string.
7337 When there is only a single match, it is fully completed in all cases.
7338
7339 Examples: >
7340 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007341< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 :set wildmode=longest,full
7343< Complete longest common string, then each full match >
7344 :set wildmode=list:full
7345< List all matches and complete each full match >
7346 :set wildmode=list,full
7347< List all matches without completing, then each full match >
7348 :set wildmode=longest,list
7349< Complete longest common string, then list alternatives.
7350
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007351 *'wildoptions'* *'wop'*
7352'wildoptions' 'wop' string (default "")
7353 global
7354 {not in Vi}
7355 {not available when compiled without the |+wildignore|
7356 feature}
7357 A list of words that change how command line completion is done.
7358 Currently only one word is allowed:
7359 tagfile When using CTRL-D to list matching tags, the kind of
7360 tag and the file of the tag is listed. Only one match
7361 is displayed per line. Often used tag kinds are:
7362 d #define
7363 f function
7364 Also see |cmdline-completion|.
7365
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 *'winaltkeys'* *'wak'*
7367'winaltkeys' 'wak' string (default "menu")
7368 global
7369 {not in Vi}
7370 {only used in Win32, Motif, GTK and Photon GUI}
7371 Some GUI versions allow the access to menu entries by using the ALT
7372 key in combination with a character that appears underlined in the
7373 menu. This conflicts with the use of the ALT key for mappings and
7374 entering special characters. This option tells what to do:
7375 no Don't use ALT keys for menus. ALT key combinations can be
7376 mapped, but there is no automatic handling. This can then be
7377 done with the |:simalt| command.
7378 yes ALT key handling is done by the windowing system. ALT key
7379 combinations cannot be mapped.
7380 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007381 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382 keys can be mapped.
7383 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7384 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007385 This option is not used for <F10>; on Win32 and with GTK <F10> will
7386 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007388 *'window'* *'wi'*
7389'window' 'wi' number (default screen height - 1)
7390 global
7391 Window height. Do not confuse this with the height of the Vim window,
7392 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007393 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7394 value is smaller than 'lines' minus one. The screen will scroll
7395 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007396 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7397 in a much smarter way, taking care of wrapping lines.
7398 When resizing the Vim window, the value is smaller than 1 or more than
7399 or equal to 'lines' it will be set to 'lines' minus 1.
7400 {Vi also uses the option to specify the number of displayed lines}
7401
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402 *'winheight'* *'wh'* *E591*
7403'winheight' 'wh' number (default 1)
7404 global
7405 {not in Vi}
7406 {not available when compiled without the +windows
7407 feature}
7408 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007409 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 current window is smaller, its size is increased, at the cost of the
7411 height of other windows. Set it to 999 to make the current window
7412 always fill the screen (although this has the drawback that ":all"
7413 will create only two windows). Set it to a small number for normal
7414 editing.
7415 Minimum value is 1.
7416 The height is not adjusted after one of the commands to change the
7417 height of the current window.
7418 'winheight' applies to the current window. Use 'winminheight' to set
7419 the minimal height for other windows.
7420
7421 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7422'winfixheight' 'wfh' boolean (default off)
7423 local to window
7424 {not in Vi}
7425 {not available when compiled without the +windows
7426 feature}
7427 Keep the window height when windows are opened or closed and
7428 'equalalways' is set. Set by default for the |preview-window| and
7429 |quickfix-window|.
7430 The height may be changed anyway when running out of room.
7431
7432 *'winminheight'* *'wmh'*
7433'winminheight' 'wmh' number (default 1)
7434 global
7435 {not in Vi}
7436 {not available when compiled without the +windows
7437 feature}
7438 The minimal height of a window, when it's not the current window.
7439 This is a hard minimum, windows will never become smaller.
7440 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7441 status bar) if necessary. They will return to at least one line when
7442 they become active (since the cursor has to have somewhere to go.)
7443 Use 'winheight' to set the minimal height of the current window.
7444 This option is only checked when making a window smaller. Don't use a
7445 large number, it will cause errors when opening more than a few
7446 windows. A value of 0 to 3 is reasonable.
7447
7448 *'winminwidth'* *'wmw'*
7449'winminwidth' 'wmw' number (default 1)
7450 global
7451 {not in Vi}
7452 {not available when compiled without the +vertsplit
7453 feature}
7454 The minimal width of a window, when it's not the current window.
7455 This is a hard minimum, windows will never become smaller.
7456 When set to zero, windows may be "squashed" to zero columns (i.e. just
7457 a vertical separator) if necessary. They will return to at least one
7458 line when they become active (since the cursor has to have somewhere
7459 to go.)
7460 Use 'winwidth' to set the minimal width of the current window.
7461 This option is only checked when making a window smaller. Don't use a
7462 large number, it will cause errors when opening more than a few
7463 windows. A value of 0 to 12 is reasonable.
7464
7465 *'winwidth'* *'wiw'* *E592*
7466'winwidth' 'wiw' number (default 20)
7467 global
7468 {not in Vi}
7469 {not available when compiled without the +vertsplit
7470 feature}
7471 Minimal number of columns for the current window. This is not a hard
7472 minimum, Vim will use fewer columns if there is not enough room. If
7473 the current window is smaller, its size is increased, at the cost of
7474 the width of other windows. Set it to 999 to make the current window
7475 always fill the screen. Set it to a small number for normal editing.
7476 The width is not adjusted after one of the commands to change the
7477 width of the current window.
7478 'winwidth' applies to the current window. Use 'winminwidth' to set
7479 the minimal width for other windows.
7480
7481 *'wrap'* *'nowrap'*
7482'wrap' boolean (default on)
7483 local to window
7484 {not in Vi}
7485 This option changes how text is displayed. It doesn't change the text
7486 in the buffer, see 'textwidth' for that.
7487 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007488 displaying continues on the next line. When off lines will not wrap
7489 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 moved to a part that is not shown, the screen will scroll
7491 horizontally.
7492 The line will be broken in the middle of a word if necessary. See
7493 'linebreak' to get the break at a word boundary.
7494 To make scrolling horizontally a bit more useful, try this: >
7495 :set sidescroll=5
7496 :set listchars+=precedes:<,extends:>
7497< See 'sidescroll', 'listchars' and |wrap-off|.
7498
7499 *'wrapmargin'* *'wm'*
7500'wrapmargin' 'wm' number (default 0)
7501 local to buffer
7502 Number of characters from the right window border where wrapping
7503 starts. When typing text beyond this limit, an <EOL> will be inserted
7504 and inserting continues on the next line.
7505 Options that add a margin, such as 'number' and 'foldcolumn', cause
7506 the text width to be further reduced. This is Vi compatible.
7507 When 'textwidth' is non-zero, this option is not used.
7508 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7509 and less usefully}
7510
7511 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7512'wrapscan' 'ws' boolean (default on) *E384* *E385*
7513 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007514 Searches wrap around the end of the file. Also applies to |]s| and
7515 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516
7517 *'write'* *'nowrite'*
7518'write' boolean (default on)
7519 global
7520 {not in Vi}
7521 Allows writing files. When not set, writing a file is not allowed.
7522 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007523 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 argument. Filtering text is still possible, even though this requires
7525 writing a temporary file.
7526
7527 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7528'writeany' 'wa' boolean (default off)
7529 global
7530 Allows writing to any file with no need for "!" override.
7531
7532 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7533'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7534 otherwise)
7535 global
7536 {not in Vi}
7537 Make a backup before overwriting a file. The backup is removed after
7538 the file was successfully written, unless the 'backup' option is
7539 also on. Reset this option if your file system is almost full. See
7540 |backup-table| for another explanation.
7541 When the 'backupskip' pattern matches, a backup is not made anyway.
7542 NOTE: This option is set to the default value when 'compatible' is
7543 set.
7544
7545 *'writedelay'* *'wd'*
7546'writedelay' 'wd' number (default 0)
7547 global
7548 {not in Vi}
7549 The number of microseconds to wait for each character sent to the
7550 screen. When non-zero, characters are sent to the terminal one by
7551 one. For MS-DOS pcterm this does not work. For debugging purposes.
7552
7553 vim:tw=78:ts=8:ft=help:norl: