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