blob: ae9f517a85f339e2919fb57cb7367706527d7f1b [file] [log] [blame]
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001*options.txt* For Vim version 7.0aa. Last change: 2006 Mar 18
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
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000450Example:
451 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452
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
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000467Example:
468 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000469
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).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000496For 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: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500There 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
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000507like:
508 /* vi:ts=4: */ ~
509will give an error message for the trailing "*/". This line is OK:
510 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511
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 Moolenaar97b2ad32006-03-18 21:40:56 +0000515backslash in front of the ':' will be removed. Example:
516 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517This 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 "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001016 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001017 {not in Vi}
1018 {only available when compiled with the |+balloon_eval|
1019 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001020 Expression for text to show in evaluation balloon. It is only used
1021 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001022
1023 v:beval_bufnr number of the buffer in which balloon is going to show
1024 v:beval_winnr number of the window
1025 v:beval_lnum line number
1026 v:beval_col column number (byte index)
1027 v:beval_text word under or after the mouse pointer
1028
1029 The evaluation of the expression must not have side effects!
1030 Example: >
1031 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001032 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001033 \', column ' . v:beval_col .
1034 \ ' of file ' . bufname(v:beval_bufnr) .
1035 \ ' on word "' . v:beval_text . '"'
1036 endfunction
1037 set bexpr=MyBalloonExpr()
1038 set ballooneval
1039<
1040 NOTE: The balloon is displayed only if the cursor is on a text
1041 character. If the result of evaluating 'balloonexpr' is not empty,
1042 Vim does not try to send a message to an external debugger (Netbeans
1043 or Sun Workshop).
1044
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001045 The expression may be evaluated in the |sandbox|, see
1046 |sandbox-option|.
1047
1048 It is not allowed to change text or jump to another window while
1049 evaluating 'balloonexpr' |textlock|.
1050
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001051 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001052 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001053< When they are supported "\n" characters will start a new line. If the
1054 expression evaluates to a |List| this is equal to using each List item
1055 as a string and putting "\n" in between them.
1056
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1058'binary' 'bin' boolean (default off)
1059 local to buffer
1060 {not in Vi}
1061 This option should be set before editing a binary file. You can also
1062 use the |-b| Vim argument. When this option is switched on a few
1063 options will be changed (also when it already was on):
1064 'textwidth' will be set to 0
1065 'wrapmargin' will be set to 0
1066 'modeline' will be off
1067 'expandtab' will be off
1068 Also, 'fileformat' and 'fileformats' options will not be used, the
1069 file is read and written like 'fileformat' was "unix" (a single <NL>
1070 separates lines).
1071 The 'fileencoding' and 'fileencodings' options will not be used, the
1072 file is read without conversion.
1073 NOTE: When you start editing a(nother) file while the 'bin' option is
1074 on, settings from autocommands may change the settings again (e.g.,
1075 'textwidth'), causing trouble when editing. You might want to set
1076 'bin' again when the file has been loaded.
1077 The previous values of these options are remembered and restored when
1078 'bin' is switched from on to off. Each buffer has its own set of
1079 saved option values.
1080 To edit a file with 'binary' set you can use the |++bin| argument.
1081 This avoids you have to do ":set bin", which would have effect for all
1082 files you edit.
1083 When writing a file the <EOL> for the last line is only written if
1084 there was one in the original file (normally Vim appends an <EOL> to
1085 the last line if there is none; this would make the file longer). See
1086 the 'endofline' option.
1087
1088 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1089'bioskey' 'biosk' boolean (default on)
1090 global
1091 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001092 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 better to detect CTRL-C, but only works for the console. When using a
1094 terminal over a serial port reset this option.
1095 Also see |'conskey'|.
1096
1097 *'bomb'* *'nobomb'*
1098'bomb' boolean (default off)
1099 local to buffer
1100 {not in Vi}
1101 {only available when compiled with the |+multi_byte|
1102 feature}
1103 When writing a file and the following conditions are met, a BOM (Byte
1104 Order Mark) is prepended to the file:
1105 - this option is on
1106 - the 'binary' option is off
1107 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1108 endian variants.
1109 Some applications use the BOM to recognize the encoding of the file.
1110 Often used for UCS-2 files on MS-Windows. For other applications it
1111 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1112 appear halfway the resulting file.
1113 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1114 check for the presence of the BOM is done and 'bomb' set accordingly.
1115 Unless 'binary' is set, it is removed from the first line, so that you
1116 don't see it when editing. When you don't change the options, the BOM
1117 will be restored when writing the file.
1118
1119 *'breakat'* *'brk'*
1120'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1121 global
1122 {not in Vi}
1123 {not available when compiled without the |+linebreak|
1124 feature}
1125 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001126 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1127 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128
1129 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001130'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 global
1132 {not in Vi} {only for Motif and Win32 GUI}
1133 Which directory to use for the file browser:
1134 last Use same directory as with last file browser.
1135 buffer Use the directory of the related buffer.
1136 current Use the current directory.
1137 {path} Use the specified directory
1138
1139 *'bufhidden'* *'bh'*
1140'bufhidden' 'bh' string (default: "")
1141 local to buffer
1142 {not in Vi}
1143 {not available when compiled without the |+quickfix|
1144 feature}
1145 This option specifies what happens when a buffer is no longer
1146 displayed in a window:
1147 <empty> follow the global 'hidden' option
1148 hide hide the buffer (don't unload it), also when 'hidden'
1149 is not set
1150 unload unload the buffer, also when 'hidden' is set or using
1151 |:hide|
1152 delete delete the buffer from the buffer list, also when
1153 'hidden' is set or using |:hide|, like using
1154 |:bdelete|
1155 wipe wipe out the buffer from the buffer list, also when
1156 'hidden' is set or using |:hide|, like using
1157 |:bwipeout|
1158
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001159 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1160 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 This option is used together with 'buftype' and 'swapfile' to specify
1162 special kinds of buffers. See |special-buffers|.
1163
1164 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1165'buflisted' 'bl' boolean (default: on)
1166 local to buffer
1167 {not in Vi}
1168 When this option is set, the buffer shows up in the buffer list. If
1169 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1170 This option is reset by Vim for buffers that are only used to remember
1171 a file name or marks. Vim sets it when starting to edit a buffer.
1172 But not when moving to a buffer with ":buffer".
1173
1174 *'buftype'* *'bt'* *E382*
1175'buftype' 'bt' string (default: "")
1176 local to buffer
1177 {not in Vi}
1178 {not available when compiled without the |+quickfix|
1179 feature}
1180 The value of this option specifies the type of a buffer:
1181 <empty> normal buffer
1182 nofile buffer which is not related to a file and will not be
1183 written
1184 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001185 acwrite buffer which will always be written with BufWriteCmd
1186 autocommands. {not available when compiled without the
1187 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001189 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 help help buffer (you are not supposed to set this
1191 manually)
1192
1193 This option is used together with 'bufhidden' and 'swapfile' to
1194 specify special kinds of buffers. See |special-buffers|.
1195
1196 Be careful with changing this option, it can have many side effects!
1197
Bram Moolenaar280f1262006-01-30 00:14:18 +00001198 A "quickfix" buffer is only used for the error list and the location
1199 list. This value is set by the |:cwindow| and |:lwindow| commands and
1200 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201
1202 "nofile" and "nowrite" buffers are similar:
1203 both: The buffer is not to be written to disk, ":w" doesn't
1204 work (":w filename" does work though).
1205 both: The buffer is never considered to be |'modified'|.
1206 There is no warning when the changes will be lost, for
1207 example when you quit Vim.
1208 both: A swap file is only created when using too much memory
1209 (when 'swapfile' has been reset there is never a swap
1210 file).
1211 nofile only: The buffer name is fixed, it is not handled like a
1212 file name. It is not modified in response to a |:cd|
1213 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001214 *E676*
1215 "acwrite" implies that the buffer name is not related to a file, like
1216 "nofile", but it will be written. Thus, in contrast to "nofile" and
1217 "nowrite", ":w" does work and a modified buffer can't be abandoned
1218 without saving. For writing there must be matching |BufWriteCmd|,
1219 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220
1221 *'casemap'* *'cmp'*
1222'casemap' 'cmp' string (default: "internal,keepascii")
1223 global
1224 {not in Vi}
1225 Specifies details about changing the case of letters. It may contain
1226 these words, separated by a comma:
1227 internal Use internal case mapping functions, the current
1228 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001229 matters when 'encoding' is a Unicode encoding,
1230 "latin1" or "iso-8859-15". When "internal" is
1231 omitted, the towupper() and towlower() system library
1232 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1234 case mapping, the current locale is not effective.
1235 This probably only matters for Turkish.
1236
1237 *'cdpath'* *'cd'* *E344* *E346*
1238'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1239 global
1240 {not in Vi}
1241 {not available when compiled without the
1242 |+file_in_path| feature}
1243 This is a list of directories which will be searched when using the
1244 |:cd| and |:lcd| commands, provided that the directory being searched
1245 for has a relative path (not starting with "/", "./" or "../").
1246 The 'cdpath' option's value has the same form and semantics as
1247 |'path'|. Also see |file-searching|.
1248 The default value is taken from $CDPATH, with a "," prepended to look
1249 in the current directory first.
1250 If the default value taken from $CDPATH is not what you want, include
1251 a modified version of the following command in your vimrc file to
1252 override it: >
1253 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1254< This option cannot be set from a |modeline| or in the |sandbox|, for
1255 security reasons.
1256 (parts of 'cdpath' can be passed to the shell to expand file names).
1257
1258 *'cedit'*
1259'cedit' string (Vi default: "", Vim default: CTRL-F)
1260 global
1261 {not in Vi}
1262 {not available when compiled without the |+vertsplit|
1263 feature}
1264 The key used in Command-line Mode to open the command-line window.
1265 The default is CTRL-F when 'compatible' is off.
1266 Only non-printable keys are allowed.
1267 The key can be specified as a single character, but it is difficult to
1268 type. The preferred way is to use the <> notation. Examples: >
1269 :set cedit=<C-Y>
1270 :set cedit=<Esc>
1271< |Nvi| also has this option, but it only uses the first character.
1272 See |cmdwin|.
1273
1274 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1275'charconvert' 'ccv' string (default "")
1276 global
1277 {only available when compiled with the |+multi_byte|
1278 feature and the |+eval| feature}
1279 {not in Vi}
1280 An expression that is used for character encoding conversion. It is
1281 evaluated when a file that is to be read or has been written has a
1282 different encoding from what is desired.
1283 'charconvert' is not used when the internal iconv() function is
1284 supported and is able to do the conversion. Using iconv() is
1285 preferred, because it is much faster.
1286 'charconvert' is not used when reading stdin |--|, because there is no
1287 file to convert from. You will have to save the text in a file first.
1288 The expression must return zero or an empty string for success,
1289 non-zero for failure.
1290 The possible encoding names encountered are in 'encoding'.
1291 Additionally, names given in 'fileencodings' and 'fileencoding' are
1292 used.
1293 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1294 is done internally by Vim, 'charconvert' is not used for this.
1295 'charconvert' is also used to convert the viminfo file, if the 'c'
1296 flag is present in 'viminfo'. Also used for Unicode conversion.
1297 Example: >
1298 set charconvert=CharConvert()
1299 fun CharConvert()
1300 system("recode "
1301 \ . v:charconvert_from . ".." . v:charconvert_to
1302 \ . " <" . v:fname_in . " >" v:fname_out)
1303 return v:shell_error
1304 endfun
1305< The related Vim variables are:
1306 v:charconvert_from name of the current encoding
1307 v:charconvert_to name of the desired encoding
1308 v:fname_in name of the input file
1309 v:fname_out name of the output file
1310 Note that v:fname_in and v:fname_out will never be the same.
1311 Note that v:charconvert_from and v:charconvert_to may be different
1312 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1313 Encryption is not done by Vim when using 'charconvert'. If you want
1314 to encrypt the file after conversion, 'charconvert' should take care
1315 of this.
1316 This option cannot be set from a |modeline| or in the |sandbox|, for
1317 security reasons.
1318
1319 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1320'cindent' 'cin' boolean (default off)
1321 local to buffer
1322 {not in Vi}
1323 {not available when compiled without the |+cindent|
1324 feature}
1325 Enables automatic C program indenting See 'cinkeys' to set the keys
1326 that trigger reindenting in insert mode and 'cinoptions' to set your
1327 preferred indent style.
1328 If 'indentexpr' is not empty, it overrules 'cindent'.
1329 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1330 the "=" operator indents using this algorithm rather than calling an
1331 external program.
1332 See |C-indenting|.
1333 When you don't like the way 'cindent' works, try the 'smartindent'
1334 option or 'indentexpr'.
1335 This option is not used when 'paste' is set.
1336 NOTE: This option is reset when 'compatible' is set.
1337
1338 *'cinkeys'* *'cink'*
1339'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1340 local to buffer
1341 {not in Vi}
1342 {not available when compiled without the |+cindent|
1343 feature}
1344 A list of keys that, when typed in Insert mode, cause reindenting of
1345 the current line. Only used if 'cindent' is on and 'indentexpr' is
1346 empty.
1347 For the format of this option see |cinkeys-format|.
1348 See |C-indenting|.
1349
1350 *'cinoptions'* *'cino'*
1351'cinoptions' 'cino' string (default "")
1352 local to buffer
1353 {not in Vi}
1354 {not available when compiled without the |+cindent|
1355 feature}
1356 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1357 program. See |cinoptions-values| for the values of this option, and
1358 |C-indenting| for info on C indenting in general.
1359
1360
1361 *'cinwords'* *'cinw'*
1362'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1363 local to buffer
1364 {not in Vi}
1365 {not available when compiled without both the
1366 |+cindent| and the |+smartindent| features}
1367 These keywords start an extra indent in the next line when
1368 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1369 an appropriate place (inside {}).
1370 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1371 matter, include the keyword both the uppercase and lowercase:
1372 "if,If,IF".
1373
1374 *'clipboard'* *'cb'*
1375'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1376 for X-windows, "" otherwise)
1377 global
1378 {not in Vi}
1379 {only in GUI versions or when the |+xterm_clipboard|
1380 feature is included}
1381 This option is a list of comma separated names.
1382 These names are recognized:
1383
1384 unnamed When included, Vim will use the clipboard register '*'
1385 for all yank, delete, change and put operations which
1386 would normally go to the unnamed register. When a
1387 register is explicitly specified, it will always be
1388 used regardless of whether "unnamed" is in 'clipboard'
1389 or not. The clipboard register can always be
1390 explicitly accessed using the "* notation. Also see
1391 |gui-clipboard|.
1392
1393 autoselect Works like the 'a' flag in 'guioptions': If present,
1394 then whenever Visual mode is started, or the Visual
1395 area extended, Vim tries to become the owner of the
1396 windowing system's global selection or put the
1397 selected text on the clipboard used by the selection
1398 register "*. See |guioptions_a| and |quotestar| for
1399 details. When the GUI is active, the 'a' flag in
1400 'guioptions' is used, when the GUI is not active, this
1401 "autoselect" flag is used.
1402 Also applies to the modeless selection.
1403
1404 autoselectml Like "autoselect", but for the modeless selection
1405 only. Compare to the 'A' flag in 'guioptions'.
1406
1407 exclude:{pattern}
1408 Defines a pattern that is matched against the name of
1409 the terminal 'term'. If there is a match, no
1410 connection will be made to the X server. This is
1411 useful in this situation:
1412 - Running Vim in a console.
1413 - $DISPLAY is set to start applications on another
1414 display.
1415 - You do not want to connect to the X server in the
1416 console, but do want this in a terminal emulator.
1417 To never connect to the X server use: >
1418 exclude:.*
1419< This has the same effect as using the |-X| argument.
1420 Note that when there is no connection to the X server
1421 the window title won't be restored and the clipboard
1422 cannot be accessed.
1423 The value of 'magic' is ignored, {pattern} is
1424 interpreted as if 'magic' was on.
1425 The rest of the option value will be used for
1426 {pattern}, this must be the last entry.
1427
1428 *'cmdheight'* *'ch'*
1429'cmdheight' 'ch' number (default 1)
1430 global
1431 {not in Vi}
1432 Number of screen lines to use for the command-line. Helps avoiding
1433 |hit-enter| prompts.
1434
1435 *'cmdwinheight'* *'cwh'*
1436'cmdwinheight' 'cwh' number (default 7)
1437 global
1438 {not in Vi}
1439 {not available when compiled without the |+vertsplit|
1440 feature}
1441 Number of screen lines to use for the command-line window. |cmdwin|
1442
1443 *'columns'* *'co'* *E594*
1444'columns' 'co' number (default 80 or terminal width)
1445 global
1446 {not in Vi}
1447 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001448 initialization and does not have to be set by hand. Also see
1449 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 When Vim is running in the GUI or in a resizable window, setting this
1451 option will cause the window size to be changed. When you only want
1452 to use the size for the GUI, put the command in your |gvimrc| file.
1453 When you set this option and Vim is unable to change the physical
1454 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001455 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456
1457 *'comments'* *'com'* *E524* *E525*
1458'comments' 'com' string (default
1459 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1460 local to buffer
1461 {not in Vi}
1462 {not available when compiled without the |+comments|
1463 feature}
1464 A comma separated list of strings that can start a comment line. See
1465 |format-comments|. See |option-backslash| about using backslashes to
1466 insert a space.
1467
1468 *'commentstring'* *'cms'* *E537*
1469'commentstring' 'cms' string (default "/*%s*/")
1470 local to buffer
1471 {not in Vi}
1472 {not available when compiled without the |+folding|
1473 feature}
1474 A template for a comment. The "%s" in the value is replaced with the
1475 comment text. Currently only used to add markers for folding, see
1476 |fold-marker|.
1477
1478 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001479'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1480 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 global
1482 {not in Vi}
1483 This option has the effect of making Vim either more Vi-compatible, or
1484 make Vim behave in a more useful way.
1485 This is a special kind of option, because when it's set or reset,
1486 other options are also changed as a side effect. CAREFUL: Setting or
1487 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001488 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 set this option in your vimrc file, you should probably put it at the
1490 very start.
1491 By default this option is on and the Vi defaults are used for the
1492 options. This default was chosen for those people who want to use Vim
1493 just like Vi, and don't even (want to) know about the 'compatible'
1494 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001495 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1496 this option is switched off, and all options that have not been
1497 modified will be set to the Vim defaults. Effectively, this means
1498 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1499 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1500 happen for the system-wide vimrc or gvimrc file). Also see
1501 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 You can also set this option with the "-C" argument, and reset it with
1503 "-N". See |-C| and |-N|.
1504 Switching this option off makes the Vim defaults be used for options
1505 that have a different Vi and Vim default value. See the options
1506 marked with a '+' below. Other options are not modified.
1507 At the moment this option is set, several other options will be set
1508 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001509 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 editing.
1511 See also 'cpoptions'.
1512
1513 option + set value effect ~
1514
1515 'allowrevins' off no CTRL-_ command
1516 'backupcopy' Unix: "yes" backup file is a copy
1517 others: "auto" copy or rename backup file
1518 'backspace' "" normal backspace
1519 'backup' off no backup file
1520 'cindent' off no C code indentation
1521 'cedit' + "" no key to open the |cmdwin|
1522 'cpoptions' + (all flags) Vi-compatible flags
1523 'cscopetag' off don't use cscope for ":tag"
1524 'cscopetagorder' 0 see |cscopetagorder|
1525 'cscopeverbose' off see |cscopeverbose|
1526 'digraph' off no digraphs
1527 'esckeys' + off no <Esc>-keys in Insert mode
1528 'expandtab' off tabs not expanded to spaces
1529 'fileformats' + "" no automatic file format detection,
1530 "dos,unix" except for DOS, Windows and OS/2
1531 'formatoptions' + "vt" Vi compatible formatting
1532 'gdefault' off no default 'g' flag for ":s"
1533 'history' + 0 no commandline history
1534 'hkmap' off no Hebrew keyboard mapping
1535 'hkmapp' off no phonetic Hebrew keyboard mapping
1536 'hlsearch' off no highlighting of search matches
1537 'incsearch' off no incremental searching
1538 'indentexpr' "" no indenting by expression
1539 'insertmode' off do not start in Insert mode
1540 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1541 characters and '_'
1542 'joinspaces' on insert 2 spaces after period
1543 'modeline' + off no modelines
1544 'more' + off no pauses in listings
1545 'revins' off no reverse insert
1546 'ruler' off no ruler
1547 'scrolljump' 1 no jump scroll
1548 'scrolloff' 0 no scroll offset
1549 'shiftround' off indent not rounded to shiftwidth
1550 'shortmess' + "" no shortening of messages
1551 'showcmd' + off command characters not shown
1552 'showmode' + off current mode not shown
1553 'smartcase' off no automatic ignore case switch
1554 'smartindent' off no smart indentation
1555 'smarttab' off no smart tab size
1556 'softtabstop' 0 tabs are always 'tabstop' positions
1557 'startofline' on goto startofline with some commands
1558 'tagrelative' + off tag file names are not relative
1559 'textauto' + off no automatic textmode detection
1560 'textwidth' 0 no automatic line wrap
1561 'tildeop' off tilde is not an operator
1562 'ttimeout' off no terminal timeout
1563 'whichwrap' + "" left-right movements don't wrap
1564 'wildchar' + CTRL-E only when the current value is <Tab>
1565 use CTRL-E for cmdline completion
1566 'writebackup' on or off depends on +writebackup feature
1567
1568 *'complete'* *'cpt'* *E535*
1569'complete' 'cpt' string (default: ".,w,b,u,t,i")
1570 local to buffer
1571 {not in Vi}
1572 This option specifies how keyword completion |ins-completion| works
1573 when CTRL-P or CTRL-N are used. It is also used for whole-line
1574 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1575 and the places to scan. It is a comma separated list of flags:
1576 . scan the current buffer ('wrapscan' is ignored)
1577 w scan buffers from other windows
1578 b scan other loaded buffers that are in the buffer list
1579 u scan the unloaded buffers that are in the buffer list
1580 U scan the buffers that are not in the buffer list
1581 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001582 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583 k{dict} scan the file {dict}. Several "k" flags can be given,
1584 patterns are valid too. For example: >
1585 :set cpt=k/usr/dict/*,k~/spanish
1586< s scan the files given with the 'thesaurus' option
1587 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1588 are valid too.
1589 i scan current and included files
1590 d scan current and included files for defined name or macro
1591 |i_CTRL-X_CTRL-D|
1592 ] tag completion
1593 t same as "]"
1594
1595 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1596 not executed, this may lead to unexpected completions from some files
1597 (gzipped files for example). Unloaded buffers are not scanned for
1598 whole-line completion.
1599
1600 The default is ".,w,b,u,t,i", which means to scan:
1601 1. the current buffer
1602 2. buffers in other windows
1603 3. other loaded buffers
1604 4. unloaded buffers
1605 5. tags
1606 6. included files
1607
1608 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001609 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1610 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001612 *'completefunc'* *'cfu'*
1613'completefunc' 'cfu' string (default: empty)
1614 local to buffer
1615 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001616 {not available when compiled without the +eval
1617 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001618 This option specifies a function to be used for Insert mode completion
1619 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001620 See |complete-functions| for an explanation of how the function is
1621 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001622
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001623
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001624 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001625'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001626 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001627 {not available when compiled without the
1628 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001629 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001630 A comma separated list of options for Insert mode completion
1631 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001632
1633 menu Use a popup menu to show the possible completions. The
1634 menu is only shown when there is more than one match and
1635 sufficient colors are available. |ins-completion-menu|
1636
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001637 menuone Use the popup menu also when there is only one match.
1638 Useful when there is additional information about the
1639 match, e.g., what file it comes from.
1640
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001641 longest Only insert the longest common text of the matches. Use
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001642 CTRL-L to add more characters. Whether case is ignored
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001643 depends on the kind of completion. For buffer text the
1644 'ignorecase' option is used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001645
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001646 preview Show extra information about the currently selected
1647 completion in the preview window.
1648
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1650'confirm' 'cf' boolean (default off)
1651 global
1652 {not in Vi}
1653 When 'confirm' is on, certain operations that would normally
1654 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1655 instead raise a |dialog| asking if you wish to save the current
1656 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1657 If 'confirm' is off you can still activate confirmation for one
1658 command only (this is most useful in mappings) with the |:confirm|
1659 command.
1660 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1661
1662 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1663'conskey' 'consk' boolean (default off)
1664 global
1665 {not in Vi} {only for MS-DOS}
1666 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001667 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 three methods of console input are available:
1669 'conskey' 'bioskey' action ~
1670 on on or off direct console input
1671 off on BIOS
1672 off off STDIN
1673
1674 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1675'copyindent' 'ci' boolean (default off)
1676 local to buffer
1677 {not in Vi}
1678 Copy the structure of the existing lines indent when autoindenting a
1679 new line. Normally the new indent is reconstructed by a series of
1680 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1681 in which case only spaces are used). Enabling this option makes the
1682 new line copy whatever characters were used for indenting on the
1683 existing line. If the new indent is greater than on the existing
1684 line, the remaining space is filled in the normal manner.
1685 NOTE: 'copyindent' is reset when 'compatible' is set.
1686 Also see 'preserveindent'.
1687
1688 *'cpoptions'* *'cpo'*
1689'cpoptions' 'cpo' string (Vim default: "aABceFs",
1690 Vi default: all flags)
1691 global
1692 {not in Vi}
1693 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001694 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 not being vi-compatible is mostly or sometimes preferred.
1696 'cpoptions' stands for "compatible-options".
1697 Commas can be added for readability.
1698 To avoid problems with flags that are added in the future, use the
1699 "+=" and "-=" feature of ":set" |add-option-flags|.
1700 NOTE: This option is set to the Vi default value when 'compatible' is
1701 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001702 NOTE: This option is set to the POSIX default value at startup when
1703 the Vi default value would be used and the $VIM_POSIX environment
1704 variable exists |posix|. This means tries to behave like the POSIX
1705 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706
1707 contains behavior ~
1708 *cpo-a*
1709 a When included, a ":read" command with a file name
1710 argument will set the alternate file name for the
1711 current window.
1712 *cpo-A*
1713 A When included, a ":write" command with a file name
1714 argument will set the alternate file name for the
1715 current window.
1716 *cpo-b*
1717 b "\|" in a ":map" command is recognized as the end of
1718 the map command. The '\' is included in the mapping,
1719 the text after the '|' is interpreted as the next
1720 command. Use a CTRL-V instead of a backslash to
1721 include the '|' in the mapping. Applies to all
1722 mapping, abbreviation, menu and autocmd commands.
1723 See also |map_bar|.
1724 *cpo-B*
1725 B A backslash has no special meaning in mappings,
1726 abbreviations and the "to" part of the menu commands.
1727 Remove this flag to be able to use a backslash like a
1728 CTRL-V. For example, the command ":map X \<Esc>"
1729 results in X being mapped to:
1730 'B' included: "\^[" (^[ is a real <Esc>)
1731 'B' excluded: "<Esc>" (5 characters)
1732 ('<' excluded in both cases)
1733 *cpo-c*
1734 c Searching continues at the end of any match at the
1735 cursor position, but not further than the start of the
1736 next line. When not present searching continues
1737 one character from the cursor position. With 'c'
1738 "abababababab" only gets three matches when repeating
1739 "/abab", without 'c' there are five matches.
1740 *cpo-C*
1741 C Do not concatenate sourced lines that start with a
1742 backslash. See |line-continuation|.
1743 *cpo-d*
1744 d Using "./" in the 'tags' option doesn't mean to use
1745 the tags file relative to the current file, but the
1746 tags file in the current directory.
1747 *cpo-D*
1748 D Can't use CTRL-K to enter a digraph after Normal mode
1749 commands with a character argument, like |r|, |f| and
1750 |t|.
1751 *cpo-e*
1752 e When executing a register with ":@r", always add a
1753 <CR> to the last line, also when the register is not
1754 linewise. If this flag is not present, the register
1755 is not linewise and the last line does not end in a
1756 <CR>, then the last line is put on the command-line
1757 and can be edited before hitting <CR>.
1758 *cpo-E*
1759 E It is an error when using "y", "d", "c", "g~", "gu" or
1760 "gU" on an Empty region. The operators only work when
1761 at least one character is to be operate on. Example:
1762 This makes "y0" fail in the first column.
1763 *cpo-f*
1764 f When included, a ":read" command with a file name
1765 argument will set the file name for the current buffer,
1766 if the current buffer doesn't have a file name yet.
1767 *cpo-F*
1768 F When included, a ":write" command with a file name
1769 argument will set the file name for the current
1770 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001771 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 *cpo-g*
1773 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001774 *cpo-H*
1775 H When using "I" on a line with only blanks, insert
1776 before the last blank. Without this flag insert after
1777 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 *cpo-i*
1779 i When included, interrupting the reading of a file will
1780 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001781 *cpo-I*
1782 I When moving the cursor up or down just after inserting
1783 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 *cpo-j*
1785 j When joining lines, only add two spaces after a '.',
1786 not after '!' or '?'. Also see 'joinspaces'.
1787 *cpo-J*
1788 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001789 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 white space.
1791 *cpo-k*
1792 k Disable the recognition of raw key codes in
1793 mappings, abbreviations, and the "to" part of menu
1794 commands. For example, if <Key> sends ^[OA (where ^[
1795 is <Esc>), the command ":map X ^[OA" results in X
1796 being mapped to:
1797 'k' included: "^[OA" (3 characters)
1798 'k' excluded: "<Key>" (one key code)
1799 Also see the '<' flag below.
1800 *cpo-K*
1801 K Don't wait for a key code to complete when it is
1802 halfway a mapping. This breaks mapping <F1><F1> when
1803 only part of the second <F1> has been read. It
1804 enables cancelling the mapping by typing <F1><Esc>.
1805 *cpo-l*
1806 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001807 literally, only "\]", "\^", "\-" and "\\" are special.
1808 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1810 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001811 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001812 *cpo-L*
1813 L When the 'list' option is set, 'wrapmargin',
1814 'textwidth', 'softtabstop' and Virtual Replace mode
1815 (see |gR|) count a <Tab> as two characters, instead of
1816 the normal behavior of a <Tab>.
1817 *cpo-m*
1818 m When included, a showmatch will always wait half a
1819 second. When not included, a showmatch will wait half
1820 a second or until a character is typed. |'showmatch'|
1821 *cpo-M*
1822 M When excluded, "%" matching will take backslashes into
1823 account. Thus in "( \( )" and "\( ( \)" the outer
1824 parenthesis match. When included "%" ignores
1825 backslashes, which is Vi compatible.
1826 *cpo-n*
1827 n When included, the column used for 'number' will also
1828 be used for text of wrapped lines.
1829 *cpo-o*
1830 o Line offset to search command is not remembered for
1831 next search.
1832 *cpo-O*
1833 O Don't complain if a file is being overwritten, even
1834 when it didn't exist when editing it. This is a
1835 protection against a file unexpectedly created by
1836 someone else. Vi didn't complain about this.
1837 *cpo-p*
1838 p Vi compatible Lisp indenting. When not present, a
1839 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001840 *cpo-P*
1841 P When included, a ":write" command that appends to a
1842 file will set the file name for the current buffer, if
1843 the current buffer doesn't have a file name yet and
1844 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001845 *cpo-q*
1846 q When joining multiple lines leave the cursor at the
1847 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 *cpo-r*
1849 r Redo ("." command) uses "/" to repeat a search
1850 command, instead of the actually used search string.
1851 *cpo-R*
1852 R Remove marks from filtered lines. Without this flag
1853 marks are kept like |:keepmarks| was used.
1854 *cpo-s*
1855 s Set buffer options when entering the buffer for the
1856 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001857 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 set when the buffer is created.
1859 *cpo-S*
1860 S Set buffer options always when entering a buffer
1861 (except 'readonly', 'fileformat', 'filetype' and
1862 'syntax'). This is the (most) Vi compatible setting.
1863 The options are set to the values in the current
1864 buffer. When you change an option and go to another
1865 buffer, the value is copied. Effectively makes the
1866 buffer options global to all buffers.
1867
1868 's' 'S' copy buffer options
1869 no no when buffer created
1870 yes no when buffer first entered (default)
1871 X yes each time when buffer entered (vi comp.)
1872 *cpo-t*
1873 t Search pattern for the tag command is remembered for
1874 "n" command. Otherwise Vim only puts the pattern in
1875 the history for search pattern, but doesn't change the
1876 last used search pattern.
1877 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001878 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 *cpo-v*
1880 v Backspaced characters remain visible on the screen in
1881 Insert mode. Without this flag the characters are
1882 erased from the screen right away. With this flag the
1883 screen newly typed text overwrites backspaced
1884 characters.
1885 *cpo-w*
1886 w When using "cw" on a blank character, only change one
1887 character and not all blanks until the start of the
1888 next word.
1889 *cpo-W*
1890 W Don't overwrite a readonly file. When omitted, ":w!"
1891 overwrites a readonly file, if possible.
1892 *cpo-x*
1893 x <Esc> on the command-line executes the command-line.
1894 The default in Vim is to abandon the command-line,
1895 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001896 *cpo-X*
1897 X When using a count with "R" the replaced text is
1898 deleted only once. Also when repeating "R" with "."
1899 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900 *cpo-y*
1901 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001902 *cpo-Z*
1903 Z When using "w!" while the 'readonly' option is set,
1904 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 *cpo-!*
1906 ! When redoing a filter command, use the last used
1907 external command, whatever it was. Otherwise the last
1908 used -filter- command is used.
1909 *cpo-$*
1910 $ When making a change to one line, don't redisplay the
1911 line, but put a '$' at the end of the changed text.
1912 The changed text will be overwritten when you type the
1913 new text. The line is redisplayed if you type any
1914 command that moves the cursor from the insertion
1915 point.
1916 *cpo-%*
1917 % Vi-compatible matching is done for the "%" command.
1918 Does not recognize "#if", "#endif", etc.
1919 Does not recognize "/*" and "*/".
1920 Parens inside single and double quotes are also
1921 counted, causing a string that contains a paren to
1922 disturb the matching. For example, in a line like
1923 "if (strcmp("foo(", s))" the first paren does not
1924 match the last one. When this flag is not included,
1925 parens inside single and double quotes are treated
1926 specially. When matching a paren outside of quotes,
1927 everything inside quotes is ignored. When matching a
1928 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001929 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001930 This flag is also used for other features, such as
1931 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001932 *cpo--*
1933 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001934 it would go above the first line or below the last
1935 line. Without it the cursor moves to the first or
1936 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001937 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001938 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001939 *cpo-+*
1940 + When included, a ":write file" command will reset the
1941 'modified' flag of the buffer, even though the buffer
1942 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001943 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944 * Use ":*" in the same way as ":@". When not included,
1945 ":*" is an alias for ":'<,'>", select the Visual area.
1946 *cpo-<*
1947 < Disable the recognition of special key codes in |<>|
1948 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001949 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950 ":map X <Tab>" results in X being mapped to:
1951 '<' included: "<Tab>" (5 characters)
1952 '<' excluded: "^I" (^I is a real <Tab>)
1953 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001954 *cpo->*
1955 > When appending to a register, put a line break before
1956 the appended text.
1957
1958 POSIX flags. These are not included in the Vi default value, except
1959 when $VIM_POSIX was set on startup. |posix|
1960
1961 contains behavior ~
1962 *cpo-#*
1963 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001964 *cpo-&*
1965 & When ":preserve" was used keep the swap file when
1966 exiting normally while this buffer is still loaded.
1967 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001968 *cpo-\*
1969 \ Backslash in a [] range in a search pattern is taken
1970 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001971 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1972 '\' excluded: "/[ \-]" finds <Space> and '-'
1973 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001974 *cpo-/*
1975 / When "%" is used as the replacement string in a |:s|
1976 command, use the previous replacement string. |:s%|
1977 *cpo-{*
1978 { The |{| and |}| commands also stop at a "{" character
1979 at the start of a line.
1980 *cpo-.*
1981 . The ":chdir" and ":cd" commands fail if the current
1982 buffer is modified, unless ! is used. Vim doesn't
1983 need this, since it remembers the full path of an
1984 opened file.
1985 *cpo-bar*
1986 | The value of the $LINES and $COLUMNS environment
1987 variables overrule the terminal size values obtained
1988 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001989
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990
1991 *'cscopepathcomp'* *'cspc'*
1992'cscopepathcomp' 'cspc' number (default 0)
1993 global
1994 {not available when compiled without the |+cscope|
1995 feature}
1996 {not in Vi}
1997 Determines how many components of the path to show in a list of tags.
1998 See |cscopepathcomp|.
1999
2000 *'cscopeprg'* *'csprg'*
2001'cscopeprg' 'csprg' string (default "cscope")
2002 global
2003 {not available when compiled without the |+cscope|
2004 feature}
2005 {not in Vi}
2006 Specifies the command to execute cscope. See |cscopeprg|.
2007 This option cannot be set from a |modeline| or in the |sandbox|, for
2008 security reasons.
2009
2010 *'cscopequickfix'* *'csqf'*
2011'cscopequickfix' 'csqf' string (default "")
2012 global
2013 {not available when compiled without the |+cscope|
2014 or |+quickfix| features}
2015 {not in Vi}
2016 Specifies whether to use quickfix window to show cscope results.
2017 See |cscopequickfix|.
2018
2019 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2020'cscopetag' 'cst' boolean (default off)
2021 global
2022 {not available when compiled without the |+cscope|
2023 feature}
2024 {not in Vi}
2025 Use cscope for tag commands. See |cscope-options|.
2026 NOTE: This option is reset when 'compatible' is set.
2027
2028 *'cscopetagorder'* *'csto'*
2029'cscopetagorder' 'csto' number (default 0)
2030 global
2031 {not available when compiled without the |+cscope|
2032 feature}
2033 {not in Vi}
2034 Determines the order in which ":cstag" performs a search. See
2035 |cscopetagorder|.
2036 NOTE: This option is set to 0 when 'compatible' is set.
2037
2038 *'cscopeverbose'* *'csverb'*
2039 *'nocscopeverbose'* *'nocsverb'*
2040'cscopeverbose' 'csverb' boolean (default off)
2041 global
2042 {not available when compiled without the |+cscope|
2043 feature}
2044 {not in Vi}
2045 Give messages when adding a cscope database. See |cscopeverbose|.
2046 NOTE: This option is reset when 'compatible' is set.
2047
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002048
2049 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2050'cursorcolumn' 'cuc' boolean (default off)
2051 local to window
2052 {not in Vi}
2053 {not available when compiled without the |+syntax|
2054 feature}
2055 Highlight the screen column of the cursor with CursorColumn
2056 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2057 slower.
2058
2059 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2060'cursorline' 'cul' boolean (default off)
2061 local to window
2062 {not in Vi}
2063 {not available when compiled without the |+syntax|
2064 feature}
2065 Highlight the screen line of the cursor with CursorLine
2066 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2067 redrawing slower.
2068
2069
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 *'debug'*
2071'debug' string (default "")
2072 global
2073 {not in Vi}
2074 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002075 be given anyway. This is useful when debugging 'foldexpr',
2076 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002077 When set to "beep", a message will be given when otherwise only a beep
2078 would be produced.
2079 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080
2081 *'define'* *'def'*
2082'define' 'def' string (default "^\s*#\s*define")
2083 global or local to buffer |global-local|
2084 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002085 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086 pattern, just like for the "/" command. This option is used for the
2087 commands like "[i" and "[d" |include-search|. The 'isident' option is
2088 used to recognize the defined name after the match:
2089 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2090 See |option-backslash| about inserting backslashes to include a space
2091 or backslash.
2092 The default value is for C programs. For C++ this value would be
2093 useful, to include const type declarations: >
2094 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2095< When using the ":set" command, you need to double the backslashes!
2096
2097 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2098'delcombine' 'deco' boolean (default off)
2099 global
2100 {not in Vi}
2101 {only available when compiled with the |+multi_byte|
2102 feature}
2103 If editing Unicode and this option is set, backspace and Normal mode
2104 "x" delete each combining character on its own. When it is off (the
2105 default) the character along with its combining characters are
2106 deleted.
2107 Note: When 'delcombine' is set "xx" may work different from "2x"!
2108
2109 This is useful for Arabic, Hebrew and many other languages where one
2110 may have combining characters overtop of base characters, and want
2111 to remove only the combining ones.
2112
2113 *'dictionary'* *'dict'*
2114'dictionary' 'dict' string (default "")
2115 global or local to buffer |global-local|
2116 {not in Vi}
2117 List of file names, separated by commas, that are used to lookup words
2118 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2119 contain a list of words. This can be one word per line, or several
2120 words per line, separated by non-keyword characters (white space is
2121 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002122 When this option is empty, or an entry "spell" is present, spell
2123 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002124 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 after a comma are ignored, otherwise spaces are included in the file
2126 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002127 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 Where to find a list of words?
2129 - On FreeBSD, there is the file "/usr/share/dict/words".
2130 - In the Simtel archive, look in the "msdos/linguist" directory.
2131 - In "miscfiles" of the GNU collection.
2132 The use of |:set+=| and |:set-=| is preferred when adding or removing
2133 directories from the list. This avoids problems when a future version
2134 uses another default.
2135 Backticks cannot be used in this option for security reasons.
2136
2137 *'diff'* *'nodiff'*
2138'diff' boolean (default off)
2139 local to window
2140 {not in Vi}
2141 {not available when compiled without the |+diff|
2142 feature}
2143 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002144 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145
2146 *'dex'* *'diffexpr'*
2147'diffexpr' 'dex' string (default "")
2148 global
2149 {not in Vi}
2150 {not available when compiled without the |+diff|
2151 feature}
2152 Expression which is evaluated to obtain an ed-style diff file from two
2153 versions of a file. See |diff-diffexpr|.
2154 This option cannot be set from a |modeline| or in the |sandbox|, for
2155 security reasons.
2156
2157 *'dip'* *'diffopt'*
2158'diffopt' 'dip' string (default "filler")
2159 global
2160 {not in Vi}
2161 {not available when compiled without the |+diff|
2162 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002163 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 All are optional. Items must be separated by a comma.
2165
2166 filler Show filler lines, to keep the text
2167 synchronized with a window that has inserted
2168 lines at the same position. Mostly useful
2169 when windows are side-by-side and 'scrollbind'
2170 is set.
2171
2172 context:{n} Use a context of {n} lines between a change
2173 and a fold that contains unchanged lines.
2174 When omitted a context of six lines is used.
2175 See |fold-diff|.
2176
2177 icase Ignore changes in case of text. "a" and "A"
2178 are considered the same. Adds the "-i" flag
2179 to the "diff" command if 'diffexpr' is empty.
2180
2181 iwhite Ignore changes in amount of white space. Adds
2182 the "-b" flag to the "diff" command if
2183 'diffexpr' is empty. Check the documentation
2184 of the "diff" command for what this does
2185 exactly. It should ignore adding trailing
2186 white space, but not leading white space.
2187
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002188 horizontal Start diff mode with horizontal splits (unless
2189 explicitly specified otherwise).
2190
2191 vertical Start diff mode with vertical splits (unless
2192 explicitly specified otherwise).
2193
2194 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2195 starting diff mode. Without this 2 is used.
2196
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 Examples: >
2198
2199 :set diffopt=filler,context:4
2200 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002201 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202<
2203 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2204'digraph' 'dg' boolean (default off)
2205 global
2206 {not in Vi}
2207 {not available when compiled without the |+digraphs|
2208 feature}
2209 Enable the entering of digraphs in Insert mode with {char1} <BS>
2210 {char2}. See |digraphs|.
2211 NOTE: This option is reset when 'compatible' is set.
2212
2213 *'directory'* *'dir'*
2214'directory' 'dir' string (default for Amiga: ".,t:",
2215 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2216 for Unix: ".,~/tmp,/var/tmp,/tmp")
2217 global
2218 List of directory names for the swap file, separated with commas.
2219 - The swap file will be created in the first directory where this is
2220 possible.
2221 - Empty means that no swap file will be used (recovery is
2222 impossible!).
2223 - A directory "." means to put the swap file in the same directory as
2224 the edited file. On Unix, a dot is prepended to the file name, so
2225 it doesn't show in a directory listing. On MS-Windows the "hidden"
2226 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002227 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 put the swap file relative to where the edited file is. The leading
2229 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002230 - For Unix and Win32, if a directory ends in two path separators "//"
2231 or "\\", the swap file name will be built from the complete path to
2232 the file with all path separators substituted to percent '%' signs.
2233 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 - Spaces after the comma are ignored, other spaces are considered part
2235 of the directory name. To have a space at the start of a directory
2236 name, precede it with a backslash.
2237 - To include a comma in a directory name precede it with a backslash.
2238 - A directory name may end in an ':' or '/'.
2239 - Environment variables are expanded |:set_env|.
2240 - Careful with '\' characters, type one before a space, type two to
2241 get one in the option (see |option-backslash|), for example: >
2242 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2243< - For backwards compatibility with Vim version 3.0 a '>' at the start
2244 of the option is removed.
2245 Using "." first in the list is recommended. This means that editing
2246 the same file twice will result in a warning. Using "/tmp" on Unix is
2247 discouraged: When the system crashes you lose the swap file.
2248 "/var/tmp" is often not cleared when rebooting, thus is a better
2249 choice than "/tmp". But it can contain a lot of files, your swap
2250 files get lost in the crowd. That is why a "tmp" directory in your
2251 home directory is tried first.
2252 The use of |:set+=| and |:set-=| is preferred when adding or removing
2253 directories from the list. This avoids problems when a future version
2254 uses another default.
2255 This option cannot be set from a |modeline| or in the |sandbox|, for
2256 security reasons.
2257 {Vi: directory to put temp file in, defaults to "/tmp"}
2258
2259 *'display'* *'dy'*
2260'display' 'dy' string (default "")
2261 global
2262 {not in Vi}
2263 Change the way text is displayed. This is comma separated list of
2264 flags:
2265 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002266 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 last line that doesn't fit is replaced with "@" lines.
2268 uhex Show unprintable characters hexadecimal as <xx>
2269 instead of using ^C and ~C.
2270
2271 *'eadirection'* *'ead'*
2272'eadirection' 'ead' string (default "both")
2273 global
2274 {not in Vi}
2275 {not available when compiled without the +vertsplit
2276 feature}
2277 Tells when the 'equalalways' option applies:
2278 ver vertically, width of windows is not affected
2279 hor horizontally, height of windows is not affected
2280 both width and height of windows is affected
2281
2282 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2283'edcompatible' 'ed' boolean (default off)
2284 global
2285 Makes the 'g' and 'c' flags of the ":substitute" command to be
2286 toggled each time the flag is given. See |complex-change|. See
2287 also 'gdefault' option.
2288 Switching this option on is discouraged!
2289
2290 *'encoding'* *'enc'* *E543*
2291'encoding' 'enc' string (default: "latin1" or value from $LANG)
2292 global
2293 {only available when compiled with the |+multi_byte|
2294 feature}
2295 {not in Vi}
2296 Sets the character encoding used inside Vim. It applies to text in
2297 the buffers, registers, Strings in expressions, text stored in the
2298 viminfo file, etc. It sets the kind of characters which Vim can work
2299 with. See |encoding-names| for the possible values.
2300
2301 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002302 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303 It should normally be kept at its default value, or set when Vim
2304 starts up. See |multibyte|.
2305
2306 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2307 "utf-8". Although care has been taken to allow different values of
2308 'encoding', "utf-8" is the natural choice for the environment and
2309 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002310 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311 versions, and to avoid changing the encoding of newly created files
2312 without your knowledge (in case 'fileencodings' is empty).
2313
2314 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002315 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 iconv() or as specified with 'charconvert'.
2317
2318 Normally 'encoding' will be equal to your current locale. This will
2319 be the default if Vim recognizes your environment settings. If
2320 'encoding' is not set to the current locale, 'termencoding' must be
2321 set to convert typed and displayed text. See |encoding-table|.
2322
2323 When you set this option, it fires the |EncodingChanged| autocommand
2324 event so that you can set up fonts if necessary.
2325
2326 When the option is set, the value is converted to lowercase. Thus
2327 you can set it with uppercase values too. Underscores are translated
2328 to '-' signs.
2329 When the encoding is recognized, it is changed to the standard name.
2330 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2331 "iso-8859-2" and "utf8" becomes "utf-8".
2332
2333 Note: "latin1" is also used when the encoding could not be detected.
2334 This only works when editing files in the same encoding! When the
2335 actual character set is not latin1, make sure 'fileencoding' and
2336 'fileencodings' are empty. When conversion is needed, switch to using
2337 utf-8.
2338
2339 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2340 You don't notice this while editing, but it does matter for the
2341 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2342 setting 'encoding' to one of these values instead of utf-8 only has
2343 effect for encoding used for files when 'fileencoding' is empty.
2344
Bram Moolenaar661b1822005-07-28 22:36:45 +00002345 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2346 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347
2348 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2349'endofline' 'eol' boolean (default on)
2350 local to buffer
2351 {not in Vi}
2352 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002353 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 option is automatically set when starting to edit a new file, unless
2355 the file does not have an <EOL> for the last line in the file, in
2356 which case it is reset. Normally you don't have to set or reset this
2357 option. When 'binary' is off the value is not used when writing the
2358 file. When 'binary' is on it is used to remember the presence of a
2359 <EOL> for the last line in the file, so that when you write the file
2360 the situation from the original file can be kept. But you can change
2361 it if you want to.
2362
2363 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2364'equalalways' 'ea' boolean (default on)
2365 global
2366 {not in Vi}
2367 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002368 splitting or closing a window. This also happens the moment the
2369 option is switched on. When off, splitting a window will reduce the
2370 size of the current window and leave the other windows the same. When
2371 closing a window the extra lines are given to the window next to it
2372 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373 When mixing vertically and horizontally split windows, a minimal size
2374 is computed and some windows may be larger if there is room. The
2375 'eadirection' option tells in which direction the size is affected.
2376 Changing the height of a window can be avoided by setting
2377 'winfixheight'.
2378
2379 *'equalprg'* *'ep'*
2380'equalprg' 'ep' string (default "")
2381 global or local to buffer |global-local|
2382 {not in Vi}
2383 External program to use for "=" command. When this option is empty
2384 the internal formatting functions are used ('lisp', 'cindent' or
2385 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002386 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 about including spaces and backslashes.
2388 This option cannot be set from a |modeline| or in the |sandbox|, for
2389 security reasons.
2390
2391 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2392'errorbells' 'eb' boolean (default off)
2393 global
2394 Ring the bell (beep or screen flash) for error messages. This only
2395 makes a difference for error messages, the bell will be used always
2396 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002397 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 screen flash or do nothing.
2399
2400 *'errorfile'* *'ef'*
2401'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2402 others: "errors.err")
2403 global
2404 {not in Vi}
2405 {not available when compiled without the |+quickfix|
2406 feature}
2407 Name of the errorfile for the QuickFix mode (see |:cf|).
2408 When the "-q" command-line argument is used, 'errorfile' is set to the
2409 following argument. See |-q|.
2410 NOT used for the ":make" command. See 'makeef' for that.
2411 Environment variables are expanded |:set_env|.
2412 See |option-backslash| about including spaces and backslashes.
2413 This option cannot be set from a |modeline| or in the |sandbox|, for
2414 security reasons.
2415
2416 *'errorformat'* *'efm'*
2417'errorformat' 'efm' string (default is very long)
2418 global or local to buffer |global-local|
2419 {not in Vi}
2420 {not available when compiled without the |+quickfix|
2421 feature}
2422 Scanf-like description of the format for the lines in the error file
2423 (see |errorformat|).
2424
2425 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2426'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2427 global
2428 {not in Vi}
2429 Function keys that start with an <Esc> are recognized in Insert
2430 mode. When this option is off, the cursor and function keys cannot be
2431 used in Insert mode if they start with an <Esc>. The advantage of
2432 this is that the single <Esc> is recognized immediately, instead of
2433 after one second. Instead of resetting this option, you might want to
2434 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2435 when 'esckeys' is off, you can still map anything, but the cursor keys
2436 won't work by default.
2437 NOTE: This option is set to the Vi default value when 'compatible' is
2438 set and to the Vim default value when 'compatible' is reset.
2439
2440 *'eventignore'* *'ei'*
2441'eventignore' 'ei' string (default "")
2442 global
2443 {not in Vi}
2444 {not available when compiled without the |+autocmd|
2445 feature}
2446 A list of autocommand event names, which are to be ignored.
2447 When set to "all", all autocommand events are ignored, autocommands
2448 will not be executed.
2449 Otherwise this is a comma separated list of event names. Example: >
2450 :set ei=WinEnter,WinLeave
2451<
2452 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2453'expandtab' 'et' boolean (default off)
2454 local to buffer
2455 {not in Vi}
2456 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002457 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2459 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2460 NOTE: This option is reset when 'compatible' is set.
2461
2462 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2463'exrc' 'ex' boolean (default off)
2464 global
2465 {not in Vi}
2466 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2467 directory. If you switch this option on you should also consider
2468 setting the 'secure' option (see |initialization|). Using a local
2469 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2470 also see |.vimrc| and |gui-init|.
2471 This option cannot be set from a |modeline| or in the |sandbox|, for
2472 security reasons.
2473
2474 *'fileencoding'* *'fenc'* *E213*
2475'fileencoding' 'fenc' string (default: "")
2476 local to buffer
2477 {only available when compiled with the |+multi_byte|
2478 feature}
2479 {not in Vi}
2480 Sets the character encoding for the file of this buffer.
2481 When 'fileencoding' is different from 'encoding', conversion will be
2482 done when reading and writing the file.
2483 When 'fileencoding' is empty, the same value as 'encoding' will be
2484 used (no conversion when reading or writing a file).
2485 WARNING: Conversion can cause loss of information! When
2486 'encoding' is "utf-8" conversion is most likely done in a way
2487 that the reverse conversion results in the same text. When
2488 'encoding' is not "utf-8" some characters may be lost!
2489 See 'encoding' for the possible values. Additionally, values may be
2490 specified that can be handled by the converter, see
2491 |mbyte-conversion|.
2492 When reading a file 'fileencoding' will be set from 'fileencodings'.
2493 To read a file in a certain encoding it won't work by setting
2494 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002495 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2497 When the option is set, the value is converted to lowercase. Thus
2498 you can set it with uppercase values too. '_' characters are
2499 replaced with '-'. If a name is recognized from the list for
2500 'encoding', it is replaced by the standard name. For example
2501 "ISO8859-2" becomes "iso-8859-2".
2502 When this option is set, after starting to edit a file, the 'modified'
2503 option is set, because the file would be different when written.
2504 If you do this in a modeline, you might want to set 'nomodified' to
2505 avoid this.
2506 This option can not be changed when 'modifiable' is off.
2507
2508 *'fe'*
2509 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002510 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 old short name was 'fe', which is no longer used.
2512
2513 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002514'fileencodings' 'fencs' string (default: "ucs-bom",
2515 "ucs-bom,utf-8,default,latin1" when
2516 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 global
2518 {only available when compiled with the |+multi_byte|
2519 feature}
2520 {not in Vi}
2521 This is a list of character encodings considered when starting to edit
2522 an existing file. When a file is read, Vim tries to use the first
2523 mentioned character encoding. If an error is detected, the next one
2524 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002525 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 an empty string, which means the value of 'encoding' is used.
2527 WARNING: Conversion can cause loss of information! When
2528 'encoding' is "utf-8" (or one of the other Unicode variants)
2529 conversion is most likely done in a way that the reverse
2530 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002531 "utf-8" some non-ASCII characters may be lost! You can use
2532 the |++bad| argument to specify what is done with characters
2533 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 For an empty file or a file with only ASCII characters most encodings
2535 will work and the first entry of 'fileencodings' will be used (except
2536 "ucs-bom", which requires the BOM to be present). If you prefer
2537 another encoding use an BufReadPost autocommand event to test if your
2538 preferred encoding is to be used. Example: >
2539 au BufReadPost * if search('\S', 'w') == 0 |
2540 \ set fenc=iso-2022-jp | endif
2541< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2542 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002543 When the |++enc| argument is used then the value of 'fileencodings' is
2544 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002545 Note that 'fileencodings' is not used for a new file, the global value
2546 of 'fileencoding' is used instead. You can set it with: >
2547 :setglobal fenc=iso-8859-2
2548< This means that a non-existing file may get a different encoding than
2549 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 The special value "ucs-bom" can be used to check for a Unicode BOM
2551 (Byte Order Mark) at the start of the file. It must not be preceded
2552 by "utf-8" or another Unicode encoding for this to work properly.
2553 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2554 because Vim cannot detect an error, thus the encoding is always
2555 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002556 The special value "default" can be used for the encoding from the
2557 environment. This is the default value for 'encoding'. It is useful
2558 when 'encoding' is set to "utf-8" and your environment uses a
2559 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002560 When 'encoding' is "utf-8" and a file contains an illegal byte
2561 sequence it won't be recognized as UTF-8. You can use the |8g8|
2562 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 WRONG VALUES: WHAT'S WRONG:
2564 latin1,utf-8 "latin1" will always be used
2565 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2566 file
2567 cp1250,latin1 "cp1250" will always be used
2568 If 'fileencodings' is empty, 'fileencoding' is not modified.
2569 See 'fileencoding' for the possible values.
2570 Setting this option does not have an effect until the next time a file
2571 is read.
2572
2573 *'fileformat'* *'ff'*
2574'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2575 Unix default: "unix",
2576 Macintosh default: "mac")
2577 local to buffer
2578 {not in Vi}
2579 This gives the <EOL> of the current buffer, which is used for
2580 reading/writing the buffer from/to a file:
2581 dos <CR> <NL>
2582 unix <NL>
2583 mac <CR>
2584 When "dos" is used, CTRL-Z at the end of a file is ignored.
2585 See |file-formats| and |file-read|.
2586 For the character encoding of the file see 'fileencoding'.
2587 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2588 works like it was set to "unix'.
2589 This option is set automatically when starting to edit a file and
2590 'fileformats' is not empty and 'binary' is off.
2591 When this option is set, after starting to edit a file, the 'modified'
2592 option is set, because the file would be different when written.
2593 This option can not be changed when 'modifiable' is off.
2594 For backwards compatibility: When this option is set to "dos",
2595 'textmode' is set, otherwise 'textmode' is reset.
2596
2597 *'fileformats'* *'ffs'*
2598'fileformats' 'ffs' string (default:
2599 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2600 Vim Unix: "unix,dos",
2601 Vim Mac: "mac,unix,dos",
2602 Vi Cygwin: "unix,dos",
2603 Vi others: "")
2604 global
2605 {not in Vi}
2606 This gives the end-of-line (<EOL>) formats that will be tried when
2607 starting to edit a new buffer and when reading a file into an existing
2608 buffer:
2609 - When empty, the format defined with 'fileformat' will be used
2610 always. It is not set automatically.
2611 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002612 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 'fileformats' name will be used when a file is read into an existing
2614 buffer, no matter what 'fileformat' for that buffer is set to.
2615 - When more than one name is present, separated by commas, automatic
2616 <EOL> detection will be done when reading a file. When starting to
2617 edit a file, a check is done for the <EOL>:
2618 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2619 'fileformat' is set to "dos".
2620 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002621 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 preceding <CR>, "unix" is preferred over "dos".
2623 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2624 This means that "mac" is only chosen when "unix" is not present,
2625 or when no <NL> is found in the file, and when "dos" is not
2626 present, or no <CR><NL> is present in the file.
2627 Also if "unix" was first chosen, but the first <CR> is before
2628 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2629 the file, then 'fileformat' is set to "mac".
2630 4. If 'fileformat' is still not set, the first name from
2631 'fileformats' is used.
2632 When reading a file into an existing buffer, the same is done, but
2633 this happens like 'fileformat' has been set appropriately for that
2634 file only, the option is not changed.
2635 When 'binary' is set, the value of 'fileformats' is not used.
2636
2637 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2638 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2639 done:
2640 - When 'fileformats' is empty, there is no automatic detection. Dos
2641 format will be used.
2642 - When 'fileformats' is set to one or more names, automatic detection
2643 is done. This is based on the first <NL> in the file: If there is a
2644 <CR> in front of it, Dos format is used, otherwise Unix format is
2645 used.
2646 Also see |file-formats|.
2647 For backwards compatibility: When this option is set to an empty
2648 string or one format (no comma is included), 'textauto' is reset,
2649 otherwise 'textauto' is set.
2650 NOTE: This option is set to the Vi default value when 'compatible' is
2651 set and to the Vim default value when 'compatible' is reset.
2652
2653 *'filetype'* *'ft'*
2654'filetype' 'ft' string (default: "")
2655 local to buffer
2656 {not in Vi}
2657 {not available when compiled without the |+autocmd|
2658 feature}
2659 When this option is set, the FileType autocommand event is triggered.
2660 All autocommands that match with the value of this option will be
2661 executed. Thus the value of 'filetype' is used in place of the file
2662 name.
2663 Otherwise this option does not always reflect the current file type.
2664 This option is normally set when the file type is detected. To enable
2665 this use the ":filetype on" command. |:filetype|
2666 Setting this option to a different value is most useful in a modeline,
2667 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002668 Example, for in an IDL file:
2669 /* vim: set filetype=idl : */ ~
2670 |FileType| |filetypes|
2671 When a dot appears in the value then this separates two filetype
2672 names. Example:
2673 /* vim: set filetype=c.doxygen : */ ~
2674 This will use the "c" filetype first, then the "doxygen" filetype.
2675 This works both for filetype plugins and for syntax files. More than
2676 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677 Do not confuse this option with 'osfiletype', which is for the file
2678 type that is actually stored with the file.
2679 This option is not copied to another buffer, independent of the 's' or
2680 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002681 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682
2683 *'fillchars'* *'fcs'*
2684'fillchars' 'fcs' string (default "vert:|,fold:-")
2685 global
2686 {not in Vi}
2687 {not available when compiled without the |+windows|
2688 and |+folding| features}
2689 Characters to fill the statuslines and vertical separators.
2690 It is a comma separated list of items:
2691
2692 item default Used for ~
2693 stl:c ' ' or '^' statusline of the current window
2694 stlnc:c ' ' or '-' statusline of the non-current windows
2695 vert:c '|' vertical separators |:vsplit|
2696 fold:c '-' filling 'foldtext'
2697 diff:c '-' deleted lines of the 'diff' option
2698
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002699 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 "stlnc" the space will be used when there is highlighting, '^' or '-'
2701 otherwise.
2702
2703 Example: >
2704 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2705< This is similar to the default, except that these characters will also
2706 be used when there is highlighting.
2707
2708 The highlighting used for these items:
2709 item highlight group ~
2710 stl:c StatusLine |hl-StatusLine|
2711 stlnc:c StatusLineNC |hl-StatusLineNC|
2712 vert:c VertSplit |hl-VertSplit|
2713 fold:c Folded |hl-Folded|
2714 diff:c DiffDelete |hl-DiffDelete|
2715
2716 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2717'fkmap' 'fk' boolean (default off) *E198*
2718 global
2719 {not in Vi}
2720 {only available when compiled with the |+rightleft|
2721 feature}
2722 When on, the keyboard is mapped for the Farsi character set.
2723 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002724 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725
2726 *'foldclose'* *'fcl'*
2727'foldclose' 'fcl' string (default "")
2728 global
2729 {not in Vi}
2730 {not available when compiled without the |+folding|
2731 feature}
2732 When set to "all", a fold is closed when the cursor isn't in it and
2733 its level is higher than 'foldlevel'. Useful if you want folds to
2734 automatically close when moving out of them.
2735
2736 *'foldcolumn'* *'fdc'*
2737'foldcolumn' 'fdc' number (default 0)
2738 local to window
2739 {not in Vi}
2740 {not available when compiled without the |+folding|
2741 feature}
2742 When non-zero, a column with the specified width is shown at the side
2743 of the window which indicates open and closed folds. The maximum
2744 value is 12.
2745 See |folding|.
2746
2747 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2748'foldenable' 'fen' boolean (default on)
2749 local to window
2750 {not in Vi}
2751 {not available when compiled without the |+folding|
2752 feature}
2753 When off, all folds are open. This option can be used to quickly
2754 switch between showing all text unfolded and viewing the text with
2755 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002756 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 'foldenable' is off.
2758 This option is set by commands that create a new fold or close a fold.
2759 See |folding|.
2760
2761 *'foldexpr'* *'fde'*
2762'foldexpr' 'fde' string (default: "0")
2763 local to window
2764 {not in Vi}
2765 {not available when compiled without the |+folding|
2766 or |+eval| feature}
2767 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002768 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002769
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002770 The expression may be evaluated in the |sandbox|, see
2771 |sandbox-option|.
2772
2773 It is not allowed to change text or jump to another window while
2774 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775
2776 *'foldignore'* *'fdi'*
2777'foldignore' 'fdi' string (default: "#")
2778 local to window
2779 {not in Vi}
2780 {not available when compiled without the |+folding|
2781 feature}
2782 Used only when 'foldmethod' is "indent". Lines starting with
2783 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002784 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 The default "#" works well for C programs. See |fold-indent|.
2786
2787 *'foldlevel'* *'fdl'*
2788'foldlevel' 'fdl' number (default: 0)
2789 local to window
2790 {not in Vi}
2791 {not available when compiled without the |+folding|
2792 feature}
2793 Sets the fold level: Folds with a higher level will be closed.
2794 Setting this option to zero will close all folds. Higher numbers will
2795 close fewer folds.
2796 This option is set by commands like |zm|, |zM| and |zR|.
2797 See |fold-foldlevel|.
2798
2799 *'foldlevelstart'* *'fdls'*
2800'foldlevelstart' 'fdls' number (default: -1)
2801 global
2802 {not in Vi}
2803 {not available when compiled without the |+folding|
2804 feature}
2805 Sets 'foldlevel' when starting to edit another buffer in a window.
2806 Useful to always start editing with all folds closed (value zero),
2807 some folds closed (one) or no folds closed (99).
2808 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002809 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 ignores this option and closes all folds.
2811 It is also done before BufReadPre autocommands, to allow an autocmd to
2812 overrule the 'foldlevel' value for specific files.
2813 When the value is negative, it is not used.
2814
2815 *'foldmarker'* *'fmr'* *E536*
2816'foldmarker' 'fmr' string (default: "{{{,}}}")
2817 local to window
2818 {not in Vi}
2819 {not available when compiled without the |+folding|
2820 feature}
2821 The start and end marker used when 'foldmethod' is "marker". There
2822 must be one comma, which separates the start and end marker. The
2823 marker is a literal string (a regular expression would be too slow).
2824 See |fold-marker|.
2825
2826 *'foldmethod'* *'fdm'*
2827'foldmethod' 'fdm' string (default: "manual")
2828 local to window
2829 {not in Vi}
2830 {not available when compiled without the |+folding|
2831 feature}
2832 The kind of folding used for the current window. Possible values:
2833 |fold-manual| manual Folds are created manually.
2834 |fold-indent| indent Lines with equal indent form a fold.
2835 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2836 |fold-marker| marker Markers are used to specify folds.
2837 |fold-syntax| syntax Syntax highlighting items specify folds.
2838 |fold-diff| diff Fold text that is not changed.
2839
2840 *'foldminlines'* *'fml'*
2841'foldminlines' 'fml' number (default: 1)
2842 local to window
2843 {not in Vi}
2844 {not available when compiled without the |+folding|
2845 feature}
2846 Sets the minimum number of screen lines for a fold to be displayed
2847 closed. Also for manually closed folds.
2848 Note that this only has an effect of what is displayed. After using
2849 "zc" to close a fold, which is displayed open because it's smaller
2850 than 'foldminlines', a following "zc" may close a containing fold.
2851
2852 *'foldnestmax'* *'fdn'*
2853'foldnestmax' 'fdn' number (default: 20)
2854 local to window
2855 {not in Vi}
2856 {not available when compiled without the |+folding|
2857 feature}
2858 Sets the maximum nesting of folds for the "indent" and "syntax"
2859 methods. This avoids that too many folds will be created. Using more
2860 than 20 doesn't work, because the internal limit is 20.
2861
2862 *'foldopen'* *'fdo'*
2863'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2864 search,tag,undo")
2865 global
2866 {not in Vi}
2867 {not available when compiled without the |+folding|
2868 feature}
2869 Specifies for which type of commands folds will be opened, if the
2870 command moves the cursor into a closed fold. It is a comma separated
2871 list of items.
2872 item commands ~
2873 all any
2874 block "(", "{", "[[", "[{", etc.
2875 hor horizontal movements: "l", "w", "fx", etc.
2876 insert any command in Insert mode
2877 jump far jumps: "G", "gg", etc.
2878 mark jumping to a mark: "'m", CTRL-O, etc.
2879 percent "%"
2880 quickfix ":cn", ":crew", ":make", etc.
2881 search search for a pattern: "/", "n", "*", "gd", etc.
2882 (not for a search pattern in a ":" command)
2883 tag jumping to a tag: ":ta", CTRL-T, etc.
2884 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002885 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 the |zv| command to the mapping to get the same effect.
2887 When a movement command is used for an operator (e.g., "dl" or "y%")
2888 this option is not used. This means the operator will include the
2889 whole closed fold.
2890 Note that vertical movements are not here, because it would make it
2891 very difficult to move onto a closed fold.
2892 In insert mode the folds containing the cursor will always be open
2893 when text is inserted.
2894 To close folds you can re-apply 'foldlevel' with the |zx| command or
2895 set the 'foldclose' option to "all".
2896
2897 *'foldtext'* *'fdt'*
2898'foldtext' 'fdt' string (default: "foldtext()")
2899 local to window
2900 {not in Vi}
2901 {not available when compiled without the |+folding|
2902 feature}
2903 An expression which is used to specify the text displayed for a closed
2904 fold. See |fold-foldtext|.
2905
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002906 The expression may be evaluated in the |sandbox|, see
2907 |sandbox-option|.
2908
2909 It is not allowed to change text or jump to another window while
2910 evaluating 'foldtext' |textlock|.
2911
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 *'formatoptions'* *'fo'*
2913'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2914 local to buffer
2915 {not in Vi}
2916 This is a sequence of letters which describes how automatic
2917 formatting is to be done. See |fo-table|. When the 'paste' option is
2918 on, no formatting is done (like 'formatoptions' is empty). Commas can
2919 be inserted for readability.
2920 To avoid problems with flags that are added in the future, use the
2921 "+=" and "-=" feature of ":set" |add-option-flags|.
2922 NOTE: This option is set to the Vi default value when 'compatible' is
2923 set and to the Vim default value when 'compatible' is reset.
2924
Bram Moolenaar86b68352004-12-27 21:59:20 +00002925 *'formatlistpat'* *'flp'*
2926'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2927 local to buffer
2928 {not in Vi}
2929 A pattern that is used to recognize a list header. This is used for
2930 the "n" flag in 'formatoptions'.
2931 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002932 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002933 while still checking more characters. There must be a character
2934 following the pattern, when it matches the whole line it is handled
2935 like there is no match.
2936 The default recognizes a number, followed by an optional punctuation
2937 character and white space.
2938
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 *'formatprg'* *'fp'*
2940'formatprg' 'fp' string (default "")
2941 global
2942 {not in Vi}
2943 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002944 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002946 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002947 If the 'formatexpr' option is not empty it will be used instead.
2948 Otherwise, if 'formatprg' option is an empty string, the internal
2949 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002950 Environment variables are expanded |:set_env|. See |option-backslash|
2951 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002952 The expression may be evaluated in the |sandbox|, see
2953 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002955 *'formatexpr'* *'fex'*
2956'formatexpr' 'fex' string (default "")
2957 local to buffer
2958 {not in Vi}
2959 {not available when compiled without the |+eval|
2960 feature}
2961 Expression which is evaluated to format a range of lines for the |gq|
2962 operator. The |v:lnum| variable holds the first line to be formatted,
2963 |v:count| the number of lines to be formatted.
2964 When this option is empty 'formatprg' is used.
2965 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002966 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002967< This will invoke the mylang#Format() function in the
2968 autoload/mylang.vim file in 'runtimepath'. |autoload|
2969
2970 The expression is also evaluated when 'textwidth' is set and adding
2971 text beyond that limit. This happens under the same conditions as
2972 when internal formatting is used. Make sure the cursor is kept in the
2973 same spot relative to the text then! The |mode()| function will
2974 return "i" or "R" in this situation. When the function returns
2975 non-zero Vim will fall back to using the internal format mechanism.
2976
2977 The expression may be evaluated in the |sandbox|, see
2978 |sandbox-option|.
2979
2980 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002981'fsync' 'fs' boolean (default on)
2982 global
2983 {not in Vi}
2984 When on, the library function fsync() will be called after writing a
2985 file. This will flush a file to disk, ensuring that it is safely
2986 written even on filesystems which do metadata-only journaling. This
2987 will force the harddrive to spin up on Linux systems running in laptop
2988 mode, so it may be undesirable in some situations. Be warned that
2989 turning this off increases the chances of data loss after a crash. On
2990 systems without an fsync() implementation, this variable is always
2991 off.
2992 Also see 'swapsync' for controlling fsync() on swap files.
2993
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2995'gdefault' 'gd' boolean (default off)
2996 global
2997 {not in Vi}
2998 When on, the ":substitute" flag 'g' is default on. This means that
2999 all matches in a line are substituted instead of one. When a 'g' flag
3000 is given to a ":substitute" command, this will toggle the substitution
3001 of all or one match. See |complex-change|.
3002
3003 command 'gdefault' on 'gdefault' off ~
3004 :s/// subst. all subst. one
3005 :s///g subst. one subst. all
3006 :s///gg subst. all subst. one
3007
3008 NOTE: This option is reset when 'compatible' is set.
3009
3010 *'grepformat'* *'gfm'*
3011'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3012 global
3013 {not in Vi}
3014 Format to recognize for the ":grep" command output.
3015 This is a scanf-like string that uses the same format as the
3016 'errorformat' option: see |errorformat|.
3017
3018 *'grepprg'* *'gp'*
3019'grepprg' 'gp' string (default "grep -n ",
3020 Unix: "grep -n $* /dev/null",
3021 Win32: "findstr /n" or "grep -n",
3022 VMS: "SEARCH/NUMBERS ")
3023 global or local to buffer |global-local|
3024 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003025 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 and '#' characters, which are expanded like when used in a command-
3027 line. The placeholder "$*" is allowed to specify where the arguments
3028 will be included. Environment variables are expanded |:set_env|. See
3029 |option-backslash| about including spaces and backslashes.
3030 When your "grep" accepts the "-H" argument, use this to make ":grep"
3031 also work well with a single file: >
3032 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003033< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003034 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3035 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003036 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 apply equally to 'grepprg'.
3038 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3039 otherwise it's "grep -n".
3040 This option cannot be set from a |modeline| or in the |sandbox|, for
3041 security reasons.
3042
3043 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3044'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3045 ve:ver35-Cursor,
3046 o:hor50-Cursor,
3047 i-ci:ver25-Cursor/lCursor,
3048 r-cr:hor20-Cursor/lCursor,
3049 sm:block-Cursor
3050 -blinkwait175-blinkoff150-blinkon175",
3051 for MS-DOS and Win32 console:
3052 "n-v-c:block,o:hor50,i-ci:hor15,
3053 r-cr:hor30,sm:block")
3054 global
3055 {not in Vi}
3056 {only available when compiled with GUI enabled, and
3057 for MS-DOS and Win32 console}
3058 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003059 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 the height of the cursor can be changed. This can be done by
3061 specifying a block cursor, or a percentage for a vertical or
3062 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003063 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003065 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 mode-list and an argument-list:
3067 mode-list:argument-list,mode-list:argument-list,..
3068 The mode-list is a dash separated list of these modes:
3069 n Normal mode
3070 v Visual mode
3071 ve Visual mode with 'selection' "exclusive" (same as 'v',
3072 if not specified)
3073 o Operator-pending mode
3074 i Insert mode
3075 r Replace mode
3076 c Command-line Normal (append) mode
3077 ci Command-line Insert mode
3078 cr Command-line Replace mode
3079 sm showmatch in Insert mode
3080 a all modes
3081 The argument-list is a dash separated list of these arguments:
3082 hor{N} horizontal bar, {N} percent of the character height
3083 ver{N} vertical bar, {N} percent of the character width
3084 block block cursor, fills the whole character
3085 [only one of the above three should be present]
3086 blinkwait{N} *cursor-blinking*
3087 blinkon{N}
3088 blinkoff{N}
3089 blink times for cursor: blinkwait is the delay before
3090 the cursor starts blinking, blinkon is the time that
3091 the cursor is shown and blinkoff is the time that the
3092 cursor is not shown. The times are in msec. When one
3093 of the numbers is zero, there is no blinking. The
3094 default is: "blinkwait700-blinkon400-blinkoff250".
3095 These numbers are used for a missing entry. This
3096 means that blinking is enabled by default. To switch
3097 blinking off you can use "blinkon0". The cursor only
3098 blinks when Vim is waiting for input, not while
3099 executing a command.
3100 To make the cursor blink in an xterm, see
3101 |xterm-blink|.
3102 {group-name}
3103 a highlight group name, that sets the color and font
3104 for the cursor
3105 {group-name}/{group-name}
3106 Two highlight group names, the first is used when
3107 no language mappings are used, the other when they
3108 are. |language-mapping|
3109
3110 Examples of parts:
3111 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3112 block cursor with colors from the "nCursor"
3113 highlight group
3114 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3115 In Insert and Command-line Insert mode, use a
3116 30% vertical bar cursor with colors from the
3117 "iCursor" highlight group. Blink a bit
3118 faster.
3119
3120 The 'a' mode is different. It will set the given argument-list for
3121 all modes. It does not reset anything to defaults. This can be used
3122 to do a common setting for all modes. For example, to switch off
3123 blinking: "a:blinkon0"
3124
3125 Examples of cursor highlighting: >
3126 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3127 :highlight Cursor gui=NONE guifg=bg guibg=fg
3128<
3129 *'guifont'* *'gfn'*
3130 *E235* *E596* *E610* *E611*
3131'guifont' 'gfn' string (default "")
3132 global
3133 {not in Vi}
3134 {only available when compiled with GUI enabled}
3135 This is a list of fonts which will be used for the GUI version of Vim.
3136 In its simplest form the value is just one font name. When
3137 the font cannot be found you will get an error message. To try other
3138 font names a list can be specified, font names separated with commas.
3139 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003140
Bram Moolenaar05159a02005-02-26 23:04:13 +00003141 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3142 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003143
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 Spaces after a comma are ignored. To include a comma in a font name
3145 precede it with a backslash. Setting an option requires an extra
3146 backslash before a space and a backslash. See also
3147 |option-backslash|. For example: >
3148 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003149< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003151
3152 If none of the fonts can be loaded, Vim will keep the current setting.
3153 If an empty font list is given, Vim will try using other resource
3154 settings (for X, it will use the Vim.font resource), and finally it
3155 will try some builtin default which should always be there ("7x13" in
3156 the case of X). The font names given should be "normal" fonts. Vim
3157 will try to find the related bold and italic fonts.
3158
Bram Moolenaar05159a02005-02-26 23:04:13 +00003159 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003160 :set guifont=*
3161< will bring up a font requester, where you can pick the font you want.
3162
3163 The font name depends on the GUI used. See |setting-guifont| for a
3164 way to set 'guifont' for various systems.
3165
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 For the GTK+ 2 GUI the font name looks like this: >
3167 :set guifont=Andale\ Mono\ 11
3168< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003169
3170 For Mac OSX you can use something like this: >
3171 :set guifont=Monaco:h10
3172< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003174 width). An exception is GTK 2: all fonts are accepted, but
3175 mono-spaced fonts look best.
3176
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 To preview a font on X11, you might be able to use the "xfontsel"
3178 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003179
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 For the Win32 GUI *E244* *E245*
3181 - takes these options in the font name:
3182 hXX - height is XX (points, can be floating-point)
3183 wXX - width is XX (points, can be floating-point)
3184 b - bold
3185 i - italic
3186 u - underline
3187 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003188 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3190 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3191 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003192 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193
3194 Use a ':' to separate the options.
3195 - A '_' can be used in the place of a space, so you don't need to use
3196 backslashes to escape the spaces.
3197 - Examples: >
3198 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3199 :set guifont=Andale_Mono:h7.5:w4.5
3200< See also |font-sizes|.
3201
3202 *'guifontset'* *'gfs'*
3203 *E250* *E252* *E234* *E597* *E598*
3204'guifontset' 'gfs' string (default "")
3205 global
3206 {not in Vi}
3207 {only available when compiled with GUI enabled and
3208 with the |+xfontset| feature}
3209 {not available in the GTK+ 2 GUI}
3210 When not empty, specifies two (or more) fonts to be used. The first
3211 one for normal English, the second one for your special language. See
3212 |xfontset|.
3213 Setting this option also means that all font names will be handled as
3214 a fontset name. Also the ones used for the "font" argument of the
3215 |:highlight| command.
3216 The fonts must match with the current locale. If fonts for the
3217 character sets that the current locale uses are not included, setting
3218 'guifontset' will fail.
3219 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3220 the comma-separated names are alternative names, one of which will be
3221 used. In 'guifontset' the whole string is one fontset name,
3222 including the commas. It is not possible to specify alternative
3223 fontset names.
3224 This example works on many X11 systems: >
3225 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3226<
3227 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3228'guifontwide' 'gfw' string (default "")
3229 global
3230 {not in Vi}
3231 {only available when compiled with GUI enabled}
3232 When not empty, specifies a comma-separated list of fonts to be used
3233 for double-width characters. The first font that can be loaded is
3234 used.
3235 Note: The size of these fonts must be exactly twice as wide as the one
3236 specified with 'guifont' and the same height.
3237
3238 All GUI versions but GTK+ 2:
3239
3240 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3241 'guifontset' is empty or invalid.
3242 When 'guifont' is set and a valid font is found in it and
3243 'guifontwide' is empty Vim will attempt to find a matching
3244 double-width font and set 'guifontwide' to it.
3245
3246 GTK+ 2 GUI only: *guifontwide_gtk2*
3247
3248 If set and valid, 'guifontwide' is always used for double width
3249 characters, even if 'encoding' is not set to "utf-8".
3250 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003251 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 font for characters not available in 'guifont'. Thus you do not need
3253 to set 'guifontwide' at all unless you want to override the choice
3254 made by Pango/Xft.
3255
3256 *'guiheadroom'* *'ghr'*
3257'guiheadroom' 'ghr' number (default 50)
3258 global
3259 {not in Vi} {only for GTK and X11 GUI}
3260 The number of pixels subtracted from the screen height when fitting
3261 the GUI window on the screen. Set this before the GUI is started,
3262 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003263 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 lines will be left for window decorations and other items on the
3265 screen. Set it to a negative value to allow windows taller than the
3266 screen.
3267
3268 *'guioptions'* *'go'*
3269'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003270 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 global
3272 {not in Vi}
3273 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003274 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 sequence of letters which describes what components and options of the
3276 GUI should be used.
3277 To avoid problems with flags that are added in the future, use the
3278 "+=" and "-=" feature of ":set" |add-option-flags|.
3279
3280 Valid letters are as follows:
3281 *guioptions_a*
3282 'a' Autoselect: If present, then whenever VISUAL mode is started,
3283 or the Visual area extended, Vim tries to become the owner of
3284 the windowing system's global selection. This means that the
3285 Visually highlighted text is available for pasting into other
3286 applications as well as into Vim itself. When the Visual mode
3287 ends, possibly due to an operation on the text, or when an
3288 application wants to paste the selection, the highlighted text
3289 is automatically yanked into the "* selection register.
3290 Thus the selection is still available for pasting into other
3291 applications after the VISUAL mode has ended.
3292 If not present, then Vim won't become the owner of the
3293 windowing system's global selection unless explicitly told to
3294 by a yank or delete operation for the "* register.
3295 The same applies to the modeless selection.
3296
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003297 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 applies to the modeless selection.
3299
3300 'guioptions' autoselect Visual autoselect modeless ~
3301 "" - -
3302 "a" yes yes
3303 "A" - yes
3304 "aA" yes yes
3305
3306 'c' Use console dialogs instead of popup dialogs for simple
3307 choices.
3308
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003309 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003310 'guitablabel' can be used to change the text in the labels.
3311 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003312 The GUI tabs are only supported on some systens, currently
3313 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003314
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 'f' Foreground: Don't use fork() to detach the GUI from the shell
3316 where it was started. Use this for programs that wait for the
3317 editor to finish (e.g., an e-mail program). Alternatively you
3318 can use "gvim -f" or ":gui -f" to start the GUI in the
3319 foreground. |gui-fork|
3320 Note: Set this option in the vimrc file. The forking may have
3321 happened already when the gvimrc file is read.
3322
3323 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3324 corner of the window. It's black&white on non-GTK, because of
3325 limitations of X11. For a color icon, see |X11-icon|.
3326
3327 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003328 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 that this flag must be added in the .vimrc file, before
3330 switching on syntax or filetype recognition (when the .gvimrc
3331 file is sourced the system menu has already been loaded; the
3332 ":syntax on" and ":filetype on" commands load the menu too).
3333 'g' Grey menu items: Make menu items that are not active grey. If
3334 'g' is not included inactive menu items are not shown at all.
3335 Exception: Athena will always use grey menu items.
3336
3337 't' Include tearoff menu items. Currently only works for Win32,
3338 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003339 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3340 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341
3342 'r' Right-hand scrollbar is always present.
3343 'R' Right-hand scrollbar is present when there is a vertically
3344 split window.
3345 'l' Left-hand scrollbar is always present.
3346 'L' Left-hand scrollbar is present when there is a vertically
3347 split window.
3348 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3349 the longest visible line, or on the cursor line if the 'h'
3350 flag is included. |gui-horiz-scroll|
3351 'h' Limit horizontal scrollbar size to the length of the cursor
3352 line. Reduces computations. |gui-horiz-scroll|
3353
3354 And yes, you may even have scrollbars on the left AND the right if
3355 you really want to :-). See |gui-scrollbars| for more information.
3356
3357 'v' Use a vertical button layout for dialogs. When not included,
3358 a horizontal layout is preferred, but when it doesn't fit a
3359 vertical layout is used anyway.
3360 'p' Use Pointer callbacks for X11 GUI. This is required for some
3361 window managers. If the cursor is not blinking or hollow at
3362 the right moment, try adding this flag. This must be done
3363 before starting the GUI. Set it in your gvimrc. Adding or
3364 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003365 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366
3367 *'guipty'* *'noguipty'*
3368'guipty' boolean (default on)
3369 global
3370 {not in Vi}
3371 {only available when compiled with GUI enabled}
3372 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3373 I/O to/from shell commands. See |gui-pty|.
3374
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003375 *'guitablabel'* *'gtl'*
3376'guitablabel' 'gtl' string (default empty)
3377 global
3378 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003379 {only available when compiled with GUI enabled and
3380 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003381 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003382 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003383 |setting-guitablabel| for more info.
3384
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003385 The format of this option is like that of 'statusline'.
3386
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003387 Only used when the GUI tab pages line is displayed. 'e' must be
3388 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3389 used.
3390
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 *'helpfile'* *'hf'*
3392'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3393 (others) "$VIMRUNTIME/doc/help.txt")
3394 global
3395 {not in Vi}
3396 Name of the main help file. All distributed help files should be
3397 placed together in one directory. Additionally, all "doc" directories
3398 in 'runtimepath' will be used.
3399 Environment variables are expanded |:set_env|. For example:
3400 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003401 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 spaces and backslashes.
3403 This option cannot be set from a |modeline| or in the |sandbox|, for
3404 security reasons.
3405
3406 *'helpheight'* *'hh'*
3407'helpheight' 'hh' number (default 20)
3408 global
3409 {not in Vi}
3410 {not available when compiled without the +windows
3411 feature}
3412 Minimal initial height of the help window when it is opened with the
3413 ":help" command. The initial height of the help window is half of the
3414 current window, or (when the 'ea' option is on) the same as other
3415 windows. When the height is less than 'helpheight', the height is
3416 set to 'helpheight'. Set to zero to disable.
3417
3418 *'helplang'* *'hlg'*
3419'helplang' 'hlg' string (default: messages language or empty)
3420 global
3421 {only available when compiled with the |+multi_lang|
3422 feature}
3423 {not in Vi}
3424 Comma separated list of languages. Vim will use the first language
3425 for which the desired help can be found. The English help will always
3426 be used as a last resort. You can add "en" to prefer English over
3427 another language, but that will only find tags that exist in that
3428 language and not in the English help.
3429 Example: >
3430 :set helplang=de,it
3431< This will first search German, then Italian and finally English help
3432 files.
3433 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3434 try to find the tag in the current language before using this option.
3435 See |help-translated|.
3436
3437 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3438'hidden' 'hid' boolean (default off)
3439 global
3440 {not in Vi}
3441 When off a buffer is unloaded when it is |abandon|ed. When on a
3442 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3443 displayed in another window, it does not become hidden, of course.
3444 The commands that move through the buffer list sometimes make a buffer
3445 hidden although the 'hidden' option is off: When the buffer is
3446 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003447 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003448 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 This option is set for one command with ":hide {command}" |:hide|.
3450 WARNING: It's easy to forget that you have changes in hidden buffers.
3451 Think twice when using ":q!" or ":qa!".
3452
3453 *'highlight'* *'hl'*
3454'highlight' 'hl' string (default (as a single string):
3455 "8:SpecialKey,@:NonText,d:Directory,
3456 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3457 M:ModeMsg,n:LineNr,r:Question,
3458 s:StatusLine,S:StatusLineNC,c:VertSplit
3459 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3460 f:Folded,F:FoldColumn,A:DiffAdd,
3461 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003462 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003463 R:SpellRare,L:SpellLocal,
3464 +:Pmenu,=:PmenuSel,
3465 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 global
3467 {not in Vi}
3468 This option can be used to set highlighting mode for various
3469 occasions. It is a comma separated list of character pairs. The
3470 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003471 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3473 |hl-NonText| @ '~' and '@' at the end of the window and
3474 characters from 'showbreak'
3475 |hl-Directory| d directories in CTRL-D listing and other special
3476 things in listings
3477 |hl-ErrorMsg| e error messages
3478 h (obsolete, ignored)
3479 |hl-IncSearch| i 'incsearch' highlighting
3480 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3481 |hl-MoreMsg| m |more-prompt|
3482 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3483 |hl-LineNr| n line number for ":number" and ":#" commands
3484 |hl-Question| r |hit-enter| prompt and yes/no questions
3485 |hl-StatusLine| s status line of current window |status-line|
3486 |hl-StatusLineNC| S status lines of not-current windows
3487 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3488 |hl-VertSplit| c column used to separate vertically split windows
3489 |hl-Visual| v Visual mode
3490 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3491 Selection" Only X11 Gui's |gui-x11| and
3492 |xterm-clipboard|.
3493 |hl-WarningMsg| w warning messages
3494 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3495 |hl-Folded| f line used for closed folds
3496 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003497 |hl-DiffAdd| A added line in diff mode
3498 |hl-DiffChange| C changed line in diff mode
3499 |hl-DiffDelete| D deleted line in diff mode
3500 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003502 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003503 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003504 |hl-SpellRare| R rare word |spell|
3505 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003506 |hl-Pmenu| + popup menu normal line
3507 |hl-PmenuSel| = popup menu normal line
3508 |hl-PmenuSbar| x popup menu scrollbar
3509 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510
3511 The display modes are:
3512 r reverse (termcap entry "mr" and "me")
3513 i italic (termcap entry "ZH" and "ZR")
3514 b bold (termcap entry "md" and "me")
3515 s standout (termcap entry "so" and "se")
3516 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003517 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 n no highlighting
3519 - no highlighting
3520 : use a highlight group
3521 The default is used for occasions that are not included.
3522 If you want to change what the display modes do, see |dos-colors|
3523 for an example.
3524 When using the ':' display mode, this must be followed by the name of
3525 a highlight group. A highlight group can be used to define any type
3526 of highlighting, including using color. See |:highlight| on how to
3527 define one. The default uses a different group for each occasion.
3528 See |highlight-default| for the default highlight groups.
3529
3530 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3531'hlsearch' 'hls' boolean (default off)
3532 global
3533 {not in Vi}
3534 {not available when compiled without the
3535 |+extra_search| feature}
3536 When there is a previous search pattern, highlight all its matches.
3537 The type of highlighting used can be set with the 'l' occasion in the
3538 'highlight' option. This uses the "Search" highlight group by
3539 default. Note that only the matching text is highlighted, any offsets
3540 are not applied.
3541 See also: 'incsearch' and |:match|.
3542 When you get bored looking at the highlighted matches, you can turn it
3543 off with |:nohlsearch|. As soon as you use a search command, the
3544 highlighting comes back.
3545 When the search pattern can match an end-of-line, Vim will try to
3546 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003547 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 line below a closed fold. A match in a previous line which is not
3549 drawn may not continue in an newly drawn line.
3550 NOTE: This option is reset when 'compatible' is set.
3551
3552 *'history'* *'hi'*
3553'history' 'hi' number (Vim default: 20, Vi default: 0)
3554 global
3555 {not in Vi}
3556 A history of ":" commands, and a history of previous search patterns
3557 are remembered. This option decides how many entries may be stored in
3558 each of these histories (see |cmdline-editing|).
3559 NOTE: This option is set to the Vi default value when 'compatible' is
3560 set and to the Vim default value when 'compatible' is reset.
3561
3562 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3563'hkmap' 'hk' boolean (default off)
3564 global
3565 {not in Vi}
3566 {only available when compiled with the |+rightleft|
3567 feature}
3568 When on, the keyboard is mapped for the Hebrew character set.
3569 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3570 toggle this option. See |rileft.txt|.
3571 NOTE: This option is reset when 'compatible' is set.
3572
3573 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3574'hkmapp' 'hkp' boolean (default off)
3575 global
3576 {not in Vi}
3577 {only available when compiled with the |+rightleft|
3578 feature}
3579 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3580 This is useful if you have a non-Hebrew keyboard.
3581 See |rileft.txt|.
3582 NOTE: This option is reset when 'compatible' is set.
3583
3584 *'icon'* *'noicon'*
3585'icon' boolean (default off, on when title can be restored)
3586 global
3587 {not in Vi}
3588 {not available when compiled without the |+title|
3589 feature}
3590 When on, the icon text of the window will be set to the value of
3591 'iconstring' (if it is not empty), or to the name of the file
3592 currently being edited. Only the last part of the name is used.
3593 Overridden by the 'iconstring' option.
3594 Only works if the terminal supports setting window icons (currently
3595 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3596 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3597 builtin termcap).
3598 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003599 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 X11.
3601
3602 *'iconstring'*
3603'iconstring' string (default "")
3604 global
3605 {not in Vi}
3606 {not available when compiled without the |+title|
3607 feature}
3608 When this option is not empty, it will be used for the icon text of
3609 the window. This happens only when the 'icon' option is on.
3610 Only works if the terminal supports setting window icon text
3611 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3612 Does not work for MS Windows.
3613 When Vim was compiled with HAVE_X11 defined, the original icon will be
3614 restored if possible |X11|.
3615 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003616 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 'titlestring' for example settings.
3618 {not available when compiled without the |+statusline| feature}
3619
3620 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3621'ignorecase' 'ic' boolean (default off)
3622 global
3623 Ignore case in search patterns. Also used when searching in the tags
3624 file.
3625 Also see 'smartcase'.
3626 Can be overruled by using "\c" or "\C" in the pattern, see
3627 |/ignorecase|.
3628
3629 *'imactivatekey'* *'imak'*
3630'imactivatekey' 'imak' string (default "")
3631 global
3632 {not in Vi}
3633 {only available when compiled with |+xim| and
3634 |+GUI_GTK|}
3635 Specifies the key that your Input Method in X-Windows uses for
3636 activation. When this is specified correctly, vim can fully control
3637 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3638 You can't use this option to change the activation key, the option
3639 tells Vim what the key is.
3640 Format:
3641 [MODIFIER_FLAG-]KEY_STRING
3642
3643 These characters can be used for MODIFIER_FLAG (case is ignored):
3644 S Shift key
3645 L Lock key
3646 C Control key
3647 1 Mod1 key
3648 2 Mod2 key
3649 3 Mod3 key
3650 4 Mod4 key
3651 5 Mod5 key
3652 Combinations are allowed, for example "S-C-space" or "SC-space" are
3653 both shift+ctrl+space.
3654 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3655
3656 Example: >
3657 :set imactivatekey=S-space
3658< "S-space" means shift+space. This is the activation key for kinput2 +
3659 canna (Japanese), and ami (Korean).
3660
3661 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3662'imcmdline' 'imc' boolean (default off)
3663 global
3664 {not in Vi}
3665 {only available when compiled with the |+xim|
3666 |+multi_byte_ime| or |global-ime| feature}
3667 When set the Input Method is always on when starting to edit a command
3668 line, unless entering a search pattern (see 'imsearch' for that).
3669 Setting this option is useful when your input method allows entering
3670 English characters directly, e.g., when it's used to type accented
3671 characters with dead keys.
3672
3673 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3674'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3675 global
3676 {not in Vi}
3677 {only available when compiled with the |+xim|
3678 |+multi_byte_ime| or |global-ime| feature}
3679 When set the Input Method is never used. This is useful to disable
3680 the IM when it doesn't work properly.
3681 Currently this option is on by default for SGI/IRIX machines. This
3682 may change in later releases.
3683
3684 *'iminsert'* *'imi'*
3685'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3686 local to buffer
3687 {not in Vi}
3688 Specifies whether :lmap or an Input Method (IM) is to be used in
3689 Insert mode. Valid values:
3690 0 :lmap is off and IM is off
3691 1 :lmap is ON and IM is off
3692 2 :lmap is off and IM is ON
3693 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3694 or |global-ime|.
3695 To always reset the option to zero when leaving Insert mode with <Esc>
3696 this can be used: >
3697 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3698< This makes :lmap and IM turn off automatically when leaving Insert
3699 mode.
3700 Note that this option changes when using CTRL-^ in Insert mode
3701 |i_CTRL-^|.
3702 The value is set to 1 when setting 'keymap' to a valid keymap name.
3703 It is also used for the argument of commands like "r" and "f".
3704 The value 0 may not work correctly with Athena and Motif with some XIM
3705 methods. Use 'imdisable' to disable XIM then.
3706
3707 *'imsearch'* *'ims'*
3708'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3709 local to buffer
3710 {not in Vi}
3711 Specifies whether :lmap or an Input Method (IM) is to be used when
3712 entering a search pattern. Valid values:
3713 -1 the value of 'iminsert' is used, makes it look like
3714 'iminsert' is also used when typing a search pattern
3715 0 :lmap is off and IM is off
3716 1 :lmap is ON and IM is off
3717 2 :lmap is off and IM is ON
3718 Note that this option changes when using CTRL-^ in Command-line mode
3719 |c_CTRL-^|.
3720 The value is set to 1 when it is not -1 and setting the 'keymap'
3721 option to a valid keymap name.
3722 The value 0 may not work correctly with Athena and Motif with some XIM
3723 methods. Use 'imdisable' to disable XIM then.
3724
3725 *'include'* *'inc'*
3726'include' 'inc' string (default "^\s*#\s*include")
3727 global or local to buffer |global-local|
3728 {not in Vi}
3729 {not available when compiled without the
3730 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003731 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 pattern, just like for the "/" command (See |pattern|). The default
3733 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003734 "]I", "[d", etc.
3735 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003736 comes after the matched pattern. But if "\zs" appears in the pattern
3737 then the text matched from "\zs" to the end, or until "\ze" if it
3738 appears, is used as the file name. Use this to include characters
3739 that are not in 'isfname', such as a space. You can then use
3740 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003741 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742
3743 *'includeexpr'* *'inex'*
3744'includeexpr' 'inex' string (default "")
3745 local to buffer
3746 {not in Vi}
3747 {not available when compiled without the
3748 |+find_in_path| or |+eval| feature}
3749 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003750 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 :set includeexpr=substitute(v:fname,'\\.','/','g')
3752< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003753
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003755 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 Also used for |<cfile>|.
3757
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003758 The expression may be evaluated in the |sandbox|, see
3759 |sandbox-option|.
3760
3761 It is not allowed to change text or jump to another window while
3762 evaluating 'includeexpr' |textlock|.
3763
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3765'incsearch' 'is' boolean (default off)
3766 global
3767 {not in Vi}
3768 {not available when compiled without the
3769 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003770 While typing a search command, show where the pattern, as it was typed
3771 so far, matches. The matched string is highlighted. If the pattern
3772 is invalid or not found, nothing is shown. The screen will be updated
3773 often, this is only useful on fast terminals.
3774 Note that the match will be shown, but the cursor will return to its
3775 original position when no match is found and when pressing <Esc>. You
3776 still need to finish the search command with <Enter> to move the
3777 cursor to the match.
3778 The highlighting can be set with the 'i' flag in 'highlight'.
3779 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003780 CTRL-L can be used to add one character from after the current match
3781 to the command line.
3782 CTRL-R CTRL-W can be used to add the word at the end of the current
3783 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 NOTE: This option is reset when 'compatible' is set.
3785
3786 *'indentexpr'* *'inde'*
3787'indentexpr' 'inde' string (default "")
3788 local to buffer
3789 {not in Vi}
3790 {not available when compiled without the |+cindent|
3791 or |+eval| features}
3792 Expression which is evaluated to obtain the proper indent for a line.
3793 It is used when a new line is created, for the |=| operator and
3794 in Insert mode as specified with the 'indentkeys' option.
3795 When this option is not empty, it overrules the 'cindent' and
3796 'smartindent' indenting.
3797 When 'paste' is set this option is not used for indenting.
3798 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003799 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 when the expression is evaluated (but it may be moved around).
3801 The expression must return the number of spaces worth of indent. It
3802 can return "-1" to keep the current indent (this means 'autoindent' is
3803 used for the indent).
3804 Functions useful for computing the indent are |indent()|, |cindent()|
3805 and |lispindent()|.
3806 The evaluation of the expression must not have side effects! It must
3807 not change the text, jump to another window, etc. Afterwards the
3808 cursor position is always restored, thus the cursor may be moved.
3809 Normally this option would be set to call a function: >
3810 :set indentexpr=GetMyIndent()
3811< Error messages will be suppressed, unless the 'debug' option contains
3812 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003813 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 NOTE: This option is made empty when 'compatible' is set.
3815
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003816 The expression may be evaluated in the |sandbox|, see
3817 |sandbox-option|.
3818
3819 It is not allowed to change text or jump to another window while
3820 evaluating 'indentexpr' |textlock|.
3821
3822
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 *'indentkeys'* *'indk'*
3824'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3825 local to buffer
3826 {not in Vi}
3827 {not available when compiled without the |+cindent|
3828 feature}
3829 A list of keys that, when typed in Insert mode, cause reindenting of
3830 the current line. Only happens if 'indentexpr' isn't empty.
3831 The format is identical to 'cinkeys', see |indentkeys-format|.
3832 See |C-indenting| and |indent-expression|.
3833
3834 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3835'infercase' 'inf' boolean (default off)
3836 local to buffer
3837 {not in Vi}
3838 When doing keyword completion in insert mode |ins-completion|, and
3839 'ignorecase' is also on, the case of the match is adjusted. If the
3840 typed text contains a lowercase letter where the match has an upper
3841 case letter, the completed part is made lowercase. If the typed text
3842 has no lowercase letters and the match has a lowercase letter where
3843 the typed text has an uppercase letter, and there is a letter before
3844 it, the completed part is made uppercase.
3845
3846 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3847'insertmode' 'im' boolean (default off)
3848 global
3849 {not in Vi}
3850 Makes Vim work in a way that Insert mode is the default mode. Useful
3851 if you want to use Vim as a modeless editor. Used for |evim|.
3852 These Insert mode commands will be useful:
3853 - Use the cursor keys to move around.
3854 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3855 this is a mapping, it is executed as if 'insertmode' was off.
3856 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003858 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3859 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860
3861 These items change when 'insertmode' is set:
3862 - when starting to edit of a file, Vim goes to Insert mode.
3863 - <Esc> in Insert mode is a no-op and beeps.
3864 - <Esc> in Normal mode makes Vim go to Insert mode.
3865 - CTRL-L in Insert mode is a command, it is not inserted.
3866 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3867 However, when <Esc> is used inside a mapping, it behaves like
3868 'insertmode' was not set. This was done to be able to use the same
3869 mappings with 'insertmode' set or not set.
3870 When executing commands with |:normal| 'insertmode' is not used.
3871
3872 NOTE: This option is reset when 'compatible' is set.
3873
3874 *'isfname'* *'isf'*
3875'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3876 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3877 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3878 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3879 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3880 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3881 global
3882 {not in Vi}
3883 The characters specified by this option are included in file names and
3884 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003885 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 Multi-byte characters 256 and above are always included, only the
3887 characters up to 255 are specified with this option.
3888 For UTF-8 the characters 0xa0 to 0xff are included as well.
3889
3890 Note that on systems using a backslash as path separator, Vim tries to
3891 do its best to make it work as you would expect. That is a bit
3892 tricky, since Vi originally used the backslash to escape special
3893 characters. Vim will not remove a backslash in front of a normal file
3894 name character on these systems, but it will on Unix and alikes. The
3895 '&' and '^' are not included by default, because these are special for
3896 cmd.exe.
3897
3898 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003899 Each part can be a single character number or a range. A range is two
3900 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 decimal number between 0 and 255 or the ASCII character itself (does
3902 not work for digits). Example:
3903 "_,-,128-140,#-43" (include '_' and '-' and the range
3904 128 to 140 and '#' to 43)
3905 If a part starts with '^', the following character number or range
3906 will be excluded from the option. The option is interpreted from left
3907 to right. Put the excluded character after the range where it is
3908 included. To include '^' itself use it as the last character of the
3909 option or the end of a range. Example:
3910 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3911 If the character is '@', all characters where isalpha() returns TRUE
3912 are included. Normally these are the characters a to z and A to Z,
3913 plus accented characters. To include '@' itself use "@-@". Examples:
3914 "@,^a-z" All alphabetic characters, excluding lower
3915 case letters.
3916 "a-z,A-Z,@-@" All letters plus the '@' character.
3917 A comma can be included by using it where a character number is
3918 expected. Example:
3919 "48-57,,,_" Digits, comma and underscore.
3920 A comma can be excluded by prepending a '^'. Example:
3921 " -~,^,,9" All characters from space to '~', excluding
3922 comma, plus <Tab>.
3923 See |option-backslash| about including spaces and backslashes.
3924
3925 *'isident'* *'isi'*
3926'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3927 "@,48-57,_,128-167,224-235"
3928 otherwise: "@,48-57,_,192-255")
3929 global
3930 {not in Vi}
3931 The characters given by this option are included in identifiers.
3932 Identifiers are used in recognizing environment variables and after a
3933 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003934 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 option.
3936 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003937 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3939
3940 *'iskeyword'* *'isk'*
3941'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3942 "@,48-57,_,128-167,224-235"
3943 otherwise: "@,48-57,_,192-255"
3944 Vi default: "@,48-57,_")
3945 local to buffer
3946 {not in Vi}
3947 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003948 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 'isfname' for a description of the format of this option. For C
3950 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3951 For a help file it is set to all non-blank printable characters except
3952 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3953 command).
3954 When the 'lisp' option is on the '-' character is always included.
3955 NOTE: This option is set to the Vi default value when 'compatible' is
3956 set and to the Vim default value when 'compatible' is reset.
3957
3958 *'isprint'* *'isp'*
3959'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3960 "@,~-255"; otherwise: "@,161-255")
3961 global
3962 {not in Vi}
3963 The characters given by this option are displayed directly on the
3964 screen. It is also used for "\p" in a |pattern|. The characters from
3965 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3966 even when they are not included in 'isprint' or excluded. See
3967 'isfname' for a description of the format of this option.
3968
3969 Non-printable characters are displayed with two characters:
3970 0 - 31 "^@" - "^_"
3971 32 - 126 always single characters
3972 127 "^?"
3973 128 - 159 "~@" - "~_"
3974 160 - 254 "| " - "|~"
3975 255 "~?"
3976 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3977 displayed as <xx>, with the hexadecimal value of the byte.
3978 When 'display' contains "uhex" all unprintable characters are
3979 displayed as <xx>.
3980 The NonText highlighting will be used for unprintable characters.
3981 |hl-NonText|
3982
3983 Multi-byte characters 256 and above are always included, only the
3984 characters up to 255 are specified with this option. When a character
3985 is printable but it is not available in the current font, a
3986 replacement character will be shown.
3987 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3988 There is no option to specify these characters.
3989
3990 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3991'joinspaces' 'js' boolean (default on)
3992 global
3993 {not in Vi}
3994 Insert two spaces after a '.', '?' and '!' with a join command.
3995 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3996 Otherwise only one space is inserted.
3997 NOTE: This option is set when 'compatible' is set.
3998
3999 *'key'*
4000'key' string (default "")
4001 local to buffer
4002 {not in Vi}
4003 The key that is used for encrypting and decrypting the current buffer.
4004 See |encryption|.
4005 Careful: Do not set the key value by hand, someone might see the typed
4006 key. Use the |:X| command. But you can make 'key' empty: >
4007 :set key=
4008< It is not possible to get the value of this option with ":set key" or
4009 "echo &key". This is to avoid showing it to someone who shouldn't
4010 know. It also means you cannot see it yourself once you have set it,
4011 be careful not to make a typing error!
4012
4013 *'keymap'* *'kmp'* *E544*
4014'keymap' 'kmp' string (default "")
4015 local to buffer
4016 {not in Vi}
4017 {only available when compiled with the |+keymap|
4018 feature}
4019 Name of a keyboard mapping. See |mbyte-keymap|.
4020 Setting this option to a valid keymap name has the side effect of
4021 setting 'iminsert' to one, so that the keymap becomes effective.
4022 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004023 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024
4025 *'keymodel'* *'km'*
4026'keymodel' 'km' string (default "")
4027 global
4028 {not in Vi}
4029 List of comma separated words, which enable special things that keys
4030 can do. These values can be used:
4031 startsel Using a shifted special key starts selection (either
4032 Select mode or Visual mode, depending on "key" being
4033 present in 'selectmode').
4034 stopsel Using a not-shifted special key stops selection.
4035 Special keys in this context are the cursor keys, <End>, <Home>,
4036 <PageUp> and <PageDown>.
4037 The 'keymodel' option is set by the |:behave| command.
4038
4039 *'keywordprg'* *'kp'*
4040'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4041 OS/2: "view /", VMS: "help")
4042 global or local to buffer |global-local|
4043 {not in Vi}
4044 Program to use for the |K| command. Environment variables are
4045 expanded |:set_env|. ":help" may be used to access the Vim internal
4046 help. (Note that previously setting the global option to the empty
4047 value did this, which is now deprecated.)
4048 When "man" is used, Vim will automatically translate a count for the
4049 "K" command to a section number. Also for "man -s", in which case the
4050 "-s" is removed when there is no count.
4051 See |option-backslash| about including spaces and backslashes.
4052 Example: >
4053 :set keywordprg=man\ -s
4054< This option cannot be set from a |modeline| or in the |sandbox|, for
4055 security reasons.
4056
4057 *'langmap'* *'lmap'* *E357* *E358*
4058'langmap' 'lmap' string (default "")
4059 global
4060 {not in Vi}
4061 {only available when compiled with the |+langmap|
4062 feature}
4063 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004064 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 inserted directly. When in command mode the 'langmap' option takes
4066 care of translating these special characters to the original meaning
4067 of the key. This means you don't have to change the keyboard mode to
4068 be able to execute Normal mode commands.
4069 This is the opposite of the 'keymap' option, where characters are
4070 mapped in Insert mode.
4071 This only works for 8-bit characters. The value of 'langmap' may be
4072 specified with multi-byte characters (e.g., UTF-8), but only the lower
4073 8 bits of each character will be used.
4074
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004075 Example (for Greek, in UTF-8): *greek* >
4076 :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 +00004077< Example (exchanges meaning of z and y for commands): >
4078 :set langmap=zy,yz,ZY,YZ
4079<
4080 The 'langmap' option is a list of parts, separated with commas. Each
4081 part can be in one of two forms:
4082 1. A list of pairs. Each pair is a "from" character immediately
4083 followed by the "to" character. Examples: "aA", "aAbBcC".
4084 2. A list of "from" characters, a semi-colon and a list of "to"
4085 characters. Example: "abc;ABC"
4086 Example: "aA,fgh;FGH,cCdDeE"
4087 Special characters need to be preceded with a backslash. These are
4088 ";", ',' and backslash itself.
4089
4090 This will allow you to activate vim actions without having to switch
4091 back and forth between the languages. Your language characters will
4092 be understood as normal vim English characters (according to the
4093 langmap mappings) in the following cases:
4094 o Normal/Visual mode (commands, buffer/register names, user mappings)
4095 o Insert/Replace Mode: Register names after CTRL-R
4096 o Insert/Replace Mode: Mappings
4097 Characters entered in Command-line mode will NOT be affected by
4098 this option. Note that this option can be changed at any time
4099 allowing to switch between mappings for different languages/encodings.
4100 Use a mapping to avoid having to type it each time!
4101
4102 *'langmenu'* *'lm'*
4103'langmenu' 'lm' string (default "")
4104 global
4105 {not in Vi}
4106 {only available when compiled with the |+menu| and
4107 |+multi_lang| features}
4108 Language to use for menu translation. Tells which file is loaded
4109 from the "lang" directory in 'runtimepath': >
4110 "lang/menu_" . &langmenu . ".vim"
4111< (without the spaces). For example, to always use the Dutch menus, no
4112 matter what $LANG is set to: >
4113 :set langmenu=nl_NL.ISO_8859-1
4114< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004115 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 If your $LANG is set to a non-English language but you do want to use
4117 the English menus: >
4118 :set langmenu=none
4119< This option must be set before loading menus, switching on filetype
4120 detection or syntax highlighting. Once the menus are defined setting
4121 this option has no effect. But you could do this: >
4122 :source $VIMRUNTIME/delmenu.vim
4123 :set langmenu=de_DE.ISO_8859-1
4124 :source $VIMRUNTIME/menu.vim
4125< Warning: This deletes all menus that you defined yourself!
4126
4127 *'laststatus'* *'ls'*
4128'laststatus' 'ls' number (default 1)
4129 global
4130 {not in Vi}
4131 The value of this option influences when the last window will have a
4132 status line:
4133 0: never
4134 1: only if there are at least two windows
4135 2: always
4136 The screen looks nicer with a status line if you have several
4137 windows, but it takes another screen line. |status-line|
4138
4139 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4140'lazyredraw' 'lz' boolean (default off)
4141 global
4142 {not in Vi}
4143 When this option is set, the screen will not be redrawn while
4144 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004145 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 update use |:redraw|.
4147
4148 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4149'linebreak' 'lbr' boolean (default off)
4150 local to window
4151 {not in Vi}
4152 {not available when compiled without the |+linebreak|
4153 feature}
4154 If on Vim will wrap long lines at a character in 'breakat' rather
4155 than at the last character that fits on the screen. Unlike
4156 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4157 it only affects the way the file is displayed, not its contents. The
4158 value of 'showbreak' is used to put in front of wrapped lines.
4159 This option is not used when the 'wrap' option is off or 'list' is on.
4160 Note that <Tab> characters after an <EOL> are mostly not displayed
4161 with the right amount of white space.
4162
4163 *'lines'* *E593*
4164'lines' number (default 24 or terminal height)
4165 global
4166 Number of lines of the Vim window.
4167 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004168 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 When Vim is running in the GUI or in a resizable window, setting this
4170 option will cause the window size to be changed. When you only want
4171 to use the size for the GUI, put the command in your |gvimrc| file.
4172 Vim limits the number of lines to what fits on the screen. You can
4173 use this command to get the tallest window possible: >
4174 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004175< Minimum value is 2, maximum value is 1000.
4176 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 When you set this option and Vim is unable to change the physical
4178 number of lines of the display, the display may be messed up.
4179
4180 *'linespace'* *'lsp'*
4181'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4182 global
4183 {not in Vi}
4184 {only in the GUI}
4185 Number of pixel lines inserted between characters. Useful if the font
4186 uses the full character cell height, making lines touch each other.
4187 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004188 With some fonts there can be too much room between lines (to have
4189 space for ascents and descents). Then it makes sense to set
4190 'linespace' to a negative value. This may cause display problems
4191 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192
4193 *'lisp'* *'nolisp'*
4194'lisp' boolean (default off)
4195 local to buffer
4196 {not available when compiled without the |+lispindent|
4197 feature}
4198 Lisp mode: When <Enter> is typed in insert mode set the indent for
4199 the next line to Lisp standards (well, sort of). Also happens with
4200 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4201 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4202 better. Also see 'lispwords'.
4203 The '-' character is included in keyword characters. Redefines the
4204 "=" operator to use this same indentation algorithm rather than
4205 calling an external program if 'equalprg' is empty.
4206 This option is not used when 'paste' is set.
4207 {Vi: Does it a little bit differently}
4208
4209 *'lispwords'* *'lw'*
4210'lispwords' 'lw' string (default is very long)
4211 global
4212 {not in Vi}
4213 {not available when compiled without the |+lispindent|
4214 feature}
4215 Comma separated list of words that influence the Lisp indenting.
4216 |'lisp'|
4217
4218 *'list'* *'nolist'*
4219'list' boolean (default off)
4220 local to window
4221 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4222 see the difference between tabs and spaces and for trailing blanks.
4223 Note that this will also affect formatting (set with 'textwidth' or
4224 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4225 changing the way tabs are displayed.
4226
4227 *'listchars'* *'lcs'*
4228'listchars' 'lcs' string (default "eol:$")
4229 global
4230 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004231 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 settings.
4233 eol:c Character to show at the end of each line. When
4234 omitted, there is no extra character at the end of the
4235 line.
4236 tab:xy Two characters to be used to show a Tab. The first
4237 char is used once. The second char is repeated to
4238 fill the space that the Tab normally occupies.
4239 "tab:>-" will show a Tab that takes four spaces as
4240 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004241 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 trailing spaces are blank.
4243 extends:c Character to show in the last column, when 'wrap' is
4244 off and the line continues beyond the right of the
4245 screen.
4246 precedes:c Character to show in the first column, when 'wrap'
4247 is off and there is text preceding the character
4248 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004249 nbsp:c Character to show for a non-breakable space (character
4250 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004252 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 be used when 'encoding' is "utf-8", otherwise only printable
4254 characters are allowed.
4255
4256 Examples: >
4257 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004258 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 :set lcs=extends:>,precedes:<
4260< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004261 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262
4263 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4264'loadplugins' 'lpl' boolean (default on)
4265 global
4266 {not in Vi}
4267 When on the plugin scripts are loaded when starting up |load-plugins|.
4268 This option can be reset in your |vimrc| file to disable the loading
4269 of plugins.
4270 Note that using the "-u NONE" and "--noplugin" command line arguments
4271 reset this option. |-u| |--noplugin|
4272
4273 *'magic'* *'nomagic'*
4274'magic' boolean (default on)
4275 global
4276 Changes the special characters that can be used in search patterns.
4277 See |pattern|.
4278 NOTE: To avoid portability problems with using patterns, always keep
4279 this option at the default "on". Only switch it off when working with
4280 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004281 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282
4283 *'makeef'* *'mef'*
4284'makeef' 'mef' string (default: "")
4285 global
4286 {not in Vi}
4287 {not available when compiled without the |+quickfix|
4288 feature}
4289 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4290 and the |:grep| command.
4291 When it is empty, an internally generated temp file will be used.
4292 When "##" is included, it is replaced by a number to make the name
4293 unique. This makes sure that the ":make" command doesn't overwrite an
4294 existing file.
4295 NOT used for the ":cf" command. See 'errorfile' for that.
4296 Environment variables are expanded |:set_env|.
4297 See |option-backslash| about including spaces and backslashes.
4298 This option cannot be set from a |modeline| or in the |sandbox|, for
4299 security reasons.
4300
4301 *'makeprg'* *'mp'*
4302'makeprg' 'mp' string (default "make", VMS: "MMS")
4303 global or local to buffer |global-local|
4304 {not in Vi}
4305 Program to use for the ":make" command. See |:make_makeprg|. This
4306 option may contain '%' and '#' characters, which are expanded like
4307 when used in a command-line. Environment variables are expanded
4308 |:set_env|. See |option-backslash| about including spaces and
4309 backslashes. Note that a '|' must be escaped twice: once for ":set"
4310 and once for the interpretation of a command. When you use a filter
4311 called "myfilter" do it like this: >
4312 :set makeprg=gmake\ \\\|\ myfilter
4313< The placeholder "$*" can be given (even multiple times) to specify
4314 where the arguments will be included, for example: >
4315 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4316< This option cannot be set from a |modeline| or in the |sandbox|, for
4317 security reasons.
4318
4319 *'matchpairs'* *'mps'*
4320'matchpairs' 'mps' string (default "(:),{:},[:]")
4321 local to buffer
4322 {not in Vi}
4323 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004324 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 must be different. The characters must be separated by a colon. The
4326 pairs must be separated by a comma. Example for including '<' and '>'
4327 (HTML): >
4328 :set mps+=<:>
4329
4330< A more exotic example, to jump between the '=' and ';' in an
4331 assignment, useful for languages like C and Java: >
4332 :au FileType c,cpp,java set mps+==:;
4333
4334< For a more advanced way of using "%", see the matchit.vim plugin in
4335 the $VIMRUNTIME/macros directory. |add-local-help|
4336
4337 *'matchtime'* *'mat'*
4338'matchtime' 'mat' number (default 5)
4339 global
4340 {not in Vi}{in Nvi}
4341 Tenths of a second to show the matching paren, when 'showmatch' is
4342 set. Note that this is not in milliseconds, like other options that
4343 set a time. This is to be compatible with Nvi.
4344
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004345 *'maxcombine'* *'mco'*
4346'maxcombine' 'mco' number (default 2)
4347 global
4348 {not in Vi}
4349 {only available when compiled with the |+multi_byte|
4350 feature}
4351 The maximum number of combining characters supported for displaying.
4352 Only used when 'encoding' is "utf-8".
4353 The default is OK for most languages. Hebrew may require 4.
4354 Maximum value is 6.
4355 Even when this option is set to 2 you can still edit text with more
4356 combining characters, you just can't see them. Use |g8| or |ga|.
4357 See |mbyte-combining|.
4358
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 *'maxfuncdepth'* *'mfd'*
4360'maxfuncdepth' 'mfd' number (default 100)
4361 global
4362 {not in Vi}
4363 Maximum depth of function calls for user functions. This normally
4364 catches endless recursion. When using a recursive function with
4365 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4366 more memory, there is the danger of failing when memory is exhausted.
4367 See also |:function|.
4368
4369 *'maxmapdepth'* *'mmd'* *E223*
4370'maxmapdepth' 'mmd' number (default 1000)
4371 global
4372 {not in Vi}
4373 Maximum number of times a mapping is done without resulting in a
4374 character to be used. This normally catches endless mappings, like
4375 ":map x y" with ":map y x". It still does not catch ":map g wg",
4376 because the 'w' is used before the next mapping is done. See also
4377 |key-mapping|.
4378
4379 *'maxmem'* *'mm'*
4380'maxmem' 'mm' number (default between 256 to 5120 (system
4381 dependent) or half the amount of memory
4382 available)
4383 global
4384 {not in Vi}
4385 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4386 limit is reached allocating extra memory for a buffer will cause
4387 other memory to be freed. Maximum value 2000000. Use this to work
4388 without a limit. Also see 'maxmemtot'.
4389
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004390 *'maxmempattern'* *'mmp'*
4391'maxmempattern' 'mmp' number (default 1000)
4392 global
4393 {not in Vi}
4394 Maximum amount of memory (in Kbyte) to use for pattern matching.
4395 Maximum value 2000000. Use this to work without a limit.
4396 *E363*
4397 When Vim runs into the limit it gives an error message mostly behaves
4398 like CTRL-C was typed.
4399 Running into the limit often means that the pattern is very
4400 inefficient or too complex. This may already happen with the pattern
4401 "\(.\)*" on a very long line. ".*" works much better.
4402 Vim may run out of memory before hitting the 'maxmempattern' limit.
4403
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 *'maxmemtot'* *'mmt'*
4405'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4406 dependent) or half the amount of memory
4407 available)
4408 global
4409 {not in Vi}
4410 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004411 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 'maxmem'.
4413
4414 *'menuitems'* *'mis'*
4415'menuitems' 'mis' number (default 25)
4416 global
4417 {not in Vi}
4418 {not available when compiled without the |+menu|
4419 feature}
4420 Maximum number of items to use in a menu. Used for menus that are
4421 generated from a list of items, e.g., the Buffers menu. Changing this
4422 option has no direct effect, the menu must be refreshed first.
4423
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004424 *'mkspellmem'* *'msm'*
4425'mkspellmem' 'msm' string (default "460000,2000,500")
4426 global
4427 {not in Vi}
4428 {not available when compiled without the |+syntax|
4429 feature}
4430 Parameters for |:mkspell|. This tunes when to start compressing the
4431 word tree. Compression can be slow when there are many words, but
4432 it's needed to avoid running out of memory. The amount of memory used
4433 per word depends very much on how similar the words are, that's why
4434 this tuning is complicated.
4435
4436 There are three numbers, separated by commas:
4437 {start},{inc},{added}
4438
4439 For most languages the uncompressed word tree fits in memory. {start}
4440 gives the amount of memory in Kbyte that can be used before any
4441 compression is done. It should be a bit smaller than the amount of
4442 memory that is available to Vim.
4443
4444 When going over the {start} limit the {inc} number specifies the
4445 amount of memory in Kbyte that can be allocated before another
4446 compression is done. A low number means compression is done after
4447 less words are added, which is slow. A high number means more memory
4448 will be allocated.
4449
4450 After doing compression, {added} times 1024 words can be added before
4451 the {inc} limit is ignored and compression is done when any extra
4452 amount of memory is needed. A low number means there is a smaller
4453 chance of hitting the {inc} limit, less memory is used but it's
4454 slower.
4455
4456 The languages for which these numbers are important are Italian and
4457 Hungarian. The default works for when you have about 512 Mbyte. If
4458 you have 1 Gbyte you could use: >
4459 :set mkspellmem=900000,3000,800
4460< If you have less than 512 Mbyte |:mkspell| may fail for some
4461 languages, no matter what you set 'mkspellmem' to.
4462
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4464'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4465 local to buffer
4466 *'modelines'* *'mls'*
4467'modelines' 'mls' number (default 5)
4468 global
4469 {not in Vi}
4470 If 'modeline' is on 'modelines' gives the number of lines that is
4471 checked for set commands. If 'modeline' is off or 'modelines' is zero
4472 no lines are checked. See |modeline|.
4473 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4474 set and to the Vim default value when 'compatible' is reset.
4475
4476 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4477'modifiable' 'ma' boolean (default on)
4478 local to buffer
4479 {not in Vi} *E21*
4480 When off the buffer contents cannot be changed. The 'fileformat' and
4481 'fileencoding' options also can't be changed.
4482 Can be reset with the |-M| command line argument.
4483
4484 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4485'modified' 'mod' boolean (default off)
4486 local to buffer
4487 {not in Vi}
4488 When on, the buffer is considered to be modified. This option is set
4489 when:
4490 1. A change was made to the text since it was last written. Using the
4491 |undo| command to go back to the original text will reset the
4492 option. But undoing changes that were made before writing the
4493 buffer will set the option again, since the text is different from
4494 when it was written.
4495 2. 'fileformat' or 'fileencoding' is different from its original
4496 value. The original value is set when the buffer is read or
4497 written. A ":set nomodified" command also resets the original
4498 values to the current values and the 'modified' option will be
4499 reset.
4500 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4501 will be ignored.
4502
4503 *'more'* *'nomore'*
4504'more' boolean (Vim default: on, Vi default: off)
4505 global
4506 {not in Vi}
4507 When on, listings pause when the whole screen is filled. You will get
4508 the |more-prompt|. When this option is off there are no pauses, the
4509 listing continues until finished.
4510 NOTE: This option is set to the Vi default value when 'compatible' is
4511 set and to the Vim default value when 'compatible' is reset.
4512
4513 *'mouse'* *E538*
4514'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4515 global
4516 {not in Vi}
4517 Enable the use of the mouse. Only works for certain terminals
4518 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4519 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4520 The mouse can be enabled for different modes:
4521 n Normal mode
4522 v Visual mode
4523 i Insert mode
4524 c Command-line mode
4525 h all previous modes when editing a help file
4526 a all previous modes
4527 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 Normally you would enable the mouse in all four modes with: >
4529 :set mouse=a
4530< When the mouse is not enabled, the GUI will still use the mouse for
4531 modeless selection. This doesn't move the text cursor.
4532
4533 See |mouse-using|. Also see |'clipboard'|.
4534
4535 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004536 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 the mouse buttons can still be used by keeping the shift key pressed.
4538 Also see the 'clipboard' option.
4539
4540 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4541'mousefocus' 'mousef' boolean (default off)
4542 global
4543 {not in Vi}
4544 {only works in the GUI}
4545 The window that the mouse pointer is on is automatically activated.
4546 When changing the window layout or window focus in another way, the
4547 mouse pointer is moved to the window with keyboard focus. Off is the
4548 default because it makes using the pull down menus a little goofy, as
4549 a pointer transit may activate a window unintentionally.
4550
4551 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4552'mousehide' 'mh' boolean (default on)
4553 global
4554 {not in Vi}
4555 {only works in the GUI}
4556 When on, the mouse pointer is hidden when characters are typed.
4557 The mouse pointer is restored when the mouse is moved.
4558
4559 *'mousemodel'* *'mousem'*
4560'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4561 global
4562 {not in Vi}
4563 Sets the model to use for the mouse. The name mostly specifies what
4564 the right mouse button is used for:
4565 extend Right mouse button extends a selection. This works
4566 like in an xterm.
4567 popup Right mouse button pops up a menu. The shifted left
4568 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004569 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 popup_setpos Like "popup", but the cursor will be moved to the
4571 position where the mouse was clicked, and thus the
4572 selected operation will act upon the clicked object.
4573 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004574 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 course, that right clicking outside a selection will
4576 end Visual mode.
4577 Overview of what button does what for each model:
4578 mouse extend popup(_setpos) ~
4579 left click place cursor place cursor
4580 left drag start selection start selection
4581 shift-left search word extend selection
4582 right click extend selection popup menu (place cursor)
4583 right drag extend selection -
4584 middle click paste paste
4585
4586 In the "popup" model the right mouse button produces a pop-up menu.
4587 You need to define this first, see |popup-menu|.
4588
4589 Note that you can further refine the meaning of buttons with mappings.
4590 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4591 selection (because that's handled in the GUI code directly).
4592
4593 The 'mousemodel' option is set by the |:behave| command.
4594
4595 *'mouseshape'* *'mouses'* *E547*
4596'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004597 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 global
4599 {not in Vi}
4600 {only available when compiled with the |+mouseshape|
4601 feature}
4602 This option tells Vim what the mouse pointer should look like in
4603 different modes. The option is a comma separated list of parts, much
4604 like used for 'guicursor'. Each part consist of a mode/location-list
4605 and an argument-list:
4606 mode-list:shape,mode-list:shape,..
4607 The mode-list is a dash separated list of these modes/locations:
4608 In a normal window: ~
4609 n Normal mode
4610 v Visual mode
4611 ve Visual mode with 'selection' "exclusive" (same as 'v',
4612 if not specified)
4613 o Operator-pending mode
4614 i Insert mode
4615 r Replace mode
4616
4617 Others: ~
4618 c appending to the command-line
4619 ci inserting in the command-line
4620 cr replacing in the command-line
4621 m at the 'Hit ENTER' or 'More' prompts
4622 ml idem, but cursor in the last line
4623 e any mode, pointer below last window
4624 s any mode, pointer on a status line
4625 sd any mode, while dragging a status line
4626 vs any mode, pointer on a vertical separator line
4627 vd any mode, while dragging a vertical separator line
4628 a everywhere
4629
4630 The shape is one of the following:
4631 avail name looks like ~
4632 w x arrow Normal mouse pointer
4633 w x blank no pointer at all (use with care!)
4634 w x beam I-beam
4635 w x updown up-down sizing arrows
4636 w x leftright left-right sizing arrows
4637 w x busy The system's usual busy pointer
4638 w x no The system's usual 'no input' pointer
4639 x udsizing indicates up-down resizing
4640 x lrsizing indicates left-right resizing
4641 x crosshair like a big thin +
4642 x hand1 black hand
4643 x hand2 white hand
4644 x pencil what you write with
4645 x question big ?
4646 x rightup-arrow arrow pointing right-up
4647 w x up-arrow arrow pointing up
4648 x <number> any X11 pointer number (see X11/cursorfont.h)
4649
4650 The "avail" column contains a 'w' if the shape is available for Win32,
4651 x for X11.
4652 Any modes not specified or shapes not available use the normal mouse
4653 pointer.
4654
4655 Example: >
4656 :set mouseshape=s:udsizing,m:no
4657< will make the mouse turn to a sizing arrow over the status lines and
4658 indicate no input when the hit-enter prompt is displayed (since
4659 clicking the mouse has no effect in this state.)
4660
4661 *'mousetime'* *'mouset'*
4662'mousetime' 'mouset' number (default 500)
4663 global
4664 {not in Vi}
4665 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4666 time in msec between two mouse clicks for the second click to be
4667 recognized as a multi click.
4668
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004669 *'mzquantum'* *'mzq'*
4670'mzquantum' 'mzq' number (default 100)
4671 global
4672 {not in Vi}
4673 {not available when compiled without the |+mzscheme|
4674 feature}
4675 The number of milliseconds between polls for MzScheme threads.
4676 Negative or zero value means no thread scheduling.
4677
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 *'nrformats'* *'nf'*
4679'nrformats' 'nf' string (default "octal,hex")
4680 local to buffer
4681 {not in Vi}
4682 This defines what bases Vim will consider for numbers when using the
4683 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4684 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004685 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 incremented or decremented. This is useful for a list with a
4687 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004688 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004690 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 considered to be hexadecimal. Example: Using CTRL-X on
4692 "0x100" results in "0x0ff".
4693 Numbers which simply begin with a digit in the range 1-9 are always
4694 considered decimal. This also happens for numbers that are not
4695 recognized as octal or hex.
4696
4697 *'number'* *'nu'* *'nonumber'* *'nonu'*
4698'number' 'nu' boolean (default off)
4699 local to window
4700 Print the line number in front of each line. When the 'n' option is
4701 excluded from 'cpoptions' a wrapped line will not use the column of
4702 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004703 The 'numberwidth' option can be used to set the room used for the line
4704 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 When a long, wrapped line doesn't start with the first character, '-'
4706 characters are put before the number.
4707 See |hl-LineNr| for the highlighting used for the number.
4708
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004709 *'numberwidth'* *'nuw'*
4710'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4711 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004712 {not in Vi}
4713 {only available when compiled with the |+linebreak|
4714 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004715 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004716 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004717 Since one space is always between the number and the text, there is
4718 one less character for the number itself.
4719 The value is the minimum width. A bigger width is used when needed to
4720 fit the highest line number in the buffer. Thus with the Vim default
4721 of 4 there is room for a line number up to 999. When the buffer has
4722 1000 lines five columns will be used.
4723 The minimum value is 1, the maximum value is 10.
4724 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4725
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004726 *'omnifunc'* *'ofu'*
4727'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004728 local to buffer
4729 {not in Vi}
4730 {not available when compiled without the +eval
4731 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004732 This option specifies a function to be used for Insert mode omni
4733 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004734 See |complete-functions| for an explanation of how the function is
4735 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004736
4737
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004738 *'operatorfunc'* *'opfunc'*
4739'operatorfunc' 'opfunc' string (default: empty)
4740 global
4741 {not in Vi}
4742 This option specifies a function to be called by the |g@| operator.
4743 See |:map-operator| for more info and an example.
4744
4745 This option cannot be set from a |modeline| or in the |sandbox|, for
4746 security reasons.
4747
4748
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 *'osfiletype'* *'oft'* *E366*
4750'osfiletype' 'oft' string (RISC-OS default: "Text",
4751 others default: "")
4752 local to buffer
4753 {not in Vi}
4754 {only available when compiled with the |+osfiletype|
4755 feature}
4756 Some operating systems store extra information about files besides
4757 name, datestamp and permissions. This option contains the extra
4758 information, the nature of which will vary between systems.
4759 The value of this option is usually set when the file is loaded, and
4760 use to set the file type when file is written.
4761 It can affect the pattern matching of the automatic commands.
4762 |autocmd-osfiletypes|
4763
4764 *'paragraphs'* *'para'*
4765'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4766 global
4767 Specifies the nroff macros that separate paragraphs. These are pairs
4768 of two letters (see |object-motions|).
4769
4770 *'paste'* *'nopaste'*
4771'paste' boolean (default off)
4772 global
4773 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004774 Put Vim in Paste mode. This is useful if you want to cut or copy
4775 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 unexpected effects.
4777 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004778 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 knows about pasting and will mostly do the right thing without 'paste'
4780 being set. The same is true for a terminal where Vim handles the
4781 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004782 This option is reset when starting the GUI. Thus if you set it in
4783 your .vimrc it will work in a terminal, but not in the GUI. Setting
4784 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4785 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 When the 'paste' option is switched on (also when it was already on):
4787 - mapping in Insert mode and Command-line mode is disabled
4788 - abbreviations are disabled
4789 - 'textwidth' is set to 0
4790 - 'wrapmargin' is set to 0
4791 - 'autoindent' is reset
4792 - 'smartindent' is reset
4793 - 'softtabstop' is set to 0
4794 - 'revins' is reset
4795 - 'ruler' is reset
4796 - 'showmatch' is reset
4797 - 'formatoptions' is used like it is empty
4798 These options keep their value, but their effect is disabled:
4799 - 'lisp'
4800 - 'indentexpr'
4801 - 'cindent'
4802 NOTE: When you start editing another file while the 'paste' option is
4803 on, settings from the modelines or autocommands may change the
4804 settings again, causing trouble when pasting text. You might want to
4805 set the 'paste' option again.
4806 When the 'paste' option is reset the mentioned options are restored to
4807 the value before the moment 'paste' was switched from off to on.
4808 Resetting 'paste' before ever setting it does not have any effect.
4809 Since mapping doesn't work while 'paste' is active, you need to use
4810 the 'pastetoggle' option to toggle the 'paste' option with some key.
4811
4812 *'pastetoggle'* *'pt'*
4813'pastetoggle' 'pt' string (default "")
4814 global
4815 {not in Vi}
4816 When non-empty, specifies the key sequence that toggles the 'paste'
4817 option. This is like specifying a mapping: >
4818 :map {keys} :set invpaste<CR>
4819< Where {keys} is the value of 'pastetoggle'.
4820 The difference is that it will work even when 'paste' is set.
4821 'pastetoggle' works in Insert mode and Normal mode, but not in
4822 Command-line mode.
4823 Mappings are checked first, thus overrule 'pastetoggle'. However,
4824 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4825 this: >
4826 :map <F10> :set paste<CR>
4827 :map <F11> :set nopaste<CR>
4828 :imap <F10> <C-O>:set paste<CR>
4829 :imap <F11> <nop>
4830 :set pastetoggle=<F11>
4831< This will make <F10> start paste mode and <F11> stop paste mode.
4832 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4833 mode everything is inserted literally, except the 'pastetoggle' key
4834 sequence.
4835
4836 *'pex'* *'patchexpr'*
4837'patchexpr' 'pex' string (default "")
4838 global
4839 {not in Vi}
4840 {not available when compiled without the |+diff|
4841 feature}
4842 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004843 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844
4845 *'patchmode'* *'pm'* *E206*
4846'patchmode' 'pm' string (default "")
4847 global
4848 {not in Vi}
4849 When non-empty the oldest version of a file is kept. This can be used
4850 to keep the original version of a file if you are changing files in a
4851 source distribution. Only the first time that a file is written a
4852 copy of the original file will be kept. The name of the copy is the
4853 name of the original file with the string in the 'patchmode' option
4854 appended. This option should start with a dot. Use a string like
4855 ".org". 'backupdir' must not be empty for this to work (Detail: The
4856 backup file is renamed to the patchmode file after the new file has
4857 been successfully written, that's why it must be possible to write a
4858 backup file). If there was no file to be backed up, an empty file is
4859 created.
4860 When the 'backupskip' pattern matches, a patchmode file is not made.
4861 Using 'patchmode' for compressed files appends the extension at the
4862 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4863 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004864 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865
4866 *'path'* *'pa'* *E343* *E345* *E347*
4867'path' 'pa' string (default on Unix: ".,/usr/include,,"
4868 on OS/2: ".,/emx/include,,"
4869 other systems: ".,,")
4870 global or local to buffer |global-local|
4871 {not in Vi}
4872 This is a list of directories which will be searched when using the
4873 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4874 being searched for has a relative path (not starting with '/'). The
4875 directories in the 'path' option may be relative or absolute.
4876 - Use commas to separate directory names: >
4877 :set path=.,/usr/local/include,/usr/include
4878< - Spaces can also be used to separate directory names (for backwards
4879 compatibility with version 3.0). To have a space in a directory
4880 name, precede it with an extra backslash, and escape the space: >
4881 :set path=.,/dir/with\\\ space
4882< - To include a comma in a directory name precede it with an extra
4883 backslash: >
4884 :set path=.,/dir/with\\,comma
4885< - To search relative to the directory of the current file, use: >
4886 :set path=.
4887< - To search in the current directory use an empty string between two
4888 commas: >
4889 :set path=,,
4890< - A directory name may end in a ':' or '/'.
4891 - Environment variables are expanded |:set_env|.
4892 - When using |netrw.vim| URLs can be used. For example, adding
4893 "http://www.vim.org" will make ":find index.html" work.
4894 - Search upwards and downwards in a directory tree:
4895 1) "*" matches a sequence of characters, e.g.: >
4896 :set path=/usr/include/*
4897< means all subdirectories in /usr/include (but not /usr/include
4898 itself). >
4899 :set path=/usr/*c
4900< matches /usr/doc and /usr/src.
4901 2) "**" matches a subtree, up to 100 directories deep. Example: >
4902 :set path=/home/user_x/src/**
4903< means search in the whole subtree under "/home/usr_x/src".
4904 3) If the path ends with a ';', this path is the startpoint
4905 for upward search.
4906 See |file-searching| for more info and exact syntax.
4907 {not available when compiled without the |+path_extra| feature}
4908 - Careful with '\' characters, type two to get one in the option: >
4909 :set path=.,c:\\include
4910< Or just use '/' instead: >
4911 :set path=.,c:/include
4912< Don't forget "." or files won't even be found in the same directory as
4913 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004914 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 it is something like 256 or 1024 characters.
4916 You can check if all the include files are found, using the value of
4917 'path', see |:checkpath|.
4918 The use of |:set+=| and |:set-=| is preferred when adding or removing
4919 directories from the list. This avoids problems when a future version
4920 uses another default. To remove the current directory use: >
4921 :set path-=
4922< To add the current directory use: >
4923 :set path+=
4924< To use an environment variable, you probably need to replace the
4925 separator. Here is an example to append $INCL, in which directory
4926 names are separated with a semi-colon: >
4927 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4928< Replace the ';' with a ':' or whatever separator is used. Note that
4929 this doesn't work when $INCL contains a comma or white space.
4930
4931 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4932'preserveindent' 'pi' boolean (default off)
4933 local to buffer
4934 {not in Vi}
4935 When changing the indent of the current line, preserve as much of the
4936 indent structure as possible. Normally the indent is replaced by a
4937 series of tabs followed by spaces as required (unless |'expandtab'| is
4938 enabled, in which case only spaces are used). Enabling this option
4939 means the indent will preserve as many existing characters as possible
4940 for indenting, and only add additional tabs or spaces as required.
4941 NOTE: When using ">>" multiple times the resulting indent is a mix of
4942 tabs and spaces. You might not like this.
4943 NOTE: 'preserveindent' is reset when 'compatible' is set.
4944 Also see 'copyindent'.
4945 Use |:retab| to clean up white space.
4946
4947 *'previewheight'* *'pvh'*
4948'previewheight' 'pvh' number (default 12)
4949 global
4950 {not in Vi}
4951 {not available when compiled without the |+windows| or
4952 |+quickfix| feature}
4953 Default height for a preview window. Used for |:ptag| and associated
4954 commands. Used for |CTRL-W_}| when no count is given.
4955
4956 *'previewwindow'* *'nopreviewwindow'*
4957 *'pvw'* *'nopvw'* *E590*
4958'previewwindow' 'pvw' boolean (default off)
4959 local to window
4960 {not in Vi}
4961 {not available when compiled without the |+windows| or
4962 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004963 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 set. It's normally not set directly, but by using one of the commands
4965 |:ptag|, |:pedit|, etc.
4966
4967 *'printdevice'* *'pdev'*
4968'printdevice' 'pdev' string (default empty)
4969 global
4970 {not in Vi}
4971 {only available when compiled with the |+printer|
4972 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004973 The name of the printer to be used for |:hardcopy|.
4974 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004975 This option cannot be set from a |modeline| or in the |sandbox|, for
4976 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977
Bram Moolenaar8299df92004-07-10 09:47:34 +00004978 *'printencoding'* *'penc'*
4979'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 global
4981 {not in Vi}
4982 {only available when compiled with the |+printer|
4983 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004984 Sets the character encoding used when printing.
4985 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986
4987 *'printexpr'* *'pexpr'*
4988'printexpr' 'pexpr' String (default: see below)
4989 global
4990 {not in Vi}
4991 {only available when compiled with the |+printer|
4992 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004993 Expression used to print the PostScript produced with |:hardcopy|.
4994 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995
Bram Moolenaar8299df92004-07-10 09:47:34 +00004996 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997'printfont' 'pfn' string (default "courier")
4998 global
4999 {not in Vi}
5000 {only available when compiled with the |+printer|
5001 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005002 The name of the font that will be used for |:hardcopy|.
5003 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004
5005 *'printheader'* *'pheader'*
5006'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5007 global
5008 {not in Vi}
5009 {only available when compiled with the |+printer|
5010 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005011 The format of the header produced in |:hardcopy| output.
5012 See |pheader-option|.
5013
5014 *'printmbcharset'* *'pmbcs'*
5015'printmbcharset' 'pmbcs' string (default "")
5016 global
5017 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005018 {only available when compiled with the |+printer|,
5019 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005020 The CJK character set to be used for CJK output from |:hardcopy|.
5021 See |pmbcs-option|.
5022
5023 *'printmbfont'* *'pmbfn'*
5024'printmbfont' 'pmbfn' string (default "")
5025 global
5026 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005027 {only available when compiled with the |+printer|,
5028 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005029 List of font names to be used for CJK output from |:hardcopy|.
5030 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031
5032 *'printoptions'* *'popt'*
5033'printoptions' 'popt' string (default "")
5034 global
5035 {not in Vi}
5036 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005037 List of items that control the format of the output of |:hardcopy|.
5038 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005040 *'prompt'* *'noprompt'*
5041'prompt' boolean (default on)
5042 global
5043 When on a ":" prompt is used in Ex mode.
5044
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005045 *'pumheight'* *'ph'*
5046'pumheight' 'ph' number (default 0)
5047 global
5048 {not available when compiled without the
5049 |+insert_expand| feature}
5050 {not in Vi}
5051 Determines the maximum number of items to show in the popup menu.
5052 When zero as much space as available is used.
5053 |ins-completion-menu|.
5054
5055
Bram Moolenaar677ee682005-01-27 14:41:15 +00005056 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005057'quoteescape' 'qe' string (default "\")
5058 local to buffer
5059 {not in Vi}
5060 The characters that are used to escape quotes in a string. Used for
5061 objects like a', a" and a` |a'|.
5062 When one of the characters in this option is found inside a string,
5063 the following character will be skipped. The default value makes the
5064 text "foo\"bar\\" considered to be one string.
5065
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5067'readonly' 'ro' boolean (default off)
5068 local to buffer
5069 If on, writes fail unless you use a '!'. Protects you from
5070 accidentally overwriting a file. Default on when Vim is started
5071 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005072 When using ":w!" the 'readonly' option is reset for the current
5073 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005075 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076
5077 *'remap'* *'noremap'*
5078'remap' boolean (default on)
5079 global
5080 Allows for mappings to work recursively. If you do not want this for
5081 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005082 NOTE: To avoid portability problems with Vim scripts, always keep
5083 this option at the default "on". Only switch it off when working with
5084 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085
5086 *'report'*
5087'report' number (default 2)
5088 global
5089 Threshold for reporting number of lines changed. When the number of
5090 changed lines is more than 'report' a message will be given for most
5091 ":" commands. If you want it always, set 'report' to 0.
5092 For the ":substitute" command the number of substitutions is used
5093 instead of the number of lines.
5094
5095 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5096'restorescreen' 'rs' boolean (default on)
5097 global
5098 {not in Vi} {only in Windows 95/NT console version}
5099 When set, the screen contents is restored when exiting Vim. This also
5100 happens when executing external commands.
5101
5102 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5103 options in your .vimrc. To disable restoring:
5104 set t_ti= t_te=
5105 To enable restoring (for an xterm):
5106 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5107 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5108
5109 *'revins'* *'ri'* *'norevins'* *'nori'*
5110'revins' 'ri' boolean (default off)
5111 global
5112 {not in Vi}
5113 {only available when compiled with the |+rightleft|
5114 feature}
5115 Inserting characters in Insert mode will work backwards. See "typing
5116 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5117 command in Insert mode, when 'allowrevins' is set.
5118 NOTE: This option is reset when 'compatible' or 'paste' is set.
5119
5120 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5121'rightleft' 'rl' boolean (default off)
5122 local to window
5123 {not in Vi}
5124 {only available when compiled with the |+rightleft|
5125 feature}
5126 When on, display orientation becomes right-to-left, i.e., characters
5127 that are stored in the file appear from the right to the left.
5128 Using this option, it is possible to edit files for languages that
5129 are written from the right to the left such as Hebrew and Arabic.
5130 This option is per window, so it is possible to edit mixed files
5131 simultaneously, or to view the same file in both ways (this is
5132 useful whenever you have a mixed text file with both right-to-left
5133 and left-to-right strings so that both sets are displayed properly
5134 in different windows). Also see |rileft.txt|.
5135
5136 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5137'rightleftcmd' 'rlc' string (default "search")
5138 local to window
5139 {not in Vi}
5140 {only available when compiled with the |+rightleft|
5141 feature}
5142 Each word in this option enables the command line editing to work in
5143 right-to-left mode for a group of commands:
5144
5145 search "/" and "?" commands
5146
5147 This is useful for languages such as Hebrew, Arabic and Farsi.
5148 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5149
5150 *'ruler'* *'ru'* *'noruler'* *'noru'*
5151'ruler' 'ru' boolean (default off)
5152 global
5153 {not in Vi}
5154 {not available when compiled without the
5155 |+cmdline_info| feature}
5156 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005157 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 text in the file is shown on the far right:
5159 Top first line is visible
5160 Bot last line is visible
5161 All first and last line are visible
5162 45% relative position in the file
5163 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005164 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005166 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 this option takes precedence over 'ruler' and 'rulerformat'
5168 If the number of characters displayed is different from the number of
5169 bytes in the text (e.g., for a TAB or a multi-byte character), both
5170 the text column (byte number) and the screen column are shown,
5171 separated with a dash.
5172 For an empty line "0-1" is shown.
5173 For an empty buffer the line number will also be zero: "0,0-1".
5174 This option is reset when the 'paste' option is set.
5175 If you don't want to see the ruler all the time but want to know where
5176 you are, use "g CTRL-G" |g_CTRL-G|.
5177 NOTE: This option is reset when 'compatible' is set.
5178
5179 *'rulerformat'* *'ruf'*
5180'rulerformat' 'ruf' string (default empty)
5181 global
5182 {not in Vi}
5183 {not available when compiled without the |+statusline|
5184 feature}
5185 When this option is not empty, it determines the content of the ruler
5186 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005187 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 The default ruler width is 17 characters. To make the ruler 15
5189 characters wide, put "%15(" at the start and "%)" at the end.
5190 Example: >
5191 :set rulerformat=%15(%c%V\ %p%%%)
5192<
5193 *'runtimepath'* *'rtp'* *vimfiles*
5194'runtimepath' 'rtp' string (default:
5195 Unix: "$HOME/.vim,
5196 $VIM/vimfiles,
5197 $VIMRUNTIME,
5198 $VIM/vimfiles/after,
5199 $HOME/.vim/after"
5200 Amiga: "home:vimfiles,
5201 $VIM/vimfiles,
5202 $VIMRUNTIME,
5203 $VIM/vimfiles/after,
5204 home:vimfiles/after"
5205 PC, OS/2: "$HOME/vimfiles,
5206 $VIM/vimfiles,
5207 $VIMRUNTIME,
5208 $VIM/vimfiles/after,
5209 $HOME/vimfiles/after"
5210 Macintosh: "$VIM:vimfiles,
5211 $VIMRUNTIME,
5212 $VIM:vimfiles:after"
5213 RISC-OS: "Choices:vimfiles,
5214 $VIMRUNTIME,
5215 Choices:vimfiles/after"
5216 VMS: "sys$login:vimfiles,
5217 $VIM/vimfiles,
5218 $VIMRUNTIME,
5219 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005220 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 global
5222 {not in Vi}
5223 This is a list of directories which will be searched for runtime
5224 files:
5225 filetype.vim filetypes by file name |new-filetype|
5226 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005227 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 colors/ color scheme files |:colorscheme|
5229 compiler/ compiler files |:compiler|
5230 doc/ documentation |write-local-help|
5231 ftplugin/ filetype plugins |write-filetype-plugin|
5232 indent/ indent scripts |indent-expression|
5233 keymap/ key mapping files |mbyte-keymap|
5234 lang/ menu translations |:menutrans|
5235 menu.vim GUI menus |menu.vim|
5236 plugin/ plugin scripts |write-plugin|
5237 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005238 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 syntax/ syntax files |mysyntaxfile|
5240 tutor/ files for vimtutor |tutor|
5241
5242 And any other file searched for with the |:runtime| command.
5243
5244 The defaults for most systems are setup to search five locations:
5245 1. In your home directory, for your personal preferences.
5246 2. In a system-wide Vim directory, for preferences from the system
5247 administrator.
5248 3. In $VIMRUNTIME, for files distributed with Vim.
5249 *after-directory*
5250 4. In the "after" directory in the system-wide Vim directory. This is
5251 for the system administrator to overrule or add to the distributed
5252 defaults (rarely needed)
5253 5. In the "after" directory in your home directory. This is for
5254 personal preferences to overrule or add to the distributed defaults
5255 or system-wide settings (rarely needed).
5256
5257 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5258 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005259 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 wildcards.
5261 See |:runtime|.
5262 Example: >
5263 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5264< This will use the directory "~/vimruntime" first (containing your
5265 personal Vim runtime files), then "/mygroup/vim" (shared between a
5266 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5267 files).
5268 You probably should always include $VIMRUNTIME somewhere, to use the
5269 distributed runtime files. You can put a directory before $VIMRUNTIME
5270 to find files which replace a distributed runtime files. You can put
5271 a directory after $VIMRUNTIME to find files which add to distributed
5272 runtime files.
5273 This option cannot be set from a |modeline| or in the |sandbox|, for
5274 security reasons.
5275
5276 *'scroll'* *'scr'*
5277'scroll' 'scr' number (default: half the window height)
5278 local to window
5279 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5280 set to half the number of lines in the window when the window size
5281 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005282 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5284 the number of screen lines instead of file lines, makes a difference
5285 when lines wrap}
5286
5287 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5288'scrollbind' 'scb' boolean (default off)
5289 local to window
5290 {not in Vi}
5291 {not available when compiled without the |+scrollbind|
5292 feature}
5293 See also |scroll-binding|. When this option is set, the current
5294 window scrolls as other scrollbind windows (windows that also have
5295 this option set) scroll. This option is useful for viewing the
5296 differences between two versions of a file, see 'diff'.
5297 See |'scrollopt'| for options that determine how this option should be
5298 interpreted.
5299 This option is mostly reset when splitting a window to edit another
5300 file. This means that ":split | edit file" results in two windows
5301 with scroll-binding, but ":split file" does not.
5302
5303 *'scrolljump'* *'sj'*
5304'scrolljump' 'sj' number (default 1)
5305 global
5306 {not in Vi}
5307 Minimal number of lines to scroll when the cursor gets off the
5308 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5309 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005310 When set to a negative number from -1 to -100 this is used as the
5311 percentage of the window height. Thus -50 scrolls half the window
5312 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 NOTE: This option is set to 1 when 'compatible' is set.
5314
5315 *'scrolloff'* *'so'*
5316'scrolloff' 'so' number (default 0)
5317 global
5318 {not in Vi}
5319 Minimal number of screen lines to keep above and below the cursor.
5320 This will make some context visible around where you are working. If
5321 you set it to a very large value (999) the cursor line will always be
5322 in the middle of the window (except at the start or end of the file or
5323 when long lines wrap).
5324 For scrolling horizontally see 'sidescrolloff'.
5325 NOTE: This option is set to 0 when 'compatible' is set.
5326
5327 *'scrollopt'* *'sbo'*
5328'scrollopt' 'sbo' string (default "ver,jump")
5329 global
5330 {not available when compiled without the |+scrollbind|
5331 feature}
5332 {not in Vi}
5333 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005334 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5335 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 The following words are available:
5337 ver Bind vertical scrolling for 'scrollbind' windows
5338 hor Bind horizontal scrolling for 'scrollbind' windows
5339 jump Applies to the offset between two windows for vertical
5340 scrolling. This offset is the difference in the first
5341 displayed line of the bound windows. When moving
5342 around in a window, another 'scrollbind' window may
5343 reach a position before the start or after the end of
5344 the buffer. The offset is not changed though, when
5345 moving back the 'scrollbind' window will try to scroll
5346 to the desired position when possible.
5347 When now making that window the current one, two
5348 things can be done with the relative offset:
5349 1. When "jump" is not included, the relative offset is
5350 adjusted for the scroll position in the new current
5351 window. When going back to the other window, the
5352 the new relative offset will be used.
5353 2. When "jump" is included, the other windows are
5354 scrolled to keep the same relative offset. When
5355 going back to the other window, it still uses the
5356 same relative offset.
5357 Also see |scroll-binding|.
5358
5359 *'sections'* *'sect'*
5360'sections' 'sect' string (default "SHNHH HUnhsh")
5361 global
5362 Specifies the nroff macros that separate sections. These are pairs of
5363 two letters (See |object-motions|). The default makes a section start
5364 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5365
5366 *'secure'* *'nosecure'* *E523*
5367'secure' boolean (default off)
5368 global
5369 {not in Vi}
5370 When on, ":autocmd", shell and write commands are not allowed in
5371 ".vimrc" and ".exrc" in the current directory and map commands are
5372 displayed. Switch it off only if you know that you will not run into
5373 problems, or when the 'exrc' option is off. On Unix this option is
5374 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005375 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 'secure' at the end of your ~/.vimrc then.
5377 This option cannot be set from a |modeline| or in the |sandbox|, for
5378 security reasons.
5379
5380 *'selection'* *'sel'*
5381'selection' 'sel' string (default "inclusive")
5382 global
5383 {not in Vi}
5384 This option defines the behavior of the selection. It is only used
5385 in Visual and Select mode.
5386 Possible values:
5387 value past line inclusive ~
5388 old no yes
5389 inclusive yes yes
5390 exclusive yes no
5391 "past line" means that the cursor is allowed to be positioned one
5392 character past the line.
5393 "inclusive" means that the last character of the selection is included
5394 in an operation. For example, when "x" is used to delete the
5395 selection.
5396 Note that when "exclusive" is used and selecting from the end
5397 backwards, you cannot include the last character of a line, when
5398 starting in Normal mode and 'virtualedit' empty.
5399
5400 The 'selection' option is set by the |:behave| command.
5401
5402 *'selectmode'* *'slm'*
5403'selectmode' 'slm' string (default "")
5404 global
5405 {not in Vi}
5406 This is a comma separated list of words, which specifies when to start
5407 Select mode instead of Visual mode, when a selection is started.
5408 Possible values:
5409 mouse when using the mouse
5410 key when using shifted special keys
5411 cmd when using "v", "V" or CTRL-V
5412 See |Select-mode|.
5413 The 'selectmode' option is set by the |:behave| command.
5414
5415 *'sessionoptions'* *'ssop'*
5416'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5417 help,options,winsize")
5418 global
5419 {not in Vi}
5420 {not available when compiled without the +mksession
5421 feature}
5422 Changes the effect of the |:mksession| command. It is a comma
5423 separated list of words. Each word enables saving and restoring
5424 something:
5425 word save and restore ~
5426 blank empty windows
5427 buffers hidden and unloaded buffers, not just those in windows
5428 curdir the current directory
5429 folds manually created folds, opened/closed folds and local
5430 fold options
5431 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005432 and contain at least one lowercase letter. Only
5433 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 help the help window
5435 localoptions options and mappings local to a window or buffer (not
5436 global values for local options)
5437 options all options and mappings (also global values for local
5438 options)
5439 resize size of the Vim window: 'lines' and 'columns'
5440 sesdir the directory in which the session file is located
5441 will become the current directory (useful with
5442 projects accessed over a network from different
5443 systems)
5444 slash backslashes in file names replaced with forward
5445 slashes
5446 unix with Unix end-of-line format (single <NL>), even when
5447 on Windows or DOS
5448 winpos position of the whole Vim window
5449 winsize window sizes
5450
5451 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005452 There is no option to include tab pages yet, only the current tab page
5453 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 When "curdir" nor "sesdir" is included, file names are stored with
5455 absolute paths.
5456 "slash" and "unix" are useful on Windows when sharing session files
5457 with Unix. The Unix version of Vim cannot source dos format scripts,
5458 but the Windows version of Vim can source unix format scripts.
5459
5460 *'shell'* *'sh'* *E91*
5461'shell' 'sh' string (default $SHELL or "sh",
5462 MS-DOS and Win32: "command.com" or
5463 "cmd.exe", OS/2: "cmd")
5464 global
5465 Name of the shell to use for ! and :! commands. When changing the
5466 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5467 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005468 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 See |option-backslash| about including spaces and backslashes.
5470 Environment variables are expanded |:set_env|.
5471 If the name of the shell contains a space, you might need to enclose
5472 it in quotes. Example: >
5473 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5474< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005475 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 "-f" is not inside the quotes, because it is not part of the command
5477 name. And Vim automagically recognizes the backslashes that are path
5478 separators.
5479 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5480 variable to change the way external commands are executed. See the
5481 libc.inf file of DJGPP.
5482 Under MS-Windows, when the executable ends in ".com" it must be
5483 included. Thus setting the shell to "command.com" or "4dos.com"
5484 works, but "command" and "4dos" do not work for all commands (e.g.,
5485 filtering).
5486 For unknown reasons, when using "4dos.com" the current directory is
5487 changed to "C:\". To avoid this set 'shell' like this: >
5488 :set shell=command.com\ /c\ 4dos
5489< This option cannot be set from a |modeline| or in the |sandbox|, for
5490 security reasons.
5491
5492 *'shellcmdflag'* *'shcf'*
5493'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5494 does not contain "sh" somewhere: "/c")
5495 global
5496 {not in Vi}
5497 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5498 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5499 systems, the default is set according to the value of 'shell', to
5500 reduce the need to set this option by the user. It's not used for
5501 OS/2 (EMX figures this out itself). See |option-backslash| about
5502 including spaces and backslashes. See |dos-shell|.
5503 This option cannot be set from a |modeline| or in the |sandbox|, for
5504 security reasons.
5505
5506 *'shellpipe'* *'sp'*
5507'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5508 global
5509 {not in Vi}
5510 {not available when compiled without the |+quickfix|
5511 feature}
5512 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005513 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 including spaces and backslashes.
5515 The name of the temporary file can be represented by "%s" if necessary
5516 (the file name is appended automatically if no %s appears in the value
5517 of this option).
5518 For the Amiga and MS-DOS the default is ">". The output is directly
5519 saved in a file and not echoed to the screen.
5520 For Unix the default it "| tee". The stdout of the compiler is saved
5521 in a file and echoed to the screen. If the 'shell' option is "csh" or
5522 "tcsh" after initializations, the default becomes "|& tee". If the
5523 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5524 "2>&1| tee". This means that stderr is also included.
5525 The initialization of this option is done after reading the ".vimrc"
5526 and the other initializations, so that when the 'shell' option is set
5527 there, the 'shellpipe' option changes automatically, unless it was
5528 explicitly set before.
5529 When 'shellpipe' is set to an empty string, no redirection of the
5530 ":make" output will be done. This is useful if you use a 'makeprg'
5531 that writes to 'makeef' by itself. If you want no piping, but do
5532 want to include the 'makeef', set 'shellpipe' to a single space.
5533 Don't forget to precede the space with a backslash: ":set sp=\ ".
5534 In the future pipes may be used for filtering and this option will
5535 become obsolete (at least for Unix).
5536 This option cannot be set from a |modeline| or in the |sandbox|, for
5537 security reasons.
5538
5539 *'shellquote'* *'shq'*
5540'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5541 contains "sh" somewhere: "\"")
5542 global
5543 {not in Vi}
5544 Quoting character(s), put around the command passed to the shell, for
5545 the "!" and ":!" commands. The redirection is kept outside of the
5546 quoting. See 'shellxquote' to include the redirection. It's
5547 probably not useful to set both options.
5548 This is an empty string by default. Only known to be useful for
5549 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5550 or bash, where it should be "\"". The default is adjusted according
5551 the value of 'shell', to reduce the need to set this option by the
5552 user. See |dos-shell|.
5553 This option cannot be set from a |modeline| or in the |sandbox|, for
5554 security reasons.
5555
5556 *'shellredir'* *'srr'*
5557'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5558 global
5559 {not in Vi}
5560 String to be used to put the output of a filter command in a temporary
5561 file. See also |:!|. See |option-backslash| about including spaces
5562 and backslashes.
5563 The name of the temporary file can be represented by "%s" if necessary
5564 (the file name is appended automatically if no %s appears in the value
5565 of this option).
5566 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5567 or "zsh" during initializations, the default becomes ">&". If the
5568 'shell' option is "sh", "ksh" or "bash" the default becomes
5569 ">%s 2>&1". This means that stderr is also included.
5570 For Win32, the Unix checks are done and additionally "cmd" is checked
5571 for, which makes the default ">%s 2>&1". Also, the same names with
5572 ".exe" appended are checked for.
5573 The initialization of this option is done after reading the ".vimrc"
5574 and the other initializations, so that when the 'shell' option is set
5575 there, the 'shellredir' option changes automatically unless it was
5576 explicitly set before.
5577 In the future pipes may be used for filtering and this option will
5578 become obsolete (at least for Unix).
5579 This option cannot be set from a |modeline| or in the |sandbox|, for
5580 security reasons.
5581
5582 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5583'shellslash' 'ssl' boolean (default off)
5584 global
5585 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5586 When set, a forward slash is used when expanding file names. This is
5587 useful when a Unix-like shell is used instead of command.com or
5588 cmd.exe. Backward slashes can still be typed, but they are changed to
5589 forward slashes by Vim.
5590 Note that setting or resetting this option has no effect for some
5591 existing file names, thus this option needs to be set before opening
5592 any file for best results. This might change in the future.
5593 'shellslash' only works when a backslash can be used as a path
5594 separator. To test if this is so use: >
5595 if exists('+shellslash')
5596<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005597 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5598'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5599 global
5600 {not in Vi}
5601 When on, use temp files for shell commands. When off use a pipe.
5602 When using a pipe is not possible temp files are used anyway.
5603 Currently a pipe is only supported on Unix. You can check it with: >
5604 :if has("filterpipe")
5605< The advantage of using a pipe is that nobody can read the temp file
5606 and the 'shell' command does not need to support redirection.
5607 The advantage of using a temp file is that the file type and encoding
5608 can be detected.
5609 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5610 |FilterWritePost| autocommands event are not triggered when
5611 'shelltemp' is off.
5612
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 *'shelltype'* *'st'*
5614'shelltype' 'st' number (default 0)
5615 global
5616 {not in Vi} {only for the Amiga}
5617 On the Amiga this option influences the way how the commands work
5618 which use a shell.
5619 0 and 1: always use the shell
5620 2 and 3: use the shell only to filter lines
5621 4 and 5: use shell only for ':sh' command
5622 When not using the shell, the command is executed directly.
5623
5624 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5625 1 and 3: use "shell cmd" to start external commands
5626
5627 *'shellxquote'* *'sxq'*
5628'shellxquote' 'sxq' string (default: "";
5629 for Win32, when 'shell' contains "sh"
5630 somewhere: "\""
5631 for Unix, when using system(): "\"")
5632 global
5633 {not in Vi}
5634 Quoting character(s), put around the command passed to the shell, for
5635 the "!" and ":!" commands. Includes the redirection. See
5636 'shellquote' to exclude the redirection. It's probably not useful
5637 to set both options.
5638 This is an empty string by default. Known to be useful for
5639 third-party shells when using the Win32 version, such as the MKS Korn
5640 Shell or bash, where it should be "\"". The default is adjusted
5641 according the value of 'shell', to reduce the need to set this option
5642 by the user. See |dos-shell|.
5643 This option cannot be set from a |modeline| or in the |sandbox|, for
5644 security reasons.
5645
5646 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5647'shiftround' 'sr' boolean (default off)
5648 global
5649 {not in Vi}
5650 Round indent to multiple of 'shiftwidth'. Applies to > and <
5651 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5652 a multiple of 'shiftwidth' (this is Vi compatible).
5653 NOTE: This option is reset when 'compatible' is set.
5654
5655 *'shiftwidth'* *'sw'*
5656'shiftwidth' 'sw' number (default 8)
5657 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005658 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 |'cindent'|, |>>|, |<<|, etc.
5660
5661 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005662'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5663 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 global
5665 {not in Vi}
5666 This option helps to avoid all the |hit-enter| prompts caused by file
5667 messages, for example with CTRL-G, and to avoid some other messages.
5668 It is a list of flags:
5669 flag meaning when present ~
5670 f use "(3 of 5)" instead of "(file 3 of 5)"
5671 i use "[noeol]" instead of "[Incomplete last line]"
5672 l use "999L, 888C" instead of "999 lines, 888 characters"
5673 m use "[+]" instead of "[Modified]"
5674 n use "[New]" instead of "[New File]"
5675 r use "[RO]" instead of "[readonly]"
5676 w use "[w]" instead of "written" for file write message
5677 and "[a]" instead of "appended" for ':w >> file' command
5678 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5679 "[unix format]" and "[mac]" instead of "[mac format]".
5680 a all of the above abbreviations
5681
5682 o overwrite message for writing a file with subsequent message
5683 for reading a file (useful for ":wn" or when 'autowrite' on)
5684 O message for reading a file overwrites any previous message.
5685 Also for quickfix message (e.g., ":cn").
5686 s don't give "search hit BOTTOM, continuing at TOP" or "search
5687 hit TOP, continuing at BOTTOM" messages
5688 t truncate file message at the start if it is too long to fit
5689 on the command-line, "<" will appear in the left most column.
5690 Ignored in Ex mode.
5691 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005692 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 Ignored in Ex mode.
5694 W don't give "written" or "[w]" when writing a file
5695 A don't give the "ATTENTION" message when an existing swap file
5696 is found.
5697 I don't give the intro message when starting Vim |:intro|.
5698
5699 This gives you the opportunity to avoid that a change between buffers
5700 requires you to hit <Enter>, but still gives as useful a message as
5701 possible for the space available. To get the whole message that you
5702 would have got with 'shm' empty, use ":file!"
5703 Useful values:
5704 shm= No abbreviation of message.
5705 shm=a Abbreviation, but no loss of information.
5706 shm=at Abbreviation, and truncate message when necessary.
5707
5708 NOTE: This option is set to the Vi default value when 'compatible' is
5709 set and to the Vim default value when 'compatible' is reset.
5710
5711 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5712'shortname' 'sn' boolean (default off)
5713 local to buffer
5714 {not in Vi, not in MS-DOS versions}
5715 Filenames are assumed to be 8 characters plus one extension of 3
5716 characters. Multiple dots in file names are not allowed. When this
5717 option is on, dots in file names are replaced with underscores when
5718 adding an extension (".~" or ".swp"). This option is not available
5719 for MS-DOS, because then it would always be on. This option is useful
5720 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5721 or crossdos. When running the Win32 GUI version under Win32s, this
5722 option is always on by default.
5723
5724 *'showbreak'* *'sbr'* *E595*
5725'showbreak' 'sbr' string (default "")
5726 global
5727 {not in Vi}
5728 {not available when compiled without the |+linebreak|
5729 feature}
5730 String to put at the start of lines that have been wrapped. Useful
5731 values are "> " or "+++ ".
5732 Only printable single-cell characters are allowed, excluding <Tab> and
5733 comma (in a future version the comma might be used to separate the
5734 part that is shown at the end and at the start of a line).
5735 The characters are highlighted according to the '@' flag in
5736 'highlight'.
5737 Note that tabs after the showbreak will be displayed differently.
5738 If you want the 'showbreak' to appear in between line numbers, add the
5739 "n" flag to 'cpoptions'.
5740
5741 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5742'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5743 off)
5744 global
5745 {not in Vi}
5746 {not available when compiled without the
5747 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005748 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 terminal is slow.
5750 In Visual mode the size of the selected area is shown:
5751 - When selecting characters within a line, the number of characters.
5752 - When selecting more than one line, the number of lines.
5753 - When selecting a block, the size in screen characters: linesxcolumns.
5754 NOTE: This option is set to the Vi default value when 'compatible' is
5755 set and to the Vim default value when 'compatible' is reset.
5756
5757 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5758'showfulltag' 'sft' boolean (default off)
5759 global
5760 {not in Vi}
5761 When completing a word in insert mode (see |ins-completion|) from the
5762 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005763 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 matched a C function, you can see a template for what arguments are
5765 required (coding style permitting).
5766
5767 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5768'showmatch' 'sm' boolean (default off)
5769 global
5770 When a bracket is inserted, briefly jump to the matching one. The
5771 jump is only done if the match can be seen on the screen. The time to
5772 show the match can be set with 'matchtime'.
5773 A Beep is given if there is no match (no matter if the match can be
5774 seen or not). This option is reset when the 'paste' option is set.
5775 When the 'm' flag is not included in 'cpoptions', typing a character
5776 will immediately move the cursor back to where it belongs.
5777 See the "sm" field in 'guicursor' for setting the cursor shape and
5778 blinking when showing the match.
5779 The 'matchpairs' option can be used to specify the characters to show
5780 matches for. 'rightleft' and 'revins' are used to look for opposite
5781 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005782 Also see the matchparen plugin for highlighting the match when moving
5783 around |pi_paren.txt|.
5784 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785
5786 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5787'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5788 global
5789 If in Insert, Replace or Visual mode put a message on the last line.
5790 Use the 'M' flag in 'highlight' to set the type of highlighting for
5791 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005792 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 doesn't mean XIM is really active, especially when 'imactivatekey' is
5794 not set.
5795 NOTE: This option is set to the Vi default value when 'compatible' is
5796 set and to the Vim default value when 'compatible' is reset.
5797
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005798 *'showtabline'* *'stal'*
5799'showtabline' 'stal' number (default 1)
5800 global
5801 {not in Vi}
5802 {not available when compiled without the +windows
5803 feature}
5804 The value of this option specifies when the line with tab page labels
5805 will be displayed:
5806 0: never
5807 1: only if there are at least two tab pages
5808 2: always
5809 This is both for the GUI and non-GUI implementation of the tab pages
5810 line.
5811 See |tab-page| for more information about tab pages.
5812
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 *'sidescroll'* *'ss'*
5814'sidescroll' 'ss' number (default 0)
5815 global
5816 {not in Vi}
5817 The minimal number of columns to scroll horizontally. Used only when
5818 the 'wrap' option is off and the cursor is moved off of the screen.
5819 When it is zero the cursor will be put in the middle of the screen.
5820 When using a slow terminal set it to a large number or 0. When using
5821 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5822 commands.
5823
5824 *'sidescrolloff'* *'siso'*
5825'sidescrolloff' 'siso' number (default 0)
5826 global
5827 {not in Vi}
5828 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005829 right of the cursor if 'nowrap' is set. Setting this option to a
5830 value greater than 0 while having |'sidescroll'| also at a non-zero
5831 value makes some context visible in the line you are scrolling in
5832 horizontally (except at beginning of the line). Setting this option
5833 to a large value (like 999) has the effect of keeping the cursor
5834 horizontally centered in the window, as long as one does not come too
5835 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 NOTE: This option is set to 0 when 'compatible' is set.
5837
5838 Example: Try this together with 'sidescroll' and 'listchars' as
5839 in the following example to never allow the cursor to move
5840 onto the "extends" character:
5841
5842 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5843 :set sidescrolloff=1
5844
5845
5846 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5847'smartcase' 'scs' boolean (default off)
5848 global
5849 {not in Vi}
5850 Override the 'ignorecase' option if the search pattern contains upper
5851 case characters. Only used when the search pattern is typed and
5852 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005853 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5855 recalling the search pattern from history and hitting <Enter>.
5856 NOTE: This option is reset when 'compatible' is set.
5857
5858 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5859'smartindent' 'si' boolean (default off)
5860 local to buffer
5861 {not in Vi}
5862 {not available when compiled without the
5863 |+smartindent| feature}
5864 Do smart autoindenting when starting a new line. Works for C-like
5865 programs, but can also be used for other languages. 'cindent' does
5866 something like this, works better in most cases, but is more strict,
5867 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5868 'indentexpr' is a more advanced alternative.
5869 Normally 'autoindent' should also be on when using 'smartindent'.
5870 An indent is automatically inserted:
5871 - After a line ending in '{'.
5872 - After a line starting with a keyword from 'cinwords'.
5873 - Before a line starting with '}' (only with the "O" command).
5874 When typing '}' as the first character in a new line, that line is
5875 given the same indent as the matching '{'.
5876 When typing '#' as the first character in a new line, the indent for
5877 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005878 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5880 When using the ">>" command, lines starting with '#' are not shifted
5881 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005882 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 is set smart indenting is disabled.
5884
5885 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5886'smarttab' 'sta' boolean (default off)
5887 global
5888 {not in Vi}
5889 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005890 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5891 <BS> will delete a 'shiftwidth' worth of space at the start of the
5892 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005893 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005894 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5895 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5897 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005898 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 NOTE: This option is reset when 'compatible' is set.
5900
5901 *'softtabstop'* *'sts'*
5902'softtabstop' 'sts' number (default 0)
5903 local to buffer
5904 {not in Vi}
5905 Number of spaces that a <Tab> counts for while performing editing
5906 operations, like inserting a <Tab> or using <BS>. It "feels" like
5907 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5908 used. This is useful to keep the 'ts' setting at its standard value
5909 of 8, while being able to edit like it is set to 'sts'. However,
5910 commands like "x" still work on the actual characters.
5911 When 'sts' is zero, this feature is off.
5912 'softtabstop' is set to 0 when the 'paste' option is set.
5913 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5914 spaces is minimized by using <Tab>s.
5915 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5916 set.
5917 NOTE: This option is set to 0 when 'compatible' is set.
5918
Bram Moolenaar217ad922005-03-20 22:37:15 +00005919 *'spell'* *'nospell'*
5920'spell' boolean (default off)
5921 local to window
5922 {not in Vi}
5923 {not available when compiled without the |+syntax|
5924 feature}
5925 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005926 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005927
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005928 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005929'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005930 local to buffer
5931 {not in Vi}
5932 {not available when compiled without the |+syntax|
5933 feature}
5934 Pattern to locate the end of a sentence. The following word will be
5935 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005936 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005937 When this check is not wanted make this option empty.
5938 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005939 Be careful with special characters, see |option-backslash| about
5940 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005941 To set this option automatically depending on the language, see
5942 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005943
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005944 *'spellfile'* *'spf'*
5945'spellfile' 'spf' string (default empty)
5946 local to buffer
5947 {not in Vi}
5948 {not available when compiled without the |+syntax|
5949 feature}
5950 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005951 commands. It must end in ".{encoding}.add". You need to include the
5952 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005953 *E765*
5954 It may also be a comma separated list of names. A count before the
5955 |zg| and |zw| commands can be used to access each. This allows using
5956 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005957 When a word is added while this option is empty Vim will set it for
5958 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005959 writable and the first language name that appears in 'spelllang',
5960 ignoring the region.
5961 The resulting ".spl" file will be used for spell checking, it does not
5962 have to appear in 'spelllang'.
5963 Normally one file is used for all regions, but you can add the region
5964 name if you want to. However, it will then only be used when
5965 'spellfile' is set to it, for entries in 'spelllang' only files
5966 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005967 This option cannot be set from a |modeline| or in the |sandbox|, for
5968 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005969
Bram Moolenaar217ad922005-03-20 22:37:15 +00005970 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005971'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005972 local to buffer
5973 {not in Vi}
5974 {not available when compiled without the |+syntax|
5975 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005976 A comma separated list of word list names. When the 'spell' option is
5977 on spellchecking will be done for these languages. Example: >
5978 set spelllang=en_us,nl,medical
5979< This means US English, Dutch and medical words are recognized. Words
5980 that are not recognized will be highlighted.
5981 The word list name must not include a comma or dot. Using a dash is
5982 recommended to separate the two letter language name from a
5983 specification. Thus "en-rare" is used for rare English words.
5984 A region name must come last and have the form "_xx", where "xx" is
5985 the two-letter, lower case region name. You can use more than one
5986 region by listing them: "en_us,en_ca" supports both US and Canadian
5987 English, but not words specific for Australia, New Zealand or Great
5988 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005989 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005990 As a special case the name of a .spl file can be given as-is. The
5991 first "_xx" in the name is removed and used as the region name
5992 (_xx is an underscore, two letters and followed by a non-letter).
5993 This is mainly for testing purposes. You must make sure the correct
5994 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005995 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005996 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5997 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005998 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005999
Bram Moolenaar98692072006-02-04 00:57:42 +00006000 If the |spellfile.vim| plugin is active and you use a language name
6001 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6002 will ask you if you want to download the file.
6003
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006004 After this option has been set successfully, Vim will source the files
6005 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006006 up to the first comma, dot or underscore.
6007 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006008
6009
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006010 *'spellsuggest'* *'sps'*
6011'spellsuggest' 'sps' string (default "best")
6012 global
6013 {not in Vi}
6014 {not available when compiled without the |+syntax|
6015 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006016 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006017 the |spellsuggest()| function. This is a comma-separated list of
6018 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006019
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006020 best Internal method that works best for English. Finds
6021 changes like "fast" and uses a bit of sound-a-like
6022 scoring to improve the ordering.
6023
6024 double Internal method that uses two methods and mixes the
6025 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006026 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006027 word. That only works when the language specifies
6028 sound folding. Can be slow and doesn't always give
6029 better results.
6030
6031 fast Internal method that only checks for simple changes:
6032 character inserts/deletes/swaps. Works well for
6033 simple typing mistakes.
6034
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006035 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006036 Not used for |spellsuggest()|. The number of
6037 suggestions is never more than the value of 'lines'
6038 minus two.
6039
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006040 file:{filename} Read file {filename}, which must have two columns,
6041 separated by a slash. The first column contains the
6042 bad word, the second column the suggested good word.
6043 Example:
6044 theribal/terrible ~
6045 Use this for common mistakes that do not appear at the
6046 top of the suggestion list with the internal methods.
6047 Lines without a slash are ignored, use this for
6048 comments.
6049 The file is used for all languages.
6050
6051 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6052 trouble with spaces. |v:val| holds the badly spelled
6053 word. The expression must evaluate to a List of
6054 Lists, each with a suggestion and a score.
6055 Example:
6056 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006057 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006058 internal methods use. A lower score is better.
6059 This may invoke |spellsuggest()| if you temporarily
6060 set 'spellsuggest' to exclude the "expr:" part.
6061 Errors are silently ignored, unless you set the
6062 'verbose' option to a non-zero value.
6063
6064 Only one of "best", "double" or "fast" may be used. The others may
6065 appear several times in any order. Example: >
6066 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6067<
6068 This option cannot be set from a |modeline| or in the |sandbox|, for
6069 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006070
6071
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6073'splitbelow' 'sb' boolean (default off)
6074 global
6075 {not in Vi}
6076 {not available when compiled without the +windows
6077 feature}
6078 When on, splitting a window will put the new window below the current
6079 one. |:split|
6080
6081 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6082'splitright' 'spr' boolean (default off)
6083 global
6084 {not in Vi}
6085 {not available when compiled without the +vertsplit
6086 feature}
6087 When on, splitting a window will put the new window right of the
6088 current one. |:vsplit|
6089
6090 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6091'startofline' 'sol' boolean (default on)
6092 global
6093 {not in Vi}
6094 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006095 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006096 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006097 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 with a linewise operator, with "%" with a count and to buffer changing
6099 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6100 only has a line number, e.g., ":25" or ":+".
6101 In case of buffer changing commands the cursor is placed at the column
6102 where it was the last time the buffer was edited.
6103 NOTE: This option is set when 'compatible' is set.
6104
6105 *'statusline'* *'stl'* *E540* *E541* *E542*
6106'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006107 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 {not in Vi}
6109 {not available when compiled without the |+statusline|
6110 feature}
6111 When nonempty, this option determines the content of the status line.
6112 Also see |status-line|.
6113
6114 The option consists of printf style '%' items interspersed with
6115 normal text. Each status line item is of the form:
6116 %-0{minwid}.{maxwid}{item}
6117 All fields except the {item} is optional. A single percent sign can
6118 be given as "%%". Up to 80 items can be specified.
6119
Bram Moolenaar238a5642006-02-21 22:12:05 +00006120 When the option starts with "%!" then it is used as an expression,
6121 evaluated and the result is used as the option value. Example: >
6122 :set statusline=%!MyStatusLine()
6123< The result can contain %{} items that will be evaluated too.
6124
6125 When there is error while evaluating the option then it will be made
6126 empty to avoid further errors. Otherwise screen updating would loop.
6127
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 Note that the only effect of 'ruler' when this option is set (and
6129 'laststatus' is 2) is controlling the output of |CTRL-G|.
6130
6131 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006132 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006134 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 minwid Minimum width of the item, padding as set by '-' & '0'.
6136 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006137 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 on the left for text items. Numeric items will be
6139 shifted down to maxwid-2 digits followed by '>'number
6140 where number is the amount of missing digits, much like
6141 an exponential notation.
6142 item A one letter code as described below.
6143
6144 Following is a description of the possible statusline items. The
6145 second character in "item" is the type:
6146 N for number
6147 S for string
6148 F for flags as described below
6149 - not applicable
6150
6151 item meaning ~
6152 f S Path to the file in the buffer, relative to current directory.
6153 F S Full path to the file in the buffer.
6154 t S File name (tail) of file in the buffer.
6155 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6156 M F Modified flag, text is ",+" or ",-".
6157 r F Readonly flag, text is " [RO]".
6158 R F Readonly flag, text is ",RO".
6159 h F Help buffer flag, text is " [help]".
6160 H F Help buffer flag, text is ",HLP".
6161 w F Preview window flag, text is " [Preview]".
6162 W F Preview window flag, text is ",PRV".
6163 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6164 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6165 {not available when compiled without |+autocmd| feature}
6166 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6167 being used: "<keymap>"
6168 n N Buffer number.
6169 b N Value of byte under cursor.
6170 B N As above, in hexadecimal.
6171 o N Byte number in file of byte under cursor, first byte is 1.
6172 Mnemonic: Offset from start of file (with one added)
6173 {not available when compiled without |+byte_offset| feature}
6174 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006175 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 l N Line number.
6177 L N Number of lines in buffer.
6178 c N Column number.
6179 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006180 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 p N Percentage through file in lines as in |CTRL-G|.
6182 P S Percentage through file of displayed window. This is like the
6183 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006184 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006186 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006187 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 ( - Start of item group. Can be used for setting the width and
6189 alignment of a section. Must be followed by %) somewhere.
6190 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006191 T N For 'tabline': start of tab page N label. Use %T after the last
6192 label. This information is used for mouse clicks.
6193 X N For 'tabline': start of close tab N label. Use %X after the
6194 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6195 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 < - Where to truncate line if too long. Default is at the start.
6197 No width fields allowed.
6198 = - Separation point between left and right aligned items.
6199 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006200 # - Set highlight group. The name must follow and then a # again.
6201 Thus use %#HLname# for highlight group HLname. The same
6202 highlighting is used, also for the statusline of non-current
6203 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006205 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 The difference between User{N} and StatusLine will be applied
6207 to StatusLineNC for the statusline of non-current windows.
6208 The number N must be between 1 and 9. See |hl-User1..9|
6209
6210 Display of flags are controlled by the following heuristic:
6211 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006212 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 with a space it is assumed that it wants to separate itself from
6214 anything but other flags. That is: A leading comma is removed if the
6215 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006216 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 make a nice display when flags are used like in the examples below.
6218
Bram Moolenaar582fd852005-03-28 20:58:01 +00006219 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 not set) and a minwid is not set for the group, the whole group will
6221 become empty. This will make a group like the following disappear
6222 completely from the statusline when none of the flags are set. >
6223 :set statusline=...%(\ [%M%R%H]%)...
6224<
6225 Beware that an expression is evaluated each and every time the status
6226 line is displayed. The current buffer and current window will be set
6227 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006228 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006230 real current buffer.
6231
6232 The 'statusline' option may be evaluated in the |sandbox|, see
6233 |sandbox-option|.
6234
6235 It is not allowed to change text or jump to another window while
6236 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237
6238 If the statusline is not updated when you want it (e.g., after setting
6239 a variable that's used in an expression), you can force an update by
6240 setting an option without changing its value. Example: >
6241 :let &ro = &ro
6242
6243< A result of all digits is regarded a number for display purposes.
6244 Otherwise the result is taken as flag text and applied to the rules
6245 described above.
6246
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006247 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6249 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6250
6251 Examples:
6252 Emulate standard status line with 'ruler' set >
6253 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6254< Similar, but add ASCII value of char under the cursor (like "ga") >
6255 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6256< Display byte count and byte value, modified flag in red. >
6257 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6258 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6259< Display a ,GZ flag if a compressed file is loaded >
6260 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6261< In the |:autocmd|'s: >
6262 :let b:gzflag = 1
6263< And: >
6264 :unlet b:gzflag
6265< And define this function: >
6266 :function VarExists(var, val)
6267 : if exists(a:var) | return a:val | else | return '' | endif
6268 :endfunction
6269<
6270 *'suffixes'* *'su'*
6271'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6272 global
6273 {not in Vi}
6274 Files with these suffixes get a lower priority when multiple files
6275 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006276 suffixes. Spaces after the comma are ignored. A dot is also seen as
6277 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 separator, precede it with a backslash (see |option-backslash| about
6279 including spaces and backslashes).
6280 See 'wildignore' for completely ignoring files.
6281 The use of |:set+=| and |:set-=| is preferred when adding or removing
6282 suffixes from the list. This avoids problems when a future version
6283 uses another default.
6284
6285 *'suffixesadd'* *'sua'*
6286'suffixesadd' 'sua' string (default "")
6287 local to buffer
6288 {not in Vi}
6289 {not available when compiled without the
6290 |+file_in_path| feature}
6291 Comma separated list of suffixes, which are used when searching for a
6292 file for the "gf", "[I", etc. commands. Example: >
6293 :set suffixesadd=.java
6294<
6295 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6296'swapfile' 'swf' boolean (default on)
6297 local to buffer
6298 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006299 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 swapfile is not wanted for a specific buffer. For example, with
6301 confidential information that even root must not be able to access.
6302 Careful: All text will be in memory:
6303 - Don't use this for big files.
6304 - Recovery will be impossible!
6305 A swapfile will only be present when |'updatecount'| is non-zero and
6306 'swapfile' is set.
6307 When 'swapfile' is reset, the swap file for the current buffer is
6308 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6309 non-zero, a swap file is immediately created.
6310 Also see |swap-file| and |'swapsync'|.
6311
6312 This option is used together with 'bufhidden' and 'buftype' to
6313 specify special kinds of buffers. See |special-buffers|.
6314
6315 *'swapsync'* *'sws'*
6316'swapsync' 'sws' string (default "fsync")
6317 global
6318 {not in Vi}
6319 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006320 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 When this option is empty parts of the swap file may be in memory and
6322 not written to disk. When the system crashes you may lose more work.
6323 On Unix the system does a sync now and then without Vim asking for it,
6324 so the disadvantage of setting this option off is small. On some
6325 systems the swap file will not be written at all. For a unix system
6326 setting it to "sync" will use the sync() call instead of the default
6327 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006328 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329
6330 *'switchbuf'* *'swb'*
6331'switchbuf' 'swb' string (default "")
6332 global
6333 {not in Vi}
6334 This option controls the behavior when switching between buffers.
6335 Possible values (comma separated list):
6336 useopen If included, jump to the first open window that
6337 contains the specified buffer (if there is one).
6338 Otherwise: Do not examine other windows.
6339 This setting is checked with |quickfix| commands, when
6340 jumping to errors (":cc", ":cn", "cp", etc.). It is
6341 also used in all buffer related split commands, for
6342 example ":sbuffer", ":sbnext", or ":sbrewind".
6343 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006344 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 Supported in |quickfix| commands that display errors.
6346
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006347 *'synmaxcol'* *'smc'*
6348'synmaxcol' 'smc' number (default 3000)
6349 local to buffer
6350 {not in Vi}
6351 {not available when compiled without the |+syntax|
6352 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006353 Maximum column in which to search for syntax items. In long lines the
6354 text after this column is not highlighted and following lines may not
6355 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006356 This helps to avoid very slow redrawing for an XML file that is one
6357 long line.
6358 Set to zero to remove the limit.
6359
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 *'syntax'* *'syn'*
6361'syntax' 'syn' string (default empty)
6362 local to buffer
6363 {not in Vi}
6364 {not available when compiled without the |+syntax|
6365 feature}
6366 When this option is set, the syntax with this name is loaded, unless
6367 syntax highlighting has been switched off with ":syntax off".
6368 Otherwise this option does not always reflect the current syntax (the
6369 b:current_syntax variable does).
6370 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006371 not automatically recognized. Example, in an IDL file:
6372 /* vim: set syntax=idl : */ ~
6373 When a dot appears in the value then this separates two filetype
6374 names. Example:
6375 /* vim: set syntax=c.doxygen : */ ~
6376 This will use the "c" syntax first, then the "doxygen" syntax.
6377 Note that the second one must be prepared to be loaded as an addition,
6378 otherwise it will be skipped. More than one dot may appear.
6379 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 :set syntax=OFF
6381< To switch syntax highlighting on according to the current value of the
6382 'filetype' option: >
6383 :set syntax=ON
6384< What actually happens when setting the 'syntax' option is that the
6385 Syntax autocommand event is triggered with the value as argument.
6386 This option is not copied to another buffer, independent of the 's' or
6387 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006388 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006390 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006391'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006392 global
6393 {not in Vi}
6394 {not available when compiled without the +windows
6395 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006396 When nonempty, this option determines the content of the tab pages
6397 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006398 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006399
6400 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006401 option and only when there is no GUI tab line. When 'e' is in
6402 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6403 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006404
6405 The value is evaluated like with 'statusline'. You can use
6406 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006407 the text to be displayed. Use "%1T" for the first label, "%2T" for
6408 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006409
6410 Keep in mind that only one of the tab pages is the current one, others
6411 are invisible and you can't jump to their windows.
6412
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006413
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006414 *'tabpagemax'* *'tpm'*
6415'tabpagemax' 'tpm' number (default 10)
6416 global
6417 {not in Vi}
6418 {not available when compiled without the +windows
6419 feature}
6420 Maximum number of tab pages to be opened by the |-p| command line
6421 argument or the ":tab all" command. |tabpage|
6422
6423
6424 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425'tabstop' 'ts' number (default 8)
6426 local to buffer
6427 Number of spaces that a <Tab> in the file counts for. Also see
6428 |:retab| command, and 'softtabstop' option.
6429
6430 Note: Setting 'tabstop' to any other value than 8 can make your file
6431 appear wrong in many places (e.g., when printing it).
6432
6433 There are four main ways to use tabs in Vim:
6434 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6435 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6436 will use a mix of tabs and spaces, but typing Tab and BS will
6437 behave like a tab appears every 4 (or 3) characters.
6438 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6439 'expandtab'. This way you will always insert spaces. The
6440 formatting will never be messed up when 'tabstop' is changed.
6441 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006442 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 works when using Vim to edit the file.
6444 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6445 'noexpandtab'. This should then work (for initial indents only)
6446 for any tabstop setting that people use. It might be nice to have
6447 tabs after the first non-blank inserted as spaces if you do this
6448 though. Otherwise aligned comments will be wrong when 'tabstop' is
6449 changed.
6450
6451 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6452'tagbsearch' 'tbs' boolean (default on)
6453 global
6454 {not in Vi}
6455 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006456 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 searching makes searching for a tag a LOT faster, but a linear search
6458 will find more tags if the tags file wasn't properly sorted.
6459 Vim normally assumes that your tags files are sorted, or indicate that
6460 they are not sorted. Only when this is not the case does the
6461 'tagbsearch' option need to be switched off.
6462
6463 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006464 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 certain files, or retry all files with a linear search. When
6466 'tagbsearch' is off, only a linear search is done.
6467
6468 Linear searching is done anyway, for one file, when Vim finds a line
6469 at the start of the file indicating that it's not sorted: >
6470 !_TAG_FILE_SORTED 0 /some command/
6471< [The whitespace before and after the '0' must be a single <Tab>]
6472
6473 When a binary search was done and no match was found in any of the
6474 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6475 instead of a normal tag name, a retry is done with a linear search.
6476 Tags in unsorted tags files, and matches with different case will only
6477 be found in the retry.
6478
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006479 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 linear search can be avoided for the 'ignorecase' case. Use a value
6481 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6482 case-fold sorted with the -f switch to "sort" in most unices, as in
6483 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6484 5.3 or higher the -f or --fold-case-sort switch can be used for this
6485 as well. Note that case must be folded to uppercase for this to work.
6486
6487 When 'tagbsearch' is off, tags searching is slower when a full match
6488 exists, but faster when no full match exists. Tags in unsorted tags
6489 files may only be found with 'tagbsearch' off.
6490 When the tags file is not sorted, or sorted in a wrong way (not on
6491 ASCII byte value), 'tagbsearch' should be off, or the line given above
6492 must be included in the tags file.
6493 This option doesn't affect commands that find all matching tags (e.g.,
6494 command-line completion and ":help").
6495 {Vi: always uses binary search in some versions}
6496
6497 *'taglength'* *'tl'*
6498'taglength' 'tl' number (default 0)
6499 global
6500 If non-zero, tags are significant up to this number of characters.
6501
6502 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6503'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6504 global
6505 {not in Vi}
6506 If on and using a tag file in another directory, file names in that
6507 tag file are relative to the directory where the tag file is.
6508 NOTE: This option is set to the Vi default value when 'compatible' is
6509 set and to the Vim default value when 'compatible' is reset.
6510
6511 *'tags'* *'tag'* *E433*
6512'tags' 'tag' string (default "./tags,tags", when compiled with
6513 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6514 global or local to buffer |global-local|
6515 Filenames for the tag command, separated by spaces or commas. To
6516 include a space or comma in a file name, precede it with a backslash
6517 (see |option-backslash| about including spaces and backslashes).
6518 When a file name starts with "./", the '.' is replaced with the path
6519 of the current file. But only when the 'd' flag is not included in
6520 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6521 |tags-option|.
6522 "*", "**" and other wildcards can be used to search for tags files in
6523 a directory tree. See |file-searching|. {not available when compiled
6524 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006525 The |tagfiles()| function can be used to get a list of the file names
6526 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6528 files are also supported. They are automatically recognized. The
6529 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6530 differences are ignored (MS-Windows). |emacs-tags|
6531 The use of |:set+=| and |:set-=| is preferred when adding or removing
6532 file names from the list. This avoids problems when a future version
6533 uses another default.
6534 {Vi: default is "tags /usr/lib/tags"}
6535
6536 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6537'tagstack' 'tgst' boolean (default on)
6538 global
6539 {not in all versions of Vi}
6540 When on, the |tagstack| is used normally. When off, a ":tag" or
6541 ":tselect" command with an argument will not push the tag onto the
6542 tagstack. A following ":tag" without an argument, a ":pop" command or
6543 any other command that uses the tagstack will use the unmodified
6544 tagstack, but does change the pointer to the active entry.
6545 Resetting this option is useful when using a ":tag" command in a
6546 mapping which should not change the tagstack.
6547
6548 *'term'* *E529* *E530* *E531*
6549'term' string (default is $TERM, if that fails:
6550 in the GUI: "builtin_gui"
6551 on Amiga: "amiga"
6552 on BeOS: "beos-ansi"
6553 on Mac: "mac-ansi"
6554 on MiNT: "vt52"
6555 on MS-DOS: "pcterm"
6556 on OS/2: "os2ansi"
6557 on Unix: "ansi"
6558 on VMS: "ansi"
6559 on Win 32: "win32")
6560 global
6561 Name of the terminal. Used for choosing the terminal control
6562 characters. Environment variables are expanded |:set_env|.
6563 For example: >
6564 :set term=$TERM
6565< See |termcap|.
6566
6567 *'termbidi'* *'tbidi'*
6568 *'notermbidi'* *'notbidi'*
6569'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6570 global
6571 {not in Vi}
6572 {only available when compiled with the |+arabic|
6573 feature}
6574 The terminal is in charge of Bi-directionality of text (as specified
6575 by Unicode). The terminal is also expected to do the required shaping
6576 that some languages (such as Arabic) require.
6577 Setting this option implies that 'rightleft' will not be set when
6578 'arabic' is set and the value of 'arabicshape' will be ignored.
6579 Note that setting 'termbidi' has the immediate effect that
6580 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6581 This option is reset when the GUI is started.
6582 For further details see |arabic.txt|.
6583
6584 *'termencoding'* *'tenc'*
6585'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6586 Macintosh GUI: "macroman")
6587 global
6588 {only available when compiled with the |+multi_byte|
6589 feature}
6590 {not in Vi}
6591 Encoding used for the terminal. This specifies what character
6592 encoding the keyboard produces and the display will understand. For
6593 the GUI it only applies to the keyboard ('encoding' is used for the
6594 display).
6595 In the Win32 console version the default value is the console codepage
6596 when it differs from the ANSI codepage.
6597 *E617*
6598 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6599 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6600 Any attempts to set a different value will be rejected, and an error
6601 message is shown.
6602 For the Win32 GUI 'termencoding' is not used for typed characters,
6603 because the Win32 system always passes Unicode characters.
6604 When empty, the same encoding is used as for the 'encoding' option.
6605 This is the normal value.
6606 Not all combinations for 'termencoding' and 'encoding' are valid. See
6607 |encoding-table|.
6608 The value for this option must be supported by internal conversions or
6609 iconv(). When this is not possible no conversion will be done and you
6610 will probably experience problems with non-ASCII characters.
6611 Example: You are working with the locale set to euc-jp (Japanese) and
6612 want to edit a UTF-8 file: >
6613 :let &termencoding = &encoding
6614 :set encoding=utf-8
6615< You need to do this when your system has no locale support for UTF-8.
6616
6617 *'terse'* *'noterse'*
6618'terse' boolean (default off)
6619 global
6620 When set: Add 's' flag to 'shortmess' option (this makes the message
6621 for a search that hits the start or end of the file not being
6622 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6623 shortens a lot of messages}
6624
6625 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6626'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6627 global
6628 {not in Vi}
6629 This option is obsolete. Use 'fileformats'.
6630 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6631 set to the default value for the current system. When 'textauto' is
6632 reset, 'fileformats' is made empty.
6633 NOTE: This option is set to the Vi default value when 'compatible' is
6634 set and to the Vim default value when 'compatible' is reset.
6635
6636 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6637'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6638 others: default off)
6639 local to buffer
6640 {not in Vi}
6641 This option is obsolete. Use 'fileformat'.
6642 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6643 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6644 "unix".
6645
6646 *'textwidth'* *'tw'*
6647'textwidth' 'tw' number (default 0)
6648 local to buffer
6649 {not in Vi}
6650 Maximum width of text that is being inserted. A longer line will be
6651 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006652 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6653 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654 'formatoptions' and |ins-textwidth|.
6655 NOTE: This option is set to 0 when 'compatible' is set.
6656
6657 *'thesaurus'* *'tsr'*
6658'thesaurus' 'tsr' string (default "")
6659 global or local to buffer |global-local|
6660 {not in Vi}
6661 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006662 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 the file should contain words with similar meaning, separated by
6664 non-keyword characters (white space is preferred). Maximum line
6665 length is 510 bytes.
6666 To obtain a file to be used here, check out the wordlist FAQ at
6667 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006668 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 after a comma are ignored, otherwise spaces are included in the file
6670 name. See |option-backslash| about using backslashes.
6671 The use of |:set+=| and |:set-=| is preferred when adding or removing
6672 directories from the list. This avoids problems when a future version
6673 uses another default.
6674 Backticks cannot be used in this option for security reasons.
6675
6676 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6677'tildeop' 'top' boolean (default off)
6678 global
6679 {not in Vi}
6680 When on: The tilde command "~" behaves like an operator.
6681 NOTE: This option is reset when 'compatible' is set.
6682
6683 *'timeout'* *'to'* *'notimeout'* *'noto'*
6684'timeout' 'to' boolean (default on)
6685 global
6686 *'ttimeout'* *'nottimeout'*
6687'ttimeout' boolean (default off)
6688 global
6689 {not in Vi}
6690 These two options together determine the behavior when part of a
6691 mapped key sequence or keyboard code has been received:
6692
6693 'timeout' 'ttimeout' action ~
6694 off off do not time out
6695 on on or off time out on :mappings and key codes
6696 off on time out on key codes
6697
6698 If both options are off, Vim will wait until either the complete
6699 mapping or key sequence has been received, or it is clear that there
6700 is no mapping or key sequence for the received characters. For
6701 example: if you have mapped "vl" and Vim has received 'v', the next
6702 character is needed to see if the 'v' is followed by an 'l'.
6703 When one of the options is on, Vim will wait for about 1 second for
6704 the next character to arrive. After that the already received
6705 characters are interpreted as single characters. The waiting time can
6706 be changed with the 'timeoutlen' option.
6707 On slow terminals or very busy systems timing out may cause
6708 malfunctioning cursor keys. If both options are off, Vim waits
6709 forever after an entered <Esc> if there are key codes that start
6710 with <Esc>. You will have to type <Esc> twice. If you do not have
6711 problems with key codes, but would like to have :mapped key
6712 sequences not timing out in 1 second, set the 'ttimeout' option and
6713 reset the 'timeout' option.
6714
6715 NOTE: 'ttimeout' is reset when 'compatible' is set.
6716
6717 *'timeoutlen'* *'tm'*
6718'timeoutlen' 'tm' number (default 1000)
6719 global
6720 {not in all versions of Vi}
6721 *'ttimeoutlen'* *'ttm'*
6722'ttimeoutlen' 'ttm' number (default -1)
6723 global
6724 {not in Vi}
6725 The time in milliseconds that is waited for a key code or mapped key
6726 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6727 when part of a command has been typed.
6728 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6729 different timeout value for key codes is desired set 'ttimeoutlen' to
6730 a non-negative number.
6731
6732 ttimeoutlen mapping delay key code delay ~
6733 < 0 'timeoutlen' 'timeoutlen'
6734 >= 0 'timeoutlen' 'ttimeoutlen'
6735
6736 The timeout only happens when the 'timeout' and 'ttimeout' options
6737 tell so. A useful setting would be >
6738 :set timeout timeoutlen=3000 ttimeoutlen=100
6739< (time out on mapping after three seconds, time out on key codes after
6740 a tenth of a second).
6741
6742 *'title'* *'notitle'*
6743'title' boolean (default off, on when title can be restored)
6744 global
6745 {not in Vi}
6746 {not available when compiled without the |+title|
6747 feature}
6748 When on, the title of the window will be set to the value of
6749 'titlestring' (if it is not empty), or to:
6750 filename [+=-] (path) - VIM
6751 Where:
6752 filename the name of the file being edited
6753 - indicates the file cannot be modified, 'ma' off
6754 + indicates the file was modified
6755 = indicates the file is read-only
6756 =+ indicates the file is read-only and modified
6757 (path) is the path of the file being edited
6758 - VIM the server name |v:servername| or "VIM"
6759 Only works if the terminal supports setting window titles
6760 (currently Amiga console, Win32 console, all GUI versions and
6761 terminals with a non- empty 't_ts' option - these are Unix xterm and
6762 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6763 *X11*
6764 When Vim was compiled with HAVE_X11 defined, the original title will
6765 be restored if possible. The output of ":version" will include "+X11"
6766 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6767 works for the icon name |'icon'|.
6768 But: When Vim was started with the |-X| argument, restoring the title
6769 will not work (except in the GUI).
6770 If the title cannot be restored, it is set to the value of 'titleold'.
6771 You might want to restore the title outside of Vim then.
6772 When using an xterm from a remote machine you can use this command:
6773 rsh machine_name xterm -display $DISPLAY &
6774 then the WINDOWID environment variable should be inherited and the
6775 title of the window should change back to what it should be after
6776 exiting Vim.
6777
6778 *'titlelen'*
6779'titlelen' number (default 85)
6780 global
6781 {not in Vi}
6782 {not available when compiled without the |+title|
6783 feature}
6784 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006785 title. When the title is longer, only the end of the path name is
6786 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 Using a percentage makes this adapt to the width of the window. But
6788 it won't work perfectly, because the actual number of characters
6789 available also depends on the font used and other things in the title
6790 bar. When 'titlelen' is zero the full path is used. Otherwise,
6791 values from 1 to 30000 percent can be used.
6792 'titlelen' is also used for the 'titlestring' option.
6793
6794 *'titleold'*
6795'titleold' string (default "Thanks for flying Vim")
6796 global
6797 {not in Vi}
6798 {only available when compiled with the |+title|
6799 feature}
6800 This option will be used for the window title when exiting Vim if the
6801 original title cannot be restored. Only happens if 'title' is on or
6802 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006803 This option cannot be set from a |modeline| or in the |sandbox|, for
6804 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 *'titlestring'*
6806'titlestring' string (default "")
6807 global
6808 {not in Vi}
6809 {not available when compiled without the |+title|
6810 feature}
6811 When this option is not empty, it will be used for the title of the
6812 window. This happens only when the 'title' option is on.
6813 Only works if the terminal supports setting window titles (currently
6814 Amiga console, Win32 console, all GUI versions and terminals with a
6815 non-empty 't_ts' option).
6816 When Vim was compiled with HAVE_X11 defined, the original title will
6817 be restored if possible |X11|.
6818 When this option contains printf-style '%' items, they will be
6819 expanded according to the rules used for 'statusline'.
6820 Example: >
6821 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6822 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6823< The value of 'titlelen' is used to align items in the middle or right
6824 of the available space.
6825 Some people prefer to have the file name first: >
6826 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6827< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006828 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 separating space only when needed.
6830 NOTE: Use of special characters in 'titlestring' may cause the display
6831 to be garbled (e.g., when it contains a CR or NL character).
6832 {not available when compiled without the |+statusline| feature}
6833
6834 *'toolbar'* *'tb'*
6835'toolbar' 'tb' string (default "icons,tooltips")
6836 global
6837 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6838 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006839 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 possible values are:
6841 icons Toolbar buttons are shown with icons.
6842 text Toolbar buttons shown with text.
6843 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006844 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006845 tooltips Tooltips are active for toolbar buttons.
6846 Tooltips refer to the popup help text which appears after the mouse
6847 cursor is placed over a toolbar button for a brief moment.
6848
6849 If you want the toolbar to be shown with icons as well as text, do the
6850 following: >
6851 :set tb=icons,text
6852< Motif and Athena cannot display icons and text at the same time. They
6853 will show icons if both are requested.
6854
6855 If none of the strings specified in 'toolbar' are valid or if
6856 'toolbar' is empty, this option is ignored. If you want to disable
6857 the toolbar, you need to set the 'guioptions' option. For example: >
6858 :set guioptions-=T
6859< Also see |gui-toolbar|.
6860
6861 *'toolbariconsize'* *'tbis'*
6862'toolbariconsize' 'tbis' string (default "small")
6863 global
6864 {not in Vi}
6865 {only in the GTK+ 2 GUI}
6866 Controls the size of toolbar icons. The possible values are:
6867 tiny Use tiny toolbar icons.
6868 small Use small toolbar icons (default).
6869 medium Use medium-sized toolbar icons.
6870 large Use large toolbar icons.
6871 The exact dimensions in pixels of the various icon sizes depend on
6872 the current theme. Common dimensions are large=32x32, medium=24x24,
6873 small=20x20 and tiny=16x16.
6874
6875 If 'toolbariconsize' is empty, the global default size as determined
6876 by user preferences or the current theme is used.
6877
6878 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6879'ttybuiltin' 'tbi' boolean (default on)
6880 global
6881 {not in Vi}
6882 When on, the builtin termcaps are searched before the external ones.
6883 When off the builtin termcaps are searched after the external ones.
6884 When this option is changed, you should set the 'term' option next for
6885 the change to take effect, for example: >
6886 :set notbi term=$TERM
6887< See also |termcap|.
6888 Rationale: The default for this option is "on", because the builtin
6889 termcap entries are generally better (many systems contain faulty
6890 xterm entries...).
6891
6892 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6893'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6894 sun-cmd, screen, rxvt, dtterm or
6895 iris-ansi; also on when running Vim in
6896 a DOS console)
6897 global
6898 {not in Vi}
6899 Indicates a fast terminal connection. More characters will be sent to
6900 the screen for redrawing, instead of using insert/delete line
6901 commands. Improves smoothness of redrawing when there are multiple
6902 windows and the terminal does not support a scrolling region.
6903 Also enables the extra writing of characters at the end of each screen
6904 line for lines that wrap. This helps when using copy/paste with the
6905 mouse in an xterm and other terminals.
6906
6907 *'ttymouse'* *'ttym'*
6908'ttymouse' 'ttym' string (default depends on 'term')
6909 global
6910 {not in Vi}
6911 {only in Unix and VMS, doesn't work in the GUI; not
6912 available when compiled without |+mouse|}
6913 Name of the terminal type for which mouse codes are to be recognized.
6914 Currently these three strings are valid:
6915 *xterm-mouse*
6916 xterm xterm-like mouse handling. The mouse generates
6917 "<Esc>[Mscr", where "scr" is three bytes:
6918 "s" = button state
6919 "c" = column plus 33
6920 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006921 This only works up to 223 columns! See "dec" for a
6922 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 xterm2 Works like "xterm", but with the xterm reporting the
6924 mouse position while the mouse is dragged. This works
6925 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006926 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 work. See below for how Vim detects this
6928 automatically.
6929 *netterm-mouse*
6930 netterm NetTerm mouse handling. The mouse generates
6931 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6932 for the row and column.
6933 *dec-mouse*
6934 dec DEC terminal mouse handling. The mouse generates a
6935 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006936 This is also available for an Xterm, if it was
6937 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 *jsbterm-mouse*
6939 jsbterm JSB term mouse handling.
6940 *pterm-mouse*
6941 pterm QNX pterm mouse handling.
6942
6943 The mouse handling must be enabled at compile time |+mouse_xterm|
6944 |+mouse_dec| |+mouse_netterm|.
6945 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6946 recognized, if enabled at compile time. DEC terminal mouse codes
6947 are recognized if enabled at compile time, and 'ttymouse' is not
6948 "xterm" (because the xterm and dec mouse codes conflict).
6949 This option is automatically set to "xterm", when the 'term' option is
6950 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6951 or "xterm2" already. The main use of this option is to set it to
6952 "xterm", when the terminal name doesn't start with "xterm", but it can
6953 handle xterm mouse codes.
6954 The "xterm2" value will be set if the xterm version is reported to be
6955 95 of higher. This only works when compiled with the |+termresponse|
6956 feature and if |t_RV| is set to the escape sequence to request the
6957 xterm version number. Otherwise "xterm2" must be set explicitly.
6958 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6959 t_RV to an empty string: >
6960 :set t_RV=
6961<
6962 *'ttyscroll'* *'tsl'*
6963'ttyscroll' 'tsl' number (default 999)
6964 global
6965 Maximum number of lines to scroll the screen. If there are more lines
6966 to scroll the window is redrawn. For terminals where scrolling is
6967 very slow and redrawing is not slow this can be set to a small number,
6968 e.g., 3, to speed up displaying.
6969
6970 *'ttytype'* *'tty'*
6971'ttytype' 'tty' string (default from $TERM)
6972 global
6973 Alias for 'term', see above.
6974
6975 *'undolevels'* *'ul'*
6976'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6977 Win32 and OS/2)
6978 global
6979 {not in Vi}
6980 Maximum number of changes that can be undone. Since undo information
6981 is kept in memory, higher numbers will cause more memory to be used
6982 (nevertheless, a single change can use an unlimited amount of memory).
6983 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6984 itself: >
6985 set ul=0
6986< But you can also get Vi compatibility by including the 'u' flag in
6987 'cpoptions', and still be able to use CTRL-R to repeat undo.
6988 Set to a negative number for no undo at all: >
6989 set ul=-1
6990< This helps when you run out of memory for a single change.
6991 Also see |undo-two-ways|.
6992
6993 *'updatecount'* *'uc'*
6994'updatecount' 'uc' number (default: 200)
6995 global
6996 {not in Vi}
6997 After typing this many characters the swap file will be written to
6998 disk. When zero, no swap file will be created at all (see chapter on
6999 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7000 Vim with the "-n" option, see |startup|. When editing in readonly
7001 mode this option will be initialized to 10000.
7002 The swapfile can be disabled per buffer with |'swapfile'|.
7003 When 'updatecount' is set from zero to non-zero, swap files are
7004 created for all buffers that have 'swapfile' set. When 'updatecount'
7005 is set to zero, existing swap files are not deleted.
7006 Also see |'swapsync'|.
7007 This option has no meaning in buffers where |'buftype'| is "nofile"
7008 or "nowrite".
7009
7010 *'updatetime'* *'ut'*
7011'updatetime' 'ut' number (default 4000)
7012 global
7013 {not in Vi}
7014 If this many milliseconds nothing is typed the swap file will be
7015 written to disk (see |crash-recovery|). Also used for the
7016 |CursorHold| autocommand event.
7017
7018 *'verbose'* *'vbs'*
7019'verbose' 'vbs' number (default 0)
7020 global
7021 {not in Vi, although some versions have a boolean
7022 verbose option}
7023 When bigger than zero, Vim will give messages about what it is doing.
7024 Currently, these messages are given:
7025 >= 1 When the viminfo file is read or written.
7026 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007027 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 >= 8 Files for which a group of autocommands is executed.
7029 >= 9 Every executed autocommand.
7030 >= 12 Every executed function.
7031 >= 13 When an exception is thrown, caught, finished, or discarded.
7032 >= 14 Anything pending in a ":finally" clause.
7033 >= 15 Every executed Ex command (truncated at 200 characters).
7034
7035 This option can also be set with the "-V" argument. See |-V|.
7036 This option is also set by the |:verbose| command.
7037
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007038 When the 'verbosefile' option is set then the verbose messages are not
7039 displayed.
7040
7041 *'verbosefile'* *'vfile'*
7042'verbosefile' 'vfile' string (default empty)
7043 global
7044 {not in Vi}
7045 When not empty all messages are written in a file with this name.
7046 When the file exists messages are appended.
7047 Writing to the file ends when Vim exits or when 'verbosefile' is made
7048 empty.
7049 Setting 'verbosefile' to a new value is like making it empty first.
7050 The difference with |:redir| is that verbose messages are not
7051 displayed when 'verbosefile' is set.
7052
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 *'viewdir'* *'vdir'*
7054'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7055 "$VIM/vimfiles/view",
7056 for Unix: "~/.vim/view",
7057 for Macintosh: "$VIM:vimfiles:view"
7058 for VMS: "sys$login:vimfiles/view"
7059 for RiscOS: "Choices:vimfiles/view")
7060 global
7061 {not in Vi}
7062 {not available when compiled without the +mksession
7063 feature}
7064 Name of the directory where to store files for |:mkview|.
7065 This option cannot be set from a |modeline| or in the |sandbox|, for
7066 security reasons.
7067
7068 *'viewoptions'* *'vop'*
7069'viewoptions' 'vop' string (default: "folds,options,cursor")
7070 global
7071 {not in Vi}
7072 {not available when compiled without the +mksession
7073 feature}
7074 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007075 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 word save and restore ~
7077 cursor cursor position in file and in window
7078 folds manually created folds, opened/closed folds and local
7079 fold options
7080 options options and mappings local to a window or buffer (not
7081 global values for local options)
7082 slash backslashes in file names replaced with forward
7083 slashes
7084 unix with Unix end-of-line format (single <NL>), even when
7085 on Windows or DOS
7086
7087 "slash" and "unix" are useful on Windows when sharing view files
7088 with Unix. The Unix version of Vim cannot source dos format scripts,
7089 but the Windows version of Vim can source unix format scripts.
7090
7091 *'viminfo'* *'vi'* *E526* *E527* *E528*
7092'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7093 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7094 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7095 for others: '20,<50,s10,h)
7096 global
7097 {not in Vi}
7098 {not available when compiled without the |+viminfo|
7099 feature}
7100 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007101 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 separated list of parameters, each consisting of a single character
7103 identifying the particular parameter, followed by a number or string
7104 which specifies the value of that parameter. If a particular
7105 character is left out, then the default value is used for that
7106 parameter. The following is a list of the identifying characters and
7107 the effect of their value.
7108 CHAR VALUE ~
7109 ! When included, save and restore global variables that start
7110 with an uppercase letter, and don't contain a lowercase
7111 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007112 and "_K_L_M" are not. Only String and Number types are
7113 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 " Maximum number of lines saved for each register. Old name of
7115 the '<' item, with the disadvantage that you need to put a
7116 backslash before the ", otherwise it will be recognized as the
7117 start of a comment!
7118 % When included, save and restore the buffer list. If Vim is
7119 started with a file name argument, the buffer list is not
7120 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007121 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122 without a file name and buffers for help files are not written
7123 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007124 When followed by a number, the number specifies the maximum
7125 number of buffers that are stored. Without a number all
7126 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007127 ' Maximum number of previously edited files for which the marks
7128 are remembered. This parameter must always be included when
7129 'viminfo' is non-empty.
7130 Including this item also means that the |jumplist| and the
7131 |changelist| are stored in the viminfo file.
7132 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007133 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 patterns are also saved. When not included, the value of
7135 'history' is used.
7136 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007137 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 < Maximum number of lines saved for each register. If zero then
7139 registers are not saved. When not included, all lines are
7140 saved. '"' is the old name for this item.
7141 Also see the 's' item below: limit specified in Kbyte.
7142 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007143 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 c When included, convert the text in the viminfo file from the
7145 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007146 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 f Whether file marks need to be stored. If zero, file marks ('0
7148 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007149 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 cursor position (when exiting or when doing ":wviminfo").
7151 h Disable the effect of 'hlsearch' when loading the viminfo
7152 file. When not included, it depends on whether ":nohlsearch"
7153 has been used since the last search command.
7154 n Name of the viminfo file. The name must immediately follow
7155 the 'n'. Must be the last one! If the "-i" argument was
7156 given when starting Vim, that file name overrides the one
7157 given here with 'viminfo'. Environment variables are expanded
7158 when opening the file, not when setting the option.
7159 r Removable media. The argument is a string (up to the next
7160 ','). This parameter can be given several times. Each
7161 specifies the start of a path for which no marks will be
7162 stored. This is to avoid removable media. For MS-DOS you
7163 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7164 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7165 ignored. Maximum length of each 'r' argument is 50
7166 characters.
7167 s Maximum size of an item in Kbyte. If zero then registers are
7168 not saved. Currently only applies to registers. The default
7169 "s10" will exclude registers with more than 10 Kbyte of text.
7170 Also see the '<' item above: line count limit.
7171
7172 Example: >
7173 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7174<
7175 '50 Marks will be remembered for the last 50 files you
7176 edited.
7177 <1000 Contents of registers (up to 1000 lines each) will be
7178 remembered.
7179 s100 Registers with more than 100 Kbyte text are skipped.
7180 :0 Command-line history will not be saved.
7181 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7182 no / Since '/' is not specified, the default will be used,
7183 that is, save all of the search history, and also the
7184 previous search and substitute patterns.
7185 no % The buffer list will not be saved nor read back.
7186 no h 'hlsearch' highlighting will be restored.
7187
7188 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7189 load the contents of the file, this is not done automatically.
7190
7191 This option cannot be set from a |modeline| or in the |sandbox|, for
7192 security reasons.
7193
7194 *'virtualedit'* *'ve'*
7195'virtualedit' 've' string (default "")
7196 global
7197 {not in Vi}
7198 {not available when compiled without the
7199 |+virtualedit| feature}
7200 A comma separated list of these words:
7201 block Allow virtual editing in Visual block mode.
7202 insert Allow virtual editing in Insert mode.
7203 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007204 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007205
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 Virtual editing means that the cursor can be positioned where there is
7207 no actual character. This can be halfway into a Tab or beyond the end
7208 of the line. Useful for selecting a rectangle in Visual mode and
7209 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007210 "onemore" is not the same, it will only allow moving the cursor just
7211 after the last character of the line. This makes some commands more
7212 consistent. Previously the cursor was always past the end of the line
7213 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007214 break some plugins or Vim scripts. For example because |l| can move
7215 the cursor after the last character. Use with care!
7216 Using the |$| command will move to the last character in the line, not
7217 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007218 It doesn't make sense to combine "all" with "onemore", but you will
7219 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220
7221 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7222'visualbell' 'vb' boolean (default off)
7223 global
7224 {not in Vi}
7225 Use visual bell instead of beeping. The terminal code to display the
7226 visual bell is given with 't_vb'. When no beep or flash is wanted,
7227 use ":set vb t_vb=".
7228 Note: When the GUI starts, 't_vb' is reset to its default value. You
7229 might want to set it again in your |gvimrc|.
7230 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7231 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7232 where 40 is the time in msec.
7233 Does not work on the Amiga, you always get a screen flash.
7234 Also see 'errorbells'.
7235
7236 *'warn'* *'nowarn'*
7237'warn' boolean (default on)
7238 global
7239 Give a warning message when a shell command is used while the buffer
7240 has been changed.
7241
7242 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7243'weirdinvert' 'wiv' boolean (default off)
7244 global
7245 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007246 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 It is provided for backwards compatibility with version 4.x.
7248 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7249 vice versa. Has no effect when the GUI is running.
7250
7251 *'whichwrap'* *'ww'*
7252'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7253 global
7254 {not in Vi}
7255 Allow specified keys that move the cursor left/right to move to the
7256 previous/next line when the cursor is on the first/last character in
7257 the line. Concatenate characters to allow this for these keys:
7258 char key mode ~
7259 b <BS> Normal and Visual
7260 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007261 h "h" Normal and Visual (not recommended)
7262 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 < <Left> Normal and Visual
7264 > <Right> Normal and Visual
7265 ~ "~" Normal
7266 [ <Left> Insert and Replace
7267 ] <Right> Insert and Replace
7268 For example: >
7269 :set ww=<,>,[,]
7270< allows wrap only when cursor keys are used.
7271 When the movement keys are used in combination with a delete or change
7272 operator, the <EOL> also counts for a character. This makes "3h"
7273 different from "3dh" when the cursor crosses the end of a line. This
7274 is also true for "x" and "X", because they do the same as "dl" and
7275 "dh". If you use this, you may also want to use the mapping
7276 ":map <BS> X" to make backspace delete the character in front of the
7277 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007278 When 'l' is included and it is used after an operator at the end of a
7279 line then it will not move to the next line. This makes "dl", "cl",
7280 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 NOTE: This option is set to the Vi default value when 'compatible' is
7282 set and to the Vim default value when 'compatible' is reset.
7283
7284 *'wildchar'* *'wc'*
7285'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7286 global
7287 {not in Vi}
7288 Character you have to type to start wildcard expansion in the
7289 command-line, as specified with 'wildmode'.
7290 The character is not recognized when used inside a macro. See
7291 'wildcharm' for that.
7292 Although 'wc' is a number option, you can set it to a special key: >
7293 :set wc=<Esc>
7294< NOTE: This option is set to the Vi default value when 'compatible' is
7295 set and to the Vim default value when 'compatible' is reset.
7296
7297 *'wildcharm'* *'wcm'*
7298'wildcharm' 'wcm' number (default: none (0))
7299 global
7300 {not in Vi}
7301 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007302 recognized when used inside a macro. You can find "spare" command-line
7303 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 you'll never actually type 'wildcharm', just use it in mappings that
7305 automatically invoke completion mode, e.g.: >
7306 :set wcm=<C-Z>
7307 :cmap ss so $vim/sessions/*.vim<C-Z>
7308< Then after typing :ss you can use CTRL-P & CTRL-N.
7309
7310 *'wildignore'* *'wig'*
7311'wildignore' 'wig' string (default "")
7312 global
7313 {not in Vi}
7314 {not available when compiled without the |+wildignore|
7315 feature}
7316 A list of file patterns. A file that matches with one of these
7317 patterns is ignored when completing file or directory names.
7318 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7319 Also see 'suffixes'.
7320 Example: >
7321 :set wildignore=*.o,*.obj
7322< The use of |:set+=| and |:set-=| is preferred when adding or removing
7323 a pattern from the list. This avoids problems when a future version
7324 uses another default.
7325
7326 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7327'wildmenu' 'wmnu' boolean (default off)
7328 global
7329 {not in Vi}
7330 {not available if compiled without the |+wildmenu|
7331 feature}
7332 When 'wildmenu' is on, command-line completion operates in an enhanced
7333 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7334 the possible matches are shown just above the command line, with the
7335 first match highlighted (overwriting the status line, if there is
7336 one). Keys that show the previous/next match, such as <Tab> or
7337 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7338 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7339 specified. "longest" and "list" do not start "wildmenu" mode.
7340 If there are more matches than can fit in the line, a ">" is shown on
7341 the right and/or a "<" is shown on the left. The status line scrolls
7342 as needed.
7343 The "wildmenu" mode is abandoned when a key is hit that is not used
7344 for selecting a completion.
7345 While the "wildmenu" is active the following keys have special
7346 meanings:
7347
7348 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7349 <Down> - in filename/menu name completion: move into a
7350 subdirectory or submenu.
7351 <CR> - in menu completion, when the cursor is just after a
7352 dot: move into a submenu.
7353 <Up> - in filename/menu name completion: move up into
7354 parent directory or parent menu.
7355
7356 This makes the menus accessible from the console |console-menus|.
7357
7358 If you prefer the <Left> and <Right> keys to move the cursor instead
7359 of selecting a different match, use this: >
7360 :cnoremap <Left> <Space><BS><Left>
7361 :cnoremap <Right> <Space><BS><Right>
7362<
7363 The "WildMenu" highlighting is used for displaying the current match
7364 |hl-WildMenu|.
7365
7366 *'wildmode'* *'wim'*
7367'wildmode' 'wim' string (Vim default: "full")
7368 global
7369 {not in Vi}
7370 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007371 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 part specifies what to do for each consecutive use of 'wildchar. The
7373 first part specifies the behavior for the first use of 'wildchar',
7374 The second part for the second use, etc.
7375 These are the possible values for each part:
7376 "" Complete only the first match.
7377 "full" Complete the next full match. After the last match,
7378 the original string is used and then the first match
7379 again.
7380 "longest" Complete till longest common string. If this doesn't
7381 result in a longer string, use the next part.
7382 "longest:full" Like "longest", but also start 'wildmenu' if it is
7383 enabled.
7384 "list" When more than one match, list all matches.
7385 "list:full" When more than one match, list all matches and
7386 complete first match.
7387 "list:longest" When more than one match, list all matches and
7388 complete till longest common string.
7389 When there is only a single match, it is fully completed in all cases.
7390
7391 Examples: >
7392 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007393< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 :set wildmode=longest,full
7395< Complete longest common string, then each full match >
7396 :set wildmode=list:full
7397< List all matches and complete each full match >
7398 :set wildmode=list,full
7399< List all matches without completing, then each full match >
7400 :set wildmode=longest,list
7401< Complete longest common string, then list alternatives.
7402
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007403 *'wildoptions'* *'wop'*
7404'wildoptions' 'wop' string (default "")
7405 global
7406 {not in Vi}
7407 {not available when compiled without the |+wildignore|
7408 feature}
7409 A list of words that change how command line completion is done.
7410 Currently only one word is allowed:
7411 tagfile When using CTRL-D to list matching tags, the kind of
7412 tag and the file of the tag is listed. Only one match
7413 is displayed per line. Often used tag kinds are:
7414 d #define
7415 f function
7416 Also see |cmdline-completion|.
7417
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 *'winaltkeys'* *'wak'*
7419'winaltkeys' 'wak' string (default "menu")
7420 global
7421 {not in Vi}
7422 {only used in Win32, Motif, GTK and Photon GUI}
7423 Some GUI versions allow the access to menu entries by using the ALT
7424 key in combination with a character that appears underlined in the
7425 menu. This conflicts with the use of the ALT key for mappings and
7426 entering special characters. This option tells what to do:
7427 no Don't use ALT keys for menus. ALT key combinations can be
7428 mapped, but there is no automatic handling. This can then be
7429 done with the |:simalt| command.
7430 yes ALT key handling is done by the windowing system. ALT key
7431 combinations cannot be mapped.
7432 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007433 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 keys can be mapped.
7435 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7436 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007437 This option is not used for <F10>; on Win32 and with GTK <F10> will
7438 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007440 *'window'* *'wi'*
7441'window' 'wi' number (default screen height - 1)
7442 global
7443 Window height. Do not confuse this with the height of the Vim window,
7444 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007445 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7446 value is smaller than 'lines' minus one. The screen will scroll
7447 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007448 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7449 in a much smarter way, taking care of wrapping lines.
7450 When resizing the Vim window, the value is smaller than 1 or more than
7451 or equal to 'lines' it will be set to 'lines' minus 1.
7452 {Vi also uses the option to specify the number of displayed lines}
7453
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 *'winheight'* *'wh'* *E591*
7455'winheight' 'wh' number (default 1)
7456 global
7457 {not in Vi}
7458 {not available when compiled without the +windows
7459 feature}
7460 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007461 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 current window is smaller, its size is increased, at the cost of the
7463 height of other windows. Set it to 999 to make the current window
7464 always fill the screen (although this has the drawback that ":all"
7465 will create only two windows). Set it to a small number for normal
7466 editing.
7467 Minimum value is 1.
7468 The height is not adjusted after one of the commands to change the
7469 height of the current window.
7470 'winheight' applies to the current window. Use 'winminheight' to set
7471 the minimal height for other windows.
7472
7473 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7474'winfixheight' 'wfh' boolean (default off)
7475 local to window
7476 {not in Vi}
7477 {not available when compiled without the +windows
7478 feature}
7479 Keep the window height when windows are opened or closed and
7480 'equalalways' is set. Set by default for the |preview-window| and
7481 |quickfix-window|.
7482 The height may be changed anyway when running out of room.
7483
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007484 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7485'winfixwidth' 'wfw' boolean (default off)
7486 local to window
7487 {not in Vi}
7488 {not available when compiled without the +windows
7489 feature}
7490 Keep the window width when windows are opened or closed and
7491 'equalalways' is set.
7492 The width may be changed anyway when running out of room.
7493
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 *'winminheight'* *'wmh'*
7495'winminheight' 'wmh' number (default 1)
7496 global
7497 {not in Vi}
7498 {not available when compiled without the +windows
7499 feature}
7500 The minimal height of a window, when it's not the current window.
7501 This is a hard minimum, windows will never become smaller.
7502 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7503 status bar) if necessary. They will return to at least one line when
7504 they become active (since the cursor has to have somewhere to go.)
7505 Use 'winheight' to set the minimal height of the current window.
7506 This option is only checked when making a window smaller. Don't use a
7507 large number, it will cause errors when opening more than a few
7508 windows. A value of 0 to 3 is reasonable.
7509
7510 *'winminwidth'* *'wmw'*
7511'winminwidth' 'wmw' number (default 1)
7512 global
7513 {not in Vi}
7514 {not available when compiled without the +vertsplit
7515 feature}
7516 The minimal width of a window, when it's not the current window.
7517 This is a hard minimum, windows will never become smaller.
7518 When set to zero, windows may be "squashed" to zero columns (i.e. just
7519 a vertical separator) if necessary. They will return to at least one
7520 line when they become active (since the cursor has to have somewhere
7521 to go.)
7522 Use 'winwidth' to set the minimal width of the current window.
7523 This option is only checked when making a window smaller. Don't use a
7524 large number, it will cause errors when opening more than a few
7525 windows. A value of 0 to 12 is reasonable.
7526
7527 *'winwidth'* *'wiw'* *E592*
7528'winwidth' 'wiw' number (default 20)
7529 global
7530 {not in Vi}
7531 {not available when compiled without the +vertsplit
7532 feature}
7533 Minimal number of columns for the current window. This is not a hard
7534 minimum, Vim will use fewer columns if there is not enough room. If
7535 the current window is smaller, its size is increased, at the cost of
7536 the width of other windows. Set it to 999 to make the current window
7537 always fill the screen. Set it to a small number for normal editing.
7538 The width is not adjusted after one of the commands to change the
7539 width of the current window.
7540 'winwidth' applies to the current window. Use 'winminwidth' to set
7541 the minimal width for other windows.
7542
7543 *'wrap'* *'nowrap'*
7544'wrap' boolean (default on)
7545 local to window
7546 {not in Vi}
7547 This option changes how text is displayed. It doesn't change the text
7548 in the buffer, see 'textwidth' for that.
7549 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007550 displaying continues on the next line. When off lines will not wrap
7551 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 moved to a part that is not shown, the screen will scroll
7553 horizontally.
7554 The line will be broken in the middle of a word if necessary. See
7555 'linebreak' to get the break at a word boundary.
7556 To make scrolling horizontally a bit more useful, try this: >
7557 :set sidescroll=5
7558 :set listchars+=precedes:<,extends:>
7559< See 'sidescroll', 'listchars' and |wrap-off|.
7560
7561 *'wrapmargin'* *'wm'*
7562'wrapmargin' 'wm' number (default 0)
7563 local to buffer
7564 Number of characters from the right window border where wrapping
7565 starts. When typing text beyond this limit, an <EOL> will be inserted
7566 and inserting continues on the next line.
7567 Options that add a margin, such as 'number' and 'foldcolumn', cause
7568 the text width to be further reduced. This is Vi compatible.
7569 When 'textwidth' is non-zero, this option is not used.
7570 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7571 and less usefully}
7572
7573 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7574'wrapscan' 'ws' boolean (default on) *E384* *E385*
7575 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007576 Searches wrap around the end of the file. Also applies to |]s| and
7577 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578
7579 *'write'* *'nowrite'*
7580'write' boolean (default on)
7581 global
7582 {not in Vi}
7583 Allows writing files. When not set, writing a file is not allowed.
7584 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007585 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 argument. Filtering text is still possible, even though this requires
7587 writing a temporary file.
7588
7589 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7590'writeany' 'wa' boolean (default off)
7591 global
7592 Allows writing to any file with no need for "!" override.
7593
7594 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7595'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7596 otherwise)
7597 global
7598 {not in Vi}
7599 Make a backup before overwriting a file. The backup is removed after
7600 the file was successfully written, unless the 'backup' option is
7601 also on. Reset this option if your file system is almost full. See
7602 |backup-table| for another explanation.
7603 When the 'backupskip' pattern matches, a backup is not made anyway.
7604 NOTE: This option is set to the default value when 'compatible' is
7605 set.
7606
7607 *'writedelay'* *'wd'*
7608'writedelay' 'wd' number (default 0)
7609 global
7610 {not in Vi}
7611 The number of microseconds to wait for each character sent to the
7612 screen. When non-zero, characters are sent to the terminal one by
7613 one. For MS-DOS pcterm this does not work. For debugging purposes.
7614
7615 vim:tw=78:ts=8:ft=help:norl: