blob: 1bb6ff1d534b6aef726d11be7262fe54cbd2cbd3 [file] [log] [blame]
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001*options.txt* For Vim version 7.0b. Last change: 2006 Mar 25
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
43:se[t] {option}! or
44:se[t] inv{option} Toggle option: Invert value. {not in Vi}
45
46 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
47:se[t] {option}& Reset option to its default value. May depend on the
48 current value of 'compatible'. {not in Vi}
49:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
50:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
51
52:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000053 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 'columns' are not changed. {not in Vi}
55
56 *:set-args* *E487* *E521*
57:se[t] {option}={value} or
58:se[t] {option}:{value}
59 Set string or number option to {value}.
60 For numeric options the value can be given in decimal,
61 hex (preceded with 0x) or octal (preceded with '0')
62 (hex and octal are only available for machines which
63 have the strtol() function).
64 The old value can be inserted by typing 'wildchar' (by
65 default this is a <Tab> or CTRL-E if 'compatible' is
66 set). See |cmdline-completion|.
67 White space between {option} and '=' is allowed and
68 will be ignored. White space between '=' and {value}
69 is not allowed.
70 See |option-backslash| for using white space and
71 backslashes in {value}.
72
73:se[t] {option}+={value} *:set+=*
74 Add the {value} to a number option, or append the
75 {value} to a string option. When the option is a
76 comma separated list, a comma is added, unless the
77 value was empty.
78 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000079 are removed. When adding a flag that was already
80 present the option value doesn't change.
Bram Moolenaar071d4272004-06-13 20:20:40 +000081< Also see |:set-args| above.
82 {not in Vi}
83
84:se[t] {option}^={value} *:set^=*
85 Multiply the {value} to a number option, or prepend
86 the {value} to a string option. When the option is a
87 comma separated list, a comma is added, unless the
88 value was empty.
89 Also see |:set-args| above.
90 {not in Vi}
91
92:se[t] {option}-={value} *:set-=*
93 Subtract the {value} from a number option, or remove
94 the {value} from a string option, if it is there.
95 If the {value} is not found in a string option, there
96 is no error or warning. When the option is a comma
97 separated list, a comma is deleted, unless the option
98 becomes empty.
99 When the option is a list of flags, {value} must be
100 exactly as they appear in the option. Remove flags
101 one by one to avoid problems.
102 Also see |:set-args| above.
103 {not in Vi}
104
105The {option} arguments to ":set" may be repeated. For example: >
106 :set ai nosi sw=3 ts=3
107If you make an error in one of the arguments, an error message will be given
108and the following arguments will be ignored.
109
110 *:set-verbose*
111When 'verbose' is non-zero, displaying an option value will also tell where it
112was last set. Example: >
113 :verbose set shiftwidth cindent?
114 shiftwidth=4
115 Last set from modeline
116 cindent
117 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
118This is only done when specific option values are requested, not for ":set
119all" or ":set" without an argument.
120When the option was set by hand there is no "Last set" message. There is only
121one value for all local options with the same name. Thus the message applies
122to the option name, not necessarily its value.
123When the option was set while executing a function, user command or
124autocommand, the script in which it was defined is reported.
125Note that an option may also have been set as a side effect of setting
126'compatible'.
127{not available when compiled without the +eval feature}
128
129 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000130For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131override the value from the termcap. You can then use it in a mapping. If
132the "xx" part contains special characters, use the <t_xx> form: >
133 :set <t_#4>=^[Ot
134This can also be used to translate a special code for a normal key. For
135example, if Alt-b produces <Esc>b, use this: >
136 :set <M-b>=^[b
137(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
138The advantage over a mapping is that it works in all situations.
139
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000140The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
141security reasons.
142
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000144at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145"set all" probably does not fit on the screen, causing Vim to give the
146|more-prompt|.
147
148 *option-backslash*
149To include white space in a string option value it has to be preceded with a
150backslash. To include a backslash you have to use two. Effectively this
151means that the number of backslashes in an option value is halved (rounded
152down).
153A few examples: >
154 :set tags=tags\ /usr/tags results in "tags /usr/tags"
155 :set tags=tags\\,file results in "tags\,file"
156 :set tags=tags\\\ file results in "tags\ file"
157
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000158The "|" character separates a ":set" command from a following command. To
159include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160'titlestring' option to "hi|there": >
161 :set titlestring=hi\|there
162This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
163 :set titlestring=hi|set iconstring=there
164
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000165Similarly, the double quote character starts a comment. To include the '"' in
166the option value, use '\"' instead. This example sets the 'titlestring'
167option to 'hi "there"': >
168 :set titlestring=hi\ \"there\"
169
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000170For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171precise: For options that expect a file name (those where environment
172variables are expanded) a backslash before a normal file name character is not
173removed. But a backslash before a special character (space, backslash, comma,
174etc.) is used like explained above.
175There is one special situation, when the value starts with "\\": >
176 :set dir=\\machine\path results in "\\machine\path"
177 :set dir=\\\\machine\\path results in "\\machine\path"
178 :set dir=\\path\\file results in "\\path\file" (wrong!)
179For the first one the start is kept, but for the second one the backslashes
180are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182result which is probably not what you want. Avoid it.
183
184 *add-option-flags* *remove-option-flags*
185 *E539* *E550* *E551* *E552*
186Some options are a list of flags. When you want to add a flag to such an
187option, without changing the existing ones, you can do it like this: >
188 :set guioptions+=a
189Remove a flag from an option like this: >
190 :set guioptions-=a
191This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000192Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
194doesn't appear.
195
196 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000197Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198environment variable exists the '$' and the following environment variable
199name is replaced with its value. If it does not exist the '$' and the name
200are not modified. Any non-id character (not a letter, digit or '_') may
201follow the environment variable name. That character and what follows is
202appended to the value of the environment variable. Examples: >
203 :set term=$TERM.new
204 :set path=/usr/$INCLUDE,$HOME/include,.
205When adding or removing a string from an option with ":set opt-=val" or ":set
206opt+=val" the expansion is done before the adding or removing.
207
208
209Handling of local options *local-options*
210
211Some of the options only apply to a window or buffer. Each window or buffer
212has its own copy of this option, thus can each have their own value. This
213allows you to set 'list' in one window but not in another. And set
214'shiftwidth' to 3 in one buffer and 4 in another.
215
216The following explains what happens to these local options in specific
217situations. You don't really need to know all of this, since Vim mostly uses
218the option values you would expect. Unfortunately, doing what the user
219expects is a bit complicated...
220
221When splitting a window, the local options are copied to the new window. Thus
222right after the split the contents of the two windows look the same.
223
224When editing a new buffer, its local option values must be initialized. Since
225the local options of the current buffer might be specifically for that buffer,
226these are not used. Instead, for each buffer-local option there also is a
227global value, which is used for new buffers. With ":set" both the local and
228global value is changed. With "setlocal" only the local value is changed,
229thus this value is not used when editing a new buffer.
230
231When editing a buffer that has been edited before, the last used window
232options are used again. If this buffer has been edited in this window, the
233values from back then are used. Otherwise the values from the window where
234the buffer was edited last are used.
235
236It's possible to set a local window option specifically for a type of buffer.
237When you edit another buffer in the same window, you don't want to keep
238using these local window options. Therefore Vim keeps a global value of the
239local window options, which is used when editing another buffer. Each window
240has its own copy of these values. Thus these are local to the window, but
241global to all buffers in the window. With this you can do: >
242 :e one
243 :set list
244 :e two
245Now the 'list' option will also be set in "two", since with the ":set list"
246command you have also set the global value. >
247 :set nolist
248 :e one
249 :setlocal list
250 :e two
251Now the 'list' option is not set, because ":set nolist" resets the global
252value, ":setlocal list" only changes the local value and ":e two" gets the
253global value. Note that if you do this next: >
254 :e one
255You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000256"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257
258 *:setl* *:setlocal*
259:setl[ocal] ... Like ":set" but set only the value local to the
260 current buffer or window. Not all options have a
261 local value. If the option does not have a local
262 value the global value is set.
263 With the "all" argument: display all local option's
264 local values.
265 Without argument: Display all local option's local
266 values which are different from the default.
267 When displaying a specific local option, show the
268 local value. For a global option the global value is
269 shown (but that might change in the future).
270 {not in Vi}
271
272:setl[ocal] {option}< Set the local value of {option} to its global value.
273 {not in Vi}
274
275 *:setg* *:setglobal*
276:setg[lobal] ... Like ":set" but set only the global value for a local
277 option without changing the local value.
278 When displaying an option, the global value is shown.
279 With the "all" argument: display all local option's
280 global values.
281 Without argument: display all local option's global
282 values which are different from the default.
283 {not in Vi}
284
285For buffer-local and window-local options:
286 Command global value local value ~
287 :set option=value set set
288 :setlocal option=value - set
289:setglobal option=value set -
290 :set option? - display
291 :setlocal option? - display
292:setglobal option? display -
293
294
295Global options with a local value *global-local*
296
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000297Options are global when you mostly use one value for all buffers and windows.
298For some global options it's useful to sometimes have a different local value.
299You can set the local value with ":setlocal". That buffer or window will then
300use the local value, while other buffers and windows continue using the global
301value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302
303For example, you have two windows, both on C source code. They use the global
304'makeprg' option. If you do this in one of the two windows: >
305 :set makeprg=gmake
306then the other window will switch to the same value. There is no need to set
307the 'makeprg' option in the other C source window too.
308However, if you start editing a Perl file in a new window, you want to use
309another 'makeprog' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000310files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 :setlocal makeprg=perlmake
312You can switch back to using the global value by making the local value empty: >
313 :setlocal makeprg=
314This only works for a string option. For a boolean option you need to use the
315"<" flag, like this: >
316 :setlocal autoread<
317Note that for non-boolean options using "<" copies the global value to the
318local value, it doesn't switch back to using the global value (that matters
319when changing the global value later).
320Note: In the future more global options can be made global-local. Using
321":setlocal" on a global option might work differently then.
322
323
324Setting the filetype
325
326:setf[iletype] {filetype} *:setf* *:setfiletype*
327 Set the 'filetype' option to {filetype}, but only if
328 not done yet in a sequence of (nested) autocommands.
329 This is short for: >
330 :if !did_filetype()
331 : setlocal filetype={filetype}
332 :endif
333< This command is used in a filetype.vim file to avoid
334 setting the 'filetype' option twice, causing different
335 settings and syntax files to be loaded.
336 {not in Vi}
337
338:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
339:opt[ions] Open a window for viewing and setting all options.
340 Options are grouped by function.
341 Offers short help for each option. Hit <CR> on the
342 short help to open a help window with more help for
343 the option.
344 Modify the value of the option and hit <CR> on the
345 "set" line to set the new value. For window and
346 buffer specific options, the last accessed window is
347 used to set the option value in, unless this is a help
348 window, in which case the window below help window is
349 used (skipping the option-window).
350 {not available when compiled without the |+eval| or
351 |+autocmd| features}
352
353 *$HOME*
354Using "~" is like using "$HOME", but it is only recognized at the start of an
355option and after a space or comma.
356
357On Unix systems "~user" can be used too. It is replaced by the home directory
358of user "user". Example: >
359 :set path=~mool/include,/usr/include,.
360
361On Unix systems the form "${HOME}" can be used too. The name between {} can
362contain non-id characters then. Note that if you want to use this for the
363"gf" command, you need to add the '{' and '}' characters to 'isfname'.
364
365NOTE: expanding environment variables and "~/" is only done with the ":set"
366command, not when assigning a value to an option with ":let".
367
368
369Note the maximum length of an expanded option is limited. How much depends on
370the system, mostly it is something like 256 or 1024 characters.
371
372 *:fix* *:fixdel*
373:fix[del] Set the value of 't_kD':
374 't_kb' is 't_kD' becomes ~
375 CTRL-? CTRL-H
376 not CTRL-? CTRL-?
377
378 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
379
380 If your delete key terminal code is wrong, but the
381 code for backspace is alright, you can put this in
382 your .vimrc: >
383 :fixdel
384< This works no matter what the actual code for
385 backspace is.
386
387 If the backspace key terminal code is wrong you can
388 use this: >
389 :if &term == "termname"
390 : set t_kb=^V<BS>
391 : fixdel
392 :endif
393< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000394 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395 with your terminal name.
396
397 If your <Delete> key sends a strange key sequence (not
398 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
399 :if &term == "termname"
400 : set t_kD=^V<Delete>
401 :endif
402< Where "^V" is CTRL-V and "<Delete>" is the delete key
403 (don't type eight characters!). Replace "termname"
404 with your terminal name.
405
406 *Linux-backspace*
407 Note about Linux: By default the backspace key
408 produces CTRL-?, which is wrong. You can fix it by
409 putting this line in your rc.local: >
410 echo "keycode 14 = BackSpace" | loadkeys
411<
412 *NetBSD-backspace*
413 Note about NetBSD: If your backspace doesn't produce
414 the right code, try this: >
415 xmodmap -e "keycode 22 = BackSpace"
416< If this works, add this in your .Xmodmap file: >
417 keysym 22 = BackSpace
418< You need to restart for this to take effect.
419
420==============================================================================
4212. Automatically setting options *auto-setting*
422
423Besides changing options with the ":set" command, there are three alternatives
424to set options automatically for one or more files:
425
4261. When starting Vim initializations are read from various places. See
427 |initialization|. Most of them are performed for all editing sessions,
428 and some of them depend on the directory where Vim is started.
429 You can create an initialization file with |:mkvimrc|, |:mkview| and
430 |:mksession|.
4312. If you start editing a new file, the automatic commands are executed.
432 This can be used to set options for files matching a particular pattern and
433 many other things. See |autocommand|.
4343. If you start editing a new file, and the 'modeline' option is on, a
435 number of lines at the beginning and end of the file are checked for
436 modelines. This is explained here.
437
438 *modeline* *vim:* *vi:* *ex:* *E520*
439There are two forms of modelines. The first form:
440 [text]{white}{vi:|vim:|ex:}[white]{options}
441
442[text] any text or empty
443{white} at least one blank character (<Space> or <Tab>)
444{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
445[white] optional white space
446{options} a list of option settings, separated with white space or ':',
447 where each part between ':' is the argument for a ":set"
448 command
449
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}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001225 {only available when compiled with the |+multi_byte|
1226 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 Specifies details about changing the case of letters. It may contain
1228 these words, separated by a comma:
1229 internal Use internal case mapping functions, the current
1230 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001231 matters when 'encoding' is a Unicode encoding,
1232 "latin1" or "iso-8859-15". When "internal" is
1233 omitted, the towupper() and towlower() system library
1234 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1236 case mapping, the current locale is not effective.
1237 This probably only matters for Turkish.
1238
1239 *'cdpath'* *'cd'* *E344* *E346*
1240'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1241 global
1242 {not in Vi}
1243 {not available when compiled without the
1244 |+file_in_path| feature}
1245 This is a list of directories which will be searched when using the
1246 |:cd| and |:lcd| commands, provided that the directory being searched
1247 for has a relative path (not starting with "/", "./" or "../").
1248 The 'cdpath' option's value has the same form and semantics as
1249 |'path'|. Also see |file-searching|.
1250 The default value is taken from $CDPATH, with a "," prepended to look
1251 in the current directory first.
1252 If the default value taken from $CDPATH is not what you want, include
1253 a modified version of the following command in your vimrc file to
1254 override it: >
1255 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1256< This option cannot be set from a |modeline| or in the |sandbox|, for
1257 security reasons.
1258 (parts of 'cdpath' can be passed to the shell to expand file names).
1259
1260 *'cedit'*
1261'cedit' string (Vi default: "", Vim default: CTRL-F)
1262 global
1263 {not in Vi}
1264 {not available when compiled without the |+vertsplit|
1265 feature}
1266 The key used in Command-line Mode to open the command-line window.
1267 The default is CTRL-F when 'compatible' is off.
1268 Only non-printable keys are allowed.
1269 The key can be specified as a single character, but it is difficult to
1270 type. The preferred way is to use the <> notation. Examples: >
1271 :set cedit=<C-Y>
1272 :set cedit=<Esc>
1273< |Nvi| also has this option, but it only uses the first character.
1274 See |cmdwin|.
1275
1276 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1277'charconvert' 'ccv' string (default "")
1278 global
1279 {only available when compiled with the |+multi_byte|
1280 feature and the |+eval| feature}
1281 {not in Vi}
1282 An expression that is used for character encoding conversion. It is
1283 evaluated when a file that is to be read or has been written has a
1284 different encoding from what is desired.
1285 'charconvert' is not used when the internal iconv() function is
1286 supported and is able to do the conversion. Using iconv() is
1287 preferred, because it is much faster.
1288 'charconvert' is not used when reading stdin |--|, because there is no
1289 file to convert from. You will have to save the text in a file first.
1290 The expression must return zero or an empty string for success,
1291 non-zero for failure.
1292 The possible encoding names encountered are in 'encoding'.
1293 Additionally, names given in 'fileencodings' and 'fileencoding' are
1294 used.
1295 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1296 is done internally by Vim, 'charconvert' is not used for this.
1297 'charconvert' is also used to convert the viminfo file, if the 'c'
1298 flag is present in 'viminfo'. Also used for Unicode conversion.
1299 Example: >
1300 set charconvert=CharConvert()
1301 fun CharConvert()
1302 system("recode "
1303 \ . v:charconvert_from . ".." . v:charconvert_to
1304 \ . " <" . v:fname_in . " >" v:fname_out)
1305 return v:shell_error
1306 endfun
1307< The related Vim variables are:
1308 v:charconvert_from name of the current encoding
1309 v:charconvert_to name of the desired encoding
1310 v:fname_in name of the input file
1311 v:fname_out name of the output file
1312 Note that v:fname_in and v:fname_out will never be the same.
1313 Note that v:charconvert_from and v:charconvert_to may be different
1314 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1315 Encryption is not done by Vim when using 'charconvert'. If you want
1316 to encrypt the file after conversion, 'charconvert' should take care
1317 of this.
1318 This option cannot be set from a |modeline| or in the |sandbox|, for
1319 security reasons.
1320
1321 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1322'cindent' 'cin' boolean (default off)
1323 local to buffer
1324 {not in Vi}
1325 {not available when compiled without the |+cindent|
1326 feature}
1327 Enables automatic C program indenting See 'cinkeys' to set the keys
1328 that trigger reindenting in insert mode and 'cinoptions' to set your
1329 preferred indent style.
1330 If 'indentexpr' is not empty, it overrules 'cindent'.
1331 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1332 the "=" operator indents using this algorithm rather than calling an
1333 external program.
1334 See |C-indenting|.
1335 When you don't like the way 'cindent' works, try the 'smartindent'
1336 option or 'indentexpr'.
1337 This option is not used when 'paste' is set.
1338 NOTE: This option is reset when 'compatible' is set.
1339
1340 *'cinkeys'* *'cink'*
1341'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1342 local to buffer
1343 {not in Vi}
1344 {not available when compiled without the |+cindent|
1345 feature}
1346 A list of keys that, when typed in Insert mode, cause reindenting of
1347 the current line. Only used if 'cindent' is on and 'indentexpr' is
1348 empty.
1349 For the format of this option see |cinkeys-format|.
1350 See |C-indenting|.
1351
1352 *'cinoptions'* *'cino'*
1353'cinoptions' 'cino' string (default "")
1354 local to buffer
1355 {not in Vi}
1356 {not available when compiled without the |+cindent|
1357 feature}
1358 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1359 program. See |cinoptions-values| for the values of this option, and
1360 |C-indenting| for info on C indenting in general.
1361
1362
1363 *'cinwords'* *'cinw'*
1364'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1365 local to buffer
1366 {not in Vi}
1367 {not available when compiled without both the
1368 |+cindent| and the |+smartindent| features}
1369 These keywords start an extra indent in the next line when
1370 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1371 an appropriate place (inside {}).
1372 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1373 matter, include the keyword both the uppercase and lowercase:
1374 "if,If,IF".
1375
1376 *'clipboard'* *'cb'*
1377'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1378 for X-windows, "" otherwise)
1379 global
1380 {not in Vi}
1381 {only in GUI versions or when the |+xterm_clipboard|
1382 feature is included}
1383 This option is a list of comma separated names.
1384 These names are recognized:
1385
1386 unnamed When included, Vim will use the clipboard register '*'
1387 for all yank, delete, change and put operations which
1388 would normally go to the unnamed register. When a
1389 register is explicitly specified, it will always be
1390 used regardless of whether "unnamed" is in 'clipboard'
1391 or not. The clipboard register can always be
1392 explicitly accessed using the "* notation. Also see
1393 |gui-clipboard|.
1394
1395 autoselect Works like the 'a' flag in 'guioptions': If present,
1396 then whenever Visual mode is started, or the Visual
1397 area extended, Vim tries to become the owner of the
1398 windowing system's global selection or put the
1399 selected text on the clipboard used by the selection
1400 register "*. See |guioptions_a| and |quotestar| for
1401 details. When the GUI is active, the 'a' flag in
1402 'guioptions' is used, when the GUI is not active, this
1403 "autoselect" flag is used.
1404 Also applies to the modeless selection.
1405
1406 autoselectml Like "autoselect", but for the modeless selection
1407 only. Compare to the 'A' flag in 'guioptions'.
1408
1409 exclude:{pattern}
1410 Defines a pattern that is matched against the name of
1411 the terminal 'term'. If there is a match, no
1412 connection will be made to the X server. This is
1413 useful in this situation:
1414 - Running Vim in a console.
1415 - $DISPLAY is set to start applications on another
1416 display.
1417 - You do not want to connect to the X server in the
1418 console, but do want this in a terminal emulator.
1419 To never connect to the X server use: >
1420 exclude:.*
1421< This has the same effect as using the |-X| argument.
1422 Note that when there is no connection to the X server
1423 the window title won't be restored and the clipboard
1424 cannot be accessed.
1425 The value of 'magic' is ignored, {pattern} is
1426 interpreted as if 'magic' was on.
1427 The rest of the option value will be used for
1428 {pattern}, this must be the last entry.
1429
1430 *'cmdheight'* *'ch'*
1431'cmdheight' 'ch' number (default 1)
1432 global
1433 {not in Vi}
1434 Number of screen lines to use for the command-line. Helps avoiding
1435 |hit-enter| prompts.
1436
1437 *'cmdwinheight'* *'cwh'*
1438'cmdwinheight' 'cwh' number (default 7)
1439 global
1440 {not in Vi}
1441 {not available when compiled without the |+vertsplit|
1442 feature}
1443 Number of screen lines to use for the command-line window. |cmdwin|
1444
1445 *'columns'* *'co'* *E594*
1446'columns' 'co' number (default 80 or terminal width)
1447 global
1448 {not in Vi}
1449 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001450 initialization and does not have to be set by hand. Also see
1451 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452 When Vim is running in the GUI or in a resizable window, setting this
1453 option will cause the window size to be changed. When you only want
1454 to use the size for the GUI, put the command in your |gvimrc| file.
1455 When you set this option and Vim is unable to change the physical
1456 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001457 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458
1459 *'comments'* *'com'* *E524* *E525*
1460'comments' 'com' string (default
1461 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1462 local to buffer
1463 {not in Vi}
1464 {not available when compiled without the |+comments|
1465 feature}
1466 A comma separated list of strings that can start a comment line. See
1467 |format-comments|. See |option-backslash| about using backslashes to
1468 insert a space.
1469
1470 *'commentstring'* *'cms'* *E537*
1471'commentstring' 'cms' string (default "/*%s*/")
1472 local to buffer
1473 {not in Vi}
1474 {not available when compiled without the |+folding|
1475 feature}
1476 A template for a comment. The "%s" in the value is replaced with the
1477 comment text. Currently only used to add markers for folding, see
1478 |fold-marker|.
1479
1480 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001481'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1482 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483 global
1484 {not in Vi}
1485 This option has the effect of making Vim either more Vi-compatible, or
1486 make Vim behave in a more useful way.
1487 This is a special kind of option, because when it's set or reset,
1488 other options are also changed as a side effect. CAREFUL: Setting or
1489 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001490 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 set this option in your vimrc file, you should probably put it at the
1492 very start.
1493 By default this option is on and the Vi defaults are used for the
1494 options. This default was chosen for those people who want to use Vim
1495 just like Vi, and don't even (want to) know about the 'compatible'
1496 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001497 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1498 this option is switched off, and all options that have not been
1499 modified will be set to the Vim defaults. Effectively, this means
1500 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1501 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1502 happen for the system-wide vimrc or gvimrc file). Also see
1503 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 You can also set this option with the "-C" argument, and reset it with
1505 "-N". See |-C| and |-N|.
1506 Switching this option off makes the Vim defaults be used for options
1507 that have a different Vi and Vim default value. See the options
1508 marked with a '+' below. Other options are not modified.
1509 At the moment this option is set, several other options will be set
1510 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001511 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512 editing.
1513 See also 'cpoptions'.
1514
1515 option + set value effect ~
1516
1517 'allowrevins' off no CTRL-_ command
1518 'backupcopy' Unix: "yes" backup file is a copy
1519 others: "auto" copy or rename backup file
1520 'backspace' "" normal backspace
1521 'backup' off no backup file
1522 'cindent' off no C code indentation
1523 'cedit' + "" no key to open the |cmdwin|
1524 'cpoptions' + (all flags) Vi-compatible flags
1525 'cscopetag' off don't use cscope for ":tag"
1526 'cscopetagorder' 0 see |cscopetagorder|
1527 'cscopeverbose' off see |cscopeverbose|
1528 'digraph' off no digraphs
1529 'esckeys' + off no <Esc>-keys in Insert mode
1530 'expandtab' off tabs not expanded to spaces
1531 'fileformats' + "" no automatic file format detection,
1532 "dos,unix" except for DOS, Windows and OS/2
1533 'formatoptions' + "vt" Vi compatible formatting
1534 'gdefault' off no default 'g' flag for ":s"
1535 'history' + 0 no commandline history
1536 'hkmap' off no Hebrew keyboard mapping
1537 'hkmapp' off no phonetic Hebrew keyboard mapping
1538 'hlsearch' off no highlighting of search matches
1539 'incsearch' off no incremental searching
1540 'indentexpr' "" no indenting by expression
1541 'insertmode' off do not start in Insert mode
1542 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1543 characters and '_'
1544 'joinspaces' on insert 2 spaces after period
1545 'modeline' + off no modelines
1546 'more' + off no pauses in listings
1547 'revins' off no reverse insert
1548 'ruler' off no ruler
1549 'scrolljump' 1 no jump scroll
1550 'scrolloff' 0 no scroll offset
1551 'shiftround' off indent not rounded to shiftwidth
1552 'shortmess' + "" no shortening of messages
1553 'showcmd' + off command characters not shown
1554 'showmode' + off current mode not shown
1555 'smartcase' off no automatic ignore case switch
1556 'smartindent' off no smart indentation
1557 'smarttab' off no smart tab size
1558 'softtabstop' 0 tabs are always 'tabstop' positions
1559 'startofline' on goto startofline with some commands
1560 'tagrelative' + off tag file names are not relative
1561 'textauto' + off no automatic textmode detection
1562 'textwidth' 0 no automatic line wrap
1563 'tildeop' off tilde is not an operator
1564 'ttimeout' off no terminal timeout
1565 'whichwrap' + "" left-right movements don't wrap
1566 'wildchar' + CTRL-E only when the current value is <Tab>
1567 use CTRL-E for cmdline completion
1568 'writebackup' on or off depends on +writebackup feature
1569
1570 *'complete'* *'cpt'* *E535*
1571'complete' 'cpt' string (default: ".,w,b,u,t,i")
1572 local to buffer
1573 {not in Vi}
1574 This option specifies how keyword completion |ins-completion| works
1575 when CTRL-P or CTRL-N are used. It is also used for whole-line
1576 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1577 and the places to scan. It is a comma separated list of flags:
1578 . scan the current buffer ('wrapscan' is ignored)
1579 w scan buffers from other windows
1580 b scan other loaded buffers that are in the buffer list
1581 u scan the unloaded buffers that are in the buffer list
1582 U scan the buffers that are not in the buffer list
1583 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001584 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585 k{dict} scan the file {dict}. Several "k" flags can be given,
1586 patterns are valid too. For example: >
1587 :set cpt=k/usr/dict/*,k~/spanish
1588< s scan the files given with the 'thesaurus' option
1589 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1590 are valid too.
1591 i scan current and included files
1592 d scan current and included files for defined name or macro
1593 |i_CTRL-X_CTRL-D|
1594 ] tag completion
1595 t same as "]"
1596
1597 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1598 not executed, this may lead to unexpected completions from some files
1599 (gzipped files for example). Unloaded buffers are not scanned for
1600 whole-line completion.
1601
1602 The default is ".,w,b,u,t,i", which means to scan:
1603 1. the current buffer
1604 2. buffers in other windows
1605 3. other loaded buffers
1606 4. unloaded buffers
1607 5. tags
1608 6. included files
1609
1610 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001611 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1612 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001614 *'completefunc'* *'cfu'*
1615'completefunc' 'cfu' string (default: empty)
1616 local to buffer
1617 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001618 {not available when compiled without the +eval
1619 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001620 This option specifies a function to be used for Insert mode completion
1621 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001622 See |complete-functions| for an explanation of how the function is
1623 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001624
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001625
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001626 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001627'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001628 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001629 {not available when compiled without the
1630 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001631 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001632 A comma separated list of options for Insert mode completion
1633 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001634
1635 menu Use a popup menu to show the possible completions. The
1636 menu is only shown when there is more than one match and
1637 sufficient colors are available. |ins-completion-menu|
1638
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001639 menuone Use the popup menu also when there is only one match.
1640 Useful when there is additional information about the
1641 match, e.g., what file it comes from.
1642
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001643 longest Only insert the longest common text of the matches. Use
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001644 CTRL-L to add more characters. Whether case is ignored
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001645 depends on the kind of completion. For buffer text the
1646 'ignorecase' option is used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001647
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001648 preview Show extra information about the currently selected
1649 completion in the preview window.
1650
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1652'confirm' 'cf' boolean (default off)
1653 global
1654 {not in Vi}
1655 When 'confirm' is on, certain operations that would normally
1656 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1657 instead raise a |dialog| asking if you wish to save the current
1658 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1659 If 'confirm' is off you can still activate confirmation for one
1660 command only (this is most useful in mappings) with the |:confirm|
1661 command.
1662 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1663
1664 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1665'conskey' 'consk' boolean (default off)
1666 global
1667 {not in Vi} {only for MS-DOS}
1668 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001669 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 three methods of console input are available:
1671 'conskey' 'bioskey' action ~
1672 on on or off direct console input
1673 off on BIOS
1674 off off STDIN
1675
1676 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1677'copyindent' 'ci' boolean (default off)
1678 local to buffer
1679 {not in Vi}
1680 Copy the structure of the existing lines indent when autoindenting a
1681 new line. Normally the new indent is reconstructed by a series of
1682 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1683 in which case only spaces are used). Enabling this option makes the
1684 new line copy whatever characters were used for indenting on the
1685 existing line. If the new indent is greater than on the existing
1686 line, the remaining space is filled in the normal manner.
1687 NOTE: 'copyindent' is reset when 'compatible' is set.
1688 Also see 'preserveindent'.
1689
1690 *'cpoptions'* *'cpo'*
1691'cpoptions' 'cpo' string (Vim default: "aABceFs",
1692 Vi default: all flags)
1693 global
1694 {not in Vi}
1695 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001696 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 not being vi-compatible is mostly or sometimes preferred.
1698 'cpoptions' stands for "compatible-options".
1699 Commas can be added for readability.
1700 To avoid problems with flags that are added in the future, use the
1701 "+=" and "-=" feature of ":set" |add-option-flags|.
1702 NOTE: This option is set to the Vi default value when 'compatible' is
1703 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001704 NOTE: This option is set to the POSIX default value at startup when
1705 the Vi default value would be used and the $VIM_POSIX environment
1706 variable exists |posix|. This means tries to behave like the POSIX
1707 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708
1709 contains behavior ~
1710 *cpo-a*
1711 a When included, a ":read" command with a file name
1712 argument will set the alternate file name for the
1713 current window.
1714 *cpo-A*
1715 A When included, a ":write" command with a file name
1716 argument will set the alternate file name for the
1717 current window.
1718 *cpo-b*
1719 b "\|" in a ":map" command is recognized as the end of
1720 the map command. The '\' is included in the mapping,
1721 the text after the '|' is interpreted as the next
1722 command. Use a CTRL-V instead of a backslash to
1723 include the '|' in the mapping. Applies to all
1724 mapping, abbreviation, menu and autocmd commands.
1725 See also |map_bar|.
1726 *cpo-B*
1727 B A backslash has no special meaning in mappings,
1728 abbreviations and the "to" part of the menu commands.
1729 Remove this flag to be able to use a backslash like a
1730 CTRL-V. For example, the command ":map X \<Esc>"
1731 results in X being mapped to:
1732 'B' included: "\^[" (^[ is a real <Esc>)
1733 'B' excluded: "<Esc>" (5 characters)
1734 ('<' excluded in both cases)
1735 *cpo-c*
1736 c Searching continues at the end of any match at the
1737 cursor position, but not further than the start of the
1738 next line. When not present searching continues
1739 one character from the cursor position. With 'c'
1740 "abababababab" only gets three matches when repeating
1741 "/abab", without 'c' there are five matches.
1742 *cpo-C*
1743 C Do not concatenate sourced lines that start with a
1744 backslash. See |line-continuation|.
1745 *cpo-d*
1746 d Using "./" in the 'tags' option doesn't mean to use
1747 the tags file relative to the current file, but the
1748 tags file in the current directory.
1749 *cpo-D*
1750 D Can't use CTRL-K to enter a digraph after Normal mode
1751 commands with a character argument, like |r|, |f| and
1752 |t|.
1753 *cpo-e*
1754 e When executing a register with ":@r", always add a
1755 <CR> to the last line, also when the register is not
1756 linewise. If this flag is not present, the register
1757 is not linewise and the last line does not end in a
1758 <CR>, then the last line is put on the command-line
1759 and can be edited before hitting <CR>.
1760 *cpo-E*
1761 E It is an error when using "y", "d", "c", "g~", "gu" or
1762 "gU" on an Empty region. The operators only work when
1763 at least one character is to be operate on. Example:
1764 This makes "y0" fail in the first column.
1765 *cpo-f*
1766 f When included, a ":read" command with a file name
1767 argument will set the file name for the current buffer,
1768 if the current buffer doesn't have a file name yet.
1769 *cpo-F*
1770 F When included, a ":write" command with a file name
1771 argument will set the file name for the current
1772 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001773 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 *cpo-g*
1775 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001776 *cpo-H*
1777 H When using "I" on a line with only blanks, insert
1778 before the last blank. Without this flag insert after
1779 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 *cpo-i*
1781 i When included, interrupting the reading of a file will
1782 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001783 *cpo-I*
1784 I When moving the cursor up or down just after inserting
1785 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 *cpo-j*
1787 j When joining lines, only add two spaces after a '.',
1788 not after '!' or '?'. Also see 'joinspaces'.
1789 *cpo-J*
1790 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001791 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 white space.
1793 *cpo-k*
1794 k Disable the recognition of raw key codes in
1795 mappings, abbreviations, and the "to" part of menu
1796 commands. For example, if <Key> sends ^[OA (where ^[
1797 is <Esc>), the command ":map X ^[OA" results in X
1798 being mapped to:
1799 'k' included: "^[OA" (3 characters)
1800 'k' excluded: "<Key>" (one key code)
1801 Also see the '<' flag below.
1802 *cpo-K*
1803 K Don't wait for a key code to complete when it is
1804 halfway a mapping. This breaks mapping <F1><F1> when
1805 only part of the second <F1> has been read. It
1806 enables cancelling the mapping by typing <F1><Esc>.
1807 *cpo-l*
1808 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001809 literally, only "\]", "\^", "\-" and "\\" are special.
1810 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1812 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001813 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 *cpo-L*
1815 L When the 'list' option is set, 'wrapmargin',
1816 'textwidth', 'softtabstop' and Virtual Replace mode
1817 (see |gR|) count a <Tab> as two characters, instead of
1818 the normal behavior of a <Tab>.
1819 *cpo-m*
1820 m When included, a showmatch will always wait half a
1821 second. When not included, a showmatch will wait half
1822 a second or until a character is typed. |'showmatch'|
1823 *cpo-M*
1824 M When excluded, "%" matching will take backslashes into
1825 account. Thus in "( \( )" and "\( ( \)" the outer
1826 parenthesis match. When included "%" ignores
1827 backslashes, which is Vi compatible.
1828 *cpo-n*
1829 n When included, the column used for 'number' will also
1830 be used for text of wrapped lines.
1831 *cpo-o*
1832 o Line offset to search command is not remembered for
1833 next search.
1834 *cpo-O*
1835 O Don't complain if a file is being overwritten, even
1836 when it didn't exist when editing it. This is a
1837 protection against a file unexpectedly created by
1838 someone else. Vi didn't complain about this.
1839 *cpo-p*
1840 p Vi compatible Lisp indenting. When not present, a
1841 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001842 *cpo-P*
1843 P When included, a ":write" command that appends to a
1844 file will set the file name for the current buffer, if
1845 the current buffer doesn't have a file name yet and
1846 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001847 *cpo-q*
1848 q When joining multiple lines leave the cursor at the
1849 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 *cpo-r*
1851 r Redo ("." command) uses "/" to repeat a search
1852 command, instead of the actually used search string.
1853 *cpo-R*
1854 R Remove marks from filtered lines. Without this flag
1855 marks are kept like |:keepmarks| was used.
1856 *cpo-s*
1857 s Set buffer options when entering the buffer for the
1858 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001859 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 set when the buffer is created.
1861 *cpo-S*
1862 S Set buffer options always when entering a buffer
1863 (except 'readonly', 'fileformat', 'filetype' and
1864 'syntax'). This is the (most) Vi compatible setting.
1865 The options are set to the values in the current
1866 buffer. When you change an option and go to another
1867 buffer, the value is copied. Effectively makes the
1868 buffer options global to all buffers.
1869
1870 's' 'S' copy buffer options
1871 no no when buffer created
1872 yes no when buffer first entered (default)
1873 X yes each time when buffer entered (vi comp.)
1874 *cpo-t*
1875 t Search pattern for the tag command is remembered for
1876 "n" command. Otherwise Vim only puts the pattern in
1877 the history for search pattern, but doesn't change the
1878 last used search pattern.
1879 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001880 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 *cpo-v*
1882 v Backspaced characters remain visible on the screen in
1883 Insert mode. Without this flag the characters are
1884 erased from the screen right away. With this flag the
1885 screen newly typed text overwrites backspaced
1886 characters.
1887 *cpo-w*
1888 w When using "cw" on a blank character, only change one
1889 character and not all blanks until the start of the
1890 next word.
1891 *cpo-W*
1892 W Don't overwrite a readonly file. When omitted, ":w!"
1893 overwrites a readonly file, if possible.
1894 *cpo-x*
1895 x <Esc> on the command-line executes the command-line.
1896 The default in Vim is to abandon the command-line,
1897 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001898 *cpo-X*
1899 X When using a count with "R" the replaced text is
1900 deleted only once. Also when repeating "R" with "."
1901 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902 *cpo-y*
1903 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001904 *cpo-Z*
1905 Z When using "w!" while the 'readonly' option is set,
1906 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907 *cpo-!*
1908 ! When redoing a filter command, use the last used
1909 external command, whatever it was. Otherwise the last
1910 used -filter- command is used.
1911 *cpo-$*
1912 $ When making a change to one line, don't redisplay the
1913 line, but put a '$' at the end of the changed text.
1914 The changed text will be overwritten when you type the
1915 new text. The line is redisplayed if you type any
1916 command that moves the cursor from the insertion
1917 point.
1918 *cpo-%*
1919 % Vi-compatible matching is done for the "%" command.
1920 Does not recognize "#if", "#endif", etc.
1921 Does not recognize "/*" and "*/".
1922 Parens inside single and double quotes are also
1923 counted, causing a string that contains a paren to
1924 disturb the matching. For example, in a line like
1925 "if (strcmp("foo(", s))" the first paren does not
1926 match the last one. When this flag is not included,
1927 parens inside single and double quotes are treated
1928 specially. When matching a paren outside of quotes,
1929 everything inside quotes is ignored. When matching a
1930 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001931 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001932 This flag is also used for other features, such as
1933 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001934 *cpo--*
1935 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001936 it would go above the first line or below the last
1937 line. Without it the cursor moves to the first or
1938 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001939 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001940 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001941 *cpo-+*
1942 + When included, a ":write file" command will reset the
1943 'modified' flag of the buffer, even though the buffer
1944 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001945 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 * Use ":*" in the same way as ":@". When not included,
1947 ":*" is an alias for ":'<,'>", select the Visual area.
1948 *cpo-<*
1949 < Disable the recognition of special key codes in |<>|
1950 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001951 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 ":map X <Tab>" results in X being mapped to:
1953 '<' included: "<Tab>" (5 characters)
1954 '<' excluded: "^I" (^I is a real <Tab>)
1955 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001956 *cpo->*
1957 > When appending to a register, put a line break before
1958 the appended text.
1959
1960 POSIX flags. These are not included in the Vi default value, except
1961 when $VIM_POSIX was set on startup. |posix|
1962
1963 contains behavior ~
1964 *cpo-#*
1965 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001966 *cpo-&*
1967 & When ":preserve" was used keep the swap file when
1968 exiting normally while this buffer is still loaded.
1969 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001970 *cpo-\*
1971 \ Backslash in a [] range in a search pattern is taken
1972 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001973 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1974 '\' excluded: "/[ \-]" finds <Space> and '-'
1975 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001976 *cpo-/*
1977 / When "%" is used as the replacement string in a |:s|
1978 command, use the previous replacement string. |:s%|
1979 *cpo-{*
1980 { The |{| and |}| commands also stop at a "{" character
1981 at the start of a line.
1982 *cpo-.*
1983 . The ":chdir" and ":cd" commands fail if the current
1984 buffer is modified, unless ! is used. Vim doesn't
1985 need this, since it remembers the full path of an
1986 opened file.
1987 *cpo-bar*
1988 | The value of the $LINES and $COLUMNS environment
1989 variables overrule the terminal size values obtained
1990 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001991
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992
1993 *'cscopepathcomp'* *'cspc'*
1994'cscopepathcomp' 'cspc' number (default 0)
1995 global
1996 {not available when compiled without the |+cscope|
1997 feature}
1998 {not in Vi}
1999 Determines how many components of the path to show in a list of tags.
2000 See |cscopepathcomp|.
2001
2002 *'cscopeprg'* *'csprg'*
2003'cscopeprg' 'csprg' string (default "cscope")
2004 global
2005 {not available when compiled without the |+cscope|
2006 feature}
2007 {not in Vi}
2008 Specifies the command to execute cscope. See |cscopeprg|.
2009 This option cannot be set from a |modeline| or in the |sandbox|, for
2010 security reasons.
2011
2012 *'cscopequickfix'* *'csqf'*
2013'cscopequickfix' 'csqf' string (default "")
2014 global
2015 {not available when compiled without the |+cscope|
2016 or |+quickfix| features}
2017 {not in Vi}
2018 Specifies whether to use quickfix window to show cscope results.
2019 See |cscopequickfix|.
2020
2021 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2022'cscopetag' 'cst' boolean (default off)
2023 global
2024 {not available when compiled without the |+cscope|
2025 feature}
2026 {not in Vi}
2027 Use cscope for tag commands. See |cscope-options|.
2028 NOTE: This option is reset when 'compatible' is set.
2029
2030 *'cscopetagorder'* *'csto'*
2031'cscopetagorder' 'csto' number (default 0)
2032 global
2033 {not available when compiled without the |+cscope|
2034 feature}
2035 {not in Vi}
2036 Determines the order in which ":cstag" performs a search. See
2037 |cscopetagorder|.
2038 NOTE: This option is set to 0 when 'compatible' is set.
2039
2040 *'cscopeverbose'* *'csverb'*
2041 *'nocscopeverbose'* *'nocsverb'*
2042'cscopeverbose' 'csverb' boolean (default off)
2043 global
2044 {not available when compiled without the |+cscope|
2045 feature}
2046 {not in Vi}
2047 Give messages when adding a cscope database. See |cscopeverbose|.
2048 NOTE: This option is reset when 'compatible' is set.
2049
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002050
2051 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2052'cursorcolumn' 'cuc' boolean (default off)
2053 local to window
2054 {not in Vi}
2055 {not available when compiled without the |+syntax|
2056 feature}
2057 Highlight the screen column of the cursor with CursorColumn
2058 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2059 slower.
2060
2061 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2062'cursorline' 'cul' boolean (default off)
2063 local to window
2064 {not in Vi}
2065 {not available when compiled without the |+syntax|
2066 feature}
2067 Highlight the screen line of the cursor with CursorLine
2068 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2069 redrawing slower.
2070
2071
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 *'debug'*
2073'debug' string (default "")
2074 global
2075 {not in Vi}
2076 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002077 be given anyway. This is useful when debugging 'foldexpr',
2078 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002079 When set to "beep", a message will be given when otherwise only a beep
2080 would be produced.
2081 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082
2083 *'define'* *'def'*
2084'define' 'def' string (default "^\s*#\s*define")
2085 global or local to buffer |global-local|
2086 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002087 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 pattern, just like for the "/" command. This option is used for the
2089 commands like "[i" and "[d" |include-search|. The 'isident' option is
2090 used to recognize the defined name after the match:
2091 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2092 See |option-backslash| about inserting backslashes to include a space
2093 or backslash.
2094 The default value is for C programs. For C++ this value would be
2095 useful, to include const type declarations: >
2096 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2097< When using the ":set" command, you need to double the backslashes!
2098
2099 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2100'delcombine' 'deco' boolean (default off)
2101 global
2102 {not in Vi}
2103 {only available when compiled with the |+multi_byte|
2104 feature}
2105 If editing Unicode and this option is set, backspace and Normal mode
2106 "x" delete each combining character on its own. When it is off (the
2107 default) the character along with its combining characters are
2108 deleted.
2109 Note: When 'delcombine' is set "xx" may work different from "2x"!
2110
2111 This is useful for Arabic, Hebrew and many other languages where one
2112 may have combining characters overtop of base characters, and want
2113 to remove only the combining ones.
2114
2115 *'dictionary'* *'dict'*
2116'dictionary' 'dict' string (default "")
2117 global or local to buffer |global-local|
2118 {not in Vi}
2119 List of file names, separated by commas, that are used to lookup words
2120 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2121 contain a list of words. This can be one word per line, or several
2122 words per line, separated by non-keyword characters (white space is
2123 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002124 When this option is empty, or an entry "spell" is present, spell
2125 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002126 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 after a comma are ignored, otherwise spaces are included in the file
2128 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002129 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 Where to find a list of words?
2131 - On FreeBSD, there is the file "/usr/share/dict/words".
2132 - In the Simtel archive, look in the "msdos/linguist" directory.
2133 - In "miscfiles" of the GNU collection.
2134 The use of |:set+=| and |:set-=| is preferred when adding or removing
2135 directories from the list. This avoids problems when a future version
2136 uses another default.
2137 Backticks cannot be used in this option for security reasons.
2138
2139 *'diff'* *'nodiff'*
2140'diff' boolean (default off)
2141 local to window
2142 {not in Vi}
2143 {not available when compiled without the |+diff|
2144 feature}
2145 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002146 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147
2148 *'dex'* *'diffexpr'*
2149'diffexpr' 'dex' string (default "")
2150 global
2151 {not in Vi}
2152 {not available when compiled without the |+diff|
2153 feature}
2154 Expression which is evaluated to obtain an ed-style diff file from two
2155 versions of a file. See |diff-diffexpr|.
2156 This option cannot be set from a |modeline| or in the |sandbox|, for
2157 security reasons.
2158
2159 *'dip'* *'diffopt'*
2160'diffopt' 'dip' string (default "filler")
2161 global
2162 {not in Vi}
2163 {not available when compiled without the |+diff|
2164 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002165 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 All are optional. Items must be separated by a comma.
2167
2168 filler Show filler lines, to keep the text
2169 synchronized with a window that has inserted
2170 lines at the same position. Mostly useful
2171 when windows are side-by-side and 'scrollbind'
2172 is set.
2173
2174 context:{n} Use a context of {n} lines between a change
2175 and a fold that contains unchanged lines.
2176 When omitted a context of six lines is used.
2177 See |fold-diff|.
2178
2179 icase Ignore changes in case of text. "a" and "A"
2180 are considered the same. Adds the "-i" flag
2181 to the "diff" command if 'diffexpr' is empty.
2182
2183 iwhite Ignore changes in amount of white space. Adds
2184 the "-b" flag to the "diff" command if
2185 'diffexpr' is empty. Check the documentation
2186 of the "diff" command for what this does
2187 exactly. It should ignore adding trailing
2188 white space, but not leading white space.
2189
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002190 horizontal Start diff mode with horizontal splits (unless
2191 explicitly specified otherwise).
2192
2193 vertical Start diff mode with vertical splits (unless
2194 explicitly specified otherwise).
2195
2196 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2197 starting diff mode. Without this 2 is used.
2198
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 Examples: >
2200
2201 :set diffopt=filler,context:4
2202 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002203 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204<
2205 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2206'digraph' 'dg' boolean (default off)
2207 global
2208 {not in Vi}
2209 {not available when compiled without the |+digraphs|
2210 feature}
2211 Enable the entering of digraphs in Insert mode with {char1} <BS>
2212 {char2}. See |digraphs|.
2213 NOTE: This option is reset when 'compatible' is set.
2214
2215 *'directory'* *'dir'*
2216'directory' 'dir' string (default for Amiga: ".,t:",
2217 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2218 for Unix: ".,~/tmp,/var/tmp,/tmp")
2219 global
2220 List of directory names for the swap file, separated with commas.
2221 - The swap file will be created in the first directory where this is
2222 possible.
2223 - Empty means that no swap file will be used (recovery is
2224 impossible!).
2225 - A directory "." means to put the swap file in the same directory as
2226 the edited file. On Unix, a dot is prepended to the file name, so
2227 it doesn't show in a directory listing. On MS-Windows the "hidden"
2228 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002229 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 put the swap file relative to where the edited file is. The leading
2231 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002232 - For Unix and Win32, if a directory ends in two path separators "//"
2233 or "\\", the swap file name will be built from the complete path to
2234 the file with all path separators substituted to percent '%' signs.
2235 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 - Spaces after the comma are ignored, other spaces are considered part
2237 of the directory name. To have a space at the start of a directory
2238 name, precede it with a backslash.
2239 - To include a comma in a directory name precede it with a backslash.
2240 - A directory name may end in an ':' or '/'.
2241 - Environment variables are expanded |:set_env|.
2242 - Careful with '\' characters, type one before a space, type two to
2243 get one in the option (see |option-backslash|), for example: >
2244 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2245< - For backwards compatibility with Vim version 3.0 a '>' at the start
2246 of the option is removed.
2247 Using "." first in the list is recommended. This means that editing
2248 the same file twice will result in a warning. Using "/tmp" on Unix is
2249 discouraged: When the system crashes you lose the swap file.
2250 "/var/tmp" is often not cleared when rebooting, thus is a better
2251 choice than "/tmp". But it can contain a lot of files, your swap
2252 files get lost in the crowd. That is why a "tmp" directory in your
2253 home directory is tried first.
2254 The use of |:set+=| and |:set-=| is preferred when adding or removing
2255 directories from the list. This avoids problems when a future version
2256 uses another default.
2257 This option cannot be set from a |modeline| or in the |sandbox|, for
2258 security reasons.
2259 {Vi: directory to put temp file in, defaults to "/tmp"}
2260
2261 *'display'* *'dy'*
2262'display' 'dy' string (default "")
2263 global
2264 {not in Vi}
2265 Change the way text is displayed. This is comma separated list of
2266 flags:
2267 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002268 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 last line that doesn't fit is replaced with "@" lines.
2270 uhex Show unprintable characters hexadecimal as <xx>
2271 instead of using ^C and ~C.
2272
2273 *'eadirection'* *'ead'*
2274'eadirection' 'ead' string (default "both")
2275 global
2276 {not in Vi}
2277 {not available when compiled without the +vertsplit
2278 feature}
2279 Tells when the 'equalalways' option applies:
2280 ver vertically, width of windows is not affected
2281 hor horizontally, height of windows is not affected
2282 both width and height of windows is affected
2283
2284 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2285'edcompatible' 'ed' boolean (default off)
2286 global
2287 Makes the 'g' and 'c' flags of the ":substitute" command to be
2288 toggled each time the flag is given. See |complex-change|. See
2289 also 'gdefault' option.
2290 Switching this option on is discouraged!
2291
2292 *'encoding'* *'enc'* *E543*
2293'encoding' 'enc' string (default: "latin1" or value from $LANG)
2294 global
2295 {only available when compiled with the |+multi_byte|
2296 feature}
2297 {not in Vi}
2298 Sets the character encoding used inside Vim. It applies to text in
2299 the buffers, registers, Strings in expressions, text stored in the
2300 viminfo file, etc. It sets the kind of characters which Vim can work
2301 with. See |encoding-names| for the possible values.
2302
2303 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002304 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305 It should normally be kept at its default value, or set when Vim
2306 starts up. See |multibyte|.
2307
2308 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2309 "utf-8". Although care has been taken to allow different values of
2310 'encoding', "utf-8" is the natural choice for the environment and
2311 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002312 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 versions, and to avoid changing the encoding of newly created files
2314 without your knowledge (in case 'fileencodings' is empty).
2315
2316 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002317 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 iconv() or as specified with 'charconvert'.
2319
2320 Normally 'encoding' will be equal to your current locale. This will
2321 be the default if Vim recognizes your environment settings. If
2322 'encoding' is not set to the current locale, 'termencoding' must be
2323 set to convert typed and displayed text. See |encoding-table|.
2324
2325 When you set this option, it fires the |EncodingChanged| autocommand
2326 event so that you can set up fonts if necessary.
2327
2328 When the option is set, the value is converted to lowercase. Thus
2329 you can set it with uppercase values too. Underscores are translated
2330 to '-' signs.
2331 When the encoding is recognized, it is changed to the standard name.
2332 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2333 "iso-8859-2" and "utf8" becomes "utf-8".
2334
2335 Note: "latin1" is also used when the encoding could not be detected.
2336 This only works when editing files in the same encoding! When the
2337 actual character set is not latin1, make sure 'fileencoding' and
2338 'fileencodings' are empty. When conversion is needed, switch to using
2339 utf-8.
2340
2341 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2342 You don't notice this while editing, but it does matter for the
2343 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2344 setting 'encoding' to one of these values instead of utf-8 only has
2345 effect for encoding used for files when 'fileencoding' is empty.
2346
Bram Moolenaar661b1822005-07-28 22:36:45 +00002347 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2348 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349
2350 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2351'endofline' 'eol' boolean (default on)
2352 local to buffer
2353 {not in Vi}
2354 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002355 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 option is automatically set when starting to edit a new file, unless
2357 the file does not have an <EOL> for the last line in the file, in
2358 which case it is reset. Normally you don't have to set or reset this
2359 option. When 'binary' is off the value is not used when writing the
2360 file. When 'binary' is on it is used to remember the presence of a
2361 <EOL> for the last line in the file, so that when you write the file
2362 the situation from the original file can be kept. But you can change
2363 it if you want to.
2364
2365 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2366'equalalways' 'ea' boolean (default on)
2367 global
2368 {not in Vi}
2369 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002370 splitting or closing a window. This also happens the moment the
2371 option is switched on. When off, splitting a window will reduce the
2372 size of the current window and leave the other windows the same. When
2373 closing a window the extra lines are given to the window next to it
2374 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 When mixing vertically and horizontally split windows, a minimal size
2376 is computed and some windows may be larger if there is room. The
2377 'eadirection' option tells in which direction the size is affected.
2378 Changing the height of a window can be avoided by setting
2379 'winfixheight'.
2380
2381 *'equalprg'* *'ep'*
2382'equalprg' 'ep' string (default "")
2383 global or local to buffer |global-local|
2384 {not in Vi}
2385 External program to use for "=" command. When this option is empty
2386 the internal formatting functions are used ('lisp', 'cindent' or
2387 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002388 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 about including spaces and backslashes.
2390 This option cannot be set from a |modeline| or in the |sandbox|, for
2391 security reasons.
2392
2393 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2394'errorbells' 'eb' boolean (default off)
2395 global
2396 Ring the bell (beep or screen flash) for error messages. This only
2397 makes a difference for error messages, the bell will be used always
2398 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002399 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 screen flash or do nothing.
2401
2402 *'errorfile'* *'ef'*
2403'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2404 others: "errors.err")
2405 global
2406 {not in Vi}
2407 {not available when compiled without the |+quickfix|
2408 feature}
2409 Name of the errorfile for the QuickFix mode (see |:cf|).
2410 When the "-q" command-line argument is used, 'errorfile' is set to the
2411 following argument. See |-q|.
2412 NOT used for the ":make" command. See 'makeef' for that.
2413 Environment variables are expanded |:set_env|.
2414 See |option-backslash| about including spaces and backslashes.
2415 This option cannot be set from a |modeline| or in the |sandbox|, for
2416 security reasons.
2417
2418 *'errorformat'* *'efm'*
2419'errorformat' 'efm' string (default is very long)
2420 global or local to buffer |global-local|
2421 {not in Vi}
2422 {not available when compiled without the |+quickfix|
2423 feature}
2424 Scanf-like description of the format for the lines in the error file
2425 (see |errorformat|).
2426
2427 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2428'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2429 global
2430 {not in Vi}
2431 Function keys that start with an <Esc> are recognized in Insert
2432 mode. When this option is off, the cursor and function keys cannot be
2433 used in Insert mode if they start with an <Esc>. The advantage of
2434 this is that the single <Esc> is recognized immediately, instead of
2435 after one second. Instead of resetting this option, you might want to
2436 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2437 when 'esckeys' is off, you can still map anything, but the cursor keys
2438 won't work by default.
2439 NOTE: This option is set to the Vi default value when 'compatible' is
2440 set and to the Vim default value when 'compatible' is reset.
2441
2442 *'eventignore'* *'ei'*
2443'eventignore' 'ei' string (default "")
2444 global
2445 {not in Vi}
2446 {not available when compiled without the |+autocmd|
2447 feature}
2448 A list of autocommand event names, which are to be ignored.
2449 When set to "all", all autocommand events are ignored, autocommands
2450 will not be executed.
2451 Otherwise this is a comma separated list of event names. Example: >
2452 :set ei=WinEnter,WinLeave
2453<
2454 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2455'expandtab' 'et' boolean (default off)
2456 local to buffer
2457 {not in Vi}
2458 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002459 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2461 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2462 NOTE: This option is reset when 'compatible' is set.
2463
2464 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2465'exrc' 'ex' boolean (default off)
2466 global
2467 {not in Vi}
2468 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2469 directory. If you switch this option on you should also consider
2470 setting the 'secure' option (see |initialization|). Using a local
2471 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2472 also see |.vimrc| and |gui-init|.
2473 This option cannot be set from a |modeline| or in the |sandbox|, for
2474 security reasons.
2475
2476 *'fileencoding'* *'fenc'* *E213*
2477'fileencoding' 'fenc' string (default: "")
2478 local to buffer
2479 {only available when compiled with the |+multi_byte|
2480 feature}
2481 {not in Vi}
2482 Sets the character encoding for the file of this buffer.
2483 When 'fileencoding' is different from 'encoding', conversion will be
2484 done when reading and writing the file.
2485 When 'fileencoding' is empty, the same value as 'encoding' will be
2486 used (no conversion when reading or writing a file).
2487 WARNING: Conversion can cause loss of information! When
2488 'encoding' is "utf-8" conversion is most likely done in a way
2489 that the reverse conversion results in the same text. When
2490 'encoding' is not "utf-8" some characters may be lost!
2491 See 'encoding' for the possible values. Additionally, values may be
2492 specified that can be handled by the converter, see
2493 |mbyte-conversion|.
2494 When reading a file 'fileencoding' will be set from 'fileencodings'.
2495 To read a file in a certain encoding it won't work by setting
2496 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002497 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2499 When the option is set, the value is converted to lowercase. Thus
2500 you can set it with uppercase values too. '_' characters are
2501 replaced with '-'. If a name is recognized from the list for
2502 'encoding', it is replaced by the standard name. For example
2503 "ISO8859-2" becomes "iso-8859-2".
2504 When this option is set, after starting to edit a file, the 'modified'
2505 option is set, because the file would be different when written.
2506 If you do this in a modeline, you might want to set 'nomodified' to
2507 avoid this.
2508 This option can not be changed when 'modifiable' is off.
2509
2510 *'fe'*
2511 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002512 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513 old short name was 'fe', which is no longer used.
2514
2515 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002516'fileencodings' 'fencs' string (default: "ucs-bom",
2517 "ucs-bom,utf-8,default,latin1" when
2518 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519 global
2520 {only available when compiled with the |+multi_byte|
2521 feature}
2522 {not in Vi}
2523 This is a list of character encodings considered when starting to edit
2524 an existing file. When a file is read, Vim tries to use the first
2525 mentioned character encoding. If an error is detected, the next one
2526 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002527 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 an empty string, which means the value of 'encoding' is used.
2529 WARNING: Conversion can cause loss of information! When
2530 'encoding' is "utf-8" (or one of the other Unicode variants)
2531 conversion is most likely done in a way that the reverse
2532 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002533 "utf-8" some non-ASCII characters may be lost! You can use
2534 the |++bad| argument to specify what is done with characters
2535 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 For an empty file or a file with only ASCII characters most encodings
2537 will work and the first entry of 'fileencodings' will be used (except
2538 "ucs-bom", which requires the BOM to be present). If you prefer
2539 another encoding use an BufReadPost autocommand event to test if your
2540 preferred encoding is to be used. Example: >
2541 au BufReadPost * if search('\S', 'w') == 0 |
2542 \ set fenc=iso-2022-jp | endif
2543< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2544 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002545 When the |++enc| argument is used then the value of 'fileencodings' is
2546 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002547 Note that 'fileencodings' is not used for a new file, the global value
2548 of 'fileencoding' is used instead. You can set it with: >
2549 :setglobal fenc=iso-8859-2
2550< This means that a non-existing file may get a different encoding than
2551 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 The special value "ucs-bom" can be used to check for a Unicode BOM
2553 (Byte Order Mark) at the start of the file. It must not be preceded
2554 by "utf-8" or another Unicode encoding for this to work properly.
2555 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2556 because Vim cannot detect an error, thus the encoding is always
2557 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002558 The special value "default" can be used for the encoding from the
2559 environment. This is the default value for 'encoding'. It is useful
2560 when 'encoding' is set to "utf-8" and your environment uses a
2561 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002562 When 'encoding' is "utf-8" and a file contains an illegal byte
2563 sequence it won't be recognized as UTF-8. You can use the |8g8|
2564 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 WRONG VALUES: WHAT'S WRONG:
2566 latin1,utf-8 "latin1" will always be used
2567 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2568 file
2569 cp1250,latin1 "cp1250" will always be used
2570 If 'fileencodings' is empty, 'fileencoding' is not modified.
2571 See 'fileencoding' for the possible values.
2572 Setting this option does not have an effect until the next time a file
2573 is read.
2574
2575 *'fileformat'* *'ff'*
2576'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2577 Unix default: "unix",
2578 Macintosh default: "mac")
2579 local to buffer
2580 {not in Vi}
2581 This gives the <EOL> of the current buffer, which is used for
2582 reading/writing the buffer from/to a file:
2583 dos <CR> <NL>
2584 unix <NL>
2585 mac <CR>
2586 When "dos" is used, CTRL-Z at the end of a file is ignored.
2587 See |file-formats| and |file-read|.
2588 For the character encoding of the file see 'fileencoding'.
2589 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2590 works like it was set to "unix'.
2591 This option is set automatically when starting to edit a file and
2592 'fileformats' is not empty and 'binary' is off.
2593 When this option is set, after starting to edit a file, the 'modified'
2594 option is set, because the file would be different when written.
2595 This option can not be changed when 'modifiable' is off.
2596 For backwards compatibility: When this option is set to "dos",
2597 'textmode' is set, otherwise 'textmode' is reset.
2598
2599 *'fileformats'* *'ffs'*
2600'fileformats' 'ffs' string (default:
2601 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2602 Vim Unix: "unix,dos",
2603 Vim Mac: "mac,unix,dos",
2604 Vi Cygwin: "unix,dos",
2605 Vi others: "")
2606 global
2607 {not in Vi}
2608 This gives the end-of-line (<EOL>) formats that will be tried when
2609 starting to edit a new buffer and when reading a file into an existing
2610 buffer:
2611 - When empty, the format defined with 'fileformat' will be used
2612 always. It is not set automatically.
2613 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002614 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 'fileformats' name will be used when a file is read into an existing
2616 buffer, no matter what 'fileformat' for that buffer is set to.
2617 - When more than one name is present, separated by commas, automatic
2618 <EOL> detection will be done when reading a file. When starting to
2619 edit a file, a check is done for the <EOL>:
2620 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2621 'fileformat' is set to "dos".
2622 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002623 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 preceding <CR>, "unix" is preferred over "dos".
2625 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2626 This means that "mac" is only chosen when "unix" is not present,
2627 or when no <NL> is found in the file, and when "dos" is not
2628 present, or no <CR><NL> is present in the file.
2629 Also if "unix" was first chosen, but the first <CR> is before
2630 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2631 the file, then 'fileformat' is set to "mac".
2632 4. If 'fileformat' is still not set, the first name from
2633 'fileformats' is used.
2634 When reading a file into an existing buffer, the same is done, but
2635 this happens like 'fileformat' has been set appropriately for that
2636 file only, the option is not changed.
2637 When 'binary' is set, the value of 'fileformats' is not used.
2638
2639 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2640 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2641 done:
2642 - When 'fileformats' is empty, there is no automatic detection. Dos
2643 format will be used.
2644 - When 'fileformats' is set to one or more names, automatic detection
2645 is done. This is based on the first <NL> in the file: If there is a
2646 <CR> in front of it, Dos format is used, otherwise Unix format is
2647 used.
2648 Also see |file-formats|.
2649 For backwards compatibility: When this option is set to an empty
2650 string or one format (no comma is included), 'textauto' is reset,
2651 otherwise 'textauto' is set.
2652 NOTE: This option is set to the Vi default value when 'compatible' is
2653 set and to the Vim default value when 'compatible' is reset.
2654
2655 *'filetype'* *'ft'*
2656'filetype' 'ft' string (default: "")
2657 local to buffer
2658 {not in Vi}
2659 {not available when compiled without the |+autocmd|
2660 feature}
2661 When this option is set, the FileType autocommand event is triggered.
2662 All autocommands that match with the value of this option will be
2663 executed. Thus the value of 'filetype' is used in place of the file
2664 name.
2665 Otherwise this option does not always reflect the current file type.
2666 This option is normally set when the file type is detected. To enable
2667 this use the ":filetype on" command. |:filetype|
2668 Setting this option to a different value is most useful in a modeline,
2669 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002670 Example, for in an IDL file:
2671 /* vim: set filetype=idl : */ ~
2672 |FileType| |filetypes|
2673 When a dot appears in the value then this separates two filetype
2674 names. Example:
2675 /* vim: set filetype=c.doxygen : */ ~
2676 This will use the "c" filetype first, then the "doxygen" filetype.
2677 This works both for filetype plugins and for syntax files. More than
2678 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 Do not confuse this option with 'osfiletype', which is for the file
2680 type that is actually stored with the file.
2681 This option is not copied to another buffer, independent of the 's' or
2682 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002683 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684
2685 *'fillchars'* *'fcs'*
2686'fillchars' 'fcs' string (default "vert:|,fold:-")
2687 global
2688 {not in Vi}
2689 {not available when compiled without the |+windows|
2690 and |+folding| features}
2691 Characters to fill the statuslines and vertical separators.
2692 It is a comma separated list of items:
2693
2694 item default Used for ~
2695 stl:c ' ' or '^' statusline of the current window
2696 stlnc:c ' ' or '-' statusline of the non-current windows
2697 vert:c '|' vertical separators |:vsplit|
2698 fold:c '-' filling 'foldtext'
2699 diff:c '-' deleted lines of the 'diff' option
2700
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002701 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 "stlnc" the space will be used when there is highlighting, '^' or '-'
2703 otherwise.
2704
2705 Example: >
2706 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2707< This is similar to the default, except that these characters will also
2708 be used when there is highlighting.
2709
2710 The highlighting used for these items:
2711 item highlight group ~
2712 stl:c StatusLine |hl-StatusLine|
2713 stlnc:c StatusLineNC |hl-StatusLineNC|
2714 vert:c VertSplit |hl-VertSplit|
2715 fold:c Folded |hl-Folded|
2716 diff:c DiffDelete |hl-DiffDelete|
2717
2718 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2719'fkmap' 'fk' boolean (default off) *E198*
2720 global
2721 {not in Vi}
2722 {only available when compiled with the |+rightleft|
2723 feature}
2724 When on, the keyboard is mapped for the Farsi character set.
2725 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002726 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727
2728 *'foldclose'* *'fcl'*
2729'foldclose' 'fcl' string (default "")
2730 global
2731 {not in Vi}
2732 {not available when compiled without the |+folding|
2733 feature}
2734 When set to "all", a fold is closed when the cursor isn't in it and
2735 its level is higher than 'foldlevel'. Useful if you want folds to
2736 automatically close when moving out of them.
2737
2738 *'foldcolumn'* *'fdc'*
2739'foldcolumn' 'fdc' number (default 0)
2740 local to window
2741 {not in Vi}
2742 {not available when compiled without the |+folding|
2743 feature}
2744 When non-zero, a column with the specified width is shown at the side
2745 of the window which indicates open and closed folds. The maximum
2746 value is 12.
2747 See |folding|.
2748
2749 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2750'foldenable' 'fen' boolean (default on)
2751 local to window
2752 {not in Vi}
2753 {not available when compiled without the |+folding|
2754 feature}
2755 When off, all folds are open. This option can be used to quickly
2756 switch between showing all text unfolded and viewing the text with
2757 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002758 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 'foldenable' is off.
2760 This option is set by commands that create a new fold or close a fold.
2761 See |folding|.
2762
2763 *'foldexpr'* *'fde'*
2764'foldexpr' 'fde' string (default: "0")
2765 local to window
2766 {not in Vi}
2767 {not available when compiled without the |+folding|
2768 or |+eval| feature}
2769 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002770 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002771
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002772 The expression may be evaluated in the |sandbox|, see
2773 |sandbox-option|.
2774
2775 It is not allowed to change text or jump to another window while
2776 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777
2778 *'foldignore'* *'fdi'*
2779'foldignore' 'fdi' string (default: "#")
2780 local to window
2781 {not in Vi}
2782 {not available when compiled without the |+folding|
2783 feature}
2784 Used only when 'foldmethod' is "indent". Lines starting with
2785 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002786 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 The default "#" works well for C programs. See |fold-indent|.
2788
2789 *'foldlevel'* *'fdl'*
2790'foldlevel' 'fdl' number (default: 0)
2791 local to window
2792 {not in Vi}
2793 {not available when compiled without the |+folding|
2794 feature}
2795 Sets the fold level: Folds with a higher level will be closed.
2796 Setting this option to zero will close all folds. Higher numbers will
2797 close fewer folds.
2798 This option is set by commands like |zm|, |zM| and |zR|.
2799 See |fold-foldlevel|.
2800
2801 *'foldlevelstart'* *'fdls'*
2802'foldlevelstart' 'fdls' number (default: -1)
2803 global
2804 {not in Vi}
2805 {not available when compiled without the |+folding|
2806 feature}
2807 Sets 'foldlevel' when starting to edit another buffer in a window.
2808 Useful to always start editing with all folds closed (value zero),
2809 some folds closed (one) or no folds closed (99).
2810 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002811 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 ignores this option and closes all folds.
2813 It is also done before BufReadPre autocommands, to allow an autocmd to
2814 overrule the 'foldlevel' value for specific files.
2815 When the value is negative, it is not used.
2816
2817 *'foldmarker'* *'fmr'* *E536*
2818'foldmarker' 'fmr' string (default: "{{{,}}}")
2819 local to window
2820 {not in Vi}
2821 {not available when compiled without the |+folding|
2822 feature}
2823 The start and end marker used when 'foldmethod' is "marker". There
2824 must be one comma, which separates the start and end marker. The
2825 marker is a literal string (a regular expression would be too slow).
2826 See |fold-marker|.
2827
2828 *'foldmethod'* *'fdm'*
2829'foldmethod' 'fdm' string (default: "manual")
2830 local to window
2831 {not in Vi}
2832 {not available when compiled without the |+folding|
2833 feature}
2834 The kind of folding used for the current window. Possible values:
2835 |fold-manual| manual Folds are created manually.
2836 |fold-indent| indent Lines with equal indent form a fold.
2837 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2838 |fold-marker| marker Markers are used to specify folds.
2839 |fold-syntax| syntax Syntax highlighting items specify folds.
2840 |fold-diff| diff Fold text that is not changed.
2841
2842 *'foldminlines'* *'fml'*
2843'foldminlines' 'fml' number (default: 1)
2844 local to window
2845 {not in Vi}
2846 {not available when compiled without the |+folding|
2847 feature}
2848 Sets the minimum number of screen lines for a fold to be displayed
2849 closed. Also for manually closed folds.
2850 Note that this only has an effect of what is displayed. After using
2851 "zc" to close a fold, which is displayed open because it's smaller
2852 than 'foldminlines', a following "zc" may close a containing fold.
2853
2854 *'foldnestmax'* *'fdn'*
2855'foldnestmax' 'fdn' number (default: 20)
2856 local to window
2857 {not in Vi}
2858 {not available when compiled without the |+folding|
2859 feature}
2860 Sets the maximum nesting of folds for the "indent" and "syntax"
2861 methods. This avoids that too many folds will be created. Using more
2862 than 20 doesn't work, because the internal limit is 20.
2863
2864 *'foldopen'* *'fdo'*
2865'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2866 search,tag,undo")
2867 global
2868 {not in Vi}
2869 {not available when compiled without the |+folding|
2870 feature}
2871 Specifies for which type of commands folds will be opened, if the
2872 command moves the cursor into a closed fold. It is a comma separated
2873 list of items.
2874 item commands ~
2875 all any
2876 block "(", "{", "[[", "[{", etc.
2877 hor horizontal movements: "l", "w", "fx", etc.
2878 insert any command in Insert mode
2879 jump far jumps: "G", "gg", etc.
2880 mark jumping to a mark: "'m", CTRL-O, etc.
2881 percent "%"
2882 quickfix ":cn", ":crew", ":make", etc.
2883 search search for a pattern: "/", "n", "*", "gd", etc.
2884 (not for a search pattern in a ":" command)
2885 tag jumping to a tag: ":ta", CTRL-T, etc.
2886 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002887 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 the |zv| command to the mapping to get the same effect.
2889 When a movement command is used for an operator (e.g., "dl" or "y%")
2890 this option is not used. This means the operator will include the
2891 whole closed fold.
2892 Note that vertical movements are not here, because it would make it
2893 very difficult to move onto a closed fold.
2894 In insert mode the folds containing the cursor will always be open
2895 when text is inserted.
2896 To close folds you can re-apply 'foldlevel' with the |zx| command or
2897 set the 'foldclose' option to "all".
2898
2899 *'foldtext'* *'fdt'*
2900'foldtext' 'fdt' string (default: "foldtext()")
2901 local to window
2902 {not in Vi}
2903 {not available when compiled without the |+folding|
2904 feature}
2905 An expression which is used to specify the text displayed for a closed
2906 fold. See |fold-foldtext|.
2907
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002908 The expression may be evaluated in the |sandbox|, see
2909 |sandbox-option|.
2910
2911 It is not allowed to change text or jump to another window while
2912 evaluating 'foldtext' |textlock|.
2913
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 *'formatoptions'* *'fo'*
2915'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2916 local to buffer
2917 {not in Vi}
2918 This is a sequence of letters which describes how automatic
2919 formatting is to be done. See |fo-table|. When the 'paste' option is
2920 on, no formatting is done (like 'formatoptions' is empty). Commas can
2921 be inserted for readability.
2922 To avoid problems with flags that are added in the future, use the
2923 "+=" and "-=" feature of ":set" |add-option-flags|.
2924 NOTE: This option is set to the Vi default value when 'compatible' is
2925 set and to the Vim default value when 'compatible' is reset.
2926
Bram Moolenaar86b68352004-12-27 21:59:20 +00002927 *'formatlistpat'* *'flp'*
2928'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2929 local to buffer
2930 {not in Vi}
2931 A pattern that is used to recognize a list header. This is used for
2932 the "n" flag in 'formatoptions'.
2933 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002934 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002935 while still checking more characters. There must be a character
2936 following the pattern, when it matches the whole line it is handled
2937 like there is no match.
2938 The default recognizes a number, followed by an optional punctuation
2939 character and white space.
2940
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 *'formatprg'* *'fp'*
2942'formatprg' 'fp' string (default "")
2943 global
2944 {not in Vi}
2945 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002946 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002948 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002949 If the 'formatexpr' option is not empty it will be used instead.
2950 Otherwise, if 'formatprg' option is an empty string, the internal
2951 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002952 Environment variables are expanded |:set_env|. See |option-backslash|
2953 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002954 The expression may be evaluated in the |sandbox|, see
2955 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002957 *'formatexpr'* *'fex'*
2958'formatexpr' 'fex' string (default "")
2959 local to buffer
2960 {not in Vi}
2961 {not available when compiled without the |+eval|
2962 feature}
2963 Expression which is evaluated to format a range of lines for the |gq|
2964 operator. The |v:lnum| variable holds the first line to be formatted,
2965 |v:count| the number of lines to be formatted.
2966 When this option is empty 'formatprg' is used.
2967 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002968 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002969< This will invoke the mylang#Format() function in the
2970 autoload/mylang.vim file in 'runtimepath'. |autoload|
2971
2972 The expression is also evaluated when 'textwidth' is set and adding
2973 text beyond that limit. This happens under the same conditions as
2974 when internal formatting is used. Make sure the cursor is kept in the
2975 same spot relative to the text then! The |mode()| function will
2976 return "i" or "R" in this situation. When the function returns
2977 non-zero Vim will fall back to using the internal format mechanism.
2978
2979 The expression may be evaluated in the |sandbox|, see
2980 |sandbox-option|.
2981
2982 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002983'fsync' 'fs' boolean (default on)
2984 global
2985 {not in Vi}
2986 When on, the library function fsync() will be called after writing a
2987 file. This will flush a file to disk, ensuring that it is safely
2988 written even on filesystems which do metadata-only journaling. This
2989 will force the harddrive to spin up on Linux systems running in laptop
2990 mode, so it may be undesirable in some situations. Be warned that
2991 turning this off increases the chances of data loss after a crash. On
2992 systems without an fsync() implementation, this variable is always
2993 off.
2994 Also see 'swapsync' for controlling fsync() on swap files.
2995
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2997'gdefault' 'gd' boolean (default off)
2998 global
2999 {not in Vi}
3000 When on, the ":substitute" flag 'g' is default on. This means that
3001 all matches in a line are substituted instead of one. When a 'g' flag
3002 is given to a ":substitute" command, this will toggle the substitution
3003 of all or one match. See |complex-change|.
3004
3005 command 'gdefault' on 'gdefault' off ~
3006 :s/// subst. all subst. one
3007 :s///g subst. one subst. all
3008 :s///gg subst. all subst. one
3009
3010 NOTE: This option is reset when 'compatible' is set.
3011
3012 *'grepformat'* *'gfm'*
3013'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3014 global
3015 {not in Vi}
3016 Format to recognize for the ":grep" command output.
3017 This is a scanf-like string that uses the same format as the
3018 'errorformat' option: see |errorformat|.
3019
3020 *'grepprg'* *'gp'*
3021'grepprg' 'gp' string (default "grep -n ",
3022 Unix: "grep -n $* /dev/null",
3023 Win32: "findstr /n" or "grep -n",
3024 VMS: "SEARCH/NUMBERS ")
3025 global or local to buffer |global-local|
3026 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003027 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 and '#' characters, which are expanded like when used in a command-
3029 line. The placeholder "$*" is allowed to specify where the arguments
3030 will be included. Environment variables are expanded |:set_env|. See
3031 |option-backslash| about including spaces and backslashes.
3032 When your "grep" accepts the "-H" argument, use this to make ":grep"
3033 also work well with a single file: >
3034 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003035< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003036 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3037 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003038 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 apply equally to 'grepprg'.
3040 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3041 otherwise it's "grep -n".
3042 This option cannot be set from a |modeline| or in the |sandbox|, for
3043 security reasons.
3044
3045 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3046'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3047 ve:ver35-Cursor,
3048 o:hor50-Cursor,
3049 i-ci:ver25-Cursor/lCursor,
3050 r-cr:hor20-Cursor/lCursor,
3051 sm:block-Cursor
3052 -blinkwait175-blinkoff150-blinkon175",
3053 for MS-DOS and Win32 console:
3054 "n-v-c:block,o:hor50,i-ci:hor15,
3055 r-cr:hor30,sm:block")
3056 global
3057 {not in Vi}
3058 {only available when compiled with GUI enabled, and
3059 for MS-DOS and Win32 console}
3060 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003061 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 the height of the cursor can be changed. This can be done by
3063 specifying a block cursor, or a percentage for a vertical or
3064 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003065 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003067 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 mode-list and an argument-list:
3069 mode-list:argument-list,mode-list:argument-list,..
3070 The mode-list is a dash separated list of these modes:
3071 n Normal mode
3072 v Visual mode
3073 ve Visual mode with 'selection' "exclusive" (same as 'v',
3074 if not specified)
3075 o Operator-pending mode
3076 i Insert mode
3077 r Replace mode
3078 c Command-line Normal (append) mode
3079 ci Command-line Insert mode
3080 cr Command-line Replace mode
3081 sm showmatch in Insert mode
3082 a all modes
3083 The argument-list is a dash separated list of these arguments:
3084 hor{N} horizontal bar, {N} percent of the character height
3085 ver{N} vertical bar, {N} percent of the character width
3086 block block cursor, fills the whole character
3087 [only one of the above three should be present]
3088 blinkwait{N} *cursor-blinking*
3089 blinkon{N}
3090 blinkoff{N}
3091 blink times for cursor: blinkwait is the delay before
3092 the cursor starts blinking, blinkon is the time that
3093 the cursor is shown and blinkoff is the time that the
3094 cursor is not shown. The times are in msec. When one
3095 of the numbers is zero, there is no blinking. The
3096 default is: "blinkwait700-blinkon400-blinkoff250".
3097 These numbers are used for a missing entry. This
3098 means that blinking is enabled by default. To switch
3099 blinking off you can use "blinkon0". The cursor only
3100 blinks when Vim is waiting for input, not while
3101 executing a command.
3102 To make the cursor blink in an xterm, see
3103 |xterm-blink|.
3104 {group-name}
3105 a highlight group name, that sets the color and font
3106 for the cursor
3107 {group-name}/{group-name}
3108 Two highlight group names, the first is used when
3109 no language mappings are used, the other when they
3110 are. |language-mapping|
3111
3112 Examples of parts:
3113 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3114 block cursor with colors from the "nCursor"
3115 highlight group
3116 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3117 In Insert and Command-line Insert mode, use a
3118 30% vertical bar cursor with colors from the
3119 "iCursor" highlight group. Blink a bit
3120 faster.
3121
3122 The 'a' mode is different. It will set the given argument-list for
3123 all modes. It does not reset anything to defaults. This can be used
3124 to do a common setting for all modes. For example, to switch off
3125 blinking: "a:blinkon0"
3126
3127 Examples of cursor highlighting: >
3128 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3129 :highlight Cursor gui=NONE guifg=bg guibg=fg
3130<
3131 *'guifont'* *'gfn'*
3132 *E235* *E596* *E610* *E611*
3133'guifont' 'gfn' string (default "")
3134 global
3135 {not in Vi}
3136 {only available when compiled with GUI enabled}
3137 This is a list of fonts which will be used for the GUI version of Vim.
3138 In its simplest form the value is just one font name. When
3139 the font cannot be found you will get an error message. To try other
3140 font names a list can be specified, font names separated with commas.
3141 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003142
Bram Moolenaar05159a02005-02-26 23:04:13 +00003143 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3144 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003145
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 Spaces after a comma are ignored. To include a comma in a font name
3147 precede it with a backslash. Setting an option requires an extra
3148 backslash before a space and a backslash. See also
3149 |option-backslash|. For example: >
3150 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003151< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003153
3154 If none of the fonts can be loaded, Vim will keep the current setting.
3155 If an empty font list is given, Vim will try using other resource
3156 settings (for X, it will use the Vim.font resource), and finally it
3157 will try some builtin default which should always be there ("7x13" in
3158 the case of X). The font names given should be "normal" fonts. Vim
3159 will try to find the related bold and italic fonts.
3160
Bram Moolenaar05159a02005-02-26 23:04:13 +00003161 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003162 :set guifont=*
3163< will bring up a font requester, where you can pick the font you want.
3164
3165 The font name depends on the GUI used. See |setting-guifont| for a
3166 way to set 'guifont' for various systems.
3167
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 For the GTK+ 2 GUI the font name looks like this: >
3169 :set guifont=Andale\ Mono\ 11
3170< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003171
3172 For Mac OSX you can use something like this: >
3173 :set guifont=Monaco:h10
3174< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003176 width). An exception is GTK 2: all fonts are accepted, but
3177 mono-spaced fonts look best.
3178
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 To preview a font on X11, you might be able to use the "xfontsel"
3180 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003181
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 For the Win32 GUI *E244* *E245*
3183 - takes these options in the font name:
3184 hXX - height is XX (points, can be floating-point)
3185 wXX - width is XX (points, can be floating-point)
3186 b - bold
3187 i - italic
3188 u - underline
3189 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003190 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3192 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3193 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003194 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195
3196 Use a ':' to separate the options.
3197 - A '_' can be used in the place of a space, so you don't need to use
3198 backslashes to escape the spaces.
3199 - Examples: >
3200 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3201 :set guifont=Andale_Mono:h7.5:w4.5
3202< See also |font-sizes|.
3203
3204 *'guifontset'* *'gfs'*
3205 *E250* *E252* *E234* *E597* *E598*
3206'guifontset' 'gfs' string (default "")
3207 global
3208 {not in Vi}
3209 {only available when compiled with GUI enabled and
3210 with the |+xfontset| feature}
3211 {not available in the GTK+ 2 GUI}
3212 When not empty, specifies two (or more) fonts to be used. The first
3213 one for normal English, the second one for your special language. See
3214 |xfontset|.
3215 Setting this option also means that all font names will be handled as
3216 a fontset name. Also the ones used for the "font" argument of the
3217 |:highlight| command.
3218 The fonts must match with the current locale. If fonts for the
3219 character sets that the current locale uses are not included, setting
3220 'guifontset' will fail.
3221 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3222 the comma-separated names are alternative names, one of which will be
3223 used. In 'guifontset' the whole string is one fontset name,
3224 including the commas. It is not possible to specify alternative
3225 fontset names.
3226 This example works on many X11 systems: >
3227 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3228<
3229 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3230'guifontwide' 'gfw' string (default "")
3231 global
3232 {not in Vi}
3233 {only available when compiled with GUI enabled}
3234 When not empty, specifies a comma-separated list of fonts to be used
3235 for double-width characters. The first font that can be loaded is
3236 used.
3237 Note: The size of these fonts must be exactly twice as wide as the one
3238 specified with 'guifont' and the same height.
3239
3240 All GUI versions but GTK+ 2:
3241
3242 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3243 'guifontset' is empty or invalid.
3244 When 'guifont' is set and a valid font is found in it and
3245 'guifontwide' is empty Vim will attempt to find a matching
3246 double-width font and set 'guifontwide' to it.
3247
3248 GTK+ 2 GUI only: *guifontwide_gtk2*
3249
3250 If set and valid, 'guifontwide' is always used for double width
3251 characters, even if 'encoding' is not set to "utf-8".
3252 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003253 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 font for characters not available in 'guifont'. Thus you do not need
3255 to set 'guifontwide' at all unless you want to override the choice
3256 made by Pango/Xft.
3257
3258 *'guiheadroom'* *'ghr'*
3259'guiheadroom' 'ghr' number (default 50)
3260 global
3261 {not in Vi} {only for GTK and X11 GUI}
3262 The number of pixels subtracted from the screen height when fitting
3263 the GUI window on the screen. Set this before the GUI is started,
3264 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003265 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 lines will be left for window decorations and other items on the
3267 screen. Set it to a negative value to allow windows taller than the
3268 screen.
3269
3270 *'guioptions'* *'go'*
3271'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003272 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 global
3274 {not in Vi}
3275 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003276 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003277 sequence of letters which describes what components and options of the
3278 GUI should be used.
3279 To avoid problems with flags that are added in the future, use the
3280 "+=" and "-=" feature of ":set" |add-option-flags|.
3281
3282 Valid letters are as follows:
3283 *guioptions_a*
3284 'a' Autoselect: If present, then whenever VISUAL mode is started,
3285 or the Visual area extended, Vim tries to become the owner of
3286 the windowing system's global selection. This means that the
3287 Visually highlighted text is available for pasting into other
3288 applications as well as into Vim itself. When the Visual mode
3289 ends, possibly due to an operation on the text, or when an
3290 application wants to paste the selection, the highlighted text
3291 is automatically yanked into the "* selection register.
3292 Thus the selection is still available for pasting into other
3293 applications after the VISUAL mode has ended.
3294 If not present, then Vim won't become the owner of the
3295 windowing system's global selection unless explicitly told to
3296 by a yank or delete operation for the "* register.
3297 The same applies to the modeless selection.
3298
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003299 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 applies to the modeless selection.
3301
3302 'guioptions' autoselect Visual autoselect modeless ~
3303 "" - -
3304 "a" yes yes
3305 "A" - yes
3306 "aA" yes yes
3307
3308 'c' Use console dialogs instead of popup dialogs for simple
3309 choices.
3310
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003311 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003312 'guitablabel' can be used to change the text in the labels.
3313 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003314 The GUI tabs are only supported on some systens, currently
3315 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003316
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 'f' Foreground: Don't use fork() to detach the GUI from the shell
3318 where it was started. Use this for programs that wait for the
3319 editor to finish (e.g., an e-mail program). Alternatively you
3320 can use "gvim -f" or ":gui -f" to start the GUI in the
3321 foreground. |gui-fork|
3322 Note: Set this option in the vimrc file. The forking may have
3323 happened already when the gvimrc file is read.
3324
3325 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3326 corner of the window. It's black&white on non-GTK, because of
3327 limitations of X11. For a color icon, see |X11-icon|.
3328
3329 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003330 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 that this flag must be added in the .vimrc file, before
3332 switching on syntax or filetype recognition (when the .gvimrc
3333 file is sourced the system menu has already been loaded; the
3334 ":syntax on" and ":filetype on" commands load the menu too).
3335 'g' Grey menu items: Make menu items that are not active grey. If
3336 'g' is not included inactive menu items are not shown at all.
3337 Exception: Athena will always use grey menu items.
3338
3339 't' Include tearoff menu items. Currently only works for Win32,
3340 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003341 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3342 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343
3344 'r' Right-hand scrollbar is always present.
3345 'R' Right-hand scrollbar is present when there is a vertically
3346 split window.
3347 'l' Left-hand scrollbar is always present.
3348 'L' Left-hand scrollbar is present when there is a vertically
3349 split window.
3350 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3351 the longest visible line, or on the cursor line if the 'h'
3352 flag is included. |gui-horiz-scroll|
3353 'h' Limit horizontal scrollbar size to the length of the cursor
3354 line. Reduces computations. |gui-horiz-scroll|
3355
3356 And yes, you may even have scrollbars on the left AND the right if
3357 you really want to :-). See |gui-scrollbars| for more information.
3358
3359 'v' Use a vertical button layout for dialogs. When not included,
3360 a horizontal layout is preferred, but when it doesn't fit a
3361 vertical layout is used anyway.
3362 'p' Use Pointer callbacks for X11 GUI. This is required for some
3363 window managers. If the cursor is not blinking or hollow at
3364 the right moment, try adding this flag. This must be done
3365 before starting the GUI. Set it in your gvimrc. Adding or
3366 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003367 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368
3369 *'guipty'* *'noguipty'*
3370'guipty' boolean (default on)
3371 global
3372 {not in Vi}
3373 {only available when compiled with GUI enabled}
3374 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3375 I/O to/from shell commands. See |gui-pty|.
3376
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003377 *'guitablabel'* *'gtl'*
3378'guitablabel' 'gtl' string (default empty)
3379 global
3380 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003381 {only available when compiled with GUI enabled and
3382 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003383 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003384 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003385 |setting-guitablabel| for more info.
3386
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003387 The format of this option is like that of 'statusline'.
3388
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003389 Only used when the GUI tab pages line is displayed. 'e' must be
3390 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3391 used.
3392
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 *'helpfile'* *'hf'*
3394'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3395 (others) "$VIMRUNTIME/doc/help.txt")
3396 global
3397 {not in Vi}
3398 Name of the main help file. All distributed help files should be
3399 placed together in one directory. Additionally, all "doc" directories
3400 in 'runtimepath' will be used.
3401 Environment variables are expanded |:set_env|. For example:
3402 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003403 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 spaces and backslashes.
3405 This option cannot be set from a |modeline| or in the |sandbox|, for
3406 security reasons.
3407
3408 *'helpheight'* *'hh'*
3409'helpheight' 'hh' number (default 20)
3410 global
3411 {not in Vi}
3412 {not available when compiled without the +windows
3413 feature}
3414 Minimal initial height of the help window when it is opened with the
3415 ":help" command. The initial height of the help window is half of the
3416 current window, or (when the 'ea' option is on) the same as other
3417 windows. When the height is less than 'helpheight', the height is
3418 set to 'helpheight'. Set to zero to disable.
3419
3420 *'helplang'* *'hlg'*
3421'helplang' 'hlg' string (default: messages language or empty)
3422 global
3423 {only available when compiled with the |+multi_lang|
3424 feature}
3425 {not in Vi}
3426 Comma separated list of languages. Vim will use the first language
3427 for which the desired help can be found. The English help will always
3428 be used as a last resort. You can add "en" to prefer English over
3429 another language, but that will only find tags that exist in that
3430 language and not in the English help.
3431 Example: >
3432 :set helplang=de,it
3433< This will first search German, then Italian and finally English help
3434 files.
3435 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3436 try to find the tag in the current language before using this option.
3437 See |help-translated|.
3438
3439 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3440'hidden' 'hid' boolean (default off)
3441 global
3442 {not in Vi}
3443 When off a buffer is unloaded when it is |abandon|ed. When on a
3444 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3445 displayed in another window, it does not become hidden, of course.
3446 The commands that move through the buffer list sometimes make a buffer
3447 hidden although the 'hidden' option is off: When the buffer is
3448 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003449 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003450 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 This option is set for one command with ":hide {command}" |:hide|.
3452 WARNING: It's easy to forget that you have changes in hidden buffers.
3453 Think twice when using ":q!" or ":qa!".
3454
3455 *'highlight'* *'hl'*
3456'highlight' 'hl' string (default (as a single string):
3457 "8:SpecialKey,@:NonText,d:Directory,
3458 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3459 M:ModeMsg,n:LineNr,r:Question,
3460 s:StatusLine,S:StatusLineNC,c:VertSplit
3461 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3462 f:Folded,F:FoldColumn,A:DiffAdd,
3463 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003464 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003465 R:SpellRare,L:SpellLocal,
3466 +:Pmenu,=:PmenuSel,
3467 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 global
3469 {not in Vi}
3470 This option can be used to set highlighting mode for various
3471 occasions. It is a comma separated list of character pairs. The
3472 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003473 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3475 |hl-NonText| @ '~' and '@' at the end of the window and
3476 characters from 'showbreak'
3477 |hl-Directory| d directories in CTRL-D listing and other special
3478 things in listings
3479 |hl-ErrorMsg| e error messages
3480 h (obsolete, ignored)
3481 |hl-IncSearch| i 'incsearch' highlighting
3482 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3483 |hl-MoreMsg| m |more-prompt|
3484 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3485 |hl-LineNr| n line number for ":number" and ":#" commands
3486 |hl-Question| r |hit-enter| prompt and yes/no questions
3487 |hl-StatusLine| s status line of current window |status-line|
3488 |hl-StatusLineNC| S status lines of not-current windows
3489 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3490 |hl-VertSplit| c column used to separate vertically split windows
3491 |hl-Visual| v Visual mode
3492 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3493 Selection" Only X11 Gui's |gui-x11| and
3494 |xterm-clipboard|.
3495 |hl-WarningMsg| w warning messages
3496 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3497 |hl-Folded| f line used for closed folds
3498 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003499 |hl-DiffAdd| A added line in diff mode
3500 |hl-DiffChange| C changed line in diff mode
3501 |hl-DiffDelete| D deleted line in diff mode
3502 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003504 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003505 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003506 |hl-SpellRare| R rare word |spell|
3507 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003508 |hl-Pmenu| + popup menu normal line
3509 |hl-PmenuSel| = popup menu normal line
3510 |hl-PmenuSbar| x popup menu scrollbar
3511 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512
3513 The display modes are:
3514 r reverse (termcap entry "mr" and "me")
3515 i italic (termcap entry "ZH" and "ZR")
3516 b bold (termcap entry "md" and "me")
3517 s standout (termcap entry "so" and "se")
3518 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003519 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 n no highlighting
3521 - no highlighting
3522 : use a highlight group
3523 The default is used for occasions that are not included.
3524 If you want to change what the display modes do, see |dos-colors|
3525 for an example.
3526 When using the ':' display mode, this must be followed by the name of
3527 a highlight group. A highlight group can be used to define any type
3528 of highlighting, including using color. See |:highlight| on how to
3529 define one. The default uses a different group for each occasion.
3530 See |highlight-default| for the default highlight groups.
3531
3532 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3533'hlsearch' 'hls' boolean (default off)
3534 global
3535 {not in Vi}
3536 {not available when compiled without the
3537 |+extra_search| feature}
3538 When there is a previous search pattern, highlight all its matches.
3539 The type of highlighting used can be set with the 'l' occasion in the
3540 'highlight' option. This uses the "Search" highlight group by
3541 default. Note that only the matching text is highlighted, any offsets
3542 are not applied.
3543 See also: 'incsearch' and |:match|.
3544 When you get bored looking at the highlighted matches, you can turn it
3545 off with |:nohlsearch|. As soon as you use a search command, the
3546 highlighting comes back.
3547 When the search pattern can match an end-of-line, Vim will try to
3548 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003549 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 line below a closed fold. A match in a previous line which is not
3551 drawn may not continue in an newly drawn line.
3552 NOTE: This option is reset when 'compatible' is set.
3553
3554 *'history'* *'hi'*
3555'history' 'hi' number (Vim default: 20, Vi default: 0)
3556 global
3557 {not in Vi}
3558 A history of ":" commands, and a history of previous search patterns
3559 are remembered. This option decides how many entries may be stored in
3560 each of these histories (see |cmdline-editing|).
3561 NOTE: This option is set to the Vi default value when 'compatible' is
3562 set and to the Vim default value when 'compatible' is reset.
3563
3564 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3565'hkmap' 'hk' boolean (default off)
3566 global
3567 {not in Vi}
3568 {only available when compiled with the |+rightleft|
3569 feature}
3570 When on, the keyboard is mapped for the Hebrew character set.
3571 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3572 toggle this option. See |rileft.txt|.
3573 NOTE: This option is reset when 'compatible' is set.
3574
3575 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3576'hkmapp' 'hkp' boolean (default off)
3577 global
3578 {not in Vi}
3579 {only available when compiled with the |+rightleft|
3580 feature}
3581 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3582 This is useful if you have a non-Hebrew keyboard.
3583 See |rileft.txt|.
3584 NOTE: This option is reset when 'compatible' is set.
3585
3586 *'icon'* *'noicon'*
3587'icon' boolean (default off, on when title can be restored)
3588 global
3589 {not in Vi}
3590 {not available when compiled without the |+title|
3591 feature}
3592 When on, the icon text of the window will be set to the value of
3593 'iconstring' (if it is not empty), or to the name of the file
3594 currently being edited. Only the last part of the name is used.
3595 Overridden by the 'iconstring' option.
3596 Only works if the terminal supports setting window icons (currently
3597 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3598 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3599 builtin termcap).
3600 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003601 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 X11.
3603
3604 *'iconstring'*
3605'iconstring' string (default "")
3606 global
3607 {not in Vi}
3608 {not available when compiled without the |+title|
3609 feature}
3610 When this option is not empty, it will be used for the icon text of
3611 the window. This happens only when the 'icon' option is on.
3612 Only works if the terminal supports setting window icon text
3613 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3614 Does not work for MS Windows.
3615 When Vim was compiled with HAVE_X11 defined, the original icon will be
3616 restored if possible |X11|.
3617 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003618 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 'titlestring' for example settings.
3620 {not available when compiled without the |+statusline| feature}
3621
3622 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3623'ignorecase' 'ic' boolean (default off)
3624 global
3625 Ignore case in search patterns. Also used when searching in the tags
3626 file.
3627 Also see 'smartcase'.
3628 Can be overruled by using "\c" or "\C" in the pattern, see
3629 |/ignorecase|.
3630
3631 *'imactivatekey'* *'imak'*
3632'imactivatekey' 'imak' string (default "")
3633 global
3634 {not in Vi}
3635 {only available when compiled with |+xim| and
3636 |+GUI_GTK|}
3637 Specifies the key that your Input Method in X-Windows uses for
3638 activation. When this is specified correctly, vim can fully control
3639 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3640 You can't use this option to change the activation key, the option
3641 tells Vim what the key is.
3642 Format:
3643 [MODIFIER_FLAG-]KEY_STRING
3644
3645 These characters can be used for MODIFIER_FLAG (case is ignored):
3646 S Shift key
3647 L Lock key
3648 C Control key
3649 1 Mod1 key
3650 2 Mod2 key
3651 3 Mod3 key
3652 4 Mod4 key
3653 5 Mod5 key
3654 Combinations are allowed, for example "S-C-space" or "SC-space" are
3655 both shift+ctrl+space.
3656 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3657
3658 Example: >
3659 :set imactivatekey=S-space
3660< "S-space" means shift+space. This is the activation key for kinput2 +
3661 canna (Japanese), and ami (Korean).
3662
3663 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3664'imcmdline' 'imc' boolean (default off)
3665 global
3666 {not in Vi}
3667 {only available when compiled with the |+xim|
3668 |+multi_byte_ime| or |global-ime| feature}
3669 When set the Input Method is always on when starting to edit a command
3670 line, unless entering a search pattern (see 'imsearch' for that).
3671 Setting this option is useful when your input method allows entering
3672 English characters directly, e.g., when it's used to type accented
3673 characters with dead keys.
3674
3675 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3676'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3677 global
3678 {not in Vi}
3679 {only available when compiled with the |+xim|
3680 |+multi_byte_ime| or |global-ime| feature}
3681 When set the Input Method is never used. This is useful to disable
3682 the IM when it doesn't work properly.
3683 Currently this option is on by default for SGI/IRIX machines. This
3684 may change in later releases.
3685
3686 *'iminsert'* *'imi'*
3687'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3688 local to buffer
3689 {not in Vi}
3690 Specifies whether :lmap or an Input Method (IM) is to be used in
3691 Insert mode. Valid values:
3692 0 :lmap is off and IM is off
3693 1 :lmap is ON and IM is off
3694 2 :lmap is off and IM is ON
3695 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3696 or |global-ime|.
3697 To always reset the option to zero when leaving Insert mode with <Esc>
3698 this can be used: >
3699 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3700< This makes :lmap and IM turn off automatically when leaving Insert
3701 mode.
3702 Note that this option changes when using CTRL-^ in Insert mode
3703 |i_CTRL-^|.
3704 The value is set to 1 when setting 'keymap' to a valid keymap name.
3705 It is also used for the argument of commands like "r" and "f".
3706 The value 0 may not work correctly with Athena and Motif with some XIM
3707 methods. Use 'imdisable' to disable XIM then.
3708
3709 *'imsearch'* *'ims'*
3710'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3711 local to buffer
3712 {not in Vi}
3713 Specifies whether :lmap or an Input Method (IM) is to be used when
3714 entering a search pattern. Valid values:
3715 -1 the value of 'iminsert' is used, makes it look like
3716 'iminsert' is also used when typing a search pattern
3717 0 :lmap is off and IM is off
3718 1 :lmap is ON and IM is off
3719 2 :lmap is off and IM is ON
3720 Note that this option changes when using CTRL-^ in Command-line mode
3721 |c_CTRL-^|.
3722 The value is set to 1 when it is not -1 and setting the 'keymap'
3723 option to a valid keymap name.
3724 The value 0 may not work correctly with Athena and Motif with some XIM
3725 methods. Use 'imdisable' to disable XIM then.
3726
3727 *'include'* *'inc'*
3728'include' 'inc' string (default "^\s*#\s*include")
3729 global or local to buffer |global-local|
3730 {not in Vi}
3731 {not available when compiled without the
3732 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003733 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 pattern, just like for the "/" command (See |pattern|). The default
3735 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003736 "]I", "[d", etc.
3737 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003738 comes after the matched pattern. But if "\zs" appears in the pattern
3739 then the text matched from "\zs" to the end, or until "\ze" if it
3740 appears, is used as the file name. Use this to include characters
3741 that are not in 'isfname', such as a space. You can then use
3742 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003743 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744
3745 *'includeexpr'* *'inex'*
3746'includeexpr' 'inex' string (default "")
3747 local to buffer
3748 {not in Vi}
3749 {not available when compiled without the
3750 |+find_in_path| or |+eval| feature}
3751 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003752 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 :set includeexpr=substitute(v:fname,'\\.','/','g')
3754< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003755
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003757 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 Also used for |<cfile>|.
3759
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003760 The expression may be evaluated in the |sandbox|, see
3761 |sandbox-option|.
3762
3763 It is not allowed to change text or jump to another window while
3764 evaluating 'includeexpr' |textlock|.
3765
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3767'incsearch' 'is' boolean (default off)
3768 global
3769 {not in Vi}
3770 {not available when compiled without the
3771 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003772 While typing a search command, show where the pattern, as it was typed
3773 so far, matches. The matched string is highlighted. If the pattern
3774 is invalid or not found, nothing is shown. The screen will be updated
3775 often, this is only useful on fast terminals.
3776 Note that the match will be shown, but the cursor will return to its
3777 original position when no match is found and when pressing <Esc>. You
3778 still need to finish the search command with <Enter> to move the
3779 cursor to the match.
3780 The highlighting can be set with the 'i' flag in 'highlight'.
3781 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003782 CTRL-L can be used to add one character from after the current match
3783 to the command line.
3784 CTRL-R CTRL-W can be used to add the word at the end of the current
3785 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 NOTE: This option is reset when 'compatible' is set.
3787
3788 *'indentexpr'* *'inde'*
3789'indentexpr' 'inde' string (default "")
3790 local to buffer
3791 {not in Vi}
3792 {not available when compiled without the |+cindent|
3793 or |+eval| features}
3794 Expression which is evaluated to obtain the proper indent for a line.
3795 It is used when a new line is created, for the |=| operator and
3796 in Insert mode as specified with the 'indentkeys' option.
3797 When this option is not empty, it overrules the 'cindent' and
3798 'smartindent' indenting.
3799 When 'paste' is set this option is not used for indenting.
3800 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003801 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 when the expression is evaluated (but it may be moved around).
3803 The expression must return the number of spaces worth of indent. It
3804 can return "-1" to keep the current indent (this means 'autoindent' is
3805 used for the indent).
3806 Functions useful for computing the indent are |indent()|, |cindent()|
3807 and |lispindent()|.
3808 The evaluation of the expression must not have side effects! It must
3809 not change the text, jump to another window, etc. Afterwards the
3810 cursor position is always restored, thus the cursor may be moved.
3811 Normally this option would be set to call a function: >
3812 :set indentexpr=GetMyIndent()
3813< Error messages will be suppressed, unless the 'debug' option contains
3814 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003815 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 NOTE: This option is made empty when 'compatible' is set.
3817
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003818 The expression may be evaluated in the |sandbox|, see
3819 |sandbox-option|.
3820
3821 It is not allowed to change text or jump to another window while
3822 evaluating 'indentexpr' |textlock|.
3823
3824
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 *'indentkeys'* *'indk'*
3826'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3827 local to buffer
3828 {not in Vi}
3829 {not available when compiled without the |+cindent|
3830 feature}
3831 A list of keys that, when typed in Insert mode, cause reindenting of
3832 the current line. Only happens if 'indentexpr' isn't empty.
3833 The format is identical to 'cinkeys', see |indentkeys-format|.
3834 See |C-indenting| and |indent-expression|.
3835
3836 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3837'infercase' 'inf' boolean (default off)
3838 local to buffer
3839 {not in Vi}
3840 When doing keyword completion in insert mode |ins-completion|, and
3841 'ignorecase' is also on, the case of the match is adjusted. If the
3842 typed text contains a lowercase letter where the match has an upper
3843 case letter, the completed part is made lowercase. If the typed text
3844 has no lowercase letters and the match has a lowercase letter where
3845 the typed text has an uppercase letter, and there is a letter before
3846 it, the completed part is made uppercase.
3847
3848 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3849'insertmode' 'im' boolean (default off)
3850 global
3851 {not in Vi}
3852 Makes Vim work in a way that Insert mode is the default mode. Useful
3853 if you want to use Vim as a modeless editor. Used for |evim|.
3854 These Insert mode commands will be useful:
3855 - Use the cursor keys to move around.
3856 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3857 this is a mapping, it is executed as if 'insertmode' was off.
3858 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003860 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3861 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862
3863 These items change when 'insertmode' is set:
3864 - when starting to edit of a file, Vim goes to Insert mode.
3865 - <Esc> in Insert mode is a no-op and beeps.
3866 - <Esc> in Normal mode makes Vim go to Insert mode.
3867 - CTRL-L in Insert mode is a command, it is not inserted.
3868 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3869 However, when <Esc> is used inside a mapping, it behaves like
3870 'insertmode' was not set. This was done to be able to use the same
3871 mappings with 'insertmode' set or not set.
3872 When executing commands with |:normal| 'insertmode' is not used.
3873
3874 NOTE: This option is reset when 'compatible' is set.
3875
3876 *'isfname'* *'isf'*
3877'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3878 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3879 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3880 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3881 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3882 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3883 global
3884 {not in Vi}
3885 The characters specified by this option are included in file names and
3886 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003887 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 Multi-byte characters 256 and above are always included, only the
3889 characters up to 255 are specified with this option.
3890 For UTF-8 the characters 0xa0 to 0xff are included as well.
3891
3892 Note that on systems using a backslash as path separator, Vim tries to
3893 do its best to make it work as you would expect. That is a bit
3894 tricky, since Vi originally used the backslash to escape special
3895 characters. Vim will not remove a backslash in front of a normal file
3896 name character on these systems, but it will on Unix and alikes. The
3897 '&' and '^' are not included by default, because these are special for
3898 cmd.exe.
3899
3900 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003901 Each part can be a single character number or a range. A range is two
3902 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 decimal number between 0 and 255 or the ASCII character itself (does
3904 not work for digits). Example:
3905 "_,-,128-140,#-43" (include '_' and '-' and the range
3906 128 to 140 and '#' to 43)
3907 If a part starts with '^', the following character number or range
3908 will be excluded from the option. The option is interpreted from left
3909 to right. Put the excluded character after the range where it is
3910 included. To include '^' itself use it as the last character of the
3911 option or the end of a range. Example:
3912 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3913 If the character is '@', all characters where isalpha() returns TRUE
3914 are included. Normally these are the characters a to z and A to Z,
3915 plus accented characters. To include '@' itself use "@-@". Examples:
3916 "@,^a-z" All alphabetic characters, excluding lower
3917 case letters.
3918 "a-z,A-Z,@-@" All letters plus the '@' character.
3919 A comma can be included by using it where a character number is
3920 expected. Example:
3921 "48-57,,,_" Digits, comma and underscore.
3922 A comma can be excluded by prepending a '^'. Example:
3923 " -~,^,,9" All characters from space to '~', excluding
3924 comma, plus <Tab>.
3925 See |option-backslash| about including spaces and backslashes.
3926
3927 *'isident'* *'isi'*
3928'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3929 "@,48-57,_,128-167,224-235"
3930 otherwise: "@,48-57,_,192-255")
3931 global
3932 {not in Vi}
3933 The characters given by this option are included in identifiers.
3934 Identifiers are used in recognizing environment variables and after a
3935 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003936 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 option.
3938 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003939 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3941
3942 *'iskeyword'* *'isk'*
3943'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3944 "@,48-57,_,128-167,224-235"
3945 otherwise: "@,48-57,_,192-255"
3946 Vi default: "@,48-57,_")
3947 local to buffer
3948 {not in Vi}
3949 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003950 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 'isfname' for a description of the format of this option. For C
3952 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3953 For a help file it is set to all non-blank printable characters except
3954 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3955 command).
3956 When the 'lisp' option is on the '-' character is always included.
3957 NOTE: This option is set to the Vi default value when 'compatible' is
3958 set and to the Vim default value when 'compatible' is reset.
3959
3960 *'isprint'* *'isp'*
3961'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3962 "@,~-255"; otherwise: "@,161-255")
3963 global
3964 {not in Vi}
3965 The characters given by this option are displayed directly on the
3966 screen. It is also used for "\p" in a |pattern|. The characters from
3967 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3968 even when they are not included in 'isprint' or excluded. See
3969 'isfname' for a description of the format of this option.
3970
3971 Non-printable characters are displayed with two characters:
3972 0 - 31 "^@" - "^_"
3973 32 - 126 always single characters
3974 127 "^?"
3975 128 - 159 "~@" - "~_"
3976 160 - 254 "| " - "|~"
3977 255 "~?"
3978 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3979 displayed as <xx>, with the hexadecimal value of the byte.
3980 When 'display' contains "uhex" all unprintable characters are
3981 displayed as <xx>.
3982 The NonText highlighting will be used for unprintable characters.
3983 |hl-NonText|
3984
3985 Multi-byte characters 256 and above are always included, only the
3986 characters up to 255 are specified with this option. When a character
3987 is printable but it is not available in the current font, a
3988 replacement character will be shown.
3989 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3990 There is no option to specify these characters.
3991
3992 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3993'joinspaces' 'js' boolean (default on)
3994 global
3995 {not in Vi}
3996 Insert two spaces after a '.', '?' and '!' with a join command.
3997 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3998 Otherwise only one space is inserted.
3999 NOTE: This option is set when 'compatible' is set.
4000
4001 *'key'*
4002'key' string (default "")
4003 local to buffer
4004 {not in Vi}
4005 The key that is used for encrypting and decrypting the current buffer.
4006 See |encryption|.
4007 Careful: Do not set the key value by hand, someone might see the typed
4008 key. Use the |:X| command. But you can make 'key' empty: >
4009 :set key=
4010< It is not possible to get the value of this option with ":set key" or
4011 "echo &key". This is to avoid showing it to someone who shouldn't
4012 know. It also means you cannot see it yourself once you have set it,
4013 be careful not to make a typing error!
4014
4015 *'keymap'* *'kmp'* *E544*
4016'keymap' 'kmp' string (default "")
4017 local to buffer
4018 {not in Vi}
4019 {only available when compiled with the |+keymap|
4020 feature}
4021 Name of a keyboard mapping. See |mbyte-keymap|.
4022 Setting this option to a valid keymap name has the side effect of
4023 setting 'iminsert' to one, so that the keymap becomes effective.
4024 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004025 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026
4027 *'keymodel'* *'km'*
4028'keymodel' 'km' string (default "")
4029 global
4030 {not in Vi}
4031 List of comma separated words, which enable special things that keys
4032 can do. These values can be used:
4033 startsel Using a shifted special key starts selection (either
4034 Select mode or Visual mode, depending on "key" being
4035 present in 'selectmode').
4036 stopsel Using a not-shifted special key stops selection.
4037 Special keys in this context are the cursor keys, <End>, <Home>,
4038 <PageUp> and <PageDown>.
4039 The 'keymodel' option is set by the |:behave| command.
4040
4041 *'keywordprg'* *'kp'*
4042'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4043 OS/2: "view /", VMS: "help")
4044 global or local to buffer |global-local|
4045 {not in Vi}
4046 Program to use for the |K| command. Environment variables are
4047 expanded |:set_env|. ":help" may be used to access the Vim internal
4048 help. (Note that previously setting the global option to the empty
4049 value did this, which is now deprecated.)
4050 When "man" is used, Vim will automatically translate a count for the
4051 "K" command to a section number. Also for "man -s", in which case the
4052 "-s" is removed when there is no count.
4053 See |option-backslash| about including spaces and backslashes.
4054 Example: >
4055 :set keywordprg=man\ -s
4056< This option cannot be set from a |modeline| or in the |sandbox|, for
4057 security reasons.
4058
4059 *'langmap'* *'lmap'* *E357* *E358*
4060'langmap' 'lmap' string (default "")
4061 global
4062 {not in Vi}
4063 {only available when compiled with the |+langmap|
4064 feature}
4065 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004066 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 inserted directly. When in command mode the 'langmap' option takes
4068 care of translating these special characters to the original meaning
4069 of the key. This means you don't have to change the keyboard mode to
4070 be able to execute Normal mode commands.
4071 This is the opposite of the 'keymap' option, where characters are
4072 mapped in Insert mode.
4073 This only works for 8-bit characters. The value of 'langmap' may be
4074 specified with multi-byte characters (e.g., UTF-8), but only the lower
4075 8 bits of each character will be used.
4076
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004077 Example (for Greek, in UTF-8): *greek* >
4078 :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 +00004079< Example (exchanges meaning of z and y for commands): >
4080 :set langmap=zy,yz,ZY,YZ
4081<
4082 The 'langmap' option is a list of parts, separated with commas. Each
4083 part can be in one of two forms:
4084 1. A list of pairs. Each pair is a "from" character immediately
4085 followed by the "to" character. Examples: "aA", "aAbBcC".
4086 2. A list of "from" characters, a semi-colon and a list of "to"
4087 characters. Example: "abc;ABC"
4088 Example: "aA,fgh;FGH,cCdDeE"
4089 Special characters need to be preceded with a backslash. These are
4090 ";", ',' and backslash itself.
4091
4092 This will allow you to activate vim actions without having to switch
4093 back and forth between the languages. Your language characters will
4094 be understood as normal vim English characters (according to the
4095 langmap mappings) in the following cases:
4096 o Normal/Visual mode (commands, buffer/register names, user mappings)
4097 o Insert/Replace Mode: Register names after CTRL-R
4098 o Insert/Replace Mode: Mappings
4099 Characters entered in Command-line mode will NOT be affected by
4100 this option. Note that this option can be changed at any time
4101 allowing to switch between mappings for different languages/encodings.
4102 Use a mapping to avoid having to type it each time!
4103
4104 *'langmenu'* *'lm'*
4105'langmenu' 'lm' string (default "")
4106 global
4107 {not in Vi}
4108 {only available when compiled with the |+menu| and
4109 |+multi_lang| features}
4110 Language to use for menu translation. Tells which file is loaded
4111 from the "lang" directory in 'runtimepath': >
4112 "lang/menu_" . &langmenu . ".vim"
4113< (without the spaces). For example, to always use the Dutch menus, no
4114 matter what $LANG is set to: >
4115 :set langmenu=nl_NL.ISO_8859-1
4116< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004117 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 If your $LANG is set to a non-English language but you do want to use
4119 the English menus: >
4120 :set langmenu=none
4121< This option must be set before loading menus, switching on filetype
4122 detection or syntax highlighting. Once the menus are defined setting
4123 this option has no effect. But you could do this: >
4124 :source $VIMRUNTIME/delmenu.vim
4125 :set langmenu=de_DE.ISO_8859-1
4126 :source $VIMRUNTIME/menu.vim
4127< Warning: This deletes all menus that you defined yourself!
4128
4129 *'laststatus'* *'ls'*
4130'laststatus' 'ls' number (default 1)
4131 global
4132 {not in Vi}
4133 The value of this option influences when the last window will have a
4134 status line:
4135 0: never
4136 1: only if there are at least two windows
4137 2: always
4138 The screen looks nicer with a status line if you have several
4139 windows, but it takes another screen line. |status-line|
4140
4141 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4142'lazyredraw' 'lz' boolean (default off)
4143 global
4144 {not in Vi}
4145 When this option is set, the screen will not be redrawn while
4146 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004147 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 update use |:redraw|.
4149
4150 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4151'linebreak' 'lbr' boolean (default off)
4152 local to window
4153 {not in Vi}
4154 {not available when compiled without the |+linebreak|
4155 feature}
4156 If on Vim will wrap long lines at a character in 'breakat' rather
4157 than at the last character that fits on the screen. Unlike
4158 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4159 it only affects the way the file is displayed, not its contents. The
4160 value of 'showbreak' is used to put in front of wrapped lines.
4161 This option is not used when the 'wrap' option is off or 'list' is on.
4162 Note that <Tab> characters after an <EOL> are mostly not displayed
4163 with the right amount of white space.
4164
4165 *'lines'* *E593*
4166'lines' number (default 24 or terminal height)
4167 global
4168 Number of lines of the Vim window.
4169 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004170 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 When Vim is running in the GUI or in a resizable window, setting this
4172 option will cause the window size to be changed. When you only want
4173 to use the size for the GUI, put the command in your |gvimrc| file.
4174 Vim limits the number of lines to what fits on the screen. You can
4175 use this command to get the tallest window possible: >
4176 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004177< Minimum value is 2, maximum value is 1000.
4178 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 When you set this option and Vim is unable to change the physical
4180 number of lines of the display, the display may be messed up.
4181
4182 *'linespace'* *'lsp'*
4183'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4184 global
4185 {not in Vi}
4186 {only in the GUI}
4187 Number of pixel lines inserted between characters. Useful if the font
4188 uses the full character cell height, making lines touch each other.
4189 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004190 With some fonts there can be too much room between lines (to have
4191 space for ascents and descents). Then it makes sense to set
4192 'linespace' to a negative value. This may cause display problems
4193 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194
4195 *'lisp'* *'nolisp'*
4196'lisp' boolean (default off)
4197 local to buffer
4198 {not available when compiled without the |+lispindent|
4199 feature}
4200 Lisp mode: When <Enter> is typed in insert mode set the indent for
4201 the next line to Lisp standards (well, sort of). Also happens with
4202 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4203 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4204 better. Also see 'lispwords'.
4205 The '-' character is included in keyword characters. Redefines the
4206 "=" operator to use this same indentation algorithm rather than
4207 calling an external program if 'equalprg' is empty.
4208 This option is not used when 'paste' is set.
4209 {Vi: Does it a little bit differently}
4210
4211 *'lispwords'* *'lw'*
4212'lispwords' 'lw' string (default is very long)
4213 global
4214 {not in Vi}
4215 {not available when compiled without the |+lispindent|
4216 feature}
4217 Comma separated list of words that influence the Lisp indenting.
4218 |'lisp'|
4219
4220 *'list'* *'nolist'*
4221'list' boolean (default off)
4222 local to window
4223 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4224 see the difference between tabs and spaces and for trailing blanks.
4225 Note that this will also affect formatting (set with 'textwidth' or
4226 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4227 changing the way tabs are displayed.
4228
4229 *'listchars'* *'lcs'*
4230'listchars' 'lcs' string (default "eol:$")
4231 global
4232 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004233 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 settings.
4235 eol:c Character to show at the end of each line. When
4236 omitted, there is no extra character at the end of the
4237 line.
4238 tab:xy Two characters to be used to show a Tab. The first
4239 char is used once. The second char is repeated to
4240 fill the space that the Tab normally occupies.
4241 "tab:>-" will show a Tab that takes four spaces as
4242 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004243 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 trailing spaces are blank.
4245 extends:c Character to show in the last column, when 'wrap' is
4246 off and the line continues beyond the right of the
4247 screen.
4248 precedes:c Character to show in the first column, when 'wrap'
4249 is off and there is text preceding the character
4250 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004251 nbsp:c Character to show for a non-breakable space (character
4252 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004254 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 be used when 'encoding' is "utf-8", otherwise only printable
4256 characters are allowed.
4257
4258 Examples: >
4259 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004260 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 :set lcs=extends:>,precedes:<
4262< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004263 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264
4265 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4266'loadplugins' 'lpl' boolean (default on)
4267 global
4268 {not in Vi}
4269 When on the plugin scripts are loaded when starting up |load-plugins|.
4270 This option can be reset in your |vimrc| file to disable the loading
4271 of plugins.
4272 Note that using the "-u NONE" and "--noplugin" command line arguments
4273 reset this option. |-u| |--noplugin|
4274
4275 *'magic'* *'nomagic'*
4276'magic' boolean (default on)
4277 global
4278 Changes the special characters that can be used in search patterns.
4279 See |pattern|.
4280 NOTE: To avoid portability problems with using patterns, always keep
4281 this option at the default "on". Only switch it off when working with
4282 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004283 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284
4285 *'makeef'* *'mef'*
4286'makeef' 'mef' string (default: "")
4287 global
4288 {not in Vi}
4289 {not available when compiled without the |+quickfix|
4290 feature}
4291 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4292 and the |:grep| command.
4293 When it is empty, an internally generated temp file will be used.
4294 When "##" is included, it is replaced by a number to make the name
4295 unique. This makes sure that the ":make" command doesn't overwrite an
4296 existing file.
4297 NOT used for the ":cf" command. See 'errorfile' for that.
4298 Environment variables are expanded |:set_env|.
4299 See |option-backslash| about including spaces and backslashes.
4300 This option cannot be set from a |modeline| or in the |sandbox|, for
4301 security reasons.
4302
4303 *'makeprg'* *'mp'*
4304'makeprg' 'mp' string (default "make", VMS: "MMS")
4305 global or local to buffer |global-local|
4306 {not in Vi}
4307 Program to use for the ":make" command. See |:make_makeprg|. This
4308 option may contain '%' and '#' characters, which are expanded like
4309 when used in a command-line. Environment variables are expanded
4310 |:set_env|. See |option-backslash| about including spaces and
4311 backslashes. Note that a '|' must be escaped twice: once for ":set"
4312 and once for the interpretation of a command. When you use a filter
4313 called "myfilter" do it like this: >
4314 :set makeprg=gmake\ \\\|\ myfilter
4315< The placeholder "$*" can be given (even multiple times) to specify
4316 where the arguments will be included, for example: >
4317 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4318< This option cannot be set from a |modeline| or in the |sandbox|, for
4319 security reasons.
4320
4321 *'matchpairs'* *'mps'*
4322'matchpairs' 'mps' string (default "(:),{:},[:]")
4323 local to buffer
4324 {not in Vi}
4325 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004326 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 must be different. The characters must be separated by a colon. The
4328 pairs must be separated by a comma. Example for including '<' and '>'
4329 (HTML): >
4330 :set mps+=<:>
4331
4332< A more exotic example, to jump between the '=' and ';' in an
4333 assignment, useful for languages like C and Java: >
4334 :au FileType c,cpp,java set mps+==:;
4335
4336< For a more advanced way of using "%", see the matchit.vim plugin in
4337 the $VIMRUNTIME/macros directory. |add-local-help|
4338
4339 *'matchtime'* *'mat'*
4340'matchtime' 'mat' number (default 5)
4341 global
4342 {not in Vi}{in Nvi}
4343 Tenths of a second to show the matching paren, when 'showmatch' is
4344 set. Note that this is not in milliseconds, like other options that
4345 set a time. This is to be compatible with Nvi.
4346
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004347 *'maxcombine'* *'mco'*
4348'maxcombine' 'mco' number (default 2)
4349 global
4350 {not in Vi}
4351 {only available when compiled with the |+multi_byte|
4352 feature}
4353 The maximum number of combining characters supported for displaying.
4354 Only used when 'encoding' is "utf-8".
4355 The default is OK for most languages. Hebrew may require 4.
4356 Maximum value is 6.
4357 Even when this option is set to 2 you can still edit text with more
4358 combining characters, you just can't see them. Use |g8| or |ga|.
4359 See |mbyte-combining|.
4360
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 *'maxfuncdepth'* *'mfd'*
4362'maxfuncdepth' 'mfd' number (default 100)
4363 global
4364 {not in Vi}
4365 Maximum depth of function calls for user functions. This normally
4366 catches endless recursion. When using a recursive function with
4367 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4368 more memory, there is the danger of failing when memory is exhausted.
4369 See also |:function|.
4370
4371 *'maxmapdepth'* *'mmd'* *E223*
4372'maxmapdepth' 'mmd' number (default 1000)
4373 global
4374 {not in Vi}
4375 Maximum number of times a mapping is done without resulting in a
4376 character to be used. This normally catches endless mappings, like
4377 ":map x y" with ":map y x". It still does not catch ":map g wg",
4378 because the 'w' is used before the next mapping is done. See also
4379 |key-mapping|.
4380
4381 *'maxmem'* *'mm'*
4382'maxmem' 'mm' number (default between 256 to 5120 (system
4383 dependent) or half the amount of memory
4384 available)
4385 global
4386 {not in Vi}
4387 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4388 limit is reached allocating extra memory for a buffer will cause
4389 other memory to be freed. Maximum value 2000000. Use this to work
4390 without a limit. Also see 'maxmemtot'.
4391
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004392 *'maxmempattern'* *'mmp'*
4393'maxmempattern' 'mmp' number (default 1000)
4394 global
4395 {not in Vi}
4396 Maximum amount of memory (in Kbyte) to use for pattern matching.
4397 Maximum value 2000000. Use this to work without a limit.
4398 *E363*
4399 When Vim runs into the limit it gives an error message mostly behaves
4400 like CTRL-C was typed.
4401 Running into the limit often means that the pattern is very
4402 inefficient or too complex. This may already happen with the pattern
4403 "\(.\)*" on a very long line. ".*" works much better.
4404 Vim may run out of memory before hitting the 'maxmempattern' limit.
4405
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 *'maxmemtot'* *'mmt'*
4407'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4408 dependent) or half the amount of memory
4409 available)
4410 global
4411 {not in Vi}
4412 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004413 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 'maxmem'.
4415
4416 *'menuitems'* *'mis'*
4417'menuitems' 'mis' number (default 25)
4418 global
4419 {not in Vi}
4420 {not available when compiled without the |+menu|
4421 feature}
4422 Maximum number of items to use in a menu. Used for menus that are
4423 generated from a list of items, e.g., the Buffers menu. Changing this
4424 option has no direct effect, the menu must be refreshed first.
4425
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004426 *'mkspellmem'* *'msm'*
4427'mkspellmem' 'msm' string (default "460000,2000,500")
4428 global
4429 {not in Vi}
4430 {not available when compiled without the |+syntax|
4431 feature}
4432 Parameters for |:mkspell|. This tunes when to start compressing the
4433 word tree. Compression can be slow when there are many words, but
4434 it's needed to avoid running out of memory. The amount of memory used
4435 per word depends very much on how similar the words are, that's why
4436 this tuning is complicated.
4437
4438 There are three numbers, separated by commas:
4439 {start},{inc},{added}
4440
4441 For most languages the uncompressed word tree fits in memory. {start}
4442 gives the amount of memory in Kbyte that can be used before any
4443 compression is done. It should be a bit smaller than the amount of
4444 memory that is available to Vim.
4445
4446 When going over the {start} limit the {inc} number specifies the
4447 amount of memory in Kbyte that can be allocated before another
4448 compression is done. A low number means compression is done after
4449 less words are added, which is slow. A high number means more memory
4450 will be allocated.
4451
4452 After doing compression, {added} times 1024 words can be added before
4453 the {inc} limit is ignored and compression is done when any extra
4454 amount of memory is needed. A low number means there is a smaller
4455 chance of hitting the {inc} limit, less memory is used but it's
4456 slower.
4457
4458 The languages for which these numbers are important are Italian and
4459 Hungarian. The default works for when you have about 512 Mbyte. If
4460 you have 1 Gbyte you could use: >
4461 :set mkspellmem=900000,3000,800
4462< If you have less than 512 Mbyte |:mkspell| may fail for some
4463 languages, no matter what you set 'mkspellmem' to.
4464
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4466'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4467 local to buffer
4468 *'modelines'* *'mls'*
4469'modelines' 'mls' number (default 5)
4470 global
4471 {not in Vi}
4472 If 'modeline' is on 'modelines' gives the number of lines that is
4473 checked for set commands. If 'modeline' is off or 'modelines' is zero
4474 no lines are checked. See |modeline|.
4475 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4476 set and to the Vim default value when 'compatible' is reset.
4477
4478 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4479'modifiable' 'ma' boolean (default on)
4480 local to buffer
4481 {not in Vi} *E21*
4482 When off the buffer contents cannot be changed. The 'fileformat' and
4483 'fileencoding' options also can't be changed.
4484 Can be reset with the |-M| command line argument.
4485
4486 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4487'modified' 'mod' boolean (default off)
4488 local to buffer
4489 {not in Vi}
4490 When on, the buffer is considered to be modified. This option is set
4491 when:
4492 1. A change was made to the text since it was last written. Using the
4493 |undo| command to go back to the original text will reset the
4494 option. But undoing changes that were made before writing the
4495 buffer will set the option again, since the text is different from
4496 when it was written.
4497 2. 'fileformat' or 'fileencoding' is different from its original
4498 value. The original value is set when the buffer is read or
4499 written. A ":set nomodified" command also resets the original
4500 values to the current values and the 'modified' option will be
4501 reset.
4502 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4503 will be ignored.
4504
4505 *'more'* *'nomore'*
4506'more' boolean (Vim default: on, Vi default: off)
4507 global
4508 {not in Vi}
4509 When on, listings pause when the whole screen is filled. You will get
4510 the |more-prompt|. When this option is off there are no pauses, the
4511 listing continues until finished.
4512 NOTE: This option is set to the Vi default value when 'compatible' is
4513 set and to the Vim default value when 'compatible' is reset.
4514
4515 *'mouse'* *E538*
4516'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4517 global
4518 {not in Vi}
4519 Enable the use of the mouse. Only works for certain terminals
4520 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4521 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4522 The mouse can be enabled for different modes:
4523 n Normal mode
4524 v Visual mode
4525 i Insert mode
4526 c Command-line mode
4527 h all previous modes when editing a help file
4528 a all previous modes
4529 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 Normally you would enable the mouse in all four modes with: >
4531 :set mouse=a
4532< When the mouse is not enabled, the GUI will still use the mouse for
4533 modeless selection. This doesn't move the text cursor.
4534
4535 See |mouse-using|. Also see |'clipboard'|.
4536
4537 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004538 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 the mouse buttons can still be used by keeping the shift key pressed.
4540 Also see the 'clipboard' option.
4541
4542 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4543'mousefocus' 'mousef' boolean (default off)
4544 global
4545 {not in Vi}
4546 {only works in the GUI}
4547 The window that the mouse pointer is on is automatically activated.
4548 When changing the window layout or window focus in another way, the
4549 mouse pointer is moved to the window with keyboard focus. Off is the
4550 default because it makes using the pull down menus a little goofy, as
4551 a pointer transit may activate a window unintentionally.
4552
4553 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4554'mousehide' 'mh' boolean (default on)
4555 global
4556 {not in Vi}
4557 {only works in the GUI}
4558 When on, the mouse pointer is hidden when characters are typed.
4559 The mouse pointer is restored when the mouse is moved.
4560
4561 *'mousemodel'* *'mousem'*
4562'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4563 global
4564 {not in Vi}
4565 Sets the model to use for the mouse. The name mostly specifies what
4566 the right mouse button is used for:
4567 extend Right mouse button extends a selection. This works
4568 like in an xterm.
4569 popup Right mouse button pops up a menu. The shifted left
4570 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004571 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 popup_setpos Like "popup", but the cursor will be moved to the
4573 position where the mouse was clicked, and thus the
4574 selected operation will act upon the clicked object.
4575 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004576 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 course, that right clicking outside a selection will
4578 end Visual mode.
4579 Overview of what button does what for each model:
4580 mouse extend popup(_setpos) ~
4581 left click place cursor place cursor
4582 left drag start selection start selection
4583 shift-left search word extend selection
4584 right click extend selection popup menu (place cursor)
4585 right drag extend selection -
4586 middle click paste paste
4587
4588 In the "popup" model the right mouse button produces a pop-up menu.
4589 You need to define this first, see |popup-menu|.
4590
4591 Note that you can further refine the meaning of buttons with mappings.
4592 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4593 selection (because that's handled in the GUI code directly).
4594
4595 The 'mousemodel' option is set by the |:behave| command.
4596
4597 *'mouseshape'* *'mouses'* *E547*
4598'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004599 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 global
4601 {not in Vi}
4602 {only available when compiled with the |+mouseshape|
4603 feature}
4604 This option tells Vim what the mouse pointer should look like in
4605 different modes. The option is a comma separated list of parts, much
4606 like used for 'guicursor'. Each part consist of a mode/location-list
4607 and an argument-list:
4608 mode-list:shape,mode-list:shape,..
4609 The mode-list is a dash separated list of these modes/locations:
4610 In a normal window: ~
4611 n Normal mode
4612 v Visual mode
4613 ve Visual mode with 'selection' "exclusive" (same as 'v',
4614 if not specified)
4615 o Operator-pending mode
4616 i Insert mode
4617 r Replace mode
4618
4619 Others: ~
4620 c appending to the command-line
4621 ci inserting in the command-line
4622 cr replacing in the command-line
4623 m at the 'Hit ENTER' or 'More' prompts
4624 ml idem, but cursor in the last line
4625 e any mode, pointer below last window
4626 s any mode, pointer on a status line
4627 sd any mode, while dragging a status line
4628 vs any mode, pointer on a vertical separator line
4629 vd any mode, while dragging a vertical separator line
4630 a everywhere
4631
4632 The shape is one of the following:
4633 avail name looks like ~
4634 w x arrow Normal mouse pointer
4635 w x blank no pointer at all (use with care!)
4636 w x beam I-beam
4637 w x updown up-down sizing arrows
4638 w x leftright left-right sizing arrows
4639 w x busy The system's usual busy pointer
4640 w x no The system's usual 'no input' pointer
4641 x udsizing indicates up-down resizing
4642 x lrsizing indicates left-right resizing
4643 x crosshair like a big thin +
4644 x hand1 black hand
4645 x hand2 white hand
4646 x pencil what you write with
4647 x question big ?
4648 x rightup-arrow arrow pointing right-up
4649 w x up-arrow arrow pointing up
4650 x <number> any X11 pointer number (see X11/cursorfont.h)
4651
4652 The "avail" column contains a 'w' if the shape is available for Win32,
4653 x for X11.
4654 Any modes not specified or shapes not available use the normal mouse
4655 pointer.
4656
4657 Example: >
4658 :set mouseshape=s:udsizing,m:no
4659< will make the mouse turn to a sizing arrow over the status lines and
4660 indicate no input when the hit-enter prompt is displayed (since
4661 clicking the mouse has no effect in this state.)
4662
4663 *'mousetime'* *'mouset'*
4664'mousetime' 'mouset' number (default 500)
4665 global
4666 {not in Vi}
4667 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4668 time in msec between two mouse clicks for the second click to be
4669 recognized as a multi click.
4670
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004671 *'mzquantum'* *'mzq'*
4672'mzquantum' 'mzq' number (default 100)
4673 global
4674 {not in Vi}
4675 {not available when compiled without the |+mzscheme|
4676 feature}
4677 The number of milliseconds between polls for MzScheme threads.
4678 Negative or zero value means no thread scheduling.
4679
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 *'nrformats'* *'nf'*
4681'nrformats' 'nf' string (default "octal,hex")
4682 local to buffer
4683 {not in Vi}
4684 This defines what bases Vim will consider for numbers when using the
4685 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4686 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004687 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 incremented or decremented. This is useful for a list with a
4689 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004690 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004692 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 considered to be hexadecimal. Example: Using CTRL-X on
4694 "0x100" results in "0x0ff".
4695 Numbers which simply begin with a digit in the range 1-9 are always
4696 considered decimal. This also happens for numbers that are not
4697 recognized as octal or hex.
4698
4699 *'number'* *'nu'* *'nonumber'* *'nonu'*
4700'number' 'nu' boolean (default off)
4701 local to window
4702 Print the line number in front of each line. When the 'n' option is
4703 excluded from 'cpoptions' a wrapped line will not use the column of
4704 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004705 The 'numberwidth' option can be used to set the room used for the line
4706 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 When a long, wrapped line doesn't start with the first character, '-'
4708 characters are put before the number.
4709 See |hl-LineNr| for the highlighting used for the number.
4710
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004711 *'numberwidth'* *'nuw'*
4712'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4713 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004714 {not in Vi}
4715 {only available when compiled with the |+linebreak|
4716 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004717 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004718 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004719 Since one space is always between the number and the text, there is
4720 one less character for the number itself.
4721 The value is the minimum width. A bigger width is used when needed to
4722 fit the highest line number in the buffer. Thus with the Vim default
4723 of 4 there is room for a line number up to 999. When the buffer has
4724 1000 lines five columns will be used.
4725 The minimum value is 1, the maximum value is 10.
4726 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4727
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004728 *'omnifunc'* *'ofu'*
4729'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004730 local to buffer
4731 {not in Vi}
4732 {not available when compiled without the +eval
4733 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004734 This option specifies a function to be used for Insert mode omni
4735 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004736 See |complete-functions| for an explanation of how the function is
4737 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004738
4739
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004740 *'operatorfunc'* *'opfunc'*
4741'operatorfunc' 'opfunc' string (default: empty)
4742 global
4743 {not in Vi}
4744 This option specifies a function to be called by the |g@| operator.
4745 See |:map-operator| for more info and an example.
4746
4747 This option cannot be set from a |modeline| or in the |sandbox|, for
4748 security reasons.
4749
4750
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 *'osfiletype'* *'oft'* *E366*
4752'osfiletype' 'oft' string (RISC-OS default: "Text",
4753 others default: "")
4754 local to buffer
4755 {not in Vi}
4756 {only available when compiled with the |+osfiletype|
4757 feature}
4758 Some operating systems store extra information about files besides
4759 name, datestamp and permissions. This option contains the extra
4760 information, the nature of which will vary between systems.
4761 The value of this option is usually set when the file is loaded, and
4762 use to set the file type when file is written.
4763 It can affect the pattern matching of the automatic commands.
4764 |autocmd-osfiletypes|
4765
4766 *'paragraphs'* *'para'*
4767'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4768 global
4769 Specifies the nroff macros that separate paragraphs. These are pairs
4770 of two letters (see |object-motions|).
4771
4772 *'paste'* *'nopaste'*
4773'paste' boolean (default off)
4774 global
4775 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004776 Put Vim in Paste mode. This is useful if you want to cut or copy
4777 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 unexpected effects.
4779 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004780 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 knows about pasting and will mostly do the right thing without 'paste'
4782 being set. The same is true for a terminal where Vim handles the
4783 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004784 This option is reset when starting the GUI. Thus if you set it in
4785 your .vimrc it will work in a terminal, but not in the GUI. Setting
4786 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4787 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 When the 'paste' option is switched on (also when it was already on):
4789 - mapping in Insert mode and Command-line mode is disabled
4790 - abbreviations are disabled
4791 - 'textwidth' is set to 0
4792 - 'wrapmargin' is set to 0
4793 - 'autoindent' is reset
4794 - 'smartindent' is reset
4795 - 'softtabstop' is set to 0
4796 - 'revins' is reset
4797 - 'ruler' is reset
4798 - 'showmatch' is reset
4799 - 'formatoptions' is used like it is empty
4800 These options keep their value, but their effect is disabled:
4801 - 'lisp'
4802 - 'indentexpr'
4803 - 'cindent'
4804 NOTE: When you start editing another file while the 'paste' option is
4805 on, settings from the modelines or autocommands may change the
4806 settings again, causing trouble when pasting text. You might want to
4807 set the 'paste' option again.
4808 When the 'paste' option is reset the mentioned options are restored to
4809 the value before the moment 'paste' was switched from off to on.
4810 Resetting 'paste' before ever setting it does not have any effect.
4811 Since mapping doesn't work while 'paste' is active, you need to use
4812 the 'pastetoggle' option to toggle the 'paste' option with some key.
4813
4814 *'pastetoggle'* *'pt'*
4815'pastetoggle' 'pt' string (default "")
4816 global
4817 {not in Vi}
4818 When non-empty, specifies the key sequence that toggles the 'paste'
4819 option. This is like specifying a mapping: >
4820 :map {keys} :set invpaste<CR>
4821< Where {keys} is the value of 'pastetoggle'.
4822 The difference is that it will work even when 'paste' is set.
4823 'pastetoggle' works in Insert mode and Normal mode, but not in
4824 Command-line mode.
4825 Mappings are checked first, thus overrule 'pastetoggle'. However,
4826 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4827 this: >
4828 :map <F10> :set paste<CR>
4829 :map <F11> :set nopaste<CR>
4830 :imap <F10> <C-O>:set paste<CR>
4831 :imap <F11> <nop>
4832 :set pastetoggle=<F11>
4833< This will make <F10> start paste mode and <F11> stop paste mode.
4834 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4835 mode everything is inserted literally, except the 'pastetoggle' key
4836 sequence.
4837
4838 *'pex'* *'patchexpr'*
4839'patchexpr' 'pex' string (default "")
4840 global
4841 {not in Vi}
4842 {not available when compiled without the |+diff|
4843 feature}
4844 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004845 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846
4847 *'patchmode'* *'pm'* *E206*
4848'patchmode' 'pm' string (default "")
4849 global
4850 {not in Vi}
4851 When non-empty the oldest version of a file is kept. This can be used
4852 to keep the original version of a file if you are changing files in a
4853 source distribution. Only the first time that a file is written a
4854 copy of the original file will be kept. The name of the copy is the
4855 name of the original file with the string in the 'patchmode' option
4856 appended. This option should start with a dot. Use a string like
4857 ".org". 'backupdir' must not be empty for this to work (Detail: The
4858 backup file is renamed to the patchmode file after the new file has
4859 been successfully written, that's why it must be possible to write a
4860 backup file). If there was no file to be backed up, an empty file is
4861 created.
4862 When the 'backupskip' pattern matches, a patchmode file is not made.
4863 Using 'patchmode' for compressed files appends the extension at the
4864 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4865 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004866 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867
4868 *'path'* *'pa'* *E343* *E345* *E347*
4869'path' 'pa' string (default on Unix: ".,/usr/include,,"
4870 on OS/2: ".,/emx/include,,"
4871 other systems: ".,,")
4872 global or local to buffer |global-local|
4873 {not in Vi}
4874 This is a list of directories which will be searched when using the
4875 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4876 being searched for has a relative path (not starting with '/'). The
4877 directories in the 'path' option may be relative or absolute.
4878 - Use commas to separate directory names: >
4879 :set path=.,/usr/local/include,/usr/include
4880< - Spaces can also be used to separate directory names (for backwards
4881 compatibility with version 3.0). To have a space in a directory
4882 name, precede it with an extra backslash, and escape the space: >
4883 :set path=.,/dir/with\\\ space
4884< - To include a comma in a directory name precede it with an extra
4885 backslash: >
4886 :set path=.,/dir/with\\,comma
4887< - To search relative to the directory of the current file, use: >
4888 :set path=.
4889< - To search in the current directory use an empty string between two
4890 commas: >
4891 :set path=,,
4892< - A directory name may end in a ':' or '/'.
4893 - Environment variables are expanded |:set_env|.
4894 - When using |netrw.vim| URLs can be used. For example, adding
4895 "http://www.vim.org" will make ":find index.html" work.
4896 - Search upwards and downwards in a directory tree:
4897 1) "*" matches a sequence of characters, e.g.: >
4898 :set path=/usr/include/*
4899< means all subdirectories in /usr/include (but not /usr/include
4900 itself). >
4901 :set path=/usr/*c
4902< matches /usr/doc and /usr/src.
4903 2) "**" matches a subtree, up to 100 directories deep. Example: >
4904 :set path=/home/user_x/src/**
4905< means search in the whole subtree under "/home/usr_x/src".
4906 3) If the path ends with a ';', this path is the startpoint
4907 for upward search.
4908 See |file-searching| for more info and exact syntax.
4909 {not available when compiled without the |+path_extra| feature}
4910 - Careful with '\' characters, type two to get one in the option: >
4911 :set path=.,c:\\include
4912< Or just use '/' instead: >
4913 :set path=.,c:/include
4914< Don't forget "." or files won't even be found in the same directory as
4915 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004916 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 it is something like 256 or 1024 characters.
4918 You can check if all the include files are found, using the value of
4919 'path', see |:checkpath|.
4920 The use of |:set+=| and |:set-=| is preferred when adding or removing
4921 directories from the list. This avoids problems when a future version
4922 uses another default. To remove the current directory use: >
4923 :set path-=
4924< To add the current directory use: >
4925 :set path+=
4926< To use an environment variable, you probably need to replace the
4927 separator. Here is an example to append $INCL, in which directory
4928 names are separated with a semi-colon: >
4929 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4930< Replace the ';' with a ':' or whatever separator is used. Note that
4931 this doesn't work when $INCL contains a comma or white space.
4932
4933 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4934'preserveindent' 'pi' boolean (default off)
4935 local to buffer
4936 {not in Vi}
4937 When changing the indent of the current line, preserve as much of the
4938 indent structure as possible. Normally the indent is replaced by a
4939 series of tabs followed by spaces as required (unless |'expandtab'| is
4940 enabled, in which case only spaces are used). Enabling this option
4941 means the indent will preserve as many existing characters as possible
4942 for indenting, and only add additional tabs or spaces as required.
4943 NOTE: When using ">>" multiple times the resulting indent is a mix of
4944 tabs and spaces. You might not like this.
4945 NOTE: 'preserveindent' is reset when 'compatible' is set.
4946 Also see 'copyindent'.
4947 Use |:retab| to clean up white space.
4948
4949 *'previewheight'* *'pvh'*
4950'previewheight' 'pvh' number (default 12)
4951 global
4952 {not in Vi}
4953 {not available when compiled without the |+windows| or
4954 |+quickfix| feature}
4955 Default height for a preview window. Used for |:ptag| and associated
4956 commands. Used for |CTRL-W_}| when no count is given.
4957
4958 *'previewwindow'* *'nopreviewwindow'*
4959 *'pvw'* *'nopvw'* *E590*
4960'previewwindow' 'pvw' boolean (default off)
4961 local to window
4962 {not in Vi}
4963 {not available when compiled without the |+windows| or
4964 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004965 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 set. It's normally not set directly, but by using one of the commands
4967 |:ptag|, |:pedit|, etc.
4968
4969 *'printdevice'* *'pdev'*
4970'printdevice' 'pdev' string (default empty)
4971 global
4972 {not in Vi}
4973 {only available when compiled with the |+printer|
4974 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004975 The name of the printer to be used for |:hardcopy|.
4976 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004977 This option cannot be set from a |modeline| or in the |sandbox|, for
4978 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979
Bram Moolenaar8299df92004-07-10 09:47:34 +00004980 *'printencoding'* *'penc'*
4981'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 global
4983 {not in Vi}
4984 {only available when compiled with the |+printer|
4985 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004986 Sets the character encoding used when printing.
4987 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988
4989 *'printexpr'* *'pexpr'*
4990'printexpr' 'pexpr' String (default: see below)
4991 global
4992 {not in Vi}
4993 {only available when compiled with the |+printer|
4994 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004995 Expression used to print the PostScript produced with |:hardcopy|.
4996 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997
Bram Moolenaar8299df92004-07-10 09:47:34 +00004998 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999'printfont' 'pfn' string (default "courier")
5000 global
5001 {not in Vi}
5002 {only available when compiled with the |+printer|
5003 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005004 The name of the font that will be used for |:hardcopy|.
5005 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006
5007 *'printheader'* *'pheader'*
5008'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5009 global
5010 {not in Vi}
5011 {only available when compiled with the |+printer|
5012 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005013 The format of the header produced in |:hardcopy| output.
5014 See |pheader-option|.
5015
5016 *'printmbcharset'* *'pmbcs'*
5017'printmbcharset' 'pmbcs' string (default "")
5018 global
5019 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005020 {only available when compiled with the |+printer|,
5021 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005022 The CJK character set to be used for CJK output from |:hardcopy|.
5023 See |pmbcs-option|.
5024
5025 *'printmbfont'* *'pmbfn'*
5026'printmbfont' 'pmbfn' string (default "")
5027 global
5028 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005029 {only available when compiled with the |+printer|,
5030 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005031 List of font names to be used for CJK output from |:hardcopy|.
5032 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033
5034 *'printoptions'* *'popt'*
5035'printoptions' 'popt' string (default "")
5036 global
5037 {not in Vi}
5038 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005039 List of items that control the format of the output of |:hardcopy|.
5040 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005042 *'prompt'* *'noprompt'*
5043'prompt' boolean (default on)
5044 global
5045 When on a ":" prompt is used in Ex mode.
5046
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005047 *'pumheight'* *'ph'*
5048'pumheight' 'ph' number (default 0)
5049 global
5050 {not available when compiled without the
5051 |+insert_expand| feature}
5052 {not in Vi}
5053 Determines the maximum number of items to show in the popup menu.
5054 When zero as much space as available is used.
5055 |ins-completion-menu|.
5056
5057
Bram Moolenaar677ee682005-01-27 14:41:15 +00005058 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005059'quoteescape' 'qe' string (default "\")
5060 local to buffer
5061 {not in Vi}
5062 The characters that are used to escape quotes in a string. Used for
5063 objects like a', a" and a` |a'|.
5064 When one of the characters in this option is found inside a string,
5065 the following character will be skipped. The default value makes the
5066 text "foo\"bar\\" considered to be one string.
5067
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5069'readonly' 'ro' boolean (default off)
5070 local to buffer
5071 If on, writes fail unless you use a '!'. Protects you from
5072 accidentally overwriting a file. Default on when Vim is started
5073 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005074 When using ":w!" the 'readonly' option is reset for the current
5075 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005077 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078
5079 *'remap'* *'noremap'*
5080'remap' boolean (default on)
5081 global
5082 Allows for mappings to work recursively. If you do not want this for
5083 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005084 NOTE: To avoid portability problems with Vim scripts, always keep
5085 this option at the default "on". Only switch it off when working with
5086 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087
5088 *'report'*
5089'report' number (default 2)
5090 global
5091 Threshold for reporting number of lines changed. When the number of
5092 changed lines is more than 'report' a message will be given for most
5093 ":" commands. If you want it always, set 'report' to 0.
5094 For the ":substitute" command the number of substitutions is used
5095 instead of the number of lines.
5096
5097 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5098'restorescreen' 'rs' boolean (default on)
5099 global
5100 {not in Vi} {only in Windows 95/NT console version}
5101 When set, the screen contents is restored when exiting Vim. This also
5102 happens when executing external commands.
5103
5104 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5105 options in your .vimrc. To disable restoring:
5106 set t_ti= t_te=
5107 To enable restoring (for an xterm):
5108 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5109 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5110
5111 *'revins'* *'ri'* *'norevins'* *'nori'*
5112'revins' 'ri' boolean (default off)
5113 global
5114 {not in Vi}
5115 {only available when compiled with the |+rightleft|
5116 feature}
5117 Inserting characters in Insert mode will work backwards. See "typing
5118 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5119 command in Insert mode, when 'allowrevins' is set.
5120 NOTE: This option is reset when 'compatible' or 'paste' is set.
5121
5122 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5123'rightleft' 'rl' boolean (default off)
5124 local to window
5125 {not in Vi}
5126 {only available when compiled with the |+rightleft|
5127 feature}
5128 When on, display orientation becomes right-to-left, i.e., characters
5129 that are stored in the file appear from the right to the left.
5130 Using this option, it is possible to edit files for languages that
5131 are written from the right to the left such as Hebrew and Arabic.
5132 This option is per window, so it is possible to edit mixed files
5133 simultaneously, or to view the same file in both ways (this is
5134 useful whenever you have a mixed text file with both right-to-left
5135 and left-to-right strings so that both sets are displayed properly
5136 in different windows). Also see |rileft.txt|.
5137
5138 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5139'rightleftcmd' 'rlc' string (default "search")
5140 local to window
5141 {not in Vi}
5142 {only available when compiled with the |+rightleft|
5143 feature}
5144 Each word in this option enables the command line editing to work in
5145 right-to-left mode for a group of commands:
5146
5147 search "/" and "?" commands
5148
5149 This is useful for languages such as Hebrew, Arabic and Farsi.
5150 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5151
5152 *'ruler'* *'ru'* *'noruler'* *'noru'*
5153'ruler' 'ru' boolean (default off)
5154 global
5155 {not in Vi}
5156 {not available when compiled without the
5157 |+cmdline_info| feature}
5158 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005159 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 text in the file is shown on the far right:
5161 Top first line is visible
5162 Bot last line is visible
5163 All first and last line are visible
5164 45% relative position in the file
5165 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005166 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005168 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 this option takes precedence over 'ruler' and 'rulerformat'
5170 If the number of characters displayed is different from the number of
5171 bytes in the text (e.g., for a TAB or a multi-byte character), both
5172 the text column (byte number) and the screen column are shown,
5173 separated with a dash.
5174 For an empty line "0-1" is shown.
5175 For an empty buffer the line number will also be zero: "0,0-1".
5176 This option is reset when the 'paste' option is set.
5177 If you don't want to see the ruler all the time but want to know where
5178 you are, use "g CTRL-G" |g_CTRL-G|.
5179 NOTE: This option is reset when 'compatible' is set.
5180
5181 *'rulerformat'* *'ruf'*
5182'rulerformat' 'ruf' string (default empty)
5183 global
5184 {not in Vi}
5185 {not available when compiled without the |+statusline|
5186 feature}
5187 When this option is not empty, it determines the content of the ruler
5188 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005189 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 The default ruler width is 17 characters. To make the ruler 15
5191 characters wide, put "%15(" at the start and "%)" at the end.
5192 Example: >
5193 :set rulerformat=%15(%c%V\ %p%%%)
5194<
5195 *'runtimepath'* *'rtp'* *vimfiles*
5196'runtimepath' 'rtp' string (default:
5197 Unix: "$HOME/.vim,
5198 $VIM/vimfiles,
5199 $VIMRUNTIME,
5200 $VIM/vimfiles/after,
5201 $HOME/.vim/after"
5202 Amiga: "home:vimfiles,
5203 $VIM/vimfiles,
5204 $VIMRUNTIME,
5205 $VIM/vimfiles/after,
5206 home:vimfiles/after"
5207 PC, OS/2: "$HOME/vimfiles,
5208 $VIM/vimfiles,
5209 $VIMRUNTIME,
5210 $VIM/vimfiles/after,
5211 $HOME/vimfiles/after"
5212 Macintosh: "$VIM:vimfiles,
5213 $VIMRUNTIME,
5214 $VIM:vimfiles:after"
5215 RISC-OS: "Choices:vimfiles,
5216 $VIMRUNTIME,
5217 Choices:vimfiles/after"
5218 VMS: "sys$login:vimfiles,
5219 $VIM/vimfiles,
5220 $VIMRUNTIME,
5221 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005222 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 global
5224 {not in Vi}
5225 This is a list of directories which will be searched for runtime
5226 files:
5227 filetype.vim filetypes by file name |new-filetype|
5228 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005229 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230 colors/ color scheme files |:colorscheme|
5231 compiler/ compiler files |:compiler|
5232 doc/ documentation |write-local-help|
5233 ftplugin/ filetype plugins |write-filetype-plugin|
5234 indent/ indent scripts |indent-expression|
5235 keymap/ key mapping files |mbyte-keymap|
5236 lang/ menu translations |:menutrans|
5237 menu.vim GUI menus |menu.vim|
5238 plugin/ plugin scripts |write-plugin|
5239 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005240 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 syntax/ syntax files |mysyntaxfile|
5242 tutor/ files for vimtutor |tutor|
5243
5244 And any other file searched for with the |:runtime| command.
5245
5246 The defaults for most systems are setup to search five locations:
5247 1. In your home directory, for your personal preferences.
5248 2. In a system-wide Vim directory, for preferences from the system
5249 administrator.
5250 3. In $VIMRUNTIME, for files distributed with Vim.
5251 *after-directory*
5252 4. In the "after" directory in the system-wide Vim directory. This is
5253 for the system administrator to overrule or add to the distributed
5254 defaults (rarely needed)
5255 5. In the "after" directory in your home directory. This is for
5256 personal preferences to overrule or add to the distributed defaults
5257 or system-wide settings (rarely needed).
5258
5259 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5260 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005261 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 wildcards.
5263 See |:runtime|.
5264 Example: >
5265 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5266< This will use the directory "~/vimruntime" first (containing your
5267 personal Vim runtime files), then "/mygroup/vim" (shared between a
5268 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5269 files).
5270 You probably should always include $VIMRUNTIME somewhere, to use the
5271 distributed runtime files. You can put a directory before $VIMRUNTIME
5272 to find files which replace a distributed runtime files. You can put
5273 a directory after $VIMRUNTIME to find files which add to distributed
5274 runtime files.
5275 This option cannot be set from a |modeline| or in the |sandbox|, for
5276 security reasons.
5277
5278 *'scroll'* *'scr'*
5279'scroll' 'scr' number (default: half the window height)
5280 local to window
5281 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5282 set to half the number of lines in the window when the window size
5283 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005284 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5286 the number of screen lines instead of file lines, makes a difference
5287 when lines wrap}
5288
5289 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5290'scrollbind' 'scb' boolean (default off)
5291 local to window
5292 {not in Vi}
5293 {not available when compiled without the |+scrollbind|
5294 feature}
5295 See also |scroll-binding|. When this option is set, the current
5296 window scrolls as other scrollbind windows (windows that also have
5297 this option set) scroll. This option is useful for viewing the
5298 differences between two versions of a file, see 'diff'.
5299 See |'scrollopt'| for options that determine how this option should be
5300 interpreted.
5301 This option is mostly reset when splitting a window to edit another
5302 file. This means that ":split | edit file" results in two windows
5303 with scroll-binding, but ":split file" does not.
5304
5305 *'scrolljump'* *'sj'*
5306'scrolljump' 'sj' number (default 1)
5307 global
5308 {not in Vi}
5309 Minimal number of lines to scroll when the cursor gets off the
5310 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5311 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005312 When set to a negative number from -1 to -100 this is used as the
5313 percentage of the window height. Thus -50 scrolls half the window
5314 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 NOTE: This option is set to 1 when 'compatible' is set.
5316
5317 *'scrolloff'* *'so'*
5318'scrolloff' 'so' number (default 0)
5319 global
5320 {not in Vi}
5321 Minimal number of screen lines to keep above and below the cursor.
5322 This will make some context visible around where you are working. If
5323 you set it to a very large value (999) the cursor line will always be
5324 in the middle of the window (except at the start or end of the file or
5325 when long lines wrap).
5326 For scrolling horizontally see 'sidescrolloff'.
5327 NOTE: This option is set to 0 when 'compatible' is set.
5328
5329 *'scrollopt'* *'sbo'*
5330'scrollopt' 'sbo' string (default "ver,jump")
5331 global
5332 {not available when compiled without the |+scrollbind|
5333 feature}
5334 {not in Vi}
5335 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005336 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5337 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 The following words are available:
5339 ver Bind vertical scrolling for 'scrollbind' windows
5340 hor Bind horizontal scrolling for 'scrollbind' windows
5341 jump Applies to the offset between two windows for vertical
5342 scrolling. This offset is the difference in the first
5343 displayed line of the bound windows. When moving
5344 around in a window, another 'scrollbind' window may
5345 reach a position before the start or after the end of
5346 the buffer. The offset is not changed though, when
5347 moving back the 'scrollbind' window will try to scroll
5348 to the desired position when possible.
5349 When now making that window the current one, two
5350 things can be done with the relative offset:
5351 1. When "jump" is not included, the relative offset is
5352 adjusted for the scroll position in the new current
5353 window. When going back to the other window, the
5354 the new relative offset will be used.
5355 2. When "jump" is included, the other windows are
5356 scrolled to keep the same relative offset. When
5357 going back to the other window, it still uses the
5358 same relative offset.
5359 Also see |scroll-binding|.
5360
5361 *'sections'* *'sect'*
5362'sections' 'sect' string (default "SHNHH HUnhsh")
5363 global
5364 Specifies the nroff macros that separate sections. These are pairs of
5365 two letters (See |object-motions|). The default makes a section start
5366 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5367
5368 *'secure'* *'nosecure'* *E523*
5369'secure' boolean (default off)
5370 global
5371 {not in Vi}
5372 When on, ":autocmd", shell and write commands are not allowed in
5373 ".vimrc" and ".exrc" in the current directory and map commands are
5374 displayed. Switch it off only if you know that you will not run into
5375 problems, or when the 'exrc' option is off. On Unix this option is
5376 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005377 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 'secure' at the end of your ~/.vimrc then.
5379 This option cannot be set from a |modeline| or in the |sandbox|, for
5380 security reasons.
5381
5382 *'selection'* *'sel'*
5383'selection' 'sel' string (default "inclusive")
5384 global
5385 {not in Vi}
5386 This option defines the behavior of the selection. It is only used
5387 in Visual and Select mode.
5388 Possible values:
5389 value past line inclusive ~
5390 old no yes
5391 inclusive yes yes
5392 exclusive yes no
5393 "past line" means that the cursor is allowed to be positioned one
5394 character past the line.
5395 "inclusive" means that the last character of the selection is included
5396 in an operation. For example, when "x" is used to delete the
5397 selection.
5398 Note that when "exclusive" is used and selecting from the end
5399 backwards, you cannot include the last character of a line, when
5400 starting in Normal mode and 'virtualedit' empty.
5401
5402 The 'selection' option is set by the |:behave| command.
5403
5404 *'selectmode'* *'slm'*
5405'selectmode' 'slm' string (default "")
5406 global
5407 {not in Vi}
5408 This is a comma separated list of words, which specifies when to start
5409 Select mode instead of Visual mode, when a selection is started.
5410 Possible values:
5411 mouse when using the mouse
5412 key when using shifted special keys
5413 cmd when using "v", "V" or CTRL-V
5414 See |Select-mode|.
5415 The 'selectmode' option is set by the |:behave| command.
5416
5417 *'sessionoptions'* *'ssop'*
5418'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5419 help,options,winsize")
5420 global
5421 {not in Vi}
5422 {not available when compiled without the +mksession
5423 feature}
5424 Changes the effect of the |:mksession| command. It is a comma
5425 separated list of words. Each word enables saving and restoring
5426 something:
5427 word save and restore ~
5428 blank empty windows
5429 buffers hidden and unloaded buffers, not just those in windows
5430 curdir the current directory
5431 folds manually created folds, opened/closed folds and local
5432 fold options
5433 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005434 and contain at least one lowercase letter. Only
5435 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 help the help window
5437 localoptions options and mappings local to a window or buffer (not
5438 global values for local options)
5439 options all options and mappings (also global values for local
5440 options)
5441 resize size of the Vim window: 'lines' and 'columns'
5442 sesdir the directory in which the session file is located
5443 will become the current directory (useful with
5444 projects accessed over a network from different
5445 systems)
5446 slash backslashes in file names replaced with forward
5447 slashes
5448 unix with Unix end-of-line format (single <NL>), even when
5449 on Windows or DOS
5450 winpos position of the whole Vim window
5451 winsize window sizes
5452
5453 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005454 There is no option to include tab pages yet, only the current tab page
5455 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 When "curdir" nor "sesdir" is included, file names are stored with
5457 absolute paths.
5458 "slash" and "unix" are useful on Windows when sharing session files
5459 with Unix. The Unix version of Vim cannot source dos format scripts,
5460 but the Windows version of Vim can source unix format scripts.
5461
5462 *'shell'* *'sh'* *E91*
5463'shell' 'sh' string (default $SHELL or "sh",
5464 MS-DOS and Win32: "command.com" or
5465 "cmd.exe", OS/2: "cmd")
5466 global
5467 Name of the shell to use for ! and :! commands. When changing the
5468 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5469 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005470 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 See |option-backslash| about including spaces and backslashes.
5472 Environment variables are expanded |:set_env|.
5473 If the name of the shell contains a space, you might need to enclose
5474 it in quotes. Example: >
5475 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5476< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005477 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478 "-f" is not inside the quotes, because it is not part of the command
5479 name. And Vim automagically recognizes the backslashes that are path
5480 separators.
5481 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5482 variable to change the way external commands are executed. See the
5483 libc.inf file of DJGPP.
5484 Under MS-Windows, when the executable ends in ".com" it must be
5485 included. Thus setting the shell to "command.com" or "4dos.com"
5486 works, but "command" and "4dos" do not work for all commands (e.g.,
5487 filtering).
5488 For unknown reasons, when using "4dos.com" the current directory is
5489 changed to "C:\". To avoid this set 'shell' like this: >
5490 :set shell=command.com\ /c\ 4dos
5491< This option cannot be set from a |modeline| or in the |sandbox|, for
5492 security reasons.
5493
5494 *'shellcmdflag'* *'shcf'*
5495'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5496 does not contain "sh" somewhere: "/c")
5497 global
5498 {not in Vi}
5499 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5500 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5501 systems, the default is set according to the value of 'shell', to
5502 reduce the need to set this option by the user. It's not used for
5503 OS/2 (EMX figures this out itself). See |option-backslash| about
5504 including spaces and backslashes. See |dos-shell|.
5505 This option cannot be set from a |modeline| or in the |sandbox|, for
5506 security reasons.
5507
5508 *'shellpipe'* *'sp'*
5509'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5510 global
5511 {not in Vi}
5512 {not available when compiled without the |+quickfix|
5513 feature}
5514 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005515 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 including spaces and backslashes.
5517 The name of the temporary file can be represented by "%s" if necessary
5518 (the file name is appended automatically if no %s appears in the value
5519 of this option).
5520 For the Amiga and MS-DOS the default is ">". The output is directly
5521 saved in a file and not echoed to the screen.
5522 For Unix the default it "| tee". The stdout of the compiler is saved
5523 in a file and echoed to the screen. If the 'shell' option is "csh" or
5524 "tcsh" after initializations, the default becomes "|& tee". If the
5525 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5526 "2>&1| tee". This means that stderr is also included.
5527 The initialization of this option is done after reading the ".vimrc"
5528 and the other initializations, so that when the 'shell' option is set
5529 there, the 'shellpipe' option changes automatically, unless it was
5530 explicitly set before.
5531 When 'shellpipe' is set to an empty string, no redirection of the
5532 ":make" output will be done. This is useful if you use a 'makeprg'
5533 that writes to 'makeef' by itself. If you want no piping, but do
5534 want to include the 'makeef', set 'shellpipe' to a single space.
5535 Don't forget to precede the space with a backslash: ":set sp=\ ".
5536 In the future pipes may be used for filtering and this option will
5537 become obsolete (at least for Unix).
5538 This option cannot be set from a |modeline| or in the |sandbox|, for
5539 security reasons.
5540
5541 *'shellquote'* *'shq'*
5542'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5543 contains "sh" somewhere: "\"")
5544 global
5545 {not in Vi}
5546 Quoting character(s), put around the command passed to the shell, for
5547 the "!" and ":!" commands. The redirection is kept outside of the
5548 quoting. See 'shellxquote' to include the redirection. It's
5549 probably not useful to set both options.
5550 This is an empty string by default. Only known to be useful for
5551 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5552 or bash, where it should be "\"". The default is adjusted according
5553 the value of 'shell', to reduce the need to set this option by the
5554 user. See |dos-shell|.
5555 This option cannot be set from a |modeline| or in the |sandbox|, for
5556 security reasons.
5557
5558 *'shellredir'* *'srr'*
5559'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5560 global
5561 {not in Vi}
5562 String to be used to put the output of a filter command in a temporary
5563 file. See also |:!|. See |option-backslash| about including spaces
5564 and backslashes.
5565 The name of the temporary file can be represented by "%s" if necessary
5566 (the file name is appended automatically if no %s appears in the value
5567 of this option).
5568 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5569 or "zsh" during initializations, the default becomes ">&". If the
5570 'shell' option is "sh", "ksh" or "bash" the default becomes
5571 ">%s 2>&1". This means that stderr is also included.
5572 For Win32, the Unix checks are done and additionally "cmd" is checked
5573 for, which makes the default ">%s 2>&1". Also, the same names with
5574 ".exe" appended are checked for.
5575 The initialization of this option is done after reading the ".vimrc"
5576 and the other initializations, so that when the 'shell' option is set
5577 there, the 'shellredir' option changes automatically unless it was
5578 explicitly set before.
5579 In the future pipes may be used for filtering and this option will
5580 become obsolete (at least for Unix).
5581 This option cannot be set from a |modeline| or in the |sandbox|, for
5582 security reasons.
5583
5584 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5585'shellslash' 'ssl' boolean (default off)
5586 global
5587 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5588 When set, a forward slash is used when expanding file names. This is
5589 useful when a Unix-like shell is used instead of command.com or
5590 cmd.exe. Backward slashes can still be typed, but they are changed to
5591 forward slashes by Vim.
5592 Note that setting or resetting this option has no effect for some
5593 existing file names, thus this option needs to be set before opening
5594 any file for best results. This might change in the future.
5595 'shellslash' only works when a backslash can be used as a path
5596 separator. To test if this is so use: >
5597 if exists('+shellslash')
5598<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005599 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5600'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5601 global
5602 {not in Vi}
5603 When on, use temp files for shell commands. When off use a pipe.
5604 When using a pipe is not possible temp files are used anyway.
5605 Currently a pipe is only supported on Unix. You can check it with: >
5606 :if has("filterpipe")
5607< The advantage of using a pipe is that nobody can read the temp file
5608 and the 'shell' command does not need to support redirection.
5609 The advantage of using a temp file is that the file type and encoding
5610 can be detected.
5611 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5612 |FilterWritePost| autocommands event are not triggered when
5613 'shelltemp' is off.
5614
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 *'shelltype'* *'st'*
5616'shelltype' 'st' number (default 0)
5617 global
5618 {not in Vi} {only for the Amiga}
5619 On the Amiga this option influences the way how the commands work
5620 which use a shell.
5621 0 and 1: always use the shell
5622 2 and 3: use the shell only to filter lines
5623 4 and 5: use shell only for ':sh' command
5624 When not using the shell, the command is executed directly.
5625
5626 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5627 1 and 3: use "shell cmd" to start external commands
5628
5629 *'shellxquote'* *'sxq'*
5630'shellxquote' 'sxq' string (default: "";
5631 for Win32, when 'shell' contains "sh"
5632 somewhere: "\""
5633 for Unix, when using system(): "\"")
5634 global
5635 {not in Vi}
5636 Quoting character(s), put around the command passed to the shell, for
5637 the "!" and ":!" commands. Includes the redirection. See
5638 'shellquote' to exclude the redirection. It's probably not useful
5639 to set both options.
5640 This is an empty string by default. Known to be useful for
5641 third-party shells when using the Win32 version, such as the MKS Korn
5642 Shell or bash, where it should be "\"". The default is adjusted
5643 according the value of 'shell', to reduce the need to set this option
5644 by the user. See |dos-shell|.
5645 This option cannot be set from a |modeline| or in the |sandbox|, for
5646 security reasons.
5647
5648 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5649'shiftround' 'sr' boolean (default off)
5650 global
5651 {not in Vi}
5652 Round indent to multiple of 'shiftwidth'. Applies to > and <
5653 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5654 a multiple of 'shiftwidth' (this is Vi compatible).
5655 NOTE: This option is reset when 'compatible' is set.
5656
5657 *'shiftwidth'* *'sw'*
5658'shiftwidth' 'sw' number (default 8)
5659 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005660 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 |'cindent'|, |>>|, |<<|, etc.
5662
5663 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005664'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5665 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 global
5667 {not in Vi}
5668 This option helps to avoid all the |hit-enter| prompts caused by file
5669 messages, for example with CTRL-G, and to avoid some other messages.
5670 It is a list of flags:
5671 flag meaning when present ~
5672 f use "(3 of 5)" instead of "(file 3 of 5)"
5673 i use "[noeol]" instead of "[Incomplete last line]"
5674 l use "999L, 888C" instead of "999 lines, 888 characters"
5675 m use "[+]" instead of "[Modified]"
5676 n use "[New]" instead of "[New File]"
5677 r use "[RO]" instead of "[readonly]"
5678 w use "[w]" instead of "written" for file write message
5679 and "[a]" instead of "appended" for ':w >> file' command
5680 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5681 "[unix format]" and "[mac]" instead of "[mac format]".
5682 a all of the above abbreviations
5683
5684 o overwrite message for writing a file with subsequent message
5685 for reading a file (useful for ":wn" or when 'autowrite' on)
5686 O message for reading a file overwrites any previous message.
5687 Also for quickfix message (e.g., ":cn").
5688 s don't give "search hit BOTTOM, continuing at TOP" or "search
5689 hit TOP, continuing at BOTTOM" messages
5690 t truncate file message at the start if it is too long to fit
5691 on the command-line, "<" will appear in the left most column.
5692 Ignored in Ex mode.
5693 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005694 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 Ignored in Ex mode.
5696 W don't give "written" or "[w]" when writing a file
5697 A don't give the "ATTENTION" message when an existing swap file
5698 is found.
5699 I don't give the intro message when starting Vim |:intro|.
5700
5701 This gives you the opportunity to avoid that a change between buffers
5702 requires you to hit <Enter>, but still gives as useful a message as
5703 possible for the space available. To get the whole message that you
5704 would have got with 'shm' empty, use ":file!"
5705 Useful values:
5706 shm= No abbreviation of message.
5707 shm=a Abbreviation, but no loss of information.
5708 shm=at Abbreviation, and truncate message when necessary.
5709
5710 NOTE: This option is set to the Vi default value when 'compatible' is
5711 set and to the Vim default value when 'compatible' is reset.
5712
5713 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5714'shortname' 'sn' boolean (default off)
5715 local to buffer
5716 {not in Vi, not in MS-DOS versions}
5717 Filenames are assumed to be 8 characters plus one extension of 3
5718 characters. Multiple dots in file names are not allowed. When this
5719 option is on, dots in file names are replaced with underscores when
5720 adding an extension (".~" or ".swp"). This option is not available
5721 for MS-DOS, because then it would always be on. This option is useful
5722 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5723 or crossdos. When running the Win32 GUI version under Win32s, this
5724 option is always on by default.
5725
5726 *'showbreak'* *'sbr'* *E595*
5727'showbreak' 'sbr' string (default "")
5728 global
5729 {not in Vi}
5730 {not available when compiled without the |+linebreak|
5731 feature}
5732 String to put at the start of lines that have been wrapped. Useful
5733 values are "> " or "+++ ".
5734 Only printable single-cell characters are allowed, excluding <Tab> and
5735 comma (in a future version the comma might be used to separate the
5736 part that is shown at the end and at the start of a line).
5737 The characters are highlighted according to the '@' flag in
5738 'highlight'.
5739 Note that tabs after the showbreak will be displayed differently.
5740 If you want the 'showbreak' to appear in between line numbers, add the
5741 "n" flag to 'cpoptions'.
5742
5743 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5744'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5745 off)
5746 global
5747 {not in Vi}
5748 {not available when compiled without the
5749 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005750 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 terminal is slow.
5752 In Visual mode the size of the selected area is shown:
5753 - When selecting characters within a line, the number of characters.
5754 - When selecting more than one line, the number of lines.
5755 - When selecting a block, the size in screen characters: linesxcolumns.
5756 NOTE: This option is set to the Vi default value when 'compatible' is
5757 set and to the Vim default value when 'compatible' is reset.
5758
5759 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5760'showfulltag' 'sft' boolean (default off)
5761 global
5762 {not in Vi}
5763 When completing a word in insert mode (see |ins-completion|) from the
5764 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005765 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 matched a C function, you can see a template for what arguments are
5767 required (coding style permitting).
5768
5769 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5770'showmatch' 'sm' boolean (default off)
5771 global
5772 When a bracket is inserted, briefly jump to the matching one. The
5773 jump is only done if the match can be seen on the screen. The time to
5774 show the match can be set with 'matchtime'.
5775 A Beep is given if there is no match (no matter if the match can be
5776 seen or not). This option is reset when the 'paste' option is set.
5777 When the 'm' flag is not included in 'cpoptions', typing a character
5778 will immediately move the cursor back to where it belongs.
5779 See the "sm" field in 'guicursor' for setting the cursor shape and
5780 blinking when showing the match.
5781 The 'matchpairs' option can be used to specify the characters to show
5782 matches for. 'rightleft' and 'revins' are used to look for opposite
5783 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005784 Also see the matchparen plugin for highlighting the match when moving
5785 around |pi_paren.txt|.
5786 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787
5788 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5789'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5790 global
5791 If in Insert, Replace or Visual mode put a message on the last line.
5792 Use the 'M' flag in 'highlight' to set the type of highlighting for
5793 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005794 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 doesn't mean XIM is really active, especially when 'imactivatekey' is
5796 not set.
5797 NOTE: This option is set to the Vi default value when 'compatible' is
5798 set and to the Vim default value when 'compatible' is reset.
5799
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005800 *'showtabline'* *'stal'*
5801'showtabline' 'stal' number (default 1)
5802 global
5803 {not in Vi}
5804 {not available when compiled without the +windows
5805 feature}
5806 The value of this option specifies when the line with tab page labels
5807 will be displayed:
5808 0: never
5809 1: only if there are at least two tab pages
5810 2: always
5811 This is both for the GUI and non-GUI implementation of the tab pages
5812 line.
5813 See |tab-page| for more information about tab pages.
5814
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 *'sidescroll'* *'ss'*
5816'sidescroll' 'ss' number (default 0)
5817 global
5818 {not in Vi}
5819 The minimal number of columns to scroll horizontally. Used only when
5820 the 'wrap' option is off and the cursor is moved off of the screen.
5821 When it is zero the cursor will be put in the middle of the screen.
5822 When using a slow terminal set it to a large number or 0. When using
5823 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5824 commands.
5825
5826 *'sidescrolloff'* *'siso'*
5827'sidescrolloff' 'siso' number (default 0)
5828 global
5829 {not in Vi}
5830 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005831 right of the cursor if 'nowrap' is set. Setting this option to a
5832 value greater than 0 while having |'sidescroll'| also at a non-zero
5833 value makes some context visible in the line you are scrolling in
5834 horizontally (except at beginning of the line). Setting this option
5835 to a large value (like 999) has the effect of keeping the cursor
5836 horizontally centered in the window, as long as one does not come too
5837 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 NOTE: This option is set to 0 when 'compatible' is set.
5839
5840 Example: Try this together with 'sidescroll' and 'listchars' as
5841 in the following example to never allow the cursor to move
5842 onto the "extends" character:
5843
5844 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5845 :set sidescrolloff=1
5846
5847
5848 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5849'smartcase' 'scs' boolean (default off)
5850 global
5851 {not in Vi}
5852 Override the 'ignorecase' option if the search pattern contains upper
5853 case characters. Only used when the search pattern is typed and
5854 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005855 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5857 recalling the search pattern from history and hitting <Enter>.
5858 NOTE: This option is reset when 'compatible' is set.
5859
5860 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5861'smartindent' 'si' boolean (default off)
5862 local to buffer
5863 {not in Vi}
5864 {not available when compiled without the
5865 |+smartindent| feature}
5866 Do smart autoindenting when starting a new line. Works for C-like
5867 programs, but can also be used for other languages. 'cindent' does
5868 something like this, works better in most cases, but is more strict,
5869 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5870 'indentexpr' is a more advanced alternative.
5871 Normally 'autoindent' should also be on when using 'smartindent'.
5872 An indent is automatically inserted:
5873 - After a line ending in '{'.
5874 - After a line starting with a keyword from 'cinwords'.
5875 - Before a line starting with '}' (only with the "O" command).
5876 When typing '}' as the first character in a new line, that line is
5877 given the same indent as the matching '{'.
5878 When typing '#' as the first character in a new line, the indent for
5879 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005880 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5882 When using the ">>" command, lines starting with '#' are not shifted
5883 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005884 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 is set smart indenting is disabled.
5886
5887 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5888'smarttab' 'sta' boolean (default off)
5889 global
5890 {not in Vi}
5891 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005892 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5893 <BS> will delete a 'shiftwidth' worth of space at the start of the
5894 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005895 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005896 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5897 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5899 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005900 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 NOTE: This option is reset when 'compatible' is set.
5902
5903 *'softtabstop'* *'sts'*
5904'softtabstop' 'sts' number (default 0)
5905 local to buffer
5906 {not in Vi}
5907 Number of spaces that a <Tab> counts for while performing editing
5908 operations, like inserting a <Tab> or using <BS>. It "feels" like
5909 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5910 used. This is useful to keep the 'ts' setting at its standard value
5911 of 8, while being able to edit like it is set to 'sts'. However,
5912 commands like "x" still work on the actual characters.
5913 When 'sts' is zero, this feature is off.
5914 'softtabstop' is set to 0 when the 'paste' option is set.
5915 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5916 spaces is minimized by using <Tab>s.
5917 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5918 set.
5919 NOTE: This option is set to 0 when 'compatible' is set.
5920
Bram Moolenaar217ad922005-03-20 22:37:15 +00005921 *'spell'* *'nospell'*
5922'spell' boolean (default off)
5923 local to window
5924 {not in Vi}
5925 {not available when compiled without the |+syntax|
5926 feature}
5927 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005928 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005929
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005930 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005931'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005932 local to buffer
5933 {not in Vi}
5934 {not available when compiled without the |+syntax|
5935 feature}
5936 Pattern to locate the end of a sentence. The following word will be
5937 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005938 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005939 When this check is not wanted make this option empty.
5940 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005941 Be careful with special characters, see |option-backslash| about
5942 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005943 To set this option automatically depending on the language, see
5944 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005945
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005946 *'spellfile'* *'spf'*
5947'spellfile' 'spf' string (default empty)
5948 local to buffer
5949 {not in Vi}
5950 {not available when compiled without the |+syntax|
5951 feature}
5952 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005953 commands. It must end in ".{encoding}.add". You need to include the
5954 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005955 *E765*
5956 It may also be a comma separated list of names. A count before the
5957 |zg| and |zw| commands can be used to access each. This allows using
5958 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005959 When a word is added while this option is empty Vim will set it for
5960 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005961 writable and the first language name that appears in 'spelllang',
5962 ignoring the region.
5963 The resulting ".spl" file will be used for spell checking, it does not
5964 have to appear in 'spelllang'.
5965 Normally one file is used for all regions, but you can add the region
5966 name if you want to. However, it will then only be used when
5967 'spellfile' is set to it, for entries in 'spelllang' only files
5968 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005969 This option cannot be set from a |modeline| or in the |sandbox|, for
5970 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005971
Bram Moolenaar217ad922005-03-20 22:37:15 +00005972 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005973'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005974 local to buffer
5975 {not in Vi}
5976 {not available when compiled without the |+syntax|
5977 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005978 A comma separated list of word list names. When the 'spell' option is
5979 on spellchecking will be done for these languages. Example: >
5980 set spelllang=en_us,nl,medical
5981< This means US English, Dutch and medical words are recognized. Words
5982 that are not recognized will be highlighted.
5983 The word list name must not include a comma or dot. Using a dash is
5984 recommended to separate the two letter language name from a
5985 specification. Thus "en-rare" is used for rare English words.
5986 A region name must come last and have the form "_xx", where "xx" is
5987 the two-letter, lower case region name. You can use more than one
5988 region by listing them: "en_us,en_ca" supports both US and Canadian
5989 English, but not words specific for Australia, New Zealand or Great
5990 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005991 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005992 As a special case the name of a .spl file can be given as-is. The
5993 first "_xx" in the name is removed and used as the region name
5994 (_xx is an underscore, two letters and followed by a non-letter).
5995 This is mainly for testing purposes. You must make sure the correct
5996 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005997 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005998 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5999 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006000 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006001
Bram Moolenaar98692072006-02-04 00:57:42 +00006002 If the |spellfile.vim| plugin is active and you use a language name
6003 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6004 will ask you if you want to download the file.
6005
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006006 After this option has been set successfully, Vim will source the files
6007 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006008 up to the first comma, dot or underscore.
6009 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006010
6011
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006012 *'spellsuggest'* *'sps'*
6013'spellsuggest' 'sps' string (default "best")
6014 global
6015 {not in Vi}
6016 {not available when compiled without the |+syntax|
6017 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006018 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006019 the |spellsuggest()| function. This is a comma-separated list of
6020 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006021
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006022 best Internal method that works best for English. Finds
6023 changes like "fast" and uses a bit of sound-a-like
6024 scoring to improve the ordering.
6025
6026 double Internal method that uses two methods and mixes the
6027 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006028 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006029 word. That only works when the language specifies
6030 sound folding. Can be slow and doesn't always give
6031 better results.
6032
6033 fast Internal method that only checks for simple changes:
6034 character inserts/deletes/swaps. Works well for
6035 simple typing mistakes.
6036
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006037 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006038 Not used for |spellsuggest()|. The number of
6039 suggestions is never more than the value of 'lines'
6040 minus two.
6041
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006042 file:{filename} Read file {filename}, which must have two columns,
6043 separated by a slash. The first column contains the
6044 bad word, the second column the suggested good word.
6045 Example:
6046 theribal/terrible ~
6047 Use this for common mistakes that do not appear at the
6048 top of the suggestion list with the internal methods.
6049 Lines without a slash are ignored, use this for
6050 comments.
6051 The file is used for all languages.
6052
6053 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6054 trouble with spaces. |v:val| holds the badly spelled
6055 word. The expression must evaluate to a List of
6056 Lists, each with a suggestion and a score.
6057 Example:
6058 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006059 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006060 internal methods use. A lower score is better.
6061 This may invoke |spellsuggest()| if you temporarily
6062 set 'spellsuggest' to exclude the "expr:" part.
6063 Errors are silently ignored, unless you set the
6064 'verbose' option to a non-zero value.
6065
6066 Only one of "best", "double" or "fast" may be used. The others may
6067 appear several times in any order. Example: >
6068 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6069<
6070 This option cannot be set from a |modeline| or in the |sandbox|, for
6071 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006072
6073
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6075'splitbelow' 'sb' boolean (default off)
6076 global
6077 {not in Vi}
6078 {not available when compiled without the +windows
6079 feature}
6080 When on, splitting a window will put the new window below the current
6081 one. |:split|
6082
6083 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6084'splitright' 'spr' boolean (default off)
6085 global
6086 {not in Vi}
6087 {not available when compiled without the +vertsplit
6088 feature}
6089 When on, splitting a window will put the new window right of the
6090 current one. |:vsplit|
6091
6092 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6093'startofline' 'sol' boolean (default on)
6094 global
6095 {not in Vi}
6096 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006097 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006098 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006099 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 with a linewise operator, with "%" with a count and to buffer changing
6101 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6102 only has a line number, e.g., ":25" or ":+".
6103 In case of buffer changing commands the cursor is placed at the column
6104 where it was the last time the buffer was edited.
6105 NOTE: This option is set when 'compatible' is set.
6106
6107 *'statusline'* *'stl'* *E540* *E541* *E542*
6108'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006109 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110 {not in Vi}
6111 {not available when compiled without the |+statusline|
6112 feature}
6113 When nonempty, this option determines the content of the status line.
6114 Also see |status-line|.
6115
6116 The option consists of printf style '%' items interspersed with
6117 normal text. Each status line item is of the form:
6118 %-0{minwid}.{maxwid}{item}
6119 All fields except the {item} is optional. A single percent sign can
6120 be given as "%%". Up to 80 items can be specified.
6121
Bram Moolenaar238a5642006-02-21 22:12:05 +00006122 When the option starts with "%!" then it is used as an expression,
6123 evaluated and the result is used as the option value. Example: >
6124 :set statusline=%!MyStatusLine()
6125< The result can contain %{} items that will be evaluated too.
6126
6127 When there is error while evaluating the option then it will be made
6128 empty to avoid further errors. Otherwise screen updating would loop.
6129
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130 Note that the only effect of 'ruler' when this option is set (and
6131 'laststatus' is 2) is controlling the output of |CTRL-G|.
6132
6133 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006134 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006136 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 minwid Minimum width of the item, padding as set by '-' & '0'.
6138 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006139 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 on the left for text items. Numeric items will be
6141 shifted down to maxwid-2 digits followed by '>'number
6142 where number is the amount of missing digits, much like
6143 an exponential notation.
6144 item A one letter code as described below.
6145
6146 Following is a description of the possible statusline items. The
6147 second character in "item" is the type:
6148 N for number
6149 S for string
6150 F for flags as described below
6151 - not applicable
6152
6153 item meaning ~
6154 f S Path to the file in the buffer, relative to current directory.
6155 F S Full path to the file in the buffer.
6156 t S File name (tail) of file in the buffer.
6157 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6158 M F Modified flag, text is ",+" or ",-".
6159 r F Readonly flag, text is " [RO]".
6160 R F Readonly flag, text is ",RO".
6161 h F Help buffer flag, text is " [help]".
6162 H F Help buffer flag, text is ",HLP".
6163 w F Preview window flag, text is " [Preview]".
6164 W F Preview window flag, text is ",PRV".
6165 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6166 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6167 {not available when compiled without |+autocmd| feature}
6168 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6169 being used: "<keymap>"
6170 n N Buffer number.
6171 b N Value of byte under cursor.
6172 B N As above, in hexadecimal.
6173 o N Byte number in file of byte under cursor, first byte is 1.
6174 Mnemonic: Offset from start of file (with one added)
6175 {not available when compiled without |+byte_offset| feature}
6176 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006177 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 l N Line number.
6179 L N Number of lines in buffer.
6180 c N Column number.
6181 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006182 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 p N Percentage through file in lines as in |CTRL-G|.
6184 P S Percentage through file of displayed window. This is like the
6185 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006186 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006188 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006189 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 ( - Start of item group. Can be used for setting the width and
6191 alignment of a section. Must be followed by %) somewhere.
6192 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006193 T N For 'tabline': start of tab page N label. Use %T after the last
6194 label. This information is used for mouse clicks.
6195 X N For 'tabline': start of close tab N label. Use %X after the
6196 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6197 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 < - Where to truncate line if too long. Default is at the start.
6199 No width fields allowed.
6200 = - Separation point between left and right aligned items.
6201 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006202 # - Set highlight group. The name must follow and then a # again.
6203 Thus use %#HLname# for highlight group HLname. The same
6204 highlighting is used, also for the statusline of non-current
6205 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006207 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 The difference between User{N} and StatusLine will be applied
6209 to StatusLineNC for the statusline of non-current windows.
6210 The number N must be between 1 and 9. See |hl-User1..9|
6211
6212 Display of flags are controlled by the following heuristic:
6213 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006214 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 with a space it is assumed that it wants to separate itself from
6216 anything but other flags. That is: A leading comma is removed if the
6217 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006218 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 make a nice display when flags are used like in the examples below.
6220
Bram Moolenaar582fd852005-03-28 20:58:01 +00006221 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 not set) and a minwid is not set for the group, the whole group will
6223 become empty. This will make a group like the following disappear
6224 completely from the statusline when none of the flags are set. >
6225 :set statusline=...%(\ [%M%R%H]%)...
6226<
6227 Beware that an expression is evaluated each and every time the status
6228 line is displayed. The current buffer and current window will be set
6229 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006230 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006232 real current buffer.
6233
6234 The 'statusline' option may be evaluated in the |sandbox|, see
6235 |sandbox-option|.
6236
6237 It is not allowed to change text or jump to another window while
6238 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239
6240 If the statusline is not updated when you want it (e.g., after setting
6241 a variable that's used in an expression), you can force an update by
6242 setting an option without changing its value. Example: >
6243 :let &ro = &ro
6244
6245< A result of all digits is regarded a number for display purposes.
6246 Otherwise the result is taken as flag text and applied to the rules
6247 described above.
6248
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006249 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6251 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6252
6253 Examples:
6254 Emulate standard status line with 'ruler' set >
6255 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6256< Similar, but add ASCII value of char under the cursor (like "ga") >
6257 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6258< Display byte count and byte value, modified flag in red. >
6259 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6260 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6261< Display a ,GZ flag if a compressed file is loaded >
6262 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6263< In the |:autocmd|'s: >
6264 :let b:gzflag = 1
6265< And: >
6266 :unlet b:gzflag
6267< And define this function: >
6268 :function VarExists(var, val)
6269 : if exists(a:var) | return a:val | else | return '' | endif
6270 :endfunction
6271<
6272 *'suffixes'* *'su'*
6273'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6274 global
6275 {not in Vi}
6276 Files with these suffixes get a lower priority when multiple files
6277 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006278 suffixes. Spaces after the comma are ignored. A dot is also seen as
6279 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 separator, precede it with a backslash (see |option-backslash| about
6281 including spaces and backslashes).
6282 See 'wildignore' for completely ignoring files.
6283 The use of |:set+=| and |:set-=| is preferred when adding or removing
6284 suffixes from the list. This avoids problems when a future version
6285 uses another default.
6286
6287 *'suffixesadd'* *'sua'*
6288'suffixesadd' 'sua' string (default "")
6289 local to buffer
6290 {not in Vi}
6291 {not available when compiled without the
6292 |+file_in_path| feature}
6293 Comma separated list of suffixes, which are used when searching for a
6294 file for the "gf", "[I", etc. commands. Example: >
6295 :set suffixesadd=.java
6296<
6297 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6298'swapfile' 'swf' boolean (default on)
6299 local to buffer
6300 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006301 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 swapfile is not wanted for a specific buffer. For example, with
6303 confidential information that even root must not be able to access.
6304 Careful: All text will be in memory:
6305 - Don't use this for big files.
6306 - Recovery will be impossible!
6307 A swapfile will only be present when |'updatecount'| is non-zero and
6308 'swapfile' is set.
6309 When 'swapfile' is reset, the swap file for the current buffer is
6310 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6311 non-zero, a swap file is immediately created.
6312 Also see |swap-file| and |'swapsync'|.
6313
6314 This option is used together with 'bufhidden' and 'buftype' to
6315 specify special kinds of buffers. See |special-buffers|.
6316
6317 *'swapsync'* *'sws'*
6318'swapsync' 'sws' string (default "fsync")
6319 global
6320 {not in Vi}
6321 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006322 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006323 When this option is empty parts of the swap file may be in memory and
6324 not written to disk. When the system crashes you may lose more work.
6325 On Unix the system does a sync now and then without Vim asking for it,
6326 so the disadvantage of setting this option off is small. On some
6327 systems the swap file will not be written at all. For a unix system
6328 setting it to "sync" will use the sync() call instead of the default
6329 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006330 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331
6332 *'switchbuf'* *'swb'*
6333'switchbuf' 'swb' string (default "")
6334 global
6335 {not in Vi}
6336 This option controls the behavior when switching between buffers.
6337 Possible values (comma separated list):
6338 useopen If included, jump to the first open window that
6339 contains the specified buffer (if there is one).
6340 Otherwise: Do not examine other windows.
6341 This setting is checked with |quickfix| commands, when
6342 jumping to errors (":cc", ":cn", "cp", etc.). It is
6343 also used in all buffer related split commands, for
6344 example ":sbuffer", ":sbnext", or ":sbrewind".
6345 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006346 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 Supported in |quickfix| commands that display errors.
6348
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006349 *'synmaxcol'* *'smc'*
6350'synmaxcol' 'smc' number (default 3000)
6351 local to buffer
6352 {not in Vi}
6353 {not available when compiled without the |+syntax|
6354 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006355 Maximum column in which to search for syntax items. In long lines the
6356 text after this column is not highlighted and following lines may not
6357 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006358 This helps to avoid very slow redrawing for an XML file that is one
6359 long line.
6360 Set to zero to remove the limit.
6361
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 *'syntax'* *'syn'*
6363'syntax' 'syn' string (default empty)
6364 local to buffer
6365 {not in Vi}
6366 {not available when compiled without the |+syntax|
6367 feature}
6368 When this option is set, the syntax with this name is loaded, unless
6369 syntax highlighting has been switched off with ":syntax off".
6370 Otherwise this option does not always reflect the current syntax (the
6371 b:current_syntax variable does).
6372 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006373 not automatically recognized. Example, in an IDL file:
6374 /* vim: set syntax=idl : */ ~
6375 When a dot appears in the value then this separates two filetype
6376 names. Example:
6377 /* vim: set syntax=c.doxygen : */ ~
6378 This will use the "c" syntax first, then the "doxygen" syntax.
6379 Note that the second one must be prepared to be loaded as an addition,
6380 otherwise it will be skipped. More than one dot may appear.
6381 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 :set syntax=OFF
6383< To switch syntax highlighting on according to the current value of the
6384 'filetype' option: >
6385 :set syntax=ON
6386< What actually happens when setting the 'syntax' option is that the
6387 Syntax autocommand event is triggered with the value as argument.
6388 This option is not copied to another buffer, independent of the 's' or
6389 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006390 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006392 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006393'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006394 global
6395 {not in Vi}
6396 {not available when compiled without the +windows
6397 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006398 When nonempty, this option determines the content of the tab pages
6399 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006400 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006401
6402 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006403 option and only when there is no GUI tab line. When 'e' is in
6404 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6405 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006406
6407 The value is evaluated like with 'statusline'. You can use
6408 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006409 the text to be displayed. Use "%1T" for the first label, "%2T" for
6410 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006411
6412 Keep in mind that only one of the tab pages is the current one, others
6413 are invisible and you can't jump to their windows.
6414
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006415
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006416 *'tabpagemax'* *'tpm'*
6417'tabpagemax' 'tpm' number (default 10)
6418 global
6419 {not in Vi}
6420 {not available when compiled without the +windows
6421 feature}
6422 Maximum number of tab pages to be opened by the |-p| command line
6423 argument or the ":tab all" command. |tabpage|
6424
6425
6426 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427'tabstop' 'ts' number (default 8)
6428 local to buffer
6429 Number of spaces that a <Tab> in the file counts for. Also see
6430 |:retab| command, and 'softtabstop' option.
6431
6432 Note: Setting 'tabstop' to any other value than 8 can make your file
6433 appear wrong in many places (e.g., when printing it).
6434
6435 There are four main ways to use tabs in Vim:
6436 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6437 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6438 will use a mix of tabs and spaces, but typing Tab and BS will
6439 behave like a tab appears every 4 (or 3) characters.
6440 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6441 'expandtab'. This way you will always insert spaces. The
6442 formatting will never be messed up when 'tabstop' is changed.
6443 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006444 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 works when using Vim to edit the file.
6446 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6447 'noexpandtab'. This should then work (for initial indents only)
6448 for any tabstop setting that people use. It might be nice to have
6449 tabs after the first non-blank inserted as spaces if you do this
6450 though. Otherwise aligned comments will be wrong when 'tabstop' is
6451 changed.
6452
6453 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6454'tagbsearch' 'tbs' boolean (default on)
6455 global
6456 {not in Vi}
6457 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006458 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 searching makes searching for a tag a LOT faster, but a linear search
6460 will find more tags if the tags file wasn't properly sorted.
6461 Vim normally assumes that your tags files are sorted, or indicate that
6462 they are not sorted. Only when this is not the case does the
6463 'tagbsearch' option need to be switched off.
6464
6465 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006466 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 certain files, or retry all files with a linear search. When
6468 'tagbsearch' is off, only a linear search is done.
6469
6470 Linear searching is done anyway, for one file, when Vim finds a line
6471 at the start of the file indicating that it's not sorted: >
6472 !_TAG_FILE_SORTED 0 /some command/
6473< [The whitespace before and after the '0' must be a single <Tab>]
6474
6475 When a binary search was done and no match was found in any of the
6476 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6477 instead of a normal tag name, a retry is done with a linear search.
6478 Tags in unsorted tags files, and matches with different case will only
6479 be found in the retry.
6480
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006481 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 linear search can be avoided for the 'ignorecase' case. Use a value
6483 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6484 case-fold sorted with the -f switch to "sort" in most unices, as in
6485 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6486 5.3 or higher the -f or --fold-case-sort switch can be used for this
6487 as well. Note that case must be folded to uppercase for this to work.
6488
6489 When 'tagbsearch' is off, tags searching is slower when a full match
6490 exists, but faster when no full match exists. Tags in unsorted tags
6491 files may only be found with 'tagbsearch' off.
6492 When the tags file is not sorted, or sorted in a wrong way (not on
6493 ASCII byte value), 'tagbsearch' should be off, or the line given above
6494 must be included in the tags file.
6495 This option doesn't affect commands that find all matching tags (e.g.,
6496 command-line completion and ":help").
6497 {Vi: always uses binary search in some versions}
6498
6499 *'taglength'* *'tl'*
6500'taglength' 'tl' number (default 0)
6501 global
6502 If non-zero, tags are significant up to this number of characters.
6503
6504 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6505'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6506 global
6507 {not in Vi}
6508 If on and using a tag file in another directory, file names in that
6509 tag file are relative to the directory where the tag file is.
6510 NOTE: This option is set to the Vi default value when 'compatible' is
6511 set and to the Vim default value when 'compatible' is reset.
6512
6513 *'tags'* *'tag'* *E433*
6514'tags' 'tag' string (default "./tags,tags", when compiled with
6515 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6516 global or local to buffer |global-local|
6517 Filenames for the tag command, separated by spaces or commas. To
6518 include a space or comma in a file name, precede it with a backslash
6519 (see |option-backslash| about including spaces and backslashes).
6520 When a file name starts with "./", the '.' is replaced with the path
6521 of the current file. But only when the 'd' flag is not included in
6522 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6523 |tags-option|.
6524 "*", "**" and other wildcards can be used to search for tags files in
6525 a directory tree. See |file-searching|. {not available when compiled
6526 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006527 The |tagfiles()| function can be used to get a list of the file names
6528 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6530 files are also supported. They are automatically recognized. The
6531 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6532 differences are ignored (MS-Windows). |emacs-tags|
6533 The use of |:set+=| and |:set-=| is preferred when adding or removing
6534 file names from the list. This avoids problems when a future version
6535 uses another default.
6536 {Vi: default is "tags /usr/lib/tags"}
6537
6538 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6539'tagstack' 'tgst' boolean (default on)
6540 global
6541 {not in all versions of Vi}
6542 When on, the |tagstack| is used normally. When off, a ":tag" or
6543 ":tselect" command with an argument will not push the tag onto the
6544 tagstack. A following ":tag" without an argument, a ":pop" command or
6545 any other command that uses the tagstack will use the unmodified
6546 tagstack, but does change the pointer to the active entry.
6547 Resetting this option is useful when using a ":tag" command in a
6548 mapping which should not change the tagstack.
6549
6550 *'term'* *E529* *E530* *E531*
6551'term' string (default is $TERM, if that fails:
6552 in the GUI: "builtin_gui"
6553 on Amiga: "amiga"
6554 on BeOS: "beos-ansi"
6555 on Mac: "mac-ansi"
6556 on MiNT: "vt52"
6557 on MS-DOS: "pcterm"
6558 on OS/2: "os2ansi"
6559 on Unix: "ansi"
6560 on VMS: "ansi"
6561 on Win 32: "win32")
6562 global
6563 Name of the terminal. Used for choosing the terminal control
6564 characters. Environment variables are expanded |:set_env|.
6565 For example: >
6566 :set term=$TERM
6567< See |termcap|.
6568
6569 *'termbidi'* *'tbidi'*
6570 *'notermbidi'* *'notbidi'*
6571'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6572 global
6573 {not in Vi}
6574 {only available when compiled with the |+arabic|
6575 feature}
6576 The terminal is in charge of Bi-directionality of text (as specified
6577 by Unicode). The terminal is also expected to do the required shaping
6578 that some languages (such as Arabic) require.
6579 Setting this option implies that 'rightleft' will not be set when
6580 'arabic' is set and the value of 'arabicshape' will be ignored.
6581 Note that setting 'termbidi' has the immediate effect that
6582 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6583 This option is reset when the GUI is started.
6584 For further details see |arabic.txt|.
6585
6586 *'termencoding'* *'tenc'*
6587'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6588 Macintosh GUI: "macroman")
6589 global
6590 {only available when compiled with the |+multi_byte|
6591 feature}
6592 {not in Vi}
6593 Encoding used for the terminal. This specifies what character
6594 encoding the keyboard produces and the display will understand. For
6595 the GUI it only applies to the keyboard ('encoding' is used for the
6596 display).
6597 In the Win32 console version the default value is the console codepage
6598 when it differs from the ANSI codepage.
6599 *E617*
6600 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6601 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6602 Any attempts to set a different value will be rejected, and an error
6603 message is shown.
6604 For the Win32 GUI 'termencoding' is not used for typed characters,
6605 because the Win32 system always passes Unicode characters.
6606 When empty, the same encoding is used as for the 'encoding' option.
6607 This is the normal value.
6608 Not all combinations for 'termencoding' and 'encoding' are valid. See
6609 |encoding-table|.
6610 The value for this option must be supported by internal conversions or
6611 iconv(). When this is not possible no conversion will be done and you
6612 will probably experience problems with non-ASCII characters.
6613 Example: You are working with the locale set to euc-jp (Japanese) and
6614 want to edit a UTF-8 file: >
6615 :let &termencoding = &encoding
6616 :set encoding=utf-8
6617< You need to do this when your system has no locale support for UTF-8.
6618
6619 *'terse'* *'noterse'*
6620'terse' boolean (default off)
6621 global
6622 When set: Add 's' flag to 'shortmess' option (this makes the message
6623 for a search that hits the start or end of the file not being
6624 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6625 shortens a lot of messages}
6626
6627 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6628'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6629 global
6630 {not in Vi}
6631 This option is obsolete. Use 'fileformats'.
6632 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6633 set to the default value for the current system. When 'textauto' is
6634 reset, 'fileformats' is made empty.
6635 NOTE: This option is set to the Vi default value when 'compatible' is
6636 set and to the Vim default value when 'compatible' is reset.
6637
6638 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6639'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6640 others: default off)
6641 local to buffer
6642 {not in Vi}
6643 This option is obsolete. Use 'fileformat'.
6644 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6645 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6646 "unix".
6647
6648 *'textwidth'* *'tw'*
6649'textwidth' 'tw' number (default 0)
6650 local to buffer
6651 {not in Vi}
6652 Maximum width of text that is being inserted. A longer line will be
6653 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006654 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6655 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 'formatoptions' and |ins-textwidth|.
6657 NOTE: This option is set to 0 when 'compatible' is set.
6658
6659 *'thesaurus'* *'tsr'*
6660'thesaurus' 'tsr' string (default "")
6661 global or local to buffer |global-local|
6662 {not in Vi}
6663 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006664 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 the file should contain words with similar meaning, separated by
6666 non-keyword characters (white space is preferred). Maximum line
6667 length is 510 bytes.
6668 To obtain a file to be used here, check out the wordlist FAQ at
6669 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006670 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 after a comma are ignored, otherwise spaces are included in the file
6672 name. See |option-backslash| about using backslashes.
6673 The use of |:set+=| and |:set-=| is preferred when adding or removing
6674 directories from the list. This avoids problems when a future version
6675 uses another default.
6676 Backticks cannot be used in this option for security reasons.
6677
6678 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6679'tildeop' 'top' boolean (default off)
6680 global
6681 {not in Vi}
6682 When on: The tilde command "~" behaves like an operator.
6683 NOTE: This option is reset when 'compatible' is set.
6684
6685 *'timeout'* *'to'* *'notimeout'* *'noto'*
6686'timeout' 'to' boolean (default on)
6687 global
6688 *'ttimeout'* *'nottimeout'*
6689'ttimeout' boolean (default off)
6690 global
6691 {not in Vi}
6692 These two options together determine the behavior when part of a
6693 mapped key sequence or keyboard code has been received:
6694
6695 'timeout' 'ttimeout' action ~
6696 off off do not time out
6697 on on or off time out on :mappings and key codes
6698 off on time out on key codes
6699
6700 If both options are off, Vim will wait until either the complete
6701 mapping or key sequence has been received, or it is clear that there
6702 is no mapping or key sequence for the received characters. For
6703 example: if you have mapped "vl" and Vim has received 'v', the next
6704 character is needed to see if the 'v' is followed by an 'l'.
6705 When one of the options is on, Vim will wait for about 1 second for
6706 the next character to arrive. After that the already received
6707 characters are interpreted as single characters. The waiting time can
6708 be changed with the 'timeoutlen' option.
6709 On slow terminals or very busy systems timing out may cause
6710 malfunctioning cursor keys. If both options are off, Vim waits
6711 forever after an entered <Esc> if there are key codes that start
6712 with <Esc>. You will have to type <Esc> twice. If you do not have
6713 problems with key codes, but would like to have :mapped key
6714 sequences not timing out in 1 second, set the 'ttimeout' option and
6715 reset the 'timeout' option.
6716
6717 NOTE: 'ttimeout' is reset when 'compatible' is set.
6718
6719 *'timeoutlen'* *'tm'*
6720'timeoutlen' 'tm' number (default 1000)
6721 global
6722 {not in all versions of Vi}
6723 *'ttimeoutlen'* *'ttm'*
6724'ttimeoutlen' 'ttm' number (default -1)
6725 global
6726 {not in Vi}
6727 The time in milliseconds that is waited for a key code or mapped key
6728 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6729 when part of a command has been typed.
6730 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6731 different timeout value for key codes is desired set 'ttimeoutlen' to
6732 a non-negative number.
6733
6734 ttimeoutlen mapping delay key code delay ~
6735 < 0 'timeoutlen' 'timeoutlen'
6736 >= 0 'timeoutlen' 'ttimeoutlen'
6737
6738 The timeout only happens when the 'timeout' and 'ttimeout' options
6739 tell so. A useful setting would be >
6740 :set timeout timeoutlen=3000 ttimeoutlen=100
6741< (time out on mapping after three seconds, time out on key codes after
6742 a tenth of a second).
6743
6744 *'title'* *'notitle'*
6745'title' boolean (default off, on when title can be restored)
6746 global
6747 {not in Vi}
6748 {not available when compiled without the |+title|
6749 feature}
6750 When on, the title of the window will be set to the value of
6751 'titlestring' (if it is not empty), or to:
6752 filename [+=-] (path) - VIM
6753 Where:
6754 filename the name of the file being edited
6755 - indicates the file cannot be modified, 'ma' off
6756 + indicates the file was modified
6757 = indicates the file is read-only
6758 =+ indicates the file is read-only and modified
6759 (path) is the path of the file being edited
6760 - VIM the server name |v:servername| or "VIM"
6761 Only works if the terminal supports setting window titles
6762 (currently Amiga console, Win32 console, all GUI versions and
6763 terminals with a non- empty 't_ts' option - these are Unix xterm and
6764 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6765 *X11*
6766 When Vim was compiled with HAVE_X11 defined, the original title will
6767 be restored if possible. The output of ":version" will include "+X11"
6768 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6769 works for the icon name |'icon'|.
6770 But: When Vim was started with the |-X| argument, restoring the title
6771 will not work (except in the GUI).
6772 If the title cannot be restored, it is set to the value of 'titleold'.
6773 You might want to restore the title outside of Vim then.
6774 When using an xterm from a remote machine you can use this command:
6775 rsh machine_name xterm -display $DISPLAY &
6776 then the WINDOWID environment variable should be inherited and the
6777 title of the window should change back to what it should be after
6778 exiting Vim.
6779
6780 *'titlelen'*
6781'titlelen' number (default 85)
6782 global
6783 {not in Vi}
6784 {not available when compiled without the |+title|
6785 feature}
6786 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006787 title. When the title is longer, only the end of the path name is
6788 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 Using a percentage makes this adapt to the width of the window. But
6790 it won't work perfectly, because the actual number of characters
6791 available also depends on the font used and other things in the title
6792 bar. When 'titlelen' is zero the full path is used. Otherwise,
6793 values from 1 to 30000 percent can be used.
6794 'titlelen' is also used for the 'titlestring' option.
6795
6796 *'titleold'*
6797'titleold' string (default "Thanks for flying Vim")
6798 global
6799 {not in Vi}
6800 {only available when compiled with the |+title|
6801 feature}
6802 This option will be used for the window title when exiting Vim if the
6803 original title cannot be restored. Only happens if 'title' is on or
6804 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006805 This option cannot be set from a |modeline| or in the |sandbox|, for
6806 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 *'titlestring'*
6808'titlestring' string (default "")
6809 global
6810 {not in Vi}
6811 {not available when compiled without the |+title|
6812 feature}
6813 When this option is not empty, it will be used for the title of the
6814 window. This happens only when the 'title' option is on.
6815 Only works if the terminal supports setting window titles (currently
6816 Amiga console, Win32 console, all GUI versions and terminals with a
6817 non-empty 't_ts' option).
6818 When Vim was compiled with HAVE_X11 defined, the original title will
6819 be restored if possible |X11|.
6820 When this option contains printf-style '%' items, they will be
6821 expanded according to the rules used for 'statusline'.
6822 Example: >
6823 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6824 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6825< The value of 'titlelen' is used to align items in the middle or right
6826 of the available space.
6827 Some people prefer to have the file name first: >
6828 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6829< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006830 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 separating space only when needed.
6832 NOTE: Use of special characters in 'titlestring' may cause the display
6833 to be garbled (e.g., when it contains a CR or NL character).
6834 {not available when compiled without the |+statusline| feature}
6835
6836 *'toolbar'* *'tb'*
6837'toolbar' 'tb' string (default "icons,tooltips")
6838 global
6839 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6840 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006841 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 possible values are:
6843 icons Toolbar buttons are shown with icons.
6844 text Toolbar buttons shown with text.
6845 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006846 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 tooltips Tooltips are active for toolbar buttons.
6848 Tooltips refer to the popup help text which appears after the mouse
6849 cursor is placed over a toolbar button for a brief moment.
6850
6851 If you want the toolbar to be shown with icons as well as text, do the
6852 following: >
6853 :set tb=icons,text
6854< Motif and Athena cannot display icons and text at the same time. They
6855 will show icons if both are requested.
6856
6857 If none of the strings specified in 'toolbar' are valid or if
6858 'toolbar' is empty, this option is ignored. If you want to disable
6859 the toolbar, you need to set the 'guioptions' option. For example: >
6860 :set guioptions-=T
6861< Also see |gui-toolbar|.
6862
6863 *'toolbariconsize'* *'tbis'*
6864'toolbariconsize' 'tbis' string (default "small")
6865 global
6866 {not in Vi}
6867 {only in the GTK+ 2 GUI}
6868 Controls the size of toolbar icons. The possible values are:
6869 tiny Use tiny toolbar icons.
6870 small Use small toolbar icons (default).
6871 medium Use medium-sized toolbar icons.
6872 large Use large toolbar icons.
6873 The exact dimensions in pixels of the various icon sizes depend on
6874 the current theme. Common dimensions are large=32x32, medium=24x24,
6875 small=20x20 and tiny=16x16.
6876
6877 If 'toolbariconsize' is empty, the global default size as determined
6878 by user preferences or the current theme is used.
6879
6880 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6881'ttybuiltin' 'tbi' boolean (default on)
6882 global
6883 {not in Vi}
6884 When on, the builtin termcaps are searched before the external ones.
6885 When off the builtin termcaps are searched after the external ones.
6886 When this option is changed, you should set the 'term' option next for
6887 the change to take effect, for example: >
6888 :set notbi term=$TERM
6889< See also |termcap|.
6890 Rationale: The default for this option is "on", because the builtin
6891 termcap entries are generally better (many systems contain faulty
6892 xterm entries...).
6893
6894 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6895'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6896 sun-cmd, screen, rxvt, dtterm or
6897 iris-ansi; also on when running Vim in
6898 a DOS console)
6899 global
6900 {not in Vi}
6901 Indicates a fast terminal connection. More characters will be sent to
6902 the screen for redrawing, instead of using insert/delete line
6903 commands. Improves smoothness of redrawing when there are multiple
6904 windows and the terminal does not support a scrolling region.
6905 Also enables the extra writing of characters at the end of each screen
6906 line for lines that wrap. This helps when using copy/paste with the
6907 mouse in an xterm and other terminals.
6908
6909 *'ttymouse'* *'ttym'*
6910'ttymouse' 'ttym' string (default depends on 'term')
6911 global
6912 {not in Vi}
6913 {only in Unix and VMS, doesn't work in the GUI; not
6914 available when compiled without |+mouse|}
6915 Name of the terminal type for which mouse codes are to be recognized.
6916 Currently these three strings are valid:
6917 *xterm-mouse*
6918 xterm xterm-like mouse handling. The mouse generates
6919 "<Esc>[Mscr", where "scr" is three bytes:
6920 "s" = button state
6921 "c" = column plus 33
6922 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006923 This only works up to 223 columns! See "dec" for a
6924 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 xterm2 Works like "xterm", but with the xterm reporting the
6926 mouse position while the mouse is dragged. This works
6927 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006928 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 work. See below for how Vim detects this
6930 automatically.
6931 *netterm-mouse*
6932 netterm NetTerm mouse handling. The mouse generates
6933 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6934 for the row and column.
6935 *dec-mouse*
6936 dec DEC terminal mouse handling. The mouse generates a
6937 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006938 This is also available for an Xterm, if it was
6939 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 *jsbterm-mouse*
6941 jsbterm JSB term mouse handling.
6942 *pterm-mouse*
6943 pterm QNX pterm mouse handling.
6944
6945 The mouse handling must be enabled at compile time |+mouse_xterm|
6946 |+mouse_dec| |+mouse_netterm|.
6947 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6948 recognized, if enabled at compile time. DEC terminal mouse codes
6949 are recognized if enabled at compile time, and 'ttymouse' is not
6950 "xterm" (because the xterm and dec mouse codes conflict).
6951 This option is automatically set to "xterm", when the 'term' option is
6952 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6953 or "xterm2" already. The main use of this option is to set it to
6954 "xterm", when the terminal name doesn't start with "xterm", but it can
6955 handle xterm mouse codes.
6956 The "xterm2" value will be set if the xterm version is reported to be
6957 95 of higher. This only works when compiled with the |+termresponse|
6958 feature and if |t_RV| is set to the escape sequence to request the
6959 xterm version number. Otherwise "xterm2" must be set explicitly.
6960 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6961 t_RV to an empty string: >
6962 :set t_RV=
6963<
6964 *'ttyscroll'* *'tsl'*
6965'ttyscroll' 'tsl' number (default 999)
6966 global
6967 Maximum number of lines to scroll the screen. If there are more lines
6968 to scroll the window is redrawn. For terminals where scrolling is
6969 very slow and redrawing is not slow this can be set to a small number,
6970 e.g., 3, to speed up displaying.
6971
6972 *'ttytype'* *'tty'*
6973'ttytype' 'tty' string (default from $TERM)
6974 global
6975 Alias for 'term', see above.
6976
6977 *'undolevels'* *'ul'*
6978'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6979 Win32 and OS/2)
6980 global
6981 {not in Vi}
6982 Maximum number of changes that can be undone. Since undo information
6983 is kept in memory, higher numbers will cause more memory to be used
6984 (nevertheless, a single change can use an unlimited amount of memory).
6985 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6986 itself: >
6987 set ul=0
6988< But you can also get Vi compatibility by including the 'u' flag in
6989 'cpoptions', and still be able to use CTRL-R to repeat undo.
6990 Set to a negative number for no undo at all: >
6991 set ul=-1
6992< This helps when you run out of memory for a single change.
6993 Also see |undo-two-ways|.
6994
6995 *'updatecount'* *'uc'*
6996'updatecount' 'uc' number (default: 200)
6997 global
6998 {not in Vi}
6999 After typing this many characters the swap file will be written to
7000 disk. When zero, no swap file will be created at all (see chapter on
7001 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7002 Vim with the "-n" option, see |startup|. When editing in readonly
7003 mode this option will be initialized to 10000.
7004 The swapfile can be disabled per buffer with |'swapfile'|.
7005 When 'updatecount' is set from zero to non-zero, swap files are
7006 created for all buffers that have 'swapfile' set. When 'updatecount'
7007 is set to zero, existing swap files are not deleted.
7008 Also see |'swapsync'|.
7009 This option has no meaning in buffers where |'buftype'| is "nofile"
7010 or "nowrite".
7011
7012 *'updatetime'* *'ut'*
7013'updatetime' 'ut' number (default 4000)
7014 global
7015 {not in Vi}
7016 If this many milliseconds nothing is typed the swap file will be
7017 written to disk (see |crash-recovery|). Also used for the
7018 |CursorHold| autocommand event.
7019
7020 *'verbose'* *'vbs'*
7021'verbose' 'vbs' number (default 0)
7022 global
7023 {not in Vi, although some versions have a boolean
7024 verbose option}
7025 When bigger than zero, Vim will give messages about what it is doing.
7026 Currently, these messages are given:
7027 >= 1 When the viminfo file is read or written.
7028 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007029 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 >= 8 Files for which a group of autocommands is executed.
7031 >= 9 Every executed autocommand.
7032 >= 12 Every executed function.
7033 >= 13 When an exception is thrown, caught, finished, or discarded.
7034 >= 14 Anything pending in a ":finally" clause.
7035 >= 15 Every executed Ex command (truncated at 200 characters).
7036
7037 This option can also be set with the "-V" argument. See |-V|.
7038 This option is also set by the |:verbose| command.
7039
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007040 When the 'verbosefile' option is set then the verbose messages are not
7041 displayed.
7042
7043 *'verbosefile'* *'vfile'*
7044'verbosefile' 'vfile' string (default empty)
7045 global
7046 {not in Vi}
7047 When not empty all messages are written in a file with this name.
7048 When the file exists messages are appended.
7049 Writing to the file ends when Vim exits or when 'verbosefile' is made
7050 empty.
7051 Setting 'verbosefile' to a new value is like making it empty first.
7052 The difference with |:redir| is that verbose messages are not
7053 displayed when 'verbosefile' is set.
7054
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 *'viewdir'* *'vdir'*
7056'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7057 "$VIM/vimfiles/view",
7058 for Unix: "~/.vim/view",
7059 for Macintosh: "$VIM:vimfiles:view"
7060 for VMS: "sys$login:vimfiles/view"
7061 for RiscOS: "Choices:vimfiles/view")
7062 global
7063 {not in Vi}
7064 {not available when compiled without the +mksession
7065 feature}
7066 Name of the directory where to store files for |:mkview|.
7067 This option cannot be set from a |modeline| or in the |sandbox|, for
7068 security reasons.
7069
7070 *'viewoptions'* *'vop'*
7071'viewoptions' 'vop' string (default: "folds,options,cursor")
7072 global
7073 {not in Vi}
7074 {not available when compiled without the +mksession
7075 feature}
7076 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007077 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 word save and restore ~
7079 cursor cursor position in file and in window
7080 folds manually created folds, opened/closed folds and local
7081 fold options
7082 options options and mappings local to a window or buffer (not
7083 global values for local options)
7084 slash backslashes in file names replaced with forward
7085 slashes
7086 unix with Unix end-of-line format (single <NL>), even when
7087 on Windows or DOS
7088
7089 "slash" and "unix" are useful on Windows when sharing view files
7090 with Unix. The Unix version of Vim cannot source dos format scripts,
7091 but the Windows version of Vim can source unix format scripts.
7092
7093 *'viminfo'* *'vi'* *E526* *E527* *E528*
7094'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7095 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7096 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7097 for others: '20,<50,s10,h)
7098 global
7099 {not in Vi}
7100 {not available when compiled without the |+viminfo|
7101 feature}
7102 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007103 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 separated list of parameters, each consisting of a single character
7105 identifying the particular parameter, followed by a number or string
7106 which specifies the value of that parameter. If a particular
7107 character is left out, then the default value is used for that
7108 parameter. The following is a list of the identifying characters and
7109 the effect of their value.
7110 CHAR VALUE ~
7111 ! When included, save and restore global variables that start
7112 with an uppercase letter, and don't contain a lowercase
7113 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007114 and "_K_L_M" are not. Only String and Number types are
7115 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 " Maximum number of lines saved for each register. Old name of
7117 the '<' item, with the disadvantage that you need to put a
7118 backslash before the ", otherwise it will be recognized as the
7119 start of a comment!
7120 % When included, save and restore the buffer list. If Vim is
7121 started with a file name argument, the buffer list is not
7122 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007123 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 without a file name and buffers for help files are not written
7125 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007126 When followed by a number, the number specifies the maximum
7127 number of buffers that are stored. Without a number all
7128 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 ' Maximum number of previously edited files for which the marks
7130 are remembered. This parameter must always be included when
7131 'viminfo' is non-empty.
7132 Including this item also means that the |jumplist| and the
7133 |changelist| are stored in the viminfo file.
7134 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007135 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 patterns are also saved. When not included, the value of
7137 'history' is used.
7138 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007139 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 < Maximum number of lines saved for each register. If zero then
7141 registers are not saved. When not included, all lines are
7142 saved. '"' is the old name for this item.
7143 Also see the 's' item below: limit specified in Kbyte.
7144 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007145 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 c When included, convert the text in the viminfo file from the
7147 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007148 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 f Whether file marks need to be stored. If zero, file marks ('0
7150 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007151 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 cursor position (when exiting or when doing ":wviminfo").
7153 h Disable the effect of 'hlsearch' when loading the viminfo
7154 file. When not included, it depends on whether ":nohlsearch"
7155 has been used since the last search command.
7156 n Name of the viminfo file. The name must immediately follow
7157 the 'n'. Must be the last one! If the "-i" argument was
7158 given when starting Vim, that file name overrides the one
7159 given here with 'viminfo'. Environment variables are expanded
7160 when opening the file, not when setting the option.
7161 r Removable media. The argument is a string (up to the next
7162 ','). This parameter can be given several times. Each
7163 specifies the start of a path for which no marks will be
7164 stored. This is to avoid removable media. For MS-DOS you
7165 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7166 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7167 ignored. Maximum length of each 'r' argument is 50
7168 characters.
7169 s Maximum size of an item in Kbyte. If zero then registers are
7170 not saved. Currently only applies to registers. The default
7171 "s10" will exclude registers with more than 10 Kbyte of text.
7172 Also see the '<' item above: line count limit.
7173
7174 Example: >
7175 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7176<
7177 '50 Marks will be remembered for the last 50 files you
7178 edited.
7179 <1000 Contents of registers (up to 1000 lines each) will be
7180 remembered.
7181 s100 Registers with more than 100 Kbyte text are skipped.
7182 :0 Command-line history will not be saved.
7183 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7184 no / Since '/' is not specified, the default will be used,
7185 that is, save all of the search history, and also the
7186 previous search and substitute patterns.
7187 no % The buffer list will not be saved nor read back.
7188 no h 'hlsearch' highlighting will be restored.
7189
7190 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7191 load the contents of the file, this is not done automatically.
7192
7193 This option cannot be set from a |modeline| or in the |sandbox|, for
7194 security reasons.
7195
7196 *'virtualedit'* *'ve'*
7197'virtualedit' 've' string (default "")
7198 global
7199 {not in Vi}
7200 {not available when compiled without the
7201 |+virtualedit| feature}
7202 A comma separated list of these words:
7203 block Allow virtual editing in Visual block mode.
7204 insert Allow virtual editing in Insert mode.
7205 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007206 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007207
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 Virtual editing means that the cursor can be positioned where there is
7209 no actual character. This can be halfway into a Tab or beyond the end
7210 of the line. Useful for selecting a rectangle in Visual mode and
7211 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007212 "onemore" is not the same, it will only allow moving the cursor just
7213 after the last character of the line. This makes some commands more
7214 consistent. Previously the cursor was always past the end of the line
7215 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007216 break some plugins or Vim scripts. For example because |l| can move
7217 the cursor after the last character. Use with care!
7218 Using the |$| command will move to the last character in the line, not
7219 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007220 It doesn't make sense to combine "all" with "onemore", but you will
7221 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222
7223 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7224'visualbell' 'vb' boolean (default off)
7225 global
7226 {not in Vi}
7227 Use visual bell instead of beeping. The terminal code to display the
7228 visual bell is given with 't_vb'. When no beep or flash is wanted,
7229 use ":set vb t_vb=".
7230 Note: When the GUI starts, 't_vb' is reset to its default value. You
7231 might want to set it again in your |gvimrc|.
7232 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7233 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7234 where 40 is the time in msec.
7235 Does not work on the Amiga, you always get a screen flash.
7236 Also see 'errorbells'.
7237
7238 *'warn'* *'nowarn'*
7239'warn' boolean (default on)
7240 global
7241 Give a warning message when a shell command is used while the buffer
7242 has been changed.
7243
7244 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7245'weirdinvert' 'wiv' boolean (default off)
7246 global
7247 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007248 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 It is provided for backwards compatibility with version 4.x.
7250 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7251 vice versa. Has no effect when the GUI is running.
7252
7253 *'whichwrap'* *'ww'*
7254'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7255 global
7256 {not in Vi}
7257 Allow specified keys that move the cursor left/right to move to the
7258 previous/next line when the cursor is on the first/last character in
7259 the line. Concatenate characters to allow this for these keys:
7260 char key mode ~
7261 b <BS> Normal and Visual
7262 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007263 h "h" Normal and Visual (not recommended)
7264 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 < <Left> Normal and Visual
7266 > <Right> Normal and Visual
7267 ~ "~" Normal
7268 [ <Left> Insert and Replace
7269 ] <Right> Insert and Replace
7270 For example: >
7271 :set ww=<,>,[,]
7272< allows wrap only when cursor keys are used.
7273 When the movement keys are used in combination with a delete or change
7274 operator, the <EOL> also counts for a character. This makes "3h"
7275 different from "3dh" when the cursor crosses the end of a line. This
7276 is also true for "x" and "X", because they do the same as "dl" and
7277 "dh". If you use this, you may also want to use the mapping
7278 ":map <BS> X" to make backspace delete the character in front of the
7279 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007280 When 'l' is included and it is used after an operator at the end of a
7281 line then it will not move to the next line. This makes "dl", "cl",
7282 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 NOTE: This option is set to the Vi default value when 'compatible' is
7284 set and to the Vim default value when 'compatible' is reset.
7285
7286 *'wildchar'* *'wc'*
7287'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7288 global
7289 {not in Vi}
7290 Character you have to type to start wildcard expansion in the
7291 command-line, as specified with 'wildmode'.
7292 The character is not recognized when used inside a macro. See
7293 'wildcharm' for that.
7294 Although 'wc' is a number option, you can set it to a special key: >
7295 :set wc=<Esc>
7296< NOTE: This option is set to the Vi default value when 'compatible' is
7297 set and to the Vim default value when 'compatible' is reset.
7298
7299 *'wildcharm'* *'wcm'*
7300'wildcharm' 'wcm' number (default: none (0))
7301 global
7302 {not in Vi}
7303 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007304 recognized when used inside a macro. You can find "spare" command-line
7305 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 you'll never actually type 'wildcharm', just use it in mappings that
7307 automatically invoke completion mode, e.g.: >
7308 :set wcm=<C-Z>
7309 :cmap ss so $vim/sessions/*.vim<C-Z>
7310< Then after typing :ss you can use CTRL-P & CTRL-N.
7311
7312 *'wildignore'* *'wig'*
7313'wildignore' 'wig' string (default "")
7314 global
7315 {not in Vi}
7316 {not available when compiled without the |+wildignore|
7317 feature}
7318 A list of file patterns. A file that matches with one of these
7319 patterns is ignored when completing file or directory names.
7320 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7321 Also see 'suffixes'.
7322 Example: >
7323 :set wildignore=*.o,*.obj
7324< The use of |:set+=| and |:set-=| is preferred when adding or removing
7325 a pattern from the list. This avoids problems when a future version
7326 uses another default.
7327
7328 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7329'wildmenu' 'wmnu' boolean (default off)
7330 global
7331 {not in Vi}
7332 {not available if compiled without the |+wildmenu|
7333 feature}
7334 When 'wildmenu' is on, command-line completion operates in an enhanced
7335 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7336 the possible matches are shown just above the command line, with the
7337 first match highlighted (overwriting the status line, if there is
7338 one). Keys that show the previous/next match, such as <Tab> or
7339 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7340 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7341 specified. "longest" and "list" do not start "wildmenu" mode.
7342 If there are more matches than can fit in the line, a ">" is shown on
7343 the right and/or a "<" is shown on the left. The status line scrolls
7344 as needed.
7345 The "wildmenu" mode is abandoned when a key is hit that is not used
7346 for selecting a completion.
7347 While the "wildmenu" is active the following keys have special
7348 meanings:
7349
7350 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7351 <Down> - in filename/menu name completion: move into a
7352 subdirectory or submenu.
7353 <CR> - in menu completion, when the cursor is just after a
7354 dot: move into a submenu.
7355 <Up> - in filename/menu name completion: move up into
7356 parent directory or parent menu.
7357
7358 This makes the menus accessible from the console |console-menus|.
7359
7360 If you prefer the <Left> and <Right> keys to move the cursor instead
7361 of selecting a different match, use this: >
7362 :cnoremap <Left> <Space><BS><Left>
7363 :cnoremap <Right> <Space><BS><Right>
7364<
7365 The "WildMenu" highlighting is used for displaying the current match
7366 |hl-WildMenu|.
7367
7368 *'wildmode'* *'wim'*
7369'wildmode' 'wim' string (Vim default: "full")
7370 global
7371 {not in Vi}
7372 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007373 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374 part specifies what to do for each consecutive use of 'wildchar. The
7375 first part specifies the behavior for the first use of 'wildchar',
7376 The second part for the second use, etc.
7377 These are the possible values for each part:
7378 "" Complete only the first match.
7379 "full" Complete the next full match. After the last match,
7380 the original string is used and then the first match
7381 again.
7382 "longest" Complete till longest common string. If this doesn't
7383 result in a longer string, use the next part.
7384 "longest:full" Like "longest", but also start 'wildmenu' if it is
7385 enabled.
7386 "list" When more than one match, list all matches.
7387 "list:full" When more than one match, list all matches and
7388 complete first match.
7389 "list:longest" When more than one match, list all matches and
7390 complete till longest common string.
7391 When there is only a single match, it is fully completed in all cases.
7392
7393 Examples: >
7394 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007395< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 :set wildmode=longest,full
7397< Complete longest common string, then each full match >
7398 :set wildmode=list:full
7399< List all matches and complete each full match >
7400 :set wildmode=list,full
7401< List all matches without completing, then each full match >
7402 :set wildmode=longest,list
7403< Complete longest common string, then list alternatives.
7404
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007405 *'wildoptions'* *'wop'*
7406'wildoptions' 'wop' string (default "")
7407 global
7408 {not in Vi}
7409 {not available when compiled without the |+wildignore|
7410 feature}
7411 A list of words that change how command line completion is done.
7412 Currently only one word is allowed:
7413 tagfile When using CTRL-D to list matching tags, the kind of
7414 tag and the file of the tag is listed. Only one match
7415 is displayed per line. Often used tag kinds are:
7416 d #define
7417 f function
7418 Also see |cmdline-completion|.
7419
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 *'winaltkeys'* *'wak'*
7421'winaltkeys' 'wak' string (default "menu")
7422 global
7423 {not in Vi}
7424 {only used in Win32, Motif, GTK and Photon GUI}
7425 Some GUI versions allow the access to menu entries by using the ALT
7426 key in combination with a character that appears underlined in the
7427 menu. This conflicts with the use of the ALT key for mappings and
7428 entering special characters. This option tells what to do:
7429 no Don't use ALT keys for menus. ALT key combinations can be
7430 mapped, but there is no automatic handling. This can then be
7431 done with the |:simalt| command.
7432 yes ALT key handling is done by the windowing system. ALT key
7433 combinations cannot be mapped.
7434 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007435 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 keys can be mapped.
7437 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7438 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007439 This option is not used for <F10>; on Win32 and with GTK <F10> will
7440 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007442 *'window'* *'wi'*
7443'window' 'wi' number (default screen height - 1)
7444 global
7445 Window height. Do not confuse this with the height of the Vim window,
7446 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007447 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7448 value is smaller than 'lines' minus one. The screen will scroll
7449 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007450 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7451 in a much smarter way, taking care of wrapping lines.
7452 When resizing the Vim window, the value is smaller than 1 or more than
7453 or equal to 'lines' it will be set to 'lines' minus 1.
7454 {Vi also uses the option to specify the number of displayed lines}
7455
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 *'winheight'* *'wh'* *E591*
7457'winheight' 'wh' number (default 1)
7458 global
7459 {not in Vi}
7460 {not available when compiled without the +windows
7461 feature}
7462 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007463 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 current window is smaller, its size is increased, at the cost of the
7465 height of other windows. Set it to 999 to make the current window
7466 always fill the screen (although this has the drawback that ":all"
7467 will create only two windows). Set it to a small number for normal
7468 editing.
7469 Minimum value is 1.
7470 The height is not adjusted after one of the commands to change the
7471 height of the current window.
7472 'winheight' applies to the current window. Use 'winminheight' to set
7473 the minimal height for other windows.
7474
7475 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7476'winfixheight' 'wfh' boolean (default off)
7477 local to window
7478 {not in Vi}
7479 {not available when compiled without the +windows
7480 feature}
7481 Keep the window height when windows are opened or closed and
7482 'equalalways' is set. Set by default for the |preview-window| and
7483 |quickfix-window|.
7484 The height may be changed anyway when running out of room.
7485
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007486 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7487'winfixwidth' 'wfw' boolean (default off)
7488 local to window
7489 {not in Vi}
7490 {not available when compiled without the +windows
7491 feature}
7492 Keep the window width when windows are opened or closed and
7493 'equalalways' is set.
7494 The width may be changed anyway when running out of room.
7495
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 *'winminheight'* *'wmh'*
7497'winminheight' 'wmh' number (default 1)
7498 global
7499 {not in Vi}
7500 {not available when compiled without the +windows
7501 feature}
7502 The minimal height of a window, when it's not the current window.
7503 This is a hard minimum, windows will never become smaller.
7504 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7505 status bar) if necessary. They will return to at least one line when
7506 they become active (since the cursor has to have somewhere to go.)
7507 Use 'winheight' to set the minimal height of the current window.
7508 This option is only checked when making a window smaller. Don't use a
7509 large number, it will cause errors when opening more than a few
7510 windows. A value of 0 to 3 is reasonable.
7511
7512 *'winminwidth'* *'wmw'*
7513'winminwidth' 'wmw' number (default 1)
7514 global
7515 {not in Vi}
7516 {not available when compiled without the +vertsplit
7517 feature}
7518 The minimal width of a window, when it's not the current window.
7519 This is a hard minimum, windows will never become smaller.
7520 When set to zero, windows may be "squashed" to zero columns (i.e. just
7521 a vertical separator) if necessary. They will return to at least one
7522 line when they become active (since the cursor has to have somewhere
7523 to go.)
7524 Use 'winwidth' to set the minimal width of the current window.
7525 This option is only checked when making a window smaller. Don't use a
7526 large number, it will cause errors when opening more than a few
7527 windows. A value of 0 to 12 is reasonable.
7528
7529 *'winwidth'* *'wiw'* *E592*
7530'winwidth' 'wiw' number (default 20)
7531 global
7532 {not in Vi}
7533 {not available when compiled without the +vertsplit
7534 feature}
7535 Minimal number of columns for the current window. This is not a hard
7536 minimum, Vim will use fewer columns if there is not enough room. If
7537 the current window is smaller, its size is increased, at the cost of
7538 the width of other windows. Set it to 999 to make the current window
7539 always fill the screen. Set it to a small number for normal editing.
7540 The width is not adjusted after one of the commands to change the
7541 width of the current window.
7542 'winwidth' applies to the current window. Use 'winminwidth' to set
7543 the minimal width for other windows.
7544
7545 *'wrap'* *'nowrap'*
7546'wrap' boolean (default on)
7547 local to window
7548 {not in Vi}
7549 This option changes how text is displayed. It doesn't change the text
7550 in the buffer, see 'textwidth' for that.
7551 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007552 displaying continues on the next line. When off lines will not wrap
7553 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 moved to a part that is not shown, the screen will scroll
7555 horizontally.
7556 The line will be broken in the middle of a word if necessary. See
7557 'linebreak' to get the break at a word boundary.
7558 To make scrolling horizontally a bit more useful, try this: >
7559 :set sidescroll=5
7560 :set listchars+=precedes:<,extends:>
7561< See 'sidescroll', 'listchars' and |wrap-off|.
7562
7563 *'wrapmargin'* *'wm'*
7564'wrapmargin' 'wm' number (default 0)
7565 local to buffer
7566 Number of characters from the right window border where wrapping
7567 starts. When typing text beyond this limit, an <EOL> will be inserted
7568 and inserting continues on the next line.
7569 Options that add a margin, such as 'number' and 'foldcolumn', cause
7570 the text width to be further reduced. This is Vi compatible.
7571 When 'textwidth' is non-zero, this option is not used.
7572 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7573 and less usefully}
7574
7575 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7576'wrapscan' 'ws' boolean (default on) *E384* *E385*
7577 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007578 Searches wrap around the end of the file. Also applies to |]s| and
7579 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580
7581 *'write'* *'nowrite'*
7582'write' boolean (default on)
7583 global
7584 {not in Vi}
7585 Allows writing files. When not set, writing a file is not allowed.
7586 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007587 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 argument. Filtering text is still possible, even though this requires
7589 writing a temporary file.
7590
7591 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7592'writeany' 'wa' boolean (default off)
7593 global
7594 Allows writing to any file with no need for "!" override.
7595
7596 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7597'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7598 otherwise)
7599 global
7600 {not in Vi}
7601 Make a backup before overwriting a file. The backup is removed after
7602 the file was successfully written, unless the 'backup' option is
7603 also on. Reset this option if your file system is almost full. See
7604 |backup-table| for another explanation.
7605 When the 'backupskip' pattern matches, a backup is not made anyway.
7606 NOTE: This option is set to the default value when 'compatible' is
7607 set.
7608
7609 *'writedelay'* *'wd'*
7610'writedelay' 'wd' number (default 0)
7611 global
7612 {not in Vi}
7613 The number of microseconds to wait for each character sent to the
7614 screen. When non-zero, characters are sent to the terminal one by
7615 one. For MS-DOS pcterm this does not work. For debugging purposes.
7616
7617 vim:tw=78:ts=8:ft=help:norl: