blob: 166c0aaad14fb05a9031d75ea86b95f8bcffadc3 [file] [log] [blame]
Bram Moolenaarcab49df2011-03-22 17:40:10 +01001*options.txt* For Vim version 7.3. Last change: 2011 Mar 22
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
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaardb84e452010-08-15 13:50:43 +0200140{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100153You can define any key codes, e.g.: >
154 :set t_xy=^[foo;
155There is no warning for using a name that isn't recognized. You can map these
156codes as you like: >
157 :map <t_xy> something
158< *E846*
159When a key code is not set, it's like it does not exist. Trying to get its
160value will result in an error: >
161 :set t_kb=
162 :set t_kb
163 E846: Key code not set: t_kb
164
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000165The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
166security reasons.
167
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000169at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170"set all" probably does not fit on the screen, causing Vim to give the
171|more-prompt|.
172
173 *option-backslash*
174To include white space in a string option value it has to be preceded with a
175backslash. To include a backslash you have to use two. Effectively this
176means that the number of backslashes in an option value is halved (rounded
177down).
178A few examples: >
179 :set tags=tags\ /usr/tags results in "tags /usr/tags"
180 :set tags=tags\\,file results in "tags\,file"
181 :set tags=tags\\\ file results in "tags\ file"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183The "|" character separates a ":set" command from a following command. To
184include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185'titlestring' option to "hi|there": >
186 :set titlestring=hi\|there
187This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
188 :set titlestring=hi|set iconstring=there
189
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000190Similarly, the double quote character starts a comment. To include the '"' in
191the option value, use '\"' instead. This example sets the 'titlestring'
192option to 'hi "there"': >
193 :set titlestring=hi\ \"there\"
194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000195For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196precise: For options that expect a file name (those where environment
197variables are expanded) a backslash before a normal file name character is not
198removed. But a backslash before a special character (space, backslash, comma,
199etc.) is used like explained above.
200There is one special situation, when the value starts with "\\": >
201 :set dir=\\machine\path results in "\\machine\path"
202 :set dir=\\\\machine\\path results in "\\machine\path"
203 :set dir=\\path\\file results in "\\path\file" (wrong!)
204For the first one the start is kept, but for the second one the backslashes
205are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000206halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207result which is probably not what you want. Avoid it.
208
209 *add-option-flags* *remove-option-flags*
210 *E539* *E550* *E551* *E552*
211Some options are a list of flags. When you want to add a flag to such an
212option, without changing the existing ones, you can do it like this: >
213 :set guioptions+=a
214Remove a flag from an option like this: >
215 :set guioptions-=a
216This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
219doesn't appear.
220
221 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000222Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223environment variable exists the '$' and the following environment variable
224name is replaced with its value. If it does not exist the '$' and the name
225are not modified. Any non-id character (not a letter, digit or '_') may
226follow the environment variable name. That character and what follows is
227appended to the value of the environment variable. Examples: >
228 :set term=$TERM.new
229 :set path=/usr/$INCLUDE,$HOME/include,.
230When adding or removing a string from an option with ":set opt-=val" or ":set
231opt+=val" the expansion is done before the adding or removing.
232
233
234Handling of local options *local-options*
235
236Some of the options only apply to a window or buffer. Each window or buffer
237has its own copy of this option, thus can each have their own value. This
238allows you to set 'list' in one window but not in another. And set
239'shiftwidth' to 3 in one buffer and 4 in another.
240
241The following explains what happens to these local options in specific
242situations. You don't really need to know all of this, since Vim mostly uses
243the option values you would expect. Unfortunately, doing what the user
244expects is a bit complicated...
245
246When splitting a window, the local options are copied to the new window. Thus
247right after the split the contents of the two windows look the same.
248
249When editing a new buffer, its local option values must be initialized. Since
250the local options of the current buffer might be specifically for that buffer,
251these are not used. Instead, for each buffer-local option there also is a
252global value, which is used for new buffers. With ":set" both the local and
253global value is changed. With "setlocal" only the local value is changed,
254thus this value is not used when editing a new buffer.
255
256When editing a buffer that has been edited before, the last used window
257options are used again. If this buffer has been edited in this window, the
258values from back then are used. Otherwise the values from the window where
259the buffer was edited last are used.
260
261It's possible to set a local window option specifically for a type of buffer.
262When you edit another buffer in the same window, you don't want to keep
263using these local window options. Therefore Vim keeps a global value of the
264local window options, which is used when editing another buffer. Each window
265has its own copy of these values. Thus these are local to the window, but
266global to all buffers in the window. With this you can do: >
267 :e one
268 :set list
269 :e two
270Now the 'list' option will also be set in "two", since with the ":set list"
271command you have also set the global value. >
272 :set nolist
273 :e one
274 :setlocal list
275 :e two
276Now the 'list' option is not set, because ":set nolist" resets the global
277value, ":setlocal list" only changes the local value and ":e two" gets the
278global value. Note that if you do this next: >
279 :e one
280You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000281"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282
283 *:setl* *:setlocal*
284:setl[ocal] ... Like ":set" but set only the value local to the
285 current buffer or window. Not all options have a
286 local value. If the option does not have a local
287 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200288 With the "all" argument: display local values for all
289 local options.
290 Without argument: Display local values for all local
291 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000293 local value. For a global/local boolean option, when
294 the global value is being used, "--" is displayed
295 before the option name.
296 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297 shown (but that might change in the future).
298 {not in Vi}
299
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000300:setl[ocal] {option}< Set the local value of {option} to its global value by
301 copying the value.
302 {not in Vi}
303
304:se[t] {option}< Set the local value of {option} to its global value by
305 making it empty. Only makes sense for |global-local|
306 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 {not in Vi}
308
309 *:setg* *:setglobal*
310:setg[lobal] ... Like ":set" but set only the global value for a local
311 option without changing the local value.
312 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200313 With the "all" argument: display global values for all
314 local options.
315 Without argument: display global values for all local
316 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 {not in Vi}
318
319For buffer-local and window-local options:
320 Command global value local value ~
321 :set option=value set set
322 :setlocal option=value - set
323:setglobal option=value set -
324 :set option? - display
325 :setlocal option? - display
326:setglobal option? display -
327
328
329Global options with a local value *global-local*
330
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000331Options are global when you mostly use one value for all buffers and windows.
332For some global options it's useful to sometimes have a different local value.
333You can set the local value with ":setlocal". That buffer or window will then
334use the local value, while other buffers and windows continue using the global
335value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336
337For example, you have two windows, both on C source code. They use the global
338'makeprg' option. If you do this in one of the two windows: >
339 :set makeprg=gmake
340then the other window will switch to the same value. There is no need to set
341the 'makeprg' option in the other C source window too.
342However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000343another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000344files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345 :setlocal makeprg=perlmake
346You can switch back to using the global value by making the local value empty: >
347 :setlocal makeprg=
348This only works for a string option. For a boolean option you need to use the
349"<" flag, like this: >
350 :setlocal autoread<
351Note that for non-boolean options using "<" copies the global value to the
352local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000353when the global value changes later). You can also use: >
354 :set path<
355This will make the local value of 'path' empty, so that the global value is
356used. Thus it does the same as: >
357 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000358Note: In the future more global options can be made global-local. Using
359":setlocal" on a global option might work differently then.
360
361
362Setting the filetype
363
364:setf[iletype] {filetype} *:setf* *:setfiletype*
365 Set the 'filetype' option to {filetype}, but only if
366 not done yet in a sequence of (nested) autocommands.
367 This is short for: >
368 :if !did_filetype()
369 : setlocal filetype={filetype}
370 :endif
371< This command is used in a filetype.vim file to avoid
372 setting the 'filetype' option twice, causing different
373 settings and syntax files to be loaded.
374 {not in Vi}
375
Bram Moolenaard58e9292011-02-09 17:07:58 +0100376 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000377:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
378:opt[ions] Open a window for viewing and setting all options.
379 Options are grouped by function.
380 Offers short help for each option. Hit <CR> on the
381 short help to open a help window with more help for
382 the option.
383 Modify the value of the option and hit <CR> on the
384 "set" line to set the new value. For window and
385 buffer specific options, the last accessed window is
386 used to set the option value in, unless this is a help
387 window, in which case the window below help window is
388 used (skipping the option-window).
389 {not available when compiled without the |+eval| or
390 |+autocmd| features}
391
392 *$HOME*
393Using "~" is like using "$HOME", but it is only recognized at the start of an
394option and after a space or comma.
395
396On Unix systems "~user" can be used too. It is replaced by the home directory
397of user "user". Example: >
398 :set path=~mool/include,/usr/include,.
399
400On Unix systems the form "${HOME}" can be used too. The name between {} can
401contain non-id characters then. Note that if you want to use this for the
402"gf" command, you need to add the '{' and '}' characters to 'isfname'.
403
404NOTE: expanding environment variables and "~/" is only done with the ":set"
405command, not when assigning a value to an option with ":let".
406
407
408Note the maximum length of an expanded option is limited. How much depends on
409the system, mostly it is something like 256 or 1024 characters.
410
411 *:fix* *:fixdel*
412:fix[del] Set the value of 't_kD':
413 't_kb' is 't_kD' becomes ~
414 CTRL-? CTRL-H
415 not CTRL-? CTRL-?
416
417 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
418
419 If your delete key terminal code is wrong, but the
420 code for backspace is alright, you can put this in
421 your .vimrc: >
422 :fixdel
423< This works no matter what the actual code for
424 backspace is.
425
426 If the backspace key terminal code is wrong you can
427 use this: >
428 :if &term == "termname"
429 : set t_kb=^V<BS>
430 : fixdel
431 :endif
432< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000433 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434 with your terminal name.
435
436 If your <Delete> key sends a strange key sequence (not
437 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
438 :if &term == "termname"
439 : set t_kD=^V<Delete>
440 :endif
441< Where "^V" is CTRL-V and "<Delete>" is the delete key
442 (don't type eight characters!). Replace "termname"
443 with your terminal name.
444
445 *Linux-backspace*
446 Note about Linux: By default the backspace key
447 produces CTRL-?, which is wrong. You can fix it by
448 putting this line in your rc.local: >
449 echo "keycode 14 = BackSpace" | loadkeys
450<
451 *NetBSD-backspace*
452 Note about NetBSD: If your backspace doesn't produce
453 the right code, try this: >
454 xmodmap -e "keycode 22 = BackSpace"
455< If this works, add this in your .Xmodmap file: >
456 keysym 22 = BackSpace
457< You need to restart for this to take effect.
458
459==============================================================================
4602. Automatically setting options *auto-setting*
461
462Besides changing options with the ":set" command, there are three alternatives
463to set options automatically for one or more files:
464
4651. When starting Vim initializations are read from various places. See
466 |initialization|. Most of them are performed for all editing sessions,
467 and some of them depend on the directory where Vim is started.
468 You can create an initialization file with |:mkvimrc|, |:mkview| and
469 |:mksession|.
4702. If you start editing a new file, the automatic commands are executed.
471 This can be used to set options for files matching a particular pattern and
472 many other things. See |autocommand|.
4733. If you start editing a new file, and the 'modeline' option is on, a
474 number of lines at the beginning and end of the file are checked for
475 modelines. This is explained here.
476
477 *modeline* *vim:* *vi:* *ex:* *E520*
478There are two forms of modelines. The first form:
479 [text]{white}{vi:|vim:|ex:}[white]{options}
480
481[text] any text or empty
482{white} at least one blank character (<Space> or <Tab>)
483{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
484[white] optional white space
485{options} a list of option settings, separated with white space or ':',
486 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000487 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000488
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000489Example:
490 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000491
492The second form (this is compatible with some versions of Vi):
493
494 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
495
496[text] any text or empty
497{white} at least one blank character (<Space> or <Tab>)
498{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
499[white] optional white space
500se[t] the string "set " or "se " (note the space)
501{options} a list of options, separated with white space, which is the
502 argument for a ":set" command
503: a colon
504[text] any text or empty
505
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000506Example:
507 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
509The white space before {vi:|vim:|ex:} is required. This minimizes the chance
510that a normal word like "lex:" is caught. There is one exception: "vi:" and
511"vim:" can also be at the start of the line (for compatibility with version
5123.0). Using "ex:" at the start of the line will be ignored (this could be
513short for "example:").
514
515 *modeline-local*
516The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000517buffer and window that contain the file. Although it's possible to set global
518options from a modeline, this is unusual. If you have two windows open and
519the files in it set the same global option to a different value, the result
520depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000522When editing a file that was already loaded, only the window-local options
523from the modeline are used. Thus if you manually changed a buffer-local
524option after opening the file, it won't be changed if you edit the same buffer
525in another window. But window-local options will be set.
526
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527 *modeline-version*
528If the modeline is only to be used for some versions of Vim, the version
529number can be specified where "vim:" is used:
530 vim{vers}: version {vers} or later
531 vim<{vers}: version before {vers}
532 vim={vers}: version {vers}
533 vim>{vers}: version after {vers}
534{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000535For example, to use a modeline only for Vim 6.0 and later:
536 /* vim600: set foldmethod=marker: */ ~
537To use a modeline for Vim before version 5.7:
538 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539There can be no blanks between "vim" and the ":".
540
541
542The number of lines that are checked can be set with the 'modelines' option.
543If 'modeline' is off or 'modelines' is 0 no lines are checked.
544
545Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000546like:
547 /* vi:ts=4: */ ~
548will give an error message for the trailing "*/". This line is OK:
549 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
551If an error is detected the rest of the line is skipped.
552
553If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000554backslash in front of the ':' will be removed. Example:
555 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556This sets the 'dir' option to "c:\tmp". Only a single backslash before the
557':' is removed. Thus to include "\:" you have to specify "\\:".
558
559No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000560might create a Trojan horse text file with modelines). And not all options
561can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000562|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000563causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
564are wrapped unexpectedly. So disable modelines before editing untrusted text.
565The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566
567Hint: If you would like to do something else than setting an option, you could
568define an autocommand that checks the file for a specific string. For
569example: >
570 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
571And define a function SetVar() that does something with the line containing
572"VAR".
573
574==============================================================================
5753. Options summary *option-summary*
576
577In the list below all the options are mentioned with their full name and with
578an abbreviation if there is one. Both forms may be used.
579
580In this document when a boolean option is "set" that means that ":set option"
581is entered. When an option is "reset", ":set nooption" is used.
582
583For some options there are two default values: The "Vim default", which is
584used when 'compatible' is not set, and the "Vi default", which is used when
585'compatible' is set.
586
587Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000588are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589different value in each window. For example the 'list' option can be set in
590one window and reset in another for the same text, giving both types of view
591at the same time. There are a few options that are specific to a certain
592file. These can have a different value for each file or buffer. For example
593the 'textwidth' option can be 78 for a normal text file and 0 for a C
594program.
595
596 global one option for all buffers and windows
597 local to window each window has its own copy of this option
598 local to buffer each buffer has its own copy of this option
599
600When creating a new window the option values from the currently active window
601are used as a default value for the window-specific options. For the
602buffer-specific options this depends on the 's' and 'S' flags in the
603'cpoptions' option. If 's' is included (which is the default) the values for
604buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000605first entered. If 'S' is present the options are copied each time the buffer
606is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607present, the options are copied from the currently active buffer when the
608buffer is created.
609
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000610Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000612Not all options are supported in all versions. This depends on the supported
613features and sometimes on the system. A remark about this is in curly braces
614below. When an option is not supported it may still be set without getting an
615error, this is called a hidden option. You can't get the value of a hidden
616option though, it is not stored.
617
618To test if option "foo" can be used with ":set" use something like this: >
619 if exists('&foo')
620This also returns true for a hidden option. To test if option "foo" is really
621supported use something like this: >
622 if exists('+foo')
623<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 *E355*
625A jump table for the options with a short description can be found at |Q_op|.
626
627 *'aleph'* *'al'* *aleph* *Aleph*
628'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 The ASCII code for the first letter of the Hebrew alphabet. The
634 routine that maps the keyboard in Hebrew mode, both in Insert mode
635 (when hkmap is set) and on the command-line (when hitting CTRL-_)
636 outputs the Hebrew characters in the range [aleph..aleph+26].
637 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
638 See |rileft.txt|.
639
640 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
641'allowrevins' 'ari' boolean (default off)
642 global
643 {not in Vi}
644 {only available when compiled with the |+rightleft|
645 feature}
646 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
647 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
648 into reverse Insert mode, and don't know how to get out. See
649 'revins'.
650 NOTE: This option is reset when 'compatible' is set.
651
652 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
653'altkeymap' 'akm' boolean (default off)
654 global
655 {not in Vi}
656 {only available when compiled with the |+farsi|
657 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000658 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659 the keyboard map between Farsi and English, when 'allowrevins' set.
660
Bram Moolenaar582fd852005-03-28 20:58:01 +0000661 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 is useful to start the Vim in native mode i.e. English (left-to-right
663 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000664 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665
666 *'ambiwidth'* *'ambw'*
667'ambiwidth' 'ambw' string (default: "single")
668 global
669 {not in Vi}
670 {only available when compiled with the |+multi_byte|
671 feature}
672 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
673 Tells Vim what to do with characters with East Asian Width Class
674 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
675 letters, Cyrillic letters).
676
677 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000678 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 expected by most users.
680 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200681 *E834* *E835*
682 The value "double" cannot be used if 'listchars' or 'fillchars'
683 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684
685 There are a number of CJK fonts for which the width of glyphs for
686 those characters are solely based on how many octets they take in
687 legacy/traditional CJK encodings. In those encodings, Euro,
688 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000689 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000691 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 Vim is running inside a terminal (emulators) that uses a CJK font
693 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
694 this option should be set to "double" to match the width perceived
695 by Vim with the width of glyphs in the font. Perhaps it also has
696 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
697 when the system locale is set to one of CJK locales. See Unicode
698 Standard Annex #11 (http://www.unicode.org/reports/tr11).
699
700 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
701'antialias' 'anti' boolean (default: off)
702 global
703 {not in Vi}
704 {only available when compiled with GUI enabled
705 on Mac OS X}
706 This option only has an effect in the GUI version of Vim on Mac OS X
707 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
708 which can be easier to read at certain sizes on certain displays.
709 Setting this option can sometimes cause problems if 'guifont' is set
710 to its default (empty string).
711
712 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
713'autochdir' 'acd' boolean (default off)
714 global
715 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200716 {only available when compiled with it, use
717 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000718 When on, Vim will change the current working directory whenever you
719 open a file, switch buffers, delete a buffer or open/close a window.
720 It will change to the directory containing the file which was opened
721 or selected.
722 This option is provided for backward compatibility with the Vim
723 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000724 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725
726 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
727'arabic' 'arab' boolean (default off)
728 local to window
729 {not in Vi}
730 {only available when compiled with the |+arabic|
731 feature}
732 This option can be set to start editing Arabic text.
733 Setting this option will:
734 - Set the 'rightleft' option, unless 'termbidi' is set.
735 - Set the 'arabicshape' option, unless 'termbidi' is set.
736 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
737 between typing English and Arabic key mapping.
738 - Set the 'delcombine' option
739 Note that 'encoding' must be "utf-8" for working with Arabic text.
740
741 Resetting this option will:
742 - Reset the 'rightleft' option.
743 - Disable the use of 'keymap' (without changing its value).
744 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
745 option.
746 Also see |arabic.txt|.
747
748 *'arabicshape'* *'arshape'*
749 *'noarabicshape'* *'noarshape'*
750'arabicshape' 'arshape' boolean (default on)
751 global
752 {not in Vi}
753 {only available when compiled with the |+arabic|
754 feature}
755 When on and 'termbidi' is off, the required visual character
756 corrections that need to take place for displaying the Arabic language
757 take affect. Shaping, in essence, gets enabled; the term is a broad
758 one which encompasses:
759 a) the changing/morphing of characters based on their location
760 within a word (initial, medial, final and stand-alone).
761 b) the enabling of the ability to compose characters
762 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100763 When disabled the display shows each character's true stand-alone
764 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 Arabic is a complex language which requires other settings, for
766 further details see |arabic.txt|.
767
768 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
769'autoindent' 'ai' boolean (default off)
770 local to buffer
771 Copy indent from current line when starting a new line (typing <CR>
772 in Insert mode or when using the "o" or "O" command). If you do not
773 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000774 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
775 to another line has the same effect, unless the 'I' flag is included
776 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000777 When autoindent is on, formatting (with the "gq" command or when you
778 reach 'textwidth' in Insert mode) uses the indentation of the first
779 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 When 'smartindent' or 'cindent' is on the indent is changed in
781 a different way.
782 The 'autoindent' option is reset when the 'paste' option is set.
783 {small difference from Vi: After the indent is deleted when typing
784 <Esc> or <CR>, the cursor position when moving up or down is after the
785 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
786
787 *'autoread'* *'ar'* *'noautoread'* *'noar'*
788'autoread' 'ar' boolean (default off)
789 global or local to buffer |global-local|
790 {not in Vi}
791 When a file has been detected to have been changed outside of Vim and
792 it has not been changed inside of Vim, automatically read it again.
793 When the file has been deleted this is not done. |timestamp|
794 If this option has a local value, use this command to switch back to
795 using the global value: >
796 :set autoread<
797<
798 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
799'autowrite' 'aw' boolean (default off)
800 global
801 Write the contents of the file, if it has been modified, on each
802 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000803 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
805 Note that for some commands the 'autowrite' option is not used, see
806 'autowriteall' for that.
807
808 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
809'autowriteall' 'awa' boolean (default off)
810 global
811 {not in Vi}
812 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
813 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
814 Setting this option also implies that Vim behaves like 'autowrite' has
815 been set.
816
817 *'background'* *'bg'*
818'background' 'bg' string (default "dark" or "light")
819 global
820 {not in Vi}
821 When set to "dark", Vim will try to use colors that look good on a
822 dark background. When set to "light", Vim will try to use colors that
823 look good on a light background. Any other value is illegal.
824 Vim tries to set the default value according to the terminal used.
825 This will not always be correct.
826 Setting this option does not change the background color, it tells Vim
827 what the background color looks like. For changing the background
828 color, see |:hi-normal|.
829
830 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000831 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000832 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100833 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834 setting 'background' will cause the color scheme to be reloaded. If
835 the color scheme adjusts to the value of 'background' this will work.
836 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100837 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838
839 When setting 'background' to the default value with: >
840 :set background&
841< Vim will guess the value. In the GUI this should work correctly,
842 in other cases Vim might not be able to guess the right value.
843
844 When starting the GUI, the default value for 'background' will be
845 "light". When the value is not set in the .gvimrc, and Vim detects
846 that the background is actually quite dark, 'background' is set to
847 "dark". But this happens only AFTER the .gvimrc file has been read
848 (because the window needs to be opened to find the actual background
849 color). To get around this, force the GUI window to be opened by
850 putting a ":gui" command in the .gvimrc file, before where the value
851 of 'background' is used (e.g., before ":syntax on").
852 Normally this option would be set in the .vimrc file. Possibly
853 depending on the terminal name. Example: >
854 :if &term == "pcterm"
855 : set background=dark
856 :endif
857< When this option is set, the default settings for the highlight groups
858 will change. To use other settings, place ":highlight" commands AFTER
859 the setting of the 'background' option.
860 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
861 to select the colors for syntax highlighting. After changing this
862 option, you must load syntax.vim again to see the result. This can be
863 done with ":syntax on".
864
865 *'backspace'* *'bs'*
866'backspace' 'bs' string (default "")
867 global
868 {not in Vi}
869 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
870 mode. This is a list of items, separated by commas. Each item allows
871 a way to backspace over something:
872 value effect ~
873 indent allow backspacing over autoindent
874 eol allow backspacing over line breaks (join lines)
875 start allow backspacing over the start of insert; CTRL-W and CTRL-U
876 stop once at the start of insert.
877
878 When the value is empty, Vi compatible backspacing is used.
879
880 For backwards compatibility with version 5.4 and earlier:
881 value effect ~
882 0 same as ":set backspace=" (Vi compatible)
883 1 same as ":set backspace=indent,eol"
884 2 same as ":set backspace=indent,eol,start"
885
886 See |:fixdel| if your <BS> or <Del> key does not do what you want.
887 NOTE: This option is set to "" when 'compatible' is set.
888
889 *'backup'* *'bk'* *'nobackup'* *'nobk'*
890'backup' 'bk' boolean (default off)
891 global
892 {not in Vi}
893 Make a backup before overwriting a file. Leave it around after the
894 file has been successfully written. If you do not want to keep the
895 backup file, but you do want a backup while the file is being
896 written, reset this option and set the 'writebackup' option (this is
897 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000898 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 |backup-table| for more explanations.
900 When the 'backupskip' pattern matches, a backup is not made anyway.
901 When 'patchmode' is set, the backup may be renamed to become the
902 oldest version of a file.
903 NOTE: This option is reset when 'compatible' is set.
904
905 *'backupcopy'* *'bkc'*
906'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
907 global
908 {not in Vi}
909 When writing a file and a backup is made, this option tells how it's
910 done. This is a comma separated list of words.
911
912 The main values are:
913 "yes" make a copy of the file and overwrite the original one
914 "no" rename the file and write a new one
915 "auto" one of the previous, what works best
916
917 Extra values that can be combined with the ones above are:
918 "breaksymlink" always break symlinks when writing
919 "breakhardlink" always break hardlinks when writing
920
921 Making a copy and overwriting the original file:
922 - Takes extra time to copy the file.
923 + When the file has special attributes, is a (hard/symbolic) link or
924 has a resource fork, all this is preserved.
925 - When the file is a link the backup will have the name of the link,
926 not of the real file.
927
928 Renaming the file and writing a new one:
929 + It's fast.
930 - Sometimes not all attributes of the file can be copied to the new
931 file.
932 - When the file is a link the new file will not be a link.
933
934 The "auto" value is the middle way: When Vim sees that renaming file
935 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000936 the file is not a link) that is used. When problems are expected, a
937 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000938
939 The "breaksymlink" and "breakhardlink" values can be used in
940 combination with any of "yes", "no" and "auto". When included, they
941 force Vim to always break either symbolic or hard links by doing
942 exactly what the "no" option does, renaming the original file to
943 become the backup and writing a new file in its place. This can be
944 useful for example in source trees where all the files are symbolic or
945 hard links and any changes should stay in the local source tree, not
946 be propagated back to the original source.
947 *crontab*
948 One situation where "no" and "auto" will cause problems: A program
949 that opens a file, invokes Vim to edit that file, and then tests if
950 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000951 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952 example.
953
954 When a copy is made, the original file is truncated and then filled
955 with the new text. This means that protection bits, owner and
956 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000957 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958 group of the backup is set to the group of the original file. If this
959 fails, the protection bits for the group are made the same as for
960 others.
961
962 When the file is renamed this is the other way around: The backup has
963 the same attributes of the original file, and the newly written file
964 is owned by the current user. When the file was a (hard/symbolic)
965 link, the new file will not! That's why the "auto" value doesn't
966 rename when the file is a link. The owner and group of the newly
967 written file will be set to the same ones as the original file, but
968 the system may refuse to do this. In that case the "auto" value will
969 again not rename the file.
970
971 *'backupdir'* *'bdir'*
972'backupdir' 'bdir' string (default for Amiga: ".,t:",
973 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
974 for Unix: ".,~/tmp,~/")
975 global
976 {not in Vi}
977 List of directories for the backup file, separated with commas.
978 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100979 where this is possible. The directory must exist, Vim will not
980 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981 - Empty means that no backup file will be created ('patchmode' is
982 impossible!). Writing may fail because of this.
983 - A directory "." means to put the backup file in the same directory
984 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000985 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 put the backup file relative to where the edited file is. The
987 leading "." is replaced with the path name of the edited file.
988 ("." inside a directory name has no special meaning).
989 - Spaces after the comma are ignored, other spaces are considered part
990 of the directory name. To have a space at the start of a directory
991 name, precede it with a backslash.
992 - To include a comma in a directory name precede it with a backslash.
993 - A directory name may end in an '/'.
994 - Environment variables are expanded |:set_env|.
995 - Careful with '\' characters, type one before a space, type two to
996 get one in the option (see |option-backslash|), for example: >
997 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
998< - For backwards compatibility with Vim version 3.0 a '>' at the start
999 of the option is removed.
1000 See also 'backup' and 'writebackup' options.
1001 If you want to hide your backup files on Unix, consider this value: >
1002 :set backupdir=./.backup,~/.backup,.,/tmp
1003< You must create a ".backup" directory in each directory and in your
1004 home directory for this to work properly.
1005 The use of |:set+=| and |:set-=| is preferred when adding or removing
1006 directories from the list. This avoids problems when a future version
1007 uses another default.
1008 This option cannot be set from a |modeline| or in the |sandbox|, for
1009 security reasons.
1010
1011 *'backupext'* *'bex'* *E589*
1012'backupext' 'bex' string (default "~", for VMS: "_")
1013 global
1014 {not in Vi}
1015 String which is appended to a file name to make the name of the
1016 backup file. The default is quite unusual, because this avoids
1017 accidentally overwriting existing files with a backup file. You might
1018 prefer using ".bak", but make sure that you don't have files with
1019 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001020 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001022 If you like to keep a lot of backups, you could use a BufWritePre
1023 autocommand to change 'backupext' just before writing the file to
1024 include a timestamp. >
1025 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1026< Use 'backupdir' to put the backup in a different directory.
1027
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 *'backupskip'* *'bsk'*
1029'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1030 global
1031 {not in Vi}
1032 {not available when compiled without the |+wildignore|
1033 feature}
1034 A list of file patterns. When one of the patterns matches with the
1035 name of the file which is written, no backup file is created. Both
1036 the specified file name and the full path name of the file are used.
1037 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1038 Watch out for special characters, see |option-backslash|.
1039 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001040 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001041
1042 Note that environment variables are not expanded. If you want to use
1043 $HOME you must expand it explicitly, e.g.: >
1044 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1045
1046< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001047 backup would be made by renaming the original file crontab won't see
1048 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049
1050 *'balloondelay'* *'bdlay'*
1051'balloondelay' 'bdlay' number (default: 600)
1052 global
1053 {not in Vi}
1054 {only available when compiled with the |+balloon_eval|
1055 feature}
1056 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1057
1058 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1059'ballooneval' 'beval' boolean (default off)
1060 global
1061 {not in Vi}
1062 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001063 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 Switch on the |balloon-eval| functionality.
1065
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001066 *'balloonexpr'* *'bexpr'*
1067'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001068 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001069 {not in Vi}
1070 {only available when compiled with the |+balloon_eval|
1071 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001072 Expression for text to show in evaluation balloon. It is only used
1073 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001074
1075 v:beval_bufnr number of the buffer in which balloon is going to show
1076 v:beval_winnr number of the window
1077 v:beval_lnum line number
1078 v:beval_col column number (byte index)
1079 v:beval_text word under or after the mouse pointer
1080
1081 The evaluation of the expression must not have side effects!
1082 Example: >
1083 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001084 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001085 \', column ' . v:beval_col .
1086 \ ' of file ' . bufname(v:beval_bufnr) .
1087 \ ' on word "' . v:beval_text . '"'
1088 endfunction
1089 set bexpr=MyBalloonExpr()
1090 set ballooneval
1091<
1092 NOTE: The balloon is displayed only if the cursor is on a text
1093 character. If the result of evaluating 'balloonexpr' is not empty,
1094 Vim does not try to send a message to an external debugger (Netbeans
1095 or Sun Workshop).
1096
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001097 The expression may be evaluated in the |sandbox|, see
1098 |sandbox-option|.
1099
1100 It is not allowed to change text or jump to another window while
1101 evaluating 'balloonexpr' |textlock|.
1102
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001103 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001104 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001105< When they are supported "\n" characters will start a new line. If the
1106 expression evaluates to a |List| this is equal to using each List item
1107 as a string and putting "\n" in between them.
1108
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1110'binary' 'bin' boolean (default off)
1111 local to buffer
1112 {not in Vi}
1113 This option should be set before editing a binary file. You can also
1114 use the |-b| Vim argument. When this option is switched on a few
1115 options will be changed (also when it already was on):
1116 'textwidth' will be set to 0
1117 'wrapmargin' will be set to 0
1118 'modeline' will be off
1119 'expandtab' will be off
1120 Also, 'fileformat' and 'fileformats' options will not be used, the
1121 file is read and written like 'fileformat' was "unix" (a single <NL>
1122 separates lines).
1123 The 'fileencoding' and 'fileencodings' options will not be used, the
1124 file is read without conversion.
1125 NOTE: When you start editing a(nother) file while the 'bin' option is
1126 on, settings from autocommands may change the settings again (e.g.,
1127 'textwidth'), causing trouble when editing. You might want to set
1128 'bin' again when the file has been loaded.
1129 The previous values of these options are remembered and restored when
1130 'bin' is switched from on to off. Each buffer has its own set of
1131 saved option values.
1132 To edit a file with 'binary' set you can use the |++bin| argument.
1133 This avoids you have to do ":set bin", which would have effect for all
1134 files you edit.
1135 When writing a file the <EOL> for the last line is only written if
1136 there was one in the original file (normally Vim appends an <EOL> to
1137 the last line if there is none; this would make the file longer). See
1138 the 'endofline' option.
1139
1140 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1141'bioskey' 'biosk' boolean (default on)
1142 global
1143 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001144 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145 better to detect CTRL-C, but only works for the console. When using a
1146 terminal over a serial port reset this option.
1147 Also see |'conskey'|.
1148
1149 *'bomb'* *'nobomb'*
1150'bomb' boolean (default off)
1151 local to buffer
1152 {not in Vi}
1153 {only available when compiled with the |+multi_byte|
1154 feature}
1155 When writing a file and the following conditions are met, a BOM (Byte
1156 Order Mark) is prepended to the file:
1157 - this option is on
1158 - the 'binary' option is off
1159 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1160 endian variants.
1161 Some applications use the BOM to recognize the encoding of the file.
1162 Often used for UCS-2 files on MS-Windows. For other applications it
1163 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001164 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1166 check for the presence of the BOM is done and 'bomb' set accordingly.
1167 Unless 'binary' is set, it is removed from the first line, so that you
1168 don't see it when editing. When you don't change the options, the BOM
1169 will be restored when writing the file.
1170
1171 *'breakat'* *'brk'*
1172'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1173 global
1174 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001175 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 feature}
1177 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001178 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1179 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180
1181 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001182'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001184 {not in Vi} {only for Motif, Athena, GTK, Mac and
1185 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001187 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001188 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189 buffer Use the directory of the related buffer.
1190 current Use the current directory.
1191 {path} Use the specified directory
1192
1193 *'bufhidden'* *'bh'*
1194'bufhidden' 'bh' string (default: "")
1195 local to buffer
1196 {not in Vi}
1197 {not available when compiled without the |+quickfix|
1198 feature}
1199 This option specifies what happens when a buffer is no longer
1200 displayed in a window:
1201 <empty> follow the global 'hidden' option
1202 hide hide the buffer (don't unload it), also when 'hidden'
1203 is not set
1204 unload unload the buffer, also when 'hidden' is set or using
1205 |:hide|
1206 delete delete the buffer from the buffer list, also when
1207 'hidden' is set or using |:hide|, like using
1208 |:bdelete|
1209 wipe wipe out the buffer from the buffer list, also when
1210 'hidden' is set or using |:hide|, like using
1211 |:bwipeout|
1212
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001213 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1214 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 This option is used together with 'buftype' and 'swapfile' to specify
1216 special kinds of buffers. See |special-buffers|.
1217
1218 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1219'buflisted' 'bl' boolean (default: on)
1220 local to buffer
1221 {not in Vi}
1222 When this option is set, the buffer shows up in the buffer list. If
1223 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1224 This option is reset by Vim for buffers that are only used to remember
1225 a file name or marks. Vim sets it when starting to edit a buffer.
1226 But not when moving to a buffer with ":buffer".
1227
1228 *'buftype'* *'bt'* *E382*
1229'buftype' 'bt' string (default: "")
1230 local to buffer
1231 {not in Vi}
1232 {not available when compiled without the |+quickfix|
1233 feature}
1234 The value of this option specifies the type of a buffer:
1235 <empty> normal buffer
1236 nofile buffer which is not related to a file and will not be
1237 written
1238 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001239 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001240 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001241 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001243 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 help help buffer (you are not supposed to set this
1245 manually)
1246
1247 This option is used together with 'bufhidden' and 'swapfile' to
1248 specify special kinds of buffers. See |special-buffers|.
1249
1250 Be careful with changing this option, it can have many side effects!
1251
Bram Moolenaar280f1262006-01-30 00:14:18 +00001252 A "quickfix" buffer is only used for the error list and the location
1253 list. This value is set by the |:cwindow| and |:lwindow| commands and
1254 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255
1256 "nofile" and "nowrite" buffers are similar:
1257 both: The buffer is not to be written to disk, ":w" doesn't
1258 work (":w filename" does work though).
1259 both: The buffer is never considered to be |'modified'|.
1260 There is no warning when the changes will be lost, for
1261 example when you quit Vim.
1262 both: A swap file is only created when using too much memory
1263 (when 'swapfile' has been reset there is never a swap
1264 file).
1265 nofile only: The buffer name is fixed, it is not handled like a
1266 file name. It is not modified in response to a |:cd|
1267 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001268 *E676*
1269 "acwrite" implies that the buffer name is not related to a file, like
1270 "nofile", but it will be written. Thus, in contrast to "nofile" and
1271 "nowrite", ":w" does work and a modified buffer can't be abandoned
1272 without saving. For writing there must be matching |BufWriteCmd|,
1273 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274
1275 *'casemap'* *'cmp'*
1276'casemap' 'cmp' string (default: "internal,keepascii")
1277 global
1278 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001279 {only available when compiled with the |+multi_byte|
1280 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281 Specifies details about changing the case of letters. It may contain
1282 these words, separated by a comma:
1283 internal Use internal case mapping functions, the current
1284 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001285 matters when 'encoding' is a Unicode encoding,
1286 "latin1" or "iso-8859-15". When "internal" is
1287 omitted, the towupper() and towlower() system library
1288 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1290 case mapping, the current locale is not effective.
1291 This probably only matters for Turkish.
1292
1293 *'cdpath'* *'cd'* *E344* *E346*
1294'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1295 global
1296 {not in Vi}
1297 {not available when compiled without the
1298 |+file_in_path| feature}
1299 This is a list of directories which will be searched when using the
1300 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001301 for has a relative path, not an absolute part starting with "/", "./"
1302 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 The 'cdpath' option's value has the same form and semantics as
1304 |'path'|. Also see |file-searching|.
1305 The default value is taken from $CDPATH, with a "," prepended to look
1306 in the current directory first.
1307 If the default value taken from $CDPATH is not what you want, include
1308 a modified version of the following command in your vimrc file to
1309 override it: >
1310 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1311< This option cannot be set from a |modeline| or in the |sandbox|, for
1312 security reasons.
1313 (parts of 'cdpath' can be passed to the shell to expand file names).
1314
1315 *'cedit'*
1316'cedit' string (Vi default: "", Vim default: CTRL-F)
1317 global
1318 {not in Vi}
1319 {not available when compiled without the |+vertsplit|
1320 feature}
1321 The key used in Command-line Mode to open the command-line window.
1322 The default is CTRL-F when 'compatible' is off.
1323 Only non-printable keys are allowed.
1324 The key can be specified as a single character, but it is difficult to
1325 type. The preferred way is to use the <> notation. Examples: >
1326 :set cedit=<C-Y>
1327 :set cedit=<Esc>
1328< |Nvi| also has this option, but it only uses the first character.
1329 See |cmdwin|.
1330
1331 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1332'charconvert' 'ccv' string (default "")
1333 global
1334 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001335 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 {not in Vi}
1337 An expression that is used for character encoding conversion. It is
1338 evaluated when a file that is to be read or has been written has a
1339 different encoding from what is desired.
1340 'charconvert' is not used when the internal iconv() function is
1341 supported and is able to do the conversion. Using iconv() is
1342 preferred, because it is much faster.
1343 'charconvert' is not used when reading stdin |--|, because there is no
1344 file to convert from. You will have to save the text in a file first.
1345 The expression must return zero or an empty string for success,
1346 non-zero for failure.
1347 The possible encoding names encountered are in 'encoding'.
1348 Additionally, names given in 'fileencodings' and 'fileencoding' are
1349 used.
1350 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1351 is done internally by Vim, 'charconvert' is not used for this.
1352 'charconvert' is also used to convert the viminfo file, if the 'c'
1353 flag is present in 'viminfo'. Also used for Unicode conversion.
1354 Example: >
1355 set charconvert=CharConvert()
1356 fun CharConvert()
1357 system("recode "
1358 \ . v:charconvert_from . ".." . v:charconvert_to
1359 \ . " <" . v:fname_in . " >" v:fname_out)
1360 return v:shell_error
1361 endfun
1362< The related Vim variables are:
1363 v:charconvert_from name of the current encoding
1364 v:charconvert_to name of the desired encoding
1365 v:fname_in name of the input file
1366 v:fname_out name of the output file
1367 Note that v:fname_in and v:fname_out will never be the same.
1368 Note that v:charconvert_from and v:charconvert_to may be different
1369 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1370 Encryption is not done by Vim when using 'charconvert'. If you want
1371 to encrypt the file after conversion, 'charconvert' should take care
1372 of this.
1373 This option cannot be set from a |modeline| or in the |sandbox|, for
1374 security reasons.
1375
1376 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1377'cindent' 'cin' boolean (default off)
1378 local to buffer
1379 {not in Vi}
1380 {not available when compiled without the |+cindent|
1381 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001382 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383 that trigger reindenting in insert mode and 'cinoptions' to set your
1384 preferred indent style.
1385 If 'indentexpr' is not empty, it overrules 'cindent'.
1386 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1387 the "=" operator indents using this algorithm rather than calling an
1388 external program.
1389 See |C-indenting|.
1390 When you don't like the way 'cindent' works, try the 'smartindent'
1391 option or 'indentexpr'.
1392 This option is not used when 'paste' is set.
1393 NOTE: This option is reset when 'compatible' is set.
1394
1395 *'cinkeys'* *'cink'*
1396'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1397 local to buffer
1398 {not in Vi}
1399 {not available when compiled without the |+cindent|
1400 feature}
1401 A list of keys that, when typed in Insert mode, cause reindenting of
1402 the current line. Only used if 'cindent' is on and 'indentexpr' is
1403 empty.
1404 For the format of this option see |cinkeys-format|.
1405 See |C-indenting|.
1406
1407 *'cinoptions'* *'cino'*
1408'cinoptions' 'cino' string (default "")
1409 local to buffer
1410 {not in Vi}
1411 {not available when compiled without the |+cindent|
1412 feature}
1413 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1414 program. See |cinoptions-values| for the values of this option, and
1415 |C-indenting| for info on C indenting in general.
1416
1417
1418 *'cinwords'* *'cinw'*
1419'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1420 local to buffer
1421 {not in Vi}
1422 {not available when compiled without both the
1423 |+cindent| and the |+smartindent| features}
1424 These keywords start an extra indent in the next line when
1425 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1426 an appropriate place (inside {}).
1427 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1428 matter, include the keyword both the uppercase and lowercase:
1429 "if,If,IF".
1430
1431 *'clipboard'* *'cb'*
1432'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1433 for X-windows, "" otherwise)
1434 global
1435 {not in Vi}
1436 {only in GUI versions or when the |+xterm_clipboard|
1437 feature is included}
1438 This option is a list of comma separated names.
1439 These names are recognized:
1440
1441 unnamed When included, Vim will use the clipboard register '*'
1442 for all yank, delete, change and put operations which
1443 would normally go to the unnamed register. When a
1444 register is explicitly specified, it will always be
1445 used regardless of whether "unnamed" is in 'clipboard'
1446 or not. The clipboard register can always be
1447 explicitly accessed using the "* notation. Also see
1448 |gui-clipboard|.
1449
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001450 unnamedplus A variant of "unnamed" flag which uses the clipboard
1451 register '+' (|quoteplus|) instead of register '*' for
1452 all operations except yank. Yank shall copy the text
1453 into register '+' and also into '*' when "unnamed" is
1454 included.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001455 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001456 Availability can be checked with: >
1457 if has('unnamedplus')
1458<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459 autoselect Works like the 'a' flag in 'guioptions': If present,
1460 then whenever Visual mode is started, or the Visual
1461 area extended, Vim tries to become the owner of the
1462 windowing system's global selection or put the
1463 selected text on the clipboard used by the selection
1464 register "*. See |guioptions_a| and |quotestar| for
1465 details. When the GUI is active, the 'a' flag in
1466 'guioptions' is used, when the GUI is not active, this
1467 "autoselect" flag is used.
1468 Also applies to the modeless selection.
1469
1470 autoselectml Like "autoselect", but for the modeless selection
1471 only. Compare to the 'A' flag in 'guioptions'.
1472
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001473 html When the clipboard contains HTML, use this when
1474 pasting. When putting text on the clipboard, mark it
1475 as HTML. This works to copy rendered HTML from
1476 Firefox, paste it as raw HTML in Vim, select the HTML
1477 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001478 You probably want to add this only temporarily,
1479 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001480 Only supported for GTK version 2 and later.
1481 Only available with the |+multi_byte| feature.
1482
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483 exclude:{pattern}
1484 Defines a pattern that is matched against the name of
1485 the terminal 'term'. If there is a match, no
1486 connection will be made to the X server. This is
1487 useful in this situation:
1488 - Running Vim in a console.
1489 - $DISPLAY is set to start applications on another
1490 display.
1491 - You do not want to connect to the X server in the
1492 console, but do want this in a terminal emulator.
1493 To never connect to the X server use: >
1494 exclude:.*
1495< This has the same effect as using the |-X| argument.
1496 Note that when there is no connection to the X server
1497 the window title won't be restored and the clipboard
1498 cannot be accessed.
1499 The value of 'magic' is ignored, {pattern} is
1500 interpreted as if 'magic' was on.
1501 The rest of the option value will be used for
1502 {pattern}, this must be the last entry.
1503
1504 *'cmdheight'* *'ch'*
1505'cmdheight' 'ch' number (default 1)
1506 global
1507 {not in Vi}
1508 Number of screen lines to use for the command-line. Helps avoiding
1509 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001510 The value of this option is stored with the tab page, so that each tab
1511 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001512
1513 *'cmdwinheight'* *'cwh'*
1514'cmdwinheight' 'cwh' number (default 7)
1515 global
1516 {not in Vi}
1517 {not available when compiled without the |+vertsplit|
1518 feature}
1519 Number of screen lines to use for the command-line window. |cmdwin|
1520
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001521 *'colorcolumn'* *'cc'*
1522'colorcolumn' 'cc' string (default "")
1523 local to window
1524 {not in Vi}
1525 {not available when compiled without the |+syntax|
1526 feature}
1527 'colorcolumn' is a comma separated list of screen columns that are
1528 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1529 text. Will make screen redrawing slower.
1530 The screen column can be an absolute number, or a number preceded with
1531 '+' or '-', which is added to or subtracted from 'textwidth'. >
1532
1533 :set cc=+1 " highlight column after 'textwidth'
1534 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1535 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1536<
1537 When 'textwidth' is zero then the items with '-' and '+' are not used.
1538 A maximum of 256 columns are highlighted.
1539
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 *'columns'* *'co'* *E594*
1541'columns' 'co' number (default 80 or terminal width)
1542 global
1543 {not in Vi}
1544 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001545 initialization and does not have to be set by hand. Also see
1546 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 When Vim is running in the GUI or in a resizable window, setting this
1548 option will cause the window size to be changed. When you only want
1549 to use the size for the GUI, put the command in your |gvimrc| file.
1550 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001551 number of columns of the display, the display may be messed up. For
1552 the GUI it is always possible and Vim limits the number of columns to
1553 what fits on the screen. You can use this command to get the widest
1554 window possible: >
1555 :set columns=9999
1556< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557
1558 *'comments'* *'com'* *E524* *E525*
1559'comments' 'com' string (default
1560 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1561 local to buffer
1562 {not in Vi}
1563 {not available when compiled without the |+comments|
1564 feature}
1565 A comma separated list of strings that can start a comment line. See
1566 |format-comments|. See |option-backslash| about using backslashes to
1567 insert a space.
1568
1569 *'commentstring'* *'cms'* *E537*
1570'commentstring' 'cms' string (default "/*%s*/")
1571 local to buffer
1572 {not in Vi}
1573 {not available when compiled without the |+folding|
1574 feature}
1575 A template for a comment. The "%s" in the value is replaced with the
1576 comment text. Currently only used to add markers for folding, see
1577 |fold-marker|.
1578
1579 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001580'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1581 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 global
1583 {not in Vi}
1584 This option has the effect of making Vim either more Vi-compatible, or
1585 make Vim behave in a more useful way.
1586 This is a special kind of option, because when it's set or reset,
1587 other options are also changed as a side effect. CAREFUL: Setting or
1588 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001589 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 set this option in your vimrc file, you should probably put it at the
1591 very start.
1592 By default this option is on and the Vi defaults are used for the
1593 options. This default was chosen for those people who want to use Vim
1594 just like Vi, and don't even (want to) know about the 'compatible'
1595 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001596 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001597 this option is switched off, and all options that have not been
1598 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001599 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001600 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001601 happen for the system-wide vimrc or gvimrc file, nor for a file given
1602 with the |-u| argument). Also see |compatible-default| and
1603 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604 You can also set this option with the "-C" argument, and reset it with
1605 "-N". See |-C| and |-N|.
1606 Switching this option off makes the Vim defaults be used for options
1607 that have a different Vi and Vim default value. See the options
1608 marked with a '+' below. Other options are not modified.
1609 At the moment this option is set, several other options will be set
1610 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001611 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 editing.
1613 See also 'cpoptions'.
1614
1615 option + set value effect ~
1616
1617 'allowrevins' off no CTRL-_ command
1618 'backupcopy' Unix: "yes" backup file is a copy
1619 others: "auto" copy or rename backup file
1620 'backspace' "" normal backspace
1621 'backup' off no backup file
1622 'cindent' off no C code indentation
1623 'cedit' + "" no key to open the |cmdwin|
1624 'cpoptions' + (all flags) Vi-compatible flags
1625 'cscopetag' off don't use cscope for ":tag"
1626 'cscopetagorder' 0 see |cscopetagorder|
1627 'cscopeverbose' off see |cscopeverbose|
1628 'digraph' off no digraphs
1629 'esckeys' + off no <Esc>-keys in Insert mode
1630 'expandtab' off tabs not expanded to spaces
1631 'fileformats' + "" no automatic file format detection,
1632 "dos,unix" except for DOS, Windows and OS/2
1633 'formatoptions' + "vt" Vi compatible formatting
1634 'gdefault' off no default 'g' flag for ":s"
1635 'history' + 0 no commandline history
1636 'hkmap' off no Hebrew keyboard mapping
1637 'hkmapp' off no phonetic Hebrew keyboard mapping
1638 'hlsearch' off no highlighting of search matches
1639 'incsearch' off no incremental searching
1640 'indentexpr' "" no indenting by expression
1641 'insertmode' off do not start in Insert mode
1642 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1643 characters and '_'
1644 'joinspaces' on insert 2 spaces after period
1645 'modeline' + off no modelines
1646 'more' + off no pauses in listings
1647 'revins' off no reverse insert
1648 'ruler' off no ruler
1649 'scrolljump' 1 no jump scroll
1650 'scrolloff' 0 no scroll offset
1651 'shiftround' off indent not rounded to shiftwidth
1652 'shortmess' + "" no shortening of messages
1653 'showcmd' + off command characters not shown
1654 'showmode' + off current mode not shown
1655 'smartcase' off no automatic ignore case switch
1656 'smartindent' off no smart indentation
1657 'smarttab' off no smart tab size
1658 'softtabstop' 0 tabs are always 'tabstop' positions
1659 'startofline' on goto startofline with some commands
1660 'tagrelative' + off tag file names are not relative
1661 'textauto' + off no automatic textmode detection
1662 'textwidth' 0 no automatic line wrap
1663 'tildeop' off tilde is not an operator
1664 'ttimeout' off no terminal timeout
1665 'whichwrap' + "" left-right movements don't wrap
1666 'wildchar' + CTRL-E only when the current value is <Tab>
1667 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001668 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669
1670 *'complete'* *'cpt'* *E535*
1671'complete' 'cpt' string (default: ".,w,b,u,t,i")
1672 local to buffer
1673 {not in Vi}
1674 This option specifies how keyword completion |ins-completion| works
1675 when CTRL-P or CTRL-N are used. It is also used for whole-line
1676 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1677 and the places to scan. It is a comma separated list of flags:
1678 . scan the current buffer ('wrapscan' is ignored)
1679 w scan buffers from other windows
1680 b scan other loaded buffers that are in the buffer list
1681 u scan the unloaded buffers that are in the buffer list
1682 U scan the buffers that are not in the buffer list
1683 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001684 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685 k{dict} scan the file {dict}. Several "k" flags can be given,
1686 patterns are valid too. For example: >
1687 :set cpt=k/usr/dict/*,k~/spanish
1688< s scan the files given with the 'thesaurus' option
1689 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1690 are valid too.
1691 i scan current and included files
1692 d scan current and included files for defined name or macro
1693 |i_CTRL-X_CTRL-D|
1694 ] tag completion
1695 t same as "]"
1696
1697 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1698 not executed, this may lead to unexpected completions from some files
1699 (gzipped files for example). Unloaded buffers are not scanned for
1700 whole-line completion.
1701
1702 The default is ".,w,b,u,t,i", which means to scan:
1703 1. the current buffer
1704 2. buffers in other windows
1705 3. other loaded buffers
1706 4. unloaded buffers
1707 5. tags
1708 6. included files
1709
1710 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001711 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1712 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001714 *'completefunc'* *'cfu'*
1715'completefunc' 'cfu' string (default: empty)
1716 local to buffer
1717 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001718 {not available when compiled without the |+eval|
1719 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001720 This option specifies a function to be used for Insert mode completion
1721 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001722 See |complete-functions| for an explanation of how the function is
1723 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001724 This option cannot be set from a |modeline| or in the |sandbox|, for
1725 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001726
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001727 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001728'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001729 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001730 {not available when compiled without the
1731 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001732 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001733 A comma separated list of options for Insert mode completion
1734 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001735
1736 menu Use a popup menu to show the possible completions. The
1737 menu is only shown when there is more than one match and
1738 sufficient colors are available. |ins-completion-menu|
1739
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001740 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001741 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001742 match, e.g., what file it comes from.
1743
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001744 longest Only insert the longest common text of the matches. If
1745 the menu is displayed you can use CTRL-L to add more
1746 characters. Whether case is ignored depends on the kind
1747 of completion. For buffer text the 'ignorecase' option is
1748 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001749
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001750 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001751 completion in the preview window. Only works in
1752 combination with "menu" or "menuone".
1753
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001754
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001755 *'concealcursor'* *'cocu'*
1756'concealcursor' 'cocu' string (default: "")
1757 local to window
1758 {not in Vi}
1759 {not available when compiled without the |+conceal|
1760 feature}
1761 Sets the modes in which text in the cursor line can also be concealed.
1762 When the current mode is listed then concealing happens just like in
1763 other lines.
1764 n Normal mode
1765 v Visual mode
1766 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001767 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001768
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001769 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001770 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001771 are moving around text is concealed, but when starting to insert text
1772 or selecting a Visual area the concealed text is displayed, so that
1773 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001774 Keep in mind that the cursor position is not always where it's
1775 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001776
1777
1778'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001779 number (default 0)
1780 local to window
1781 {not in Vi}
1782 {not available when compiled without the |+conceal|
1783 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001784 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1785 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001786
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001787 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001788 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001789 1 Each block of concealed text is replaced with one
1790 character. If the syntax item does not have a custom
1791 replacement character defined (see |:syn-cchar|) the
1792 character defined in 'listchars' is used (default is a
1793 space).
1794 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001795 2 Concealed text is completely hidden unless it has a
1796 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001797 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001798 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001799
Bram Moolenaara7781e02010-07-19 20:13:22 +02001800 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001801 edit and copy the text. This can be changed with the 'concealcursor'
1802 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001803
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1805'confirm' 'cf' boolean (default off)
1806 global
1807 {not in Vi}
1808 When 'confirm' is on, certain operations that would normally
1809 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1810 instead raise a |dialog| asking if you wish to save the current
1811 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1812 If 'confirm' is off you can still activate confirmation for one
1813 command only (this is most useful in mappings) with the |:confirm|
1814 command.
1815 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1816
1817 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1818'conskey' 'consk' boolean (default off)
1819 global
1820 {not in Vi} {only for MS-DOS}
1821 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001822 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 three methods of console input are available:
1824 'conskey' 'bioskey' action ~
1825 on on or off direct console input
1826 off on BIOS
1827 off off STDIN
1828
1829 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1830'copyindent' 'ci' boolean (default off)
1831 local to buffer
1832 {not in Vi}
1833 Copy the structure of the existing lines indent when autoindenting a
1834 new line. Normally the new indent is reconstructed by a series of
1835 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1836 in which case only spaces are used). Enabling this option makes the
1837 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001838 existing line. 'expandtab' has no effect on these characters, a Tab
1839 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 line, the remaining space is filled in the normal manner.
1841 NOTE: 'copyindent' is reset when 'compatible' is set.
1842 Also see 'preserveindent'.
1843
1844 *'cpoptions'* *'cpo'*
1845'cpoptions' 'cpo' string (Vim default: "aABceFs",
1846 Vi default: all flags)
1847 global
1848 {not in Vi}
1849 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001850 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 not being vi-compatible is mostly or sometimes preferred.
1852 'cpoptions' stands for "compatible-options".
1853 Commas can be added for readability.
1854 To avoid problems with flags that are added in the future, use the
1855 "+=" and "-=" feature of ":set" |add-option-flags|.
1856 NOTE: This option is set to the Vi default value when 'compatible' is
1857 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001858 NOTE: This option is set to the POSIX default value at startup when
1859 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001860 variable exists |posix|. This means Vim tries to behave like the
1861 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862
1863 contains behavior ~
1864 *cpo-a*
1865 a When included, a ":read" command with a file name
1866 argument will set the alternate file name for the
1867 current window.
1868 *cpo-A*
1869 A When included, a ":write" command with a file name
1870 argument will set the alternate file name for the
1871 current window.
1872 *cpo-b*
1873 b "\|" in a ":map" command is recognized as the end of
1874 the map command. The '\' is included in the mapping,
1875 the text after the '|' is interpreted as the next
1876 command. Use a CTRL-V instead of a backslash to
1877 include the '|' in the mapping. Applies to all
1878 mapping, abbreviation, menu and autocmd commands.
1879 See also |map_bar|.
1880 *cpo-B*
1881 B A backslash has no special meaning in mappings,
1882 abbreviations and the "to" part of the menu commands.
1883 Remove this flag to be able to use a backslash like a
1884 CTRL-V. For example, the command ":map X \<Esc>"
1885 results in X being mapped to:
1886 'B' included: "\^[" (^[ is a real <Esc>)
1887 'B' excluded: "<Esc>" (5 characters)
1888 ('<' excluded in both cases)
1889 *cpo-c*
1890 c Searching continues at the end of any match at the
1891 cursor position, but not further than the start of the
1892 next line. When not present searching continues
1893 one character from the cursor position. With 'c'
1894 "abababababab" only gets three matches when repeating
1895 "/abab", without 'c' there are five matches.
1896 *cpo-C*
1897 C Do not concatenate sourced lines that start with a
1898 backslash. See |line-continuation|.
1899 *cpo-d*
1900 d Using "./" in the 'tags' option doesn't mean to use
1901 the tags file relative to the current file, but the
1902 tags file in the current directory.
1903 *cpo-D*
1904 D Can't use CTRL-K to enter a digraph after Normal mode
1905 commands with a character argument, like |r|, |f| and
1906 |t|.
1907 *cpo-e*
1908 e When executing a register with ":@r", always add a
1909 <CR> to the last line, also when the register is not
1910 linewise. If this flag is not present, the register
1911 is not linewise and the last line does not end in a
1912 <CR>, then the last line is put on the command-line
1913 and can be edited before hitting <CR>.
1914 *cpo-E*
1915 E It is an error when using "y", "d", "c", "g~", "gu" or
1916 "gU" on an Empty region. The operators only work when
1917 at least one character is to be operate on. Example:
1918 This makes "y0" fail in the first column.
1919 *cpo-f*
1920 f When included, a ":read" command with a file name
1921 argument will set the file name for the current buffer,
1922 if the current buffer doesn't have a file name yet.
1923 *cpo-F*
1924 F When included, a ":write" command with a file name
1925 argument will set the file name for the current
1926 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001927 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 *cpo-g*
1929 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001930 *cpo-H*
1931 H When using "I" on a line with only blanks, insert
1932 before the last blank. Without this flag insert after
1933 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 *cpo-i*
1935 i When included, interrupting the reading of a file will
1936 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001937 *cpo-I*
1938 I When moving the cursor up or down just after inserting
1939 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 *cpo-j*
1941 j When joining lines, only add two spaces after a '.',
1942 not after '!' or '?'. Also see 'joinspaces'.
1943 *cpo-J*
1944 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001945 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 white space.
1947 *cpo-k*
1948 k Disable the recognition of raw key codes in
1949 mappings, abbreviations, and the "to" part of menu
1950 commands. For example, if <Key> sends ^[OA (where ^[
1951 is <Esc>), the command ":map X ^[OA" results in X
1952 being mapped to:
1953 'k' included: "^[OA" (3 characters)
1954 'k' excluded: "<Key>" (one key code)
1955 Also see the '<' flag below.
1956 *cpo-K*
1957 K Don't wait for a key code to complete when it is
1958 halfway a mapping. This breaks mapping <F1><F1> when
1959 only part of the second <F1> has been read. It
1960 enables cancelling the mapping by typing <F1><Esc>.
1961 *cpo-l*
1962 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001963 literally, only "\]", "\^", "\-" and "\\" are special.
1964 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1966 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001967 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 *cpo-L*
1969 L When the 'list' option is set, 'wrapmargin',
1970 'textwidth', 'softtabstop' and Virtual Replace mode
1971 (see |gR|) count a <Tab> as two characters, instead of
1972 the normal behavior of a <Tab>.
1973 *cpo-m*
1974 m When included, a showmatch will always wait half a
1975 second. When not included, a showmatch will wait half
1976 a second or until a character is typed. |'showmatch'|
1977 *cpo-M*
1978 M When excluded, "%" matching will take backslashes into
1979 account. Thus in "( \( )" and "\( ( \)" the outer
1980 parenthesis match. When included "%" ignores
1981 backslashes, which is Vi compatible.
1982 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001983 n When included, the column used for 'number' and
1984 'relativenumber' will also be used for text of wrapped
1985 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001986 *cpo-o*
1987 o Line offset to search command is not remembered for
1988 next search.
1989 *cpo-O*
1990 O Don't complain if a file is being overwritten, even
1991 when it didn't exist when editing it. This is a
1992 protection against a file unexpectedly created by
1993 someone else. Vi didn't complain about this.
1994 *cpo-p*
1995 p Vi compatible Lisp indenting. When not present, a
1996 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001997 *cpo-P*
1998 P When included, a ":write" command that appends to a
1999 file will set the file name for the current buffer, if
2000 the current buffer doesn't have a file name yet and
2001 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002002 *cpo-q*
2003 q When joining multiple lines leave the cursor at the
2004 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 *cpo-r*
2006 r Redo ("." command) uses "/" to repeat a search
2007 command, instead of the actually used search string.
2008 *cpo-R*
2009 R Remove marks from filtered lines. Without this flag
2010 marks are kept like |:keepmarks| was used.
2011 *cpo-s*
2012 s Set buffer options when entering the buffer for the
2013 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002014 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015 set when the buffer is created.
2016 *cpo-S*
2017 S Set buffer options always when entering a buffer
2018 (except 'readonly', 'fileformat', 'filetype' and
2019 'syntax'). This is the (most) Vi compatible setting.
2020 The options are set to the values in the current
2021 buffer. When you change an option and go to another
2022 buffer, the value is copied. Effectively makes the
2023 buffer options global to all buffers.
2024
2025 's' 'S' copy buffer options
2026 no no when buffer created
2027 yes no when buffer first entered (default)
2028 X yes each time when buffer entered (vi comp.)
2029 *cpo-t*
2030 t Search pattern for the tag command is remembered for
2031 "n" command. Otherwise Vim only puts the pattern in
2032 the history for search pattern, but doesn't change the
2033 last used search pattern.
2034 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002035 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 *cpo-v*
2037 v Backspaced characters remain visible on the screen in
2038 Insert mode. Without this flag the characters are
2039 erased from the screen right away. With this flag the
2040 screen newly typed text overwrites backspaced
2041 characters.
2042 *cpo-w*
2043 w When using "cw" on a blank character, only change one
2044 character and not all blanks until the start of the
2045 next word.
2046 *cpo-W*
2047 W Don't overwrite a readonly file. When omitted, ":w!"
2048 overwrites a readonly file, if possible.
2049 *cpo-x*
2050 x <Esc> on the command-line executes the command-line.
2051 The default in Vim is to abandon the command-line,
2052 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002053 *cpo-X*
2054 X When using a count with "R" the replaced text is
2055 deleted only once. Also when repeating "R" with "."
2056 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 *cpo-y*
2058 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002059 *cpo-Z*
2060 Z When using "w!" while the 'readonly' option is set,
2061 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 *cpo-!*
2063 ! When redoing a filter command, use the last used
2064 external command, whatever it was. Otherwise the last
2065 used -filter- command is used.
2066 *cpo-$*
2067 $ When making a change to one line, don't redisplay the
2068 line, but put a '$' at the end of the changed text.
2069 The changed text will be overwritten when you type the
2070 new text. The line is redisplayed if you type any
2071 command that moves the cursor from the insertion
2072 point.
2073 *cpo-%*
2074 % Vi-compatible matching is done for the "%" command.
2075 Does not recognize "#if", "#endif", etc.
2076 Does not recognize "/*" and "*/".
2077 Parens inside single and double quotes are also
2078 counted, causing a string that contains a paren to
2079 disturb the matching. For example, in a line like
2080 "if (strcmp("foo(", s))" the first paren does not
2081 match the last one. When this flag is not included,
2082 parens inside single and double quotes are treated
2083 specially. When matching a paren outside of quotes,
2084 everything inside quotes is ignored. When matching a
2085 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002086 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002087 This flag is also used for other features, such as
2088 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002089 *cpo--*
2090 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002091 it would go above the first line or below the last
2092 line. Without it the cursor moves to the first or
2093 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002094 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002095 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002096 *cpo-+*
2097 + When included, a ":write file" command will reset the
2098 'modified' flag of the buffer, even though the buffer
2099 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002100 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 * Use ":*" in the same way as ":@". When not included,
2102 ":*" is an alias for ":'<,'>", select the Visual area.
2103 *cpo-<*
2104 < Disable the recognition of special key codes in |<>|
2105 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002106 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 ":map X <Tab>" results in X being mapped to:
2108 '<' included: "<Tab>" (5 characters)
2109 '<' excluded: "^I" (^I is a real <Tab>)
2110 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002111 *cpo->*
2112 > When appending to a register, put a line break before
2113 the appended text.
2114
2115 POSIX flags. These are not included in the Vi default value, except
2116 when $VIM_POSIX was set on startup. |posix|
2117
2118 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002119 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002120 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002121 *cpo-&*
2122 & When ":preserve" was used keep the swap file when
2123 exiting normally while this buffer is still loaded.
2124 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002125 *cpo-\*
2126 \ Backslash in a [] range in a search pattern is taken
2127 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002128 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2129 '\' excluded: "/[ \-]" finds <Space> and '-'
2130 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002131 *cpo-/*
2132 / When "%" is used as the replacement string in a |:s|
2133 command, use the previous replacement string. |:s%|
2134 *cpo-{*
2135 { The |{| and |}| commands also stop at a "{" character
2136 at the start of a line.
2137 *cpo-.*
2138 . The ":chdir" and ":cd" commands fail if the current
2139 buffer is modified, unless ! is used. Vim doesn't
2140 need this, since it remembers the full path of an
2141 opened file.
2142 *cpo-bar*
2143 | The value of the $LINES and $COLUMNS environment
2144 variables overrule the terminal size values obtained
2145 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002146
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002148 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002149'cryptmethod' string (default "zip")
2150 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002151 {not in Vi}
2152 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002153 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002154 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002155 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002156 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002157 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002158 or later, files can NOT be read by Vim 7.2 and older.
2159 This adds a "seed" to the file, every time you write
2160 the file the encrypted bytes will be different.
2161
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002162 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002163 to the detected method of the file being read. Thus if you write it
2164 without changing 'cryptmethod' the same method will be used.
2165 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002166 explicitly write it, you don't get a warning unless there are other
2167 modifications. Also see |:X|.
2168
2169 When setting the global value to an empty string, it will end up with
2170 the value "zip". When setting the local value to an empty string the
2171 buffer will use the global value.
2172
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002173 When a new encryption method is added in a later version of Vim, and
2174 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002175 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002176
2177
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 *'cscopepathcomp'* *'cspc'*
2179'cscopepathcomp' 'cspc' number (default 0)
2180 global
2181 {not available when compiled without the |+cscope|
2182 feature}
2183 {not in Vi}
2184 Determines how many components of the path to show in a list of tags.
2185 See |cscopepathcomp|.
2186
2187 *'cscopeprg'* *'csprg'*
2188'cscopeprg' 'csprg' string (default "cscope")
2189 global
2190 {not available when compiled without the |+cscope|
2191 feature}
2192 {not in Vi}
2193 Specifies the command to execute cscope. See |cscopeprg|.
2194 This option cannot be set from a |modeline| or in the |sandbox|, for
2195 security reasons.
2196
2197 *'cscopequickfix'* *'csqf'*
2198'cscopequickfix' 'csqf' string (default "")
2199 global
2200 {not available when compiled without the |+cscope|
2201 or |+quickfix| features}
2202 {not in Vi}
2203 Specifies whether to use quickfix window to show cscope results.
2204 See |cscopequickfix|.
2205
2206 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2207'cscopetag' 'cst' boolean (default off)
2208 global
2209 {not available when compiled without the |+cscope|
2210 feature}
2211 {not in Vi}
2212 Use cscope for tag commands. See |cscope-options|.
2213 NOTE: This option is reset when 'compatible' is set.
2214
2215 *'cscopetagorder'* *'csto'*
2216'cscopetagorder' 'csto' number (default 0)
2217 global
2218 {not available when compiled without the |+cscope|
2219 feature}
2220 {not in Vi}
2221 Determines the order in which ":cstag" performs a search. See
2222 |cscopetagorder|.
2223 NOTE: This option is set to 0 when 'compatible' is set.
2224
2225 *'cscopeverbose'* *'csverb'*
2226 *'nocscopeverbose'* *'nocsverb'*
2227'cscopeverbose' 'csverb' boolean (default off)
2228 global
2229 {not available when compiled without the |+cscope|
2230 feature}
2231 {not in Vi}
2232 Give messages when adding a cscope database. See |cscopeverbose|.
2233 NOTE: This option is reset when 'compatible' is set.
2234
Bram Moolenaar860cae12010-06-05 23:22:07 +02002235 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2236'cursorbind' 'crb' boolean (default off)
2237 local to window
2238 {not in Vi}
2239 {not available when compiled without the |+cursorbind|
2240 feature}
2241 When this option is set, as the cursor in the current
2242 window moves other cursorbound windows (windows that also have
2243 this option set) move their cursors to the corresponding line and
2244 column. This option is useful for viewing the
2245 differences between two versions of a file (see 'diff'); in diff mode,
2246 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002247 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002248
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002249
2250 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2251'cursorcolumn' 'cuc' boolean (default off)
2252 local to window
2253 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002254 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002255 feature}
2256 Highlight the screen column of the cursor with CursorColumn
2257 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2258 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002259 If you only want the highlighting in the current window you can use
2260 these autocommands: >
2261 au WinLeave * set nocursorline nocursorcolumn
2262 au WinEnter * set cursorline cursorcolumn
2263<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002264
2265 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2266'cursorline' 'cul' boolean (default off)
2267 local to window
2268 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002269 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002270 feature}
2271 Highlight the screen line of the cursor with CursorLine
2272 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2273 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002274 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002275 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002276
2277
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 *'debug'*
2279'debug' string (default "")
2280 global
2281 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002282 These values can be used:
2283 msg Error messages that would otherwise be omitted will be given
2284 anyway.
2285 throw Error messages that would otherwise be omitted will be given
2286 anyway and also throw an exception and set |v:errmsg|.
2287 beep A message will be given when otherwise only a beep would be
2288 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002289 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002290 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2291 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292
2293 *'define'* *'def'*
2294'define' 'def' string (default "^\s*#\s*define")
2295 global or local to buffer |global-local|
2296 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002297 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 pattern, just like for the "/" command. This option is used for the
2299 commands like "[i" and "[d" |include-search|. The 'isident' option is
2300 used to recognize the defined name after the match:
2301 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2302 See |option-backslash| about inserting backslashes to include a space
2303 or backslash.
2304 The default value is for C programs. For C++ this value would be
2305 useful, to include const type declarations: >
2306 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2307< When using the ":set" command, you need to double the backslashes!
2308
2309 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2310'delcombine' 'deco' boolean (default off)
2311 global
2312 {not in Vi}
2313 {only available when compiled with the |+multi_byte|
2314 feature}
2315 If editing Unicode and this option is set, backspace and Normal mode
2316 "x" delete each combining character on its own. When it is off (the
2317 default) the character along with its combining characters are
2318 deleted.
2319 Note: When 'delcombine' is set "xx" may work different from "2x"!
2320
2321 This is useful for Arabic, Hebrew and many other languages where one
2322 may have combining characters overtop of base characters, and want
2323 to remove only the combining ones.
2324
2325 *'dictionary'* *'dict'*
2326'dictionary' 'dict' string (default "")
2327 global or local to buffer |global-local|
2328 {not in Vi}
2329 List of file names, separated by commas, that are used to lookup words
2330 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2331 contain a list of words. This can be one word per line, or several
2332 words per line, separated by non-keyword characters (white space is
2333 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002334 When this option is empty, or an entry "spell" is present, spell
2335 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002336 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 after a comma are ignored, otherwise spaces are included in the file
2338 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002339 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 Where to find a list of words?
2341 - On FreeBSD, there is the file "/usr/share/dict/words".
2342 - In the Simtel archive, look in the "msdos/linguist" directory.
2343 - In "miscfiles" of the GNU collection.
2344 The use of |:set+=| and |:set-=| is preferred when adding or removing
2345 directories from the list. This avoids problems when a future version
2346 uses another default.
2347 Backticks cannot be used in this option for security reasons.
2348
2349 *'diff'* *'nodiff'*
2350'diff' boolean (default off)
2351 local to window
2352 {not in Vi}
2353 {not available when compiled without the |+diff|
2354 feature}
2355 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002356 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357
2358 *'dex'* *'diffexpr'*
2359'diffexpr' 'dex' string (default "")
2360 global
2361 {not in Vi}
2362 {not available when compiled without the |+diff|
2363 feature}
2364 Expression which is evaluated to obtain an ed-style diff file from two
2365 versions of a file. See |diff-diffexpr|.
2366 This option cannot be set from a |modeline| or in the |sandbox|, for
2367 security reasons.
2368
2369 *'dip'* *'diffopt'*
2370'diffopt' 'dip' string (default "filler")
2371 global
2372 {not in Vi}
2373 {not available when compiled without the |+diff|
2374 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002375 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 All are optional. Items must be separated by a comma.
2377
2378 filler Show filler lines, to keep the text
2379 synchronized with a window that has inserted
2380 lines at the same position. Mostly useful
2381 when windows are side-by-side and 'scrollbind'
2382 is set.
2383
2384 context:{n} Use a context of {n} lines between a change
2385 and a fold that contains unchanged lines.
2386 When omitted a context of six lines is used.
2387 See |fold-diff|.
2388
2389 icase Ignore changes in case of text. "a" and "A"
2390 are considered the same. Adds the "-i" flag
2391 to the "diff" command if 'diffexpr' is empty.
2392
2393 iwhite Ignore changes in amount of white space. Adds
2394 the "-b" flag to the "diff" command if
2395 'diffexpr' is empty. Check the documentation
2396 of the "diff" command for what this does
2397 exactly. It should ignore adding trailing
2398 white space, but not leading white space.
2399
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002400 horizontal Start diff mode with horizontal splits (unless
2401 explicitly specified otherwise).
2402
2403 vertical Start diff mode with vertical splits (unless
2404 explicitly specified otherwise).
2405
2406 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2407 starting diff mode. Without this 2 is used.
2408
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 Examples: >
2410
2411 :set diffopt=filler,context:4
2412 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002413 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414<
2415 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2416'digraph' 'dg' boolean (default off)
2417 global
2418 {not in Vi}
2419 {not available when compiled without the |+digraphs|
2420 feature}
2421 Enable the entering of digraphs in Insert mode with {char1} <BS>
2422 {char2}. See |digraphs|.
2423 NOTE: This option is reset when 'compatible' is set.
2424
2425 *'directory'* *'dir'*
2426'directory' 'dir' string (default for Amiga: ".,t:",
2427 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2428 for Unix: ".,~/tmp,/var/tmp,/tmp")
2429 global
2430 List of directory names for the swap file, separated with commas.
2431 - The swap file will be created in the first directory where this is
2432 possible.
2433 - Empty means that no swap file will be used (recovery is
2434 impossible!).
2435 - A directory "." means to put the swap file in the same directory as
2436 the edited file. On Unix, a dot is prepended to the file name, so
2437 it doesn't show in a directory listing. On MS-Windows the "hidden"
2438 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002439 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 put the swap file relative to where the edited file is. The leading
2441 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002442 - For Unix and Win32, if a directory ends in two path separators "//"
2443 or "\\", the swap file name will be built from the complete path to
2444 the file with all path separators substituted to percent '%' signs.
2445 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002446 On Win32, when a separating comma is following, you must use "//",
2447 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 - Spaces after the comma are ignored, other spaces are considered part
2449 of the directory name. To have a space at the start of a directory
2450 name, precede it with a backslash.
2451 - To include a comma in a directory name precede it with a backslash.
2452 - A directory name may end in an ':' or '/'.
2453 - Environment variables are expanded |:set_env|.
2454 - Careful with '\' characters, type one before a space, type two to
2455 get one in the option (see |option-backslash|), for example: >
2456 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2457< - For backwards compatibility with Vim version 3.0 a '>' at the start
2458 of the option is removed.
2459 Using "." first in the list is recommended. This means that editing
2460 the same file twice will result in a warning. Using "/tmp" on Unix is
2461 discouraged: When the system crashes you lose the swap file.
2462 "/var/tmp" is often not cleared when rebooting, thus is a better
2463 choice than "/tmp". But it can contain a lot of files, your swap
2464 files get lost in the crowd. That is why a "tmp" directory in your
2465 home directory is tried first.
2466 The use of |:set+=| and |:set-=| is preferred when adding or removing
2467 directories from the list. This avoids problems when a future version
2468 uses another default.
2469 This option cannot be set from a |modeline| or in the |sandbox|, for
2470 security reasons.
2471 {Vi: directory to put temp file in, defaults to "/tmp"}
2472
2473 *'display'* *'dy'*
2474'display' 'dy' string (default "")
2475 global
2476 {not in Vi}
2477 Change the way text is displayed. This is comma separated list of
2478 flags:
2479 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002480 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 last line that doesn't fit is replaced with "@" lines.
2482 uhex Show unprintable characters hexadecimal as <xx>
2483 instead of using ^C and ~C.
2484
2485 *'eadirection'* *'ead'*
2486'eadirection' 'ead' string (default "both")
2487 global
2488 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002489 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490 feature}
2491 Tells when the 'equalalways' option applies:
2492 ver vertically, width of windows is not affected
2493 hor horizontally, height of windows is not affected
2494 both width and height of windows is affected
2495
2496 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2497'edcompatible' 'ed' boolean (default off)
2498 global
2499 Makes the 'g' and 'c' flags of the ":substitute" command to be
2500 toggled each time the flag is given. See |complex-change|. See
2501 also 'gdefault' option.
2502 Switching this option on is discouraged!
2503
2504 *'encoding'* *'enc'* *E543*
2505'encoding' 'enc' string (default: "latin1" or value from $LANG)
2506 global
2507 {only available when compiled with the |+multi_byte|
2508 feature}
2509 {not in Vi}
2510 Sets the character encoding used inside Vim. It applies to text in
2511 the buffers, registers, Strings in expressions, text stored in the
2512 viminfo file, etc. It sets the kind of characters which Vim can work
2513 with. See |encoding-names| for the possible values.
2514
2515 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002516 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002518 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519
Bram Moolenaar865242e2010-07-14 21:12:05 +02002520 This option cannot be set from a |modeline|. It would most likely
2521 corrupt the text.
2522
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2524 "utf-8". Although care has been taken to allow different values of
2525 'encoding', "utf-8" is the natural choice for the environment and
2526 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002527 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 versions, and to avoid changing the encoding of newly created files
2529 without your knowledge (in case 'fileencodings' is empty).
2530
2531 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002532 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 iconv() or as specified with 'charconvert'.
2534
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002535 If you need to know whether 'encoding' is a multi-byte encoding, you
2536 can use: >
2537 if has("multi_byte_encoding")
2538<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 Normally 'encoding' will be equal to your current locale. This will
2540 be the default if Vim recognizes your environment settings. If
2541 'encoding' is not set to the current locale, 'termencoding' must be
2542 set to convert typed and displayed text. See |encoding-table|.
2543
2544 When you set this option, it fires the |EncodingChanged| autocommand
2545 event so that you can set up fonts if necessary.
2546
2547 When the option is set, the value is converted to lowercase. Thus
2548 you can set it with uppercase values too. Underscores are translated
2549 to '-' signs.
2550 When the encoding is recognized, it is changed to the standard name.
2551 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2552 "iso-8859-2" and "utf8" becomes "utf-8".
2553
2554 Note: "latin1" is also used when the encoding could not be detected.
2555 This only works when editing files in the same encoding! When the
2556 actual character set is not latin1, make sure 'fileencoding' and
2557 'fileencodings' are empty. When conversion is needed, switch to using
2558 utf-8.
2559
2560 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2561 You don't notice this while editing, but it does matter for the
2562 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2563 setting 'encoding' to one of these values instead of utf-8 only has
2564 effect for encoding used for files when 'fileencoding' is empty.
2565
Bram Moolenaar661b1822005-07-28 22:36:45 +00002566 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2567 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568
2569 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2570'endofline' 'eol' boolean (default on)
2571 local to buffer
2572 {not in Vi}
2573 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002574 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 option is automatically set when starting to edit a new file, unless
2576 the file does not have an <EOL> for the last line in the file, in
2577 which case it is reset. Normally you don't have to set or reset this
2578 option. When 'binary' is off the value is not used when writing the
2579 file. When 'binary' is on it is used to remember the presence of a
2580 <EOL> for the last line in the file, so that when you write the file
2581 the situation from the original file can be kept. But you can change
2582 it if you want to.
2583
2584 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2585'equalalways' 'ea' boolean (default on)
2586 global
2587 {not in Vi}
2588 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002589 splitting or closing a window. This also happens the moment the
2590 option is switched on. When off, splitting a window will reduce the
2591 size of the current window and leave the other windows the same. When
2592 closing a window the extra lines are given to the window next to it
2593 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 When mixing vertically and horizontally split windows, a minimal size
2595 is computed and some windows may be larger if there is room. The
2596 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002597 Changing the height and width of a window can be avoided by setting
2598 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002599 If a window size is specified when creating a new window sizes are
2600 currently not equalized (it's complicated, but may be implemented in
2601 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602
2603 *'equalprg'* *'ep'*
2604'equalprg' 'ep' string (default "")
2605 global or local to buffer |global-local|
2606 {not in Vi}
2607 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002608 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002609 or 'indentexpr'. When Vim was compiled without internal formatting,
2610 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002611 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 about including spaces and backslashes.
2613 This option cannot be set from a |modeline| or in the |sandbox|, for
2614 security reasons.
2615
2616 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2617'errorbells' 'eb' boolean (default off)
2618 global
2619 Ring the bell (beep or screen flash) for error messages. This only
2620 makes a difference for error messages, the bell will be used always
2621 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002622 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 screen flash or do nothing.
2624
2625 *'errorfile'* *'ef'*
2626'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2627 others: "errors.err")
2628 global
2629 {not in Vi}
2630 {not available when compiled without the |+quickfix|
2631 feature}
2632 Name of the errorfile for the QuickFix mode (see |:cf|).
2633 When the "-q" command-line argument is used, 'errorfile' is set to the
2634 following argument. See |-q|.
2635 NOT used for the ":make" command. See 'makeef' for that.
2636 Environment variables are expanded |:set_env|.
2637 See |option-backslash| about including spaces and backslashes.
2638 This option cannot be set from a |modeline| or in the |sandbox|, for
2639 security reasons.
2640
2641 *'errorformat'* *'efm'*
2642'errorformat' 'efm' string (default is very long)
2643 global or local to buffer |global-local|
2644 {not in Vi}
2645 {not available when compiled without the |+quickfix|
2646 feature}
2647 Scanf-like description of the format for the lines in the error file
2648 (see |errorformat|).
2649
2650 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2651'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2652 global
2653 {not in Vi}
2654 Function keys that start with an <Esc> are recognized in Insert
2655 mode. When this option is off, the cursor and function keys cannot be
2656 used in Insert mode if they start with an <Esc>. The advantage of
2657 this is that the single <Esc> is recognized immediately, instead of
2658 after one second. Instead of resetting this option, you might want to
2659 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2660 when 'esckeys' is off, you can still map anything, but the cursor keys
2661 won't work by default.
2662 NOTE: This option is set to the Vi default value when 'compatible' is
2663 set and to the Vim default value when 'compatible' is reset.
2664
2665 *'eventignore'* *'ei'*
2666'eventignore' 'ei' string (default "")
2667 global
2668 {not in Vi}
2669 {not available when compiled without the |+autocmd|
2670 feature}
2671 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002672 When set to "all" or when "all" is one of the items, all autocommand
2673 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 Otherwise this is a comma separated list of event names. Example: >
2675 :set ei=WinEnter,WinLeave
2676<
2677 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2678'expandtab' 'et' boolean (default off)
2679 local to buffer
2680 {not in Vi}
2681 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002682 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2684 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2685 NOTE: This option is reset when 'compatible' is set.
2686
2687 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2688'exrc' 'ex' boolean (default off)
2689 global
2690 {not in Vi}
2691 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2692 directory. If you switch this option on you should also consider
2693 setting the 'secure' option (see |initialization|). Using a local
2694 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2695 also see |.vimrc| and |gui-init|.
2696 This option cannot be set from a |modeline| or in the |sandbox|, for
2697 security reasons.
2698
2699 *'fileencoding'* *'fenc'* *E213*
2700'fileencoding' 'fenc' string (default: "")
2701 local to buffer
2702 {only available when compiled with the |+multi_byte|
2703 feature}
2704 {not in Vi}
2705 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002706
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002708 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 When 'fileencoding' is empty, the same value as 'encoding' will be
2710 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002711 Conversion will also be done when 'encoding' and 'fileencoding' are
2712 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2713 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002715 'encoding' is "utf-8" or another Unicode encoding, conversion
2716 is most likely done in a way that the reverse conversion
2717 results in the same text. When 'encoding' is not "utf-8" some
2718 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002719
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 See 'encoding' for the possible values. Additionally, values may be
2721 specified that can be handled by the converter, see
2722 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002723
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 When reading a file 'fileencoding' will be set from 'fileencodings'.
2725 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002726 'fileencoding', use the |++enc| argument. One exception: when
2727 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002728 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002729
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2731 When the option is set, the value is converted to lowercase. Thus
2732 you can set it with uppercase values too. '_' characters are
2733 replaced with '-'. If a name is recognized from the list for
2734 'encoding', it is replaced by the standard name. For example
2735 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002736
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 When this option is set, after starting to edit a file, the 'modified'
2738 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002739
2740 Keep in mind that changing 'fenc' from a modeline happens
2741 AFTER the text has been read, thus it applies to when the file will be
2742 written. If you do set 'fenc' in a modeline, you might want to set
2743 'nomodified' to avoid not being able to ":q".
2744
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 This option can not be changed when 'modifiable' is off.
2746
2747 *'fe'*
2748 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002749 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 old short name was 'fe', which is no longer used.
2751
2752 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002753'fileencodings' 'fencs' string (default: "ucs-bom",
2754 "ucs-bom,utf-8,default,latin1" when
2755 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 global
2757 {only available when compiled with the |+multi_byte|
2758 feature}
2759 {not in Vi}
2760 This is a list of character encodings considered when starting to edit
2761 an existing file. When a file is read, Vim tries to use the first
2762 mentioned character encoding. If an error is detected, the next one
2763 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002764 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 an empty string, which means the value of 'encoding' is used.
2766 WARNING: Conversion can cause loss of information! When
2767 'encoding' is "utf-8" (or one of the other Unicode variants)
2768 conversion is most likely done in a way that the reverse
2769 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002770 "utf-8" some non-ASCII characters may be lost! You can use
2771 the |++bad| argument to specify what is done with characters
2772 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 For an empty file or a file with only ASCII characters most encodings
2774 will work and the first entry of 'fileencodings' will be used (except
2775 "ucs-bom", which requires the BOM to be present). If you prefer
2776 another encoding use an BufReadPost autocommand event to test if your
2777 preferred encoding is to be used. Example: >
2778 au BufReadPost * if search('\S', 'w') == 0 |
2779 \ set fenc=iso-2022-jp | endif
2780< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2781 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002782 When the |++enc| argument is used then the value of 'fileencodings' is
2783 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002784 Note that 'fileencodings' is not used for a new file, the global value
2785 of 'fileencoding' is used instead. You can set it with: >
2786 :setglobal fenc=iso-8859-2
2787< This means that a non-existing file may get a different encoding than
2788 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 The special value "ucs-bom" can be used to check for a Unicode BOM
2790 (Byte Order Mark) at the start of the file. It must not be preceded
2791 by "utf-8" or another Unicode encoding for this to work properly.
2792 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2793 because Vim cannot detect an error, thus the encoding is always
2794 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002795 The special value "default" can be used for the encoding from the
2796 environment. This is the default value for 'encoding'. It is useful
2797 when 'encoding' is set to "utf-8" and your environment uses a
2798 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002799 When 'encoding' is "utf-8" and a file contains an illegal byte
2800 sequence it won't be recognized as UTF-8. You can use the |8g8|
2801 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 WRONG VALUES: WHAT'S WRONG:
2803 latin1,utf-8 "latin1" will always be used
2804 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2805 file
2806 cp1250,latin1 "cp1250" will always be used
2807 If 'fileencodings' is empty, 'fileencoding' is not modified.
2808 See 'fileencoding' for the possible values.
2809 Setting this option does not have an effect until the next time a file
2810 is read.
2811
2812 *'fileformat'* *'ff'*
2813'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2814 Unix default: "unix",
2815 Macintosh default: "mac")
2816 local to buffer
2817 {not in Vi}
2818 This gives the <EOL> of the current buffer, which is used for
2819 reading/writing the buffer from/to a file:
2820 dos <CR> <NL>
2821 unix <NL>
2822 mac <CR>
2823 When "dos" is used, CTRL-Z at the end of a file is ignored.
2824 See |file-formats| and |file-read|.
2825 For the character encoding of the file see 'fileencoding'.
2826 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2827 works like it was set to "unix'.
2828 This option is set automatically when starting to edit a file and
2829 'fileformats' is not empty and 'binary' is off.
2830 When this option is set, after starting to edit a file, the 'modified'
2831 option is set, because the file would be different when written.
2832 This option can not be changed when 'modifiable' is off.
2833 For backwards compatibility: When this option is set to "dos",
2834 'textmode' is set, otherwise 'textmode' is reset.
2835
2836 *'fileformats'* *'ffs'*
2837'fileformats' 'ffs' string (default:
2838 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2839 Vim Unix: "unix,dos",
2840 Vim Mac: "mac,unix,dos",
2841 Vi Cygwin: "unix,dos",
2842 Vi others: "")
2843 global
2844 {not in Vi}
2845 This gives the end-of-line (<EOL>) formats that will be tried when
2846 starting to edit a new buffer and when reading a file into an existing
2847 buffer:
2848 - When empty, the format defined with 'fileformat' will be used
2849 always. It is not set automatically.
2850 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002851 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 'fileformats' name will be used when a file is read into an existing
2853 buffer, no matter what 'fileformat' for that buffer is set to.
2854 - When more than one name is present, separated by commas, automatic
2855 <EOL> detection will be done when reading a file. When starting to
2856 edit a file, a check is done for the <EOL>:
2857 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2858 'fileformat' is set to "dos".
2859 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002860 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002862 3. If 'fileformat' has not yet been set, and if 'fileformats'
2863 includes "mac", 'fileformat' is set to "mac".
2864 This means that "mac" is only chosen when:
2865 "unix" is not present or no <NL> is found in the file, and
2866 "dos" is not present or no <CR><NL> is found in the file.
2867 Except: if "unix" was chosen, but there is a <CR> before
2868 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002869 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 4. If 'fileformat' is still not set, the first name from
2871 'fileformats' is used.
2872 When reading a file into an existing buffer, the same is done, but
2873 this happens like 'fileformat' has been set appropriately for that
2874 file only, the option is not changed.
2875 When 'binary' is set, the value of 'fileformats' is not used.
2876
Bram Moolenaar81af9252010-12-10 20:35:50 +01002877 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002878 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002879
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2881 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2882 done:
2883 - When 'fileformats' is empty, there is no automatic detection. Dos
2884 format will be used.
2885 - When 'fileformats' is set to one or more names, automatic detection
2886 is done. This is based on the first <NL> in the file: If there is a
2887 <CR> in front of it, Dos format is used, otherwise Unix format is
2888 used.
2889 Also see |file-formats|.
2890 For backwards compatibility: When this option is set to an empty
2891 string or one format (no comma is included), 'textauto' is reset,
2892 otherwise 'textauto' is set.
2893 NOTE: This option is set to the Vi default value when 'compatible' is
2894 set and to the Vim default value when 'compatible' is reset.
2895
2896 *'filetype'* *'ft'*
2897'filetype' 'ft' string (default: "")
2898 local to buffer
2899 {not in Vi}
2900 {not available when compiled without the |+autocmd|
2901 feature}
2902 When this option is set, the FileType autocommand event is triggered.
2903 All autocommands that match with the value of this option will be
2904 executed. Thus the value of 'filetype' is used in place of the file
2905 name.
2906 Otherwise this option does not always reflect the current file type.
2907 This option is normally set when the file type is detected. To enable
2908 this use the ":filetype on" command. |:filetype|
2909 Setting this option to a different value is most useful in a modeline,
2910 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002911 Example, for in an IDL file:
2912 /* vim: set filetype=idl : */ ~
2913 |FileType| |filetypes|
2914 When a dot appears in the value then this separates two filetype
2915 names. Example:
2916 /* vim: set filetype=c.doxygen : */ ~
2917 This will use the "c" filetype first, then the "doxygen" filetype.
2918 This works both for filetype plugins and for syntax files. More than
2919 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 Do not confuse this option with 'osfiletype', which is for the file
2921 type that is actually stored with the file.
2922 This option is not copied to another buffer, independent of the 's' or
2923 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002924 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925
2926 *'fillchars'* *'fcs'*
2927'fillchars' 'fcs' string (default "vert:|,fold:-")
2928 global
2929 {not in Vi}
2930 {not available when compiled without the |+windows|
2931 and |+folding| features}
2932 Characters to fill the statuslines and vertical separators.
2933 It is a comma separated list of items:
2934
2935 item default Used for ~
2936 stl:c ' ' or '^' statusline of the current window
2937 stlnc:c ' ' or '-' statusline of the non-current windows
2938 vert:c '|' vertical separators |:vsplit|
2939 fold:c '-' filling 'foldtext'
2940 diff:c '-' deleted lines of the 'diff' option
2941
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002942 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 "stlnc" the space will be used when there is highlighting, '^' or '-'
2944 otherwise.
2945
2946 Example: >
2947 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2948< This is similar to the default, except that these characters will also
2949 be used when there is highlighting.
2950
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002951 for "stl" and "stlnc" only single-byte values are supported.
2952
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 The highlighting used for these items:
2954 item highlight group ~
2955 stl:c StatusLine |hl-StatusLine|
2956 stlnc:c StatusLineNC |hl-StatusLineNC|
2957 vert:c VertSplit |hl-VertSplit|
2958 fold:c Folded |hl-Folded|
2959 diff:c DiffDelete |hl-DiffDelete|
2960
2961 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2962'fkmap' 'fk' boolean (default off) *E198*
2963 global
2964 {not in Vi}
2965 {only available when compiled with the |+rightleft|
2966 feature}
2967 When on, the keyboard is mapped for the Farsi character set.
2968 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002969 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970
2971 *'foldclose'* *'fcl'*
2972'foldclose' 'fcl' string (default "")
2973 global
2974 {not in Vi}
2975 {not available when compiled without the |+folding|
2976 feature}
2977 When set to "all", a fold is closed when the cursor isn't in it and
2978 its level is higher than 'foldlevel'. Useful if you want folds to
2979 automatically close when moving out of them.
2980
2981 *'foldcolumn'* *'fdc'*
2982'foldcolumn' 'fdc' number (default 0)
2983 local to window
2984 {not in Vi}
2985 {not available when compiled without the |+folding|
2986 feature}
2987 When non-zero, a column with the specified width is shown at the side
2988 of the window which indicates open and closed folds. The maximum
2989 value is 12.
2990 See |folding|.
2991
2992 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2993'foldenable' 'fen' boolean (default on)
2994 local to window
2995 {not in Vi}
2996 {not available when compiled without the |+folding|
2997 feature}
2998 When off, all folds are open. This option can be used to quickly
2999 switch between showing all text unfolded and viewing the text with
3000 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003001 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 'foldenable' is off.
3003 This option is set by commands that create a new fold or close a fold.
3004 See |folding|.
3005
3006 *'foldexpr'* *'fde'*
3007'foldexpr' 'fde' string (default: "0")
3008 local to window
3009 {not in Vi}
3010 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003011 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003013 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003014
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003015 The expression may be evaluated in the |sandbox|, see
3016 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003017 This option can't be set from a |modeline| when the 'diff' option is
3018 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003019
3020 It is not allowed to change text or jump to another window while
3021 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022
3023 *'foldignore'* *'fdi'*
3024'foldignore' 'fdi' string (default: "#")
3025 local to window
3026 {not in Vi}
3027 {not available when compiled without the |+folding|
3028 feature}
3029 Used only when 'foldmethod' is "indent". Lines starting with
3030 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003031 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 The default "#" works well for C programs. See |fold-indent|.
3033
3034 *'foldlevel'* *'fdl'*
3035'foldlevel' 'fdl' number (default: 0)
3036 local to window
3037 {not in Vi}
3038 {not available when compiled without the |+folding|
3039 feature}
3040 Sets the fold level: Folds with a higher level will be closed.
3041 Setting this option to zero will close all folds. Higher numbers will
3042 close fewer folds.
3043 This option is set by commands like |zm|, |zM| and |zR|.
3044 See |fold-foldlevel|.
3045
3046 *'foldlevelstart'* *'fdls'*
3047'foldlevelstart' 'fdls' number (default: -1)
3048 global
3049 {not in Vi}
3050 {not available when compiled without the |+folding|
3051 feature}
3052 Sets 'foldlevel' when starting to edit another buffer in a window.
3053 Useful to always start editing with all folds closed (value zero),
3054 some folds closed (one) or no folds closed (99).
3055 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003056 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 ignores this option and closes all folds.
3058 It is also done before BufReadPre autocommands, to allow an autocmd to
3059 overrule the 'foldlevel' value for specific files.
3060 When the value is negative, it is not used.
3061
3062 *'foldmarker'* *'fmr'* *E536*
3063'foldmarker' 'fmr' string (default: "{{{,}}}")
3064 local to window
3065 {not in Vi}
3066 {not available when compiled without the |+folding|
3067 feature}
3068 The start and end marker used when 'foldmethod' is "marker". There
3069 must be one comma, which separates the start and end marker. The
3070 marker is a literal string (a regular expression would be too slow).
3071 See |fold-marker|.
3072
3073 *'foldmethod'* *'fdm'*
3074'foldmethod' 'fdm' string (default: "manual")
3075 local to window
3076 {not in Vi}
3077 {not available when compiled without the |+folding|
3078 feature}
3079 The kind of folding used for the current window. Possible values:
3080 |fold-manual| manual Folds are created manually.
3081 |fold-indent| indent Lines with equal indent form a fold.
3082 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3083 |fold-marker| marker Markers are used to specify folds.
3084 |fold-syntax| syntax Syntax highlighting items specify folds.
3085 |fold-diff| diff Fold text that is not changed.
3086
3087 *'foldminlines'* *'fml'*
3088'foldminlines' 'fml' number (default: 1)
3089 local to window
3090 {not in Vi}
3091 {not available when compiled without the |+folding|
3092 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003093 Sets the number of screen lines above which a fold can be displayed
3094 closed. Also for manually closed folds. With the default value of
3095 one a fold can only be closed if it takes up two or more screen lines.
3096 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 Note that this only has an effect of what is displayed. After using
3098 "zc" to close a fold, which is displayed open because it's smaller
3099 than 'foldminlines', a following "zc" may close a containing fold.
3100
3101 *'foldnestmax'* *'fdn'*
3102'foldnestmax' 'fdn' number (default: 20)
3103 local to window
3104 {not in Vi}
3105 {not available when compiled without the |+folding|
3106 feature}
3107 Sets the maximum nesting of folds for the "indent" and "syntax"
3108 methods. This avoids that too many folds will be created. Using more
3109 than 20 doesn't work, because the internal limit is 20.
3110
3111 *'foldopen'* *'fdo'*
3112'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3113 search,tag,undo")
3114 global
3115 {not in Vi}
3116 {not available when compiled without the |+folding|
3117 feature}
3118 Specifies for which type of commands folds will be opened, if the
3119 command moves the cursor into a closed fold. It is a comma separated
3120 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003121 NOTE: When the command is part of a mapping this option is not used.
3122 Add the |zv| command to the mapping to get the same effect.
3123 (rationale: the mapping may want to control opening folds itself)
3124
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 item commands ~
3126 all any
3127 block "(", "{", "[[", "[{", etc.
3128 hor horizontal movements: "l", "w", "fx", etc.
3129 insert any command in Insert mode
3130 jump far jumps: "G", "gg", etc.
3131 mark jumping to a mark: "'m", CTRL-O, etc.
3132 percent "%"
3133 quickfix ":cn", ":crew", ":make", etc.
3134 search search for a pattern: "/", "n", "*", "gd", etc.
3135 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003136 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 tag jumping to a tag: ":ta", CTRL-T, etc.
3138 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 When a movement command is used for an operator (e.g., "dl" or "y%")
3140 this option is not used. This means the operator will include the
3141 whole closed fold.
3142 Note that vertical movements are not here, because it would make it
3143 very difficult to move onto a closed fold.
3144 In insert mode the folds containing the cursor will always be open
3145 when text is inserted.
3146 To close folds you can re-apply 'foldlevel' with the |zx| command or
3147 set the 'foldclose' option to "all".
3148
3149 *'foldtext'* *'fdt'*
3150'foldtext' 'fdt' string (default: "foldtext()")
3151 local to window
3152 {not in Vi}
3153 {not available when compiled without the |+folding|
3154 feature}
3155 An expression which is used to specify the text displayed for a closed
3156 fold. See |fold-foldtext|.
3157
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003158 The expression may be evaluated in the |sandbox|, see
3159 |sandbox-option|.
3160
3161 It is not allowed to change text or jump to another window while
3162 evaluating 'foldtext' |textlock|.
3163
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 *'formatoptions'* *'fo'*
3165'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3166 local to buffer
3167 {not in Vi}
3168 This is a sequence of letters which describes how automatic
3169 formatting is to be done. See |fo-table|. When the 'paste' option is
3170 on, no formatting is done (like 'formatoptions' is empty). Commas can
3171 be inserted for readability.
3172 To avoid problems with flags that are added in the future, use the
3173 "+=" and "-=" feature of ":set" |add-option-flags|.
3174 NOTE: This option is set to the Vi default value when 'compatible' is
3175 set and to the Vim default value when 'compatible' is reset.
3176
Bram Moolenaar86b68352004-12-27 21:59:20 +00003177 *'formatlistpat'* *'flp'*
3178'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3179 local to buffer
3180 {not in Vi}
3181 A pattern that is used to recognize a list header. This is used for
3182 the "n" flag in 'formatoptions'.
3183 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003184 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003185 while still checking more characters. There must be a character
3186 following the pattern, when it matches the whole line it is handled
3187 like there is no match.
3188 The default recognizes a number, followed by an optional punctuation
3189 character and white space.
3190
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 *'formatprg'* *'fp'*
3192'formatprg' 'fp' string (default "")
3193 global
3194 {not in Vi}
3195 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003196 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003198 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003199 If the 'formatexpr' option is not empty it will be used instead.
3200 Otherwise, if 'formatprg' option is an empty string, the internal
3201 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003202 Environment variables are expanded |:set_env|. See |option-backslash|
3203 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003204 The expression may be evaluated in the |sandbox|, see
3205 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003207 *'formatexpr'* *'fex'*
3208'formatexpr' 'fex' string (default "")
3209 local to buffer
3210 {not in Vi}
3211 {not available when compiled without the |+eval|
3212 feature}
3213 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003214 operator or automatic formatting (see 'formatoptions'). When this
3215 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003216
3217 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003218 The |v:count| variable holds the number of lines to be formatted.
3219 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003220 inserted if the expression is being evaluated due to
3221 automatic formatting. This can be empty. Don't insert
3222 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003223
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003224 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003225 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003226< This will invoke the mylang#Format() function in the
3227 autoload/mylang.vim file in 'runtimepath'. |autoload|
3228
3229 The expression is also evaluated when 'textwidth' is set and adding
3230 text beyond that limit. This happens under the same conditions as
3231 when internal formatting is used. Make sure the cursor is kept in the
3232 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003233 return "i" or "R" in this situation.
3234
3235 When the expression evaluates to non-zero Vim will fall back to using
3236 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003237
3238 The expression may be evaluated in the |sandbox|, see
Bram Moolenaar81af9252010-12-10 20:35:50 +01003239 |sandbox-option|. That stops the option from working, since changing
3240 the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003241
3242 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003243'fsync' 'fs' boolean (default on)
3244 global
3245 {not in Vi}
3246 When on, the library function fsync() will be called after writing a
3247 file. This will flush a file to disk, ensuring that it is safely
3248 written even on filesystems which do metadata-only journaling. This
3249 will force the harddrive to spin up on Linux systems running in laptop
3250 mode, so it may be undesirable in some situations. Be warned that
3251 turning this off increases the chances of data loss after a crash. On
3252 systems without an fsync() implementation, this variable is always
3253 off.
3254 Also see 'swapsync' for controlling fsync() on swap files.
3255
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3257'gdefault' 'gd' boolean (default off)
3258 global
3259 {not in Vi}
3260 When on, the ":substitute" flag 'g' is default on. This means that
3261 all matches in a line are substituted instead of one. When a 'g' flag
3262 is given to a ":substitute" command, this will toggle the substitution
3263 of all or one match. See |complex-change|.
3264
3265 command 'gdefault' on 'gdefault' off ~
3266 :s/// subst. all subst. one
3267 :s///g subst. one subst. all
3268 :s///gg subst. all subst. one
3269
3270 NOTE: This option is reset when 'compatible' is set.
3271
3272 *'grepformat'* *'gfm'*
3273'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3274 global
3275 {not in Vi}
3276 Format to recognize for the ":grep" command output.
3277 This is a scanf-like string that uses the same format as the
3278 'errorformat' option: see |errorformat|.
3279
3280 *'grepprg'* *'gp'*
3281'grepprg' 'gp' string (default "grep -n ",
3282 Unix: "grep -n $* /dev/null",
3283 Win32: "findstr /n" or "grep -n",
3284 VMS: "SEARCH/NUMBERS ")
3285 global or local to buffer |global-local|
3286 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003287 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 and '#' characters, which are expanded like when used in a command-
3289 line. The placeholder "$*" is allowed to specify where the arguments
3290 will be included. Environment variables are expanded |:set_env|. See
3291 |option-backslash| about including spaces and backslashes.
3292 When your "grep" accepts the "-H" argument, use this to make ":grep"
3293 also work well with a single file: >
3294 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003295< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003296 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3297 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003298 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 apply equally to 'grepprg'.
3300 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3301 otherwise it's "grep -n".
3302 This option cannot be set from a |modeline| or in the |sandbox|, for
3303 security reasons.
3304
3305 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3306'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3307 ve:ver35-Cursor,
3308 o:hor50-Cursor,
3309 i-ci:ver25-Cursor/lCursor,
3310 r-cr:hor20-Cursor/lCursor,
3311 sm:block-Cursor
3312 -blinkwait175-blinkoff150-blinkon175",
3313 for MS-DOS and Win32 console:
3314 "n-v-c:block,o:hor50,i-ci:hor15,
3315 r-cr:hor30,sm:block")
3316 global
3317 {not in Vi}
3318 {only available when compiled with GUI enabled, and
3319 for MS-DOS and Win32 console}
3320 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003321 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 the height of the cursor can be changed. This can be done by
3323 specifying a block cursor, or a percentage for a vertical or
3324 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003325 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003327 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 mode-list and an argument-list:
3329 mode-list:argument-list,mode-list:argument-list,..
3330 The mode-list is a dash separated list of these modes:
3331 n Normal mode
3332 v Visual mode
3333 ve Visual mode with 'selection' "exclusive" (same as 'v',
3334 if not specified)
3335 o Operator-pending mode
3336 i Insert mode
3337 r Replace mode
3338 c Command-line Normal (append) mode
3339 ci Command-line Insert mode
3340 cr Command-line Replace mode
3341 sm showmatch in Insert mode
3342 a all modes
3343 The argument-list is a dash separated list of these arguments:
3344 hor{N} horizontal bar, {N} percent of the character height
3345 ver{N} vertical bar, {N} percent of the character width
3346 block block cursor, fills the whole character
3347 [only one of the above three should be present]
3348 blinkwait{N} *cursor-blinking*
3349 blinkon{N}
3350 blinkoff{N}
3351 blink times for cursor: blinkwait is the delay before
3352 the cursor starts blinking, blinkon is the time that
3353 the cursor is shown and blinkoff is the time that the
3354 cursor is not shown. The times are in msec. When one
3355 of the numbers is zero, there is no blinking. The
3356 default is: "blinkwait700-blinkon400-blinkoff250".
3357 These numbers are used for a missing entry. This
3358 means that blinking is enabled by default. To switch
3359 blinking off you can use "blinkon0". The cursor only
3360 blinks when Vim is waiting for input, not while
3361 executing a command.
3362 To make the cursor blink in an xterm, see
3363 |xterm-blink|.
3364 {group-name}
3365 a highlight group name, that sets the color and font
3366 for the cursor
3367 {group-name}/{group-name}
3368 Two highlight group names, the first is used when
3369 no language mappings are used, the other when they
3370 are. |language-mapping|
3371
3372 Examples of parts:
3373 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3374 block cursor with colors from the "nCursor"
3375 highlight group
3376 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3377 In Insert and Command-line Insert mode, use a
3378 30% vertical bar cursor with colors from the
3379 "iCursor" highlight group. Blink a bit
3380 faster.
3381
3382 The 'a' mode is different. It will set the given argument-list for
3383 all modes. It does not reset anything to defaults. This can be used
3384 to do a common setting for all modes. For example, to switch off
3385 blinking: "a:blinkon0"
3386
3387 Examples of cursor highlighting: >
3388 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3389 :highlight Cursor gui=NONE guifg=bg guibg=fg
3390<
3391 *'guifont'* *'gfn'*
3392 *E235* *E596* *E610* *E611*
3393'guifont' 'gfn' string (default "")
3394 global
3395 {not in Vi}
3396 {only available when compiled with GUI enabled}
3397 This is a list of fonts which will be used for the GUI version of Vim.
3398 In its simplest form the value is just one font name. When
3399 the font cannot be found you will get an error message. To try other
3400 font names a list can be specified, font names separated with commas.
3401 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003402
Bram Moolenaar05159a02005-02-26 23:04:13 +00003403 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3404 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003405
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 Spaces after a comma are ignored. To include a comma in a font name
3407 precede it with a backslash. Setting an option requires an extra
3408 backslash before a space and a backslash. See also
3409 |option-backslash|. For example: >
3410 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003411< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003413
3414 If none of the fonts can be loaded, Vim will keep the current setting.
3415 If an empty font list is given, Vim will try using other resource
3416 settings (for X, it will use the Vim.font resource), and finally it
3417 will try some builtin default which should always be there ("7x13" in
3418 the case of X). The font names given should be "normal" fonts. Vim
3419 will try to find the related bold and italic fonts.
3420
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003421 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003422 :set guifont=*
3423< will bring up a font requester, where you can pick the font you want.
3424
3425 The font name depends on the GUI used. See |setting-guifont| for a
3426 way to set 'guifont' for various systems.
3427
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 For the GTK+ 2 GUI the font name looks like this: >
3429 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003430< That's all. XLFDs are not used. For Chinese this is reported to work
3431 well: >
3432 if has("gui_gtk2")
3433 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3434 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3435 endif
3436<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003437 For Mac OSX you can use something like this: >
3438 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003439< Also see 'macatsui', it can help fix display problems.
3440 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003442 width). An exception is GTK 2: all fonts are accepted, but
3443 mono-spaced fonts look best.
3444
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 To preview a font on X11, you might be able to use the "xfontsel"
3446 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003447
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 For the Win32 GUI *E244* *E245*
3449 - takes these options in the font name:
3450 hXX - height is XX (points, can be floating-point)
3451 wXX - width is XX (points, can be floating-point)
3452 b - bold
3453 i - italic
3454 u - underline
3455 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003456 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3458 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3459 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003460 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461
3462 Use a ':' to separate the options.
3463 - A '_' can be used in the place of a space, so you don't need to use
3464 backslashes to escape the spaces.
3465 - Examples: >
3466 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3467 :set guifont=Andale_Mono:h7.5:w4.5
3468< See also |font-sizes|.
3469
3470 *'guifontset'* *'gfs'*
3471 *E250* *E252* *E234* *E597* *E598*
3472'guifontset' 'gfs' string (default "")
3473 global
3474 {not in Vi}
3475 {only available when compiled with GUI enabled and
3476 with the |+xfontset| feature}
3477 {not available in the GTK+ 2 GUI}
3478 When not empty, specifies two (or more) fonts to be used. The first
3479 one for normal English, the second one for your special language. See
3480 |xfontset|.
3481 Setting this option also means that all font names will be handled as
3482 a fontset name. Also the ones used for the "font" argument of the
3483 |:highlight| command.
3484 The fonts must match with the current locale. If fonts for the
3485 character sets that the current locale uses are not included, setting
3486 'guifontset' will fail.
3487 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3488 the comma-separated names are alternative names, one of which will be
3489 used. In 'guifontset' the whole string is one fontset name,
3490 including the commas. It is not possible to specify alternative
3491 fontset names.
3492 This example works on many X11 systems: >
3493 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3494<
3495 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3496'guifontwide' 'gfw' string (default "")
3497 global
3498 {not in Vi}
3499 {only available when compiled with GUI enabled}
3500 When not empty, specifies a comma-separated list of fonts to be used
3501 for double-width characters. The first font that can be loaded is
3502 used.
3503 Note: The size of these fonts must be exactly twice as wide as the one
3504 specified with 'guifont' and the same height.
3505
3506 All GUI versions but GTK+ 2:
3507
3508 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3509 'guifontset' is empty or invalid.
3510 When 'guifont' is set and a valid font is found in it and
3511 'guifontwide' is empty Vim will attempt to find a matching
3512 double-width font and set 'guifontwide' to it.
3513
3514 GTK+ 2 GUI only: *guifontwide_gtk2*
3515
3516 If set and valid, 'guifontwide' is always used for double width
3517 characters, even if 'encoding' is not set to "utf-8".
3518 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003519 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 font for characters not available in 'guifont'. Thus you do not need
3521 to set 'guifontwide' at all unless you want to override the choice
3522 made by Pango/Xft.
3523
3524 *'guiheadroom'* *'ghr'*
3525'guiheadroom' 'ghr' number (default 50)
3526 global
3527 {not in Vi} {only for GTK and X11 GUI}
3528 The number of pixels subtracted from the screen height when fitting
3529 the GUI window on the screen. Set this before the GUI is started,
3530 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003531 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 lines will be left for window decorations and other items on the
3533 screen. Set it to a negative value to allow windows taller than the
3534 screen.
3535
3536 *'guioptions'* *'go'*
3537'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003538 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 global
3540 {not in Vi}
3541 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003542 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 sequence of letters which describes what components and options of the
3544 GUI should be used.
3545 To avoid problems with flags that are added in the future, use the
3546 "+=" and "-=" feature of ":set" |add-option-flags|.
3547
3548 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003549 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 'a' Autoselect: If present, then whenever VISUAL mode is started,
3551 or the Visual area extended, Vim tries to become the owner of
3552 the windowing system's global selection. This means that the
3553 Visually highlighted text is available for pasting into other
3554 applications as well as into Vim itself. When the Visual mode
3555 ends, possibly due to an operation on the text, or when an
3556 application wants to paste the selection, the highlighted text
3557 is automatically yanked into the "* selection register.
3558 Thus the selection is still available for pasting into other
3559 applications after the VISUAL mode has ended.
3560 If not present, then Vim won't become the owner of the
3561 windowing system's global selection unless explicitly told to
3562 by a yank or delete operation for the "* register.
3563 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003564 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003565 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 applies to the modeless selection.
3567
3568 'guioptions' autoselect Visual autoselect modeless ~
3569 "" - -
3570 "a" yes yes
3571 "A" - yes
3572 "aA" yes yes
3573
Bram Moolenaar02467872007-05-06 13:22:01 +00003574 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 'c' Use console dialogs instead of popup dialogs for simple
3576 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003577 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003578 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003579 'guitablabel' can be used to change the text in the labels.
3580 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003581 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003582 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003583 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 'f' Foreground: Don't use fork() to detach the GUI from the shell
3585 where it was started. Use this for programs that wait for the
3586 editor to finish (e.g., an e-mail program). Alternatively you
3587 can use "gvim -f" or ":gui -f" to start the GUI in the
3588 foreground. |gui-fork|
3589 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003590 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003591 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3593 corner of the window. It's black&white on non-GTK, because of
3594 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003595 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003597 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003598 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003600 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 file is sourced the system menu has already been loaded; the
3602 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003603 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 'g' Grey menu items: Make menu items that are not active grey. If
3605 'g' is not included inactive menu items are not shown at all.
3606 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003607 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 't' Include tearoff menu items. Currently only works for Win32,
3609 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003610 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003611 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003612 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003613 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003615 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 'R' Right-hand scrollbar is present when there is a vertically
3617 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003618 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003620 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 'L' Left-hand scrollbar is present when there is a vertically
3622 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003623 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3625 the longest visible line, or on the cursor line if the 'h'
3626 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003627 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 'h' Limit horizontal scrollbar size to the length of the cursor
3629 line. Reduces computations. |gui-horiz-scroll|
3630
3631 And yes, you may even have scrollbars on the left AND the right if
3632 you really want to :-). See |gui-scrollbars| for more information.
3633
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003634 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 'v' Use a vertical button layout for dialogs. When not included,
3636 a horizontal layout is preferred, but when it doesn't fit a
3637 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003638 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 'p' Use Pointer callbacks for X11 GUI. This is required for some
3640 window managers. If the cursor is not blinking or hollow at
3641 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003642 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003644 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003645 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646
Bram Moolenaar02467872007-05-06 13:22:01 +00003647
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 *'guipty'* *'noguipty'*
3649'guipty' boolean (default on)
3650 global
3651 {not in Vi}
3652 {only available when compiled with GUI enabled}
3653 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3654 I/O to/from shell commands. See |gui-pty|.
3655
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003656 *'guitablabel'* *'gtl'*
3657'guitablabel' 'gtl' string (default empty)
3658 global
3659 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003660 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003661 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003662 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003663 pages line. When empty and when the result is empty Vim will use a
3664 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003665
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003666 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003667 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003668
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003669 Only used when the GUI tab pages line is displayed. 'e' must be
3670 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3671 used.
3672
Bram Moolenaar57657d82006-04-21 22:12:41 +00003673 *'guitabtooltip'* *'gtt'*
3674'guitabtooltip' 'gtt' string (default empty)
3675 global
3676 {not in Vi}
3677 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003678 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003679 When nonempty describes the text to use in a tooltip for the GUI tab
3680 pages line. When empty Vim will use a default tooltip.
3681 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003682 You can include a line break. Simplest method is to use |:let|: >
3683 :let &guitabtooltip = "line one\nline two"
3684<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003685
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 *'helpfile'* *'hf'*
3687'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3688 (others) "$VIMRUNTIME/doc/help.txt")
3689 global
3690 {not in Vi}
3691 Name of the main help file. All distributed help files should be
3692 placed together in one directory. Additionally, all "doc" directories
3693 in 'runtimepath' will be used.
3694 Environment variables are expanded |:set_env|. For example:
3695 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003696 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 spaces and backslashes.
3698 This option cannot be set from a |modeline| or in the |sandbox|, for
3699 security reasons.
3700
3701 *'helpheight'* *'hh'*
3702'helpheight' 'hh' number (default 20)
3703 global
3704 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003705 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 feature}
3707 Minimal initial height of the help window when it is opened with the
3708 ":help" command. The initial height of the help window is half of the
3709 current window, or (when the 'ea' option is on) the same as other
3710 windows. When the height is less than 'helpheight', the height is
3711 set to 'helpheight'. Set to zero to disable.
3712
3713 *'helplang'* *'hlg'*
3714'helplang' 'hlg' string (default: messages language or empty)
3715 global
3716 {only available when compiled with the |+multi_lang|
3717 feature}
3718 {not in Vi}
3719 Comma separated list of languages. Vim will use the first language
3720 for which the desired help can be found. The English help will always
3721 be used as a last resort. You can add "en" to prefer English over
3722 another language, but that will only find tags that exist in that
3723 language and not in the English help.
3724 Example: >
3725 :set helplang=de,it
3726< This will first search German, then Italian and finally English help
3727 files.
3728 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3729 try to find the tag in the current language before using this option.
3730 See |help-translated|.
3731
3732 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3733'hidden' 'hid' boolean (default off)
3734 global
3735 {not in Vi}
3736 When off a buffer is unloaded when it is |abandon|ed. When on a
3737 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3738 displayed in another window, it does not become hidden, of course.
3739 The commands that move through the buffer list sometimes make a buffer
3740 hidden although the 'hidden' option is off: When the buffer is
3741 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003742 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003743 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 This option is set for one command with ":hide {command}" |:hide|.
3745 WARNING: It's easy to forget that you have changes in hidden buffers.
3746 Think twice when using ":q!" or ":qa!".
3747
3748 *'highlight'* *'hl'*
3749'highlight' 'hl' string (default (as a single string):
3750 "8:SpecialKey,@:NonText,d:Directory,
3751 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3752 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003753 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3755 f:Folded,F:FoldColumn,A:DiffAdd,
3756 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003757 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003758 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003759 +:Pmenu,=:PmenuSel,
3760 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003761 global
3762 {not in Vi}
3763 This option can be used to set highlighting mode for various
3764 occasions. It is a comma separated list of character pairs. The
3765 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003766 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3768 |hl-NonText| @ '~' and '@' at the end of the window and
3769 characters from 'showbreak'
3770 |hl-Directory| d directories in CTRL-D listing and other special
3771 things in listings
3772 |hl-ErrorMsg| e error messages
3773 h (obsolete, ignored)
3774 |hl-IncSearch| i 'incsearch' highlighting
3775 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3776 |hl-MoreMsg| m |more-prompt|
3777 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003778 |hl-LineNr| n line number for ":number" and ":#" commands, and
3779 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 |hl-Question| r |hit-enter| prompt and yes/no questions
3781 |hl-StatusLine| s status line of current window |status-line|
3782 |hl-StatusLineNC| S status lines of not-current windows
3783 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3784 |hl-VertSplit| c column used to separate vertically split windows
3785 |hl-Visual| v Visual mode
3786 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3787 Selection" Only X11 Gui's |gui-x11| and
3788 |xterm-clipboard|.
3789 |hl-WarningMsg| w warning messages
3790 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3791 |hl-Folded| f line used for closed folds
3792 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003793 |hl-DiffAdd| A added line in diff mode
3794 |hl-DiffChange| C changed line in diff mode
3795 |hl-DiffDelete| D deleted line in diff mode
3796 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003798 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003799 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003800 |hl-SpellRare| R rare word |spell|
3801 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003802 |hl-Conceal| - the placeholders used for concealed characters
3803 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003804 |hl-Pmenu| + popup menu normal line
3805 |hl-PmenuSel| = popup menu normal line
3806 |hl-PmenuSbar| x popup menu scrollbar
3807 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808
3809 The display modes are:
3810 r reverse (termcap entry "mr" and "me")
3811 i italic (termcap entry "ZH" and "ZR")
3812 b bold (termcap entry "md" and "me")
3813 s standout (termcap entry "so" and "se")
3814 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003815 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 n no highlighting
3817 - no highlighting
3818 : use a highlight group
3819 The default is used for occasions that are not included.
3820 If you want to change what the display modes do, see |dos-colors|
3821 for an example.
3822 When using the ':' display mode, this must be followed by the name of
3823 a highlight group. A highlight group can be used to define any type
3824 of highlighting, including using color. See |:highlight| on how to
3825 define one. The default uses a different group for each occasion.
3826 See |highlight-default| for the default highlight groups.
3827
3828 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3829'hlsearch' 'hls' boolean (default off)
3830 global
3831 {not in Vi}
3832 {not available when compiled without the
3833 |+extra_search| feature}
3834 When there is a previous search pattern, highlight all its matches.
3835 The type of highlighting used can be set with the 'l' occasion in the
3836 'highlight' option. This uses the "Search" highlight group by
3837 default. Note that only the matching text is highlighted, any offsets
3838 are not applied.
3839 See also: 'incsearch' and |:match|.
3840 When you get bored looking at the highlighted matches, you can turn it
3841 off with |:nohlsearch|. As soon as you use a search command, the
3842 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003843 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 When the search pattern can match an end-of-line, Vim will try to
3845 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003846 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003848 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 NOTE: This option is reset when 'compatible' is set.
3850
3851 *'history'* *'hi'*
3852'history' 'hi' number (Vim default: 20, Vi default: 0)
3853 global
3854 {not in Vi}
3855 A history of ":" commands, and a history of previous search patterns
3856 are remembered. This option decides how many entries may be stored in
3857 each of these histories (see |cmdline-editing|).
3858 NOTE: This option is set to the Vi default value when 'compatible' is
3859 set and to the Vim default value when 'compatible' is reset.
3860
3861 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3862'hkmap' 'hk' boolean (default off)
3863 global
3864 {not in Vi}
3865 {only available when compiled with the |+rightleft|
3866 feature}
3867 When on, the keyboard is mapped for the Hebrew character set.
3868 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3869 toggle this option. See |rileft.txt|.
3870 NOTE: This option is reset when 'compatible' is set.
3871
3872 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3873'hkmapp' 'hkp' boolean (default off)
3874 global
3875 {not in Vi}
3876 {only available when compiled with the |+rightleft|
3877 feature}
3878 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3879 This is useful if you have a non-Hebrew keyboard.
3880 See |rileft.txt|.
3881 NOTE: This option is reset when 'compatible' is set.
3882
3883 *'icon'* *'noicon'*
3884'icon' boolean (default off, on when title can be restored)
3885 global
3886 {not in Vi}
3887 {not available when compiled without the |+title|
3888 feature}
3889 When on, the icon text of the window will be set to the value of
3890 'iconstring' (if it is not empty), or to the name of the file
3891 currently being edited. Only the last part of the name is used.
3892 Overridden by the 'iconstring' option.
3893 Only works if the terminal supports setting window icons (currently
3894 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3895 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3896 builtin termcap).
3897 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003898 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 X11.
3900
3901 *'iconstring'*
3902'iconstring' string (default "")
3903 global
3904 {not in Vi}
3905 {not available when compiled without the |+title|
3906 feature}
3907 When this option is not empty, it will be used for the icon text of
3908 the window. This happens only when the 'icon' option is on.
3909 Only works if the terminal supports setting window icon text
3910 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3911 Does not work for MS Windows.
3912 When Vim was compiled with HAVE_X11 defined, the original icon will be
3913 restored if possible |X11|.
3914 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003915 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 'titlestring' for example settings.
3917 {not available when compiled without the |+statusline| feature}
3918
3919 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3920'ignorecase' 'ic' boolean (default off)
3921 global
3922 Ignore case in search patterns. Also used when searching in the tags
3923 file.
3924 Also see 'smartcase'.
3925 Can be overruled by using "\c" or "\C" in the pattern, see
3926 |/ignorecase|.
3927
3928 *'imactivatekey'* *'imak'*
3929'imactivatekey' 'imak' string (default "")
3930 global
3931 {not in Vi}
3932 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003933 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 Specifies the key that your Input Method in X-Windows uses for
3935 activation. When this is specified correctly, vim can fully control
3936 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3937 You can't use this option to change the activation key, the option
3938 tells Vim what the key is.
3939 Format:
3940 [MODIFIER_FLAG-]KEY_STRING
3941
3942 These characters can be used for MODIFIER_FLAG (case is ignored):
3943 S Shift key
3944 L Lock key
3945 C Control key
3946 1 Mod1 key
3947 2 Mod2 key
3948 3 Mod3 key
3949 4 Mod4 key
3950 5 Mod5 key
3951 Combinations are allowed, for example "S-C-space" or "SC-space" are
3952 both shift+ctrl+space.
3953 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3954
3955 Example: >
3956 :set imactivatekey=S-space
3957< "S-space" means shift+space. This is the activation key for kinput2 +
3958 canna (Japanese), and ami (Korean).
3959
3960 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3961'imcmdline' 'imc' boolean (default off)
3962 global
3963 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003964 {only available when compiled with the |+xim|,
3965 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 When set the Input Method is always on when starting to edit a command
3967 line, unless entering a search pattern (see 'imsearch' for that).
3968 Setting this option is useful when your input method allows entering
3969 English characters directly, e.g., when it's used to type accented
3970 characters with dead keys.
3971
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003972 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3974 global
3975 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003976 {only available when compiled with the |+xim|,
3977 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 When set the Input Method is never used. This is useful to disable
3979 the IM when it doesn't work properly.
3980 Currently this option is on by default for SGI/IRIX machines. This
3981 may change in later releases.
3982
3983 *'iminsert'* *'imi'*
3984'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3985 local to buffer
3986 {not in Vi}
3987 Specifies whether :lmap or an Input Method (IM) is to be used in
3988 Insert mode. Valid values:
3989 0 :lmap is off and IM is off
3990 1 :lmap is ON and IM is off
3991 2 :lmap is off and IM is ON
3992 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3993 or |global-ime|.
3994 To always reset the option to zero when leaving Insert mode with <Esc>
3995 this can be used: >
3996 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3997< This makes :lmap and IM turn off automatically when leaving Insert
3998 mode.
3999 Note that this option changes when using CTRL-^ in Insert mode
4000 |i_CTRL-^|.
4001 The value is set to 1 when setting 'keymap' to a valid keymap name.
4002 It is also used for the argument of commands like "r" and "f".
4003 The value 0 may not work correctly with Athena and Motif with some XIM
4004 methods. Use 'imdisable' to disable XIM then.
4005
4006 *'imsearch'* *'ims'*
4007'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4008 local to buffer
4009 {not in Vi}
4010 Specifies whether :lmap or an Input Method (IM) is to be used when
4011 entering a search pattern. Valid values:
4012 -1 the value of 'iminsert' is used, makes it look like
4013 'iminsert' is also used when typing a search pattern
4014 0 :lmap is off and IM is off
4015 1 :lmap is ON and IM is off
4016 2 :lmap is off and IM is ON
4017 Note that this option changes when using CTRL-^ in Command-line mode
4018 |c_CTRL-^|.
4019 The value is set to 1 when it is not -1 and setting the 'keymap'
4020 option to a valid keymap name.
4021 The value 0 may not work correctly with Athena and Motif with some XIM
4022 methods. Use 'imdisable' to disable XIM then.
4023
4024 *'include'* *'inc'*
4025'include' 'inc' string (default "^\s*#\s*include")
4026 global or local to buffer |global-local|
4027 {not in Vi}
4028 {not available when compiled without the
4029 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004030 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 pattern, just like for the "/" command (See |pattern|). The default
4032 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004033 "]I", "[d", etc.
4034 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004035 comes after the matched pattern. But if "\zs" appears in the pattern
4036 then the text matched from "\zs" to the end, or until "\ze" if it
4037 appears, is used as the file name. Use this to include characters
4038 that are not in 'isfname', such as a space. You can then use
4039 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004040 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041
4042 *'includeexpr'* *'inex'*
4043'includeexpr' 'inex' string (default "")
4044 local to buffer
4045 {not in Vi}
4046 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004047 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004049 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 :set includeexpr=substitute(v:fname,'\\.','/','g')
4051< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004052
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004054 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 Also used for |<cfile>|.
4056
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004057 The expression may be evaluated in the |sandbox|, see
4058 |sandbox-option|.
4059
4060 It is not allowed to change text or jump to another window while
4061 evaluating 'includeexpr' |textlock|.
4062
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4064'incsearch' 'is' boolean (default off)
4065 global
4066 {not in Vi}
4067 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004068 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004069 While typing a search command, show where the pattern, as it was typed
4070 so far, matches. The matched string is highlighted. If the pattern
4071 is invalid or not found, nothing is shown. The screen will be updated
4072 often, this is only useful on fast terminals.
4073 Note that the match will be shown, but the cursor will return to its
4074 original position when no match is found and when pressing <Esc>. You
4075 still need to finish the search command with <Enter> to move the
4076 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004077 When compiled with the |+reltime| feature Vim only searches for about
4078 half a second. With a complicated pattern and/or a lot of text the
4079 match may not be found. This is to avoid that Vim hangs while you
4080 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004081 The highlighting can be set with the 'i' flag in 'highlight'.
4082 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004083 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004084 to the command line. If 'ignorecase' and 'smartcase' are set and the
4085 command line has no uppercase characters, the added character is
4086 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004087 CTRL-R CTRL-W can be used to add the word at the end of the current
4088 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 NOTE: This option is reset when 'compatible' is set.
4090
4091 *'indentexpr'* *'inde'*
4092'indentexpr' 'inde' string (default "")
4093 local to buffer
4094 {not in Vi}
4095 {not available when compiled without the |+cindent|
4096 or |+eval| features}
4097 Expression which is evaluated to obtain the proper indent for a line.
4098 It is used when a new line is created, for the |=| operator and
4099 in Insert mode as specified with the 'indentkeys' option.
4100 When this option is not empty, it overrules the 'cindent' and
4101 'smartindent' indenting.
4102 When 'paste' is set this option is not used for indenting.
4103 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004104 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 when the expression is evaluated (but it may be moved around).
4106 The expression must return the number of spaces worth of indent. It
4107 can return "-1" to keep the current indent (this means 'autoindent' is
4108 used for the indent).
4109 Functions useful for computing the indent are |indent()|, |cindent()|
4110 and |lispindent()|.
4111 The evaluation of the expression must not have side effects! It must
4112 not change the text, jump to another window, etc. Afterwards the
4113 cursor position is always restored, thus the cursor may be moved.
4114 Normally this option would be set to call a function: >
4115 :set indentexpr=GetMyIndent()
4116< Error messages will be suppressed, unless the 'debug' option contains
4117 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004118 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 NOTE: This option is made empty when 'compatible' is set.
4120
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004121 The expression may be evaluated in the |sandbox|, see
4122 |sandbox-option|.
4123
4124 It is not allowed to change text or jump to another window while
4125 evaluating 'indentexpr' |textlock|.
4126
4127
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 *'indentkeys'* *'indk'*
4129'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4130 local to buffer
4131 {not in Vi}
4132 {not available when compiled without the |+cindent|
4133 feature}
4134 A list of keys that, when typed in Insert mode, cause reindenting of
4135 the current line. Only happens if 'indentexpr' isn't empty.
4136 The format is identical to 'cinkeys', see |indentkeys-format|.
4137 See |C-indenting| and |indent-expression|.
4138
4139 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4140'infercase' 'inf' boolean (default off)
4141 local to buffer
4142 {not in Vi}
4143 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004144 'ignorecase' is also on, the case of the match is adjusted depending
4145 on the typed text. If the typed text contains a lowercase letter
4146 where the match has an upper case letter, the completed part is made
4147 lowercase. If the typed text has no lowercase letters and the match
4148 has a lowercase letter where the typed text has an uppercase letter,
4149 and there is a letter before it, the completed part is made uppercase.
4150 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151
4152 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4153'insertmode' 'im' boolean (default off)
4154 global
4155 {not in Vi}
4156 Makes Vim work in a way that Insert mode is the default mode. Useful
4157 if you want to use Vim as a modeless editor. Used for |evim|.
4158 These Insert mode commands will be useful:
4159 - Use the cursor keys to move around.
4160 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4161 this is a mapping, it is executed as if 'insertmode' was off.
4162 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004164 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4165 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166
4167 These items change when 'insertmode' is set:
4168 - when starting to edit of a file, Vim goes to Insert mode.
4169 - <Esc> in Insert mode is a no-op and beeps.
4170 - <Esc> in Normal mode makes Vim go to Insert mode.
4171 - CTRL-L in Insert mode is a command, it is not inserted.
4172 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4173 However, when <Esc> is used inside a mapping, it behaves like
4174 'insertmode' was not set. This was done to be able to use the same
4175 mappings with 'insertmode' set or not set.
4176 When executing commands with |:normal| 'insertmode' is not used.
4177
4178 NOTE: This option is reset when 'compatible' is set.
4179
4180 *'isfname'* *'isf'*
4181'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4182 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4183 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4184 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4185 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4186 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4187 global
4188 {not in Vi}
4189 The characters specified by this option are included in file names and
4190 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004191 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 Multi-byte characters 256 and above are always included, only the
4193 characters up to 255 are specified with this option.
4194 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004195 Think twice before adding white space to this option. Although a
4196 space may appear inside a file name, the effect will be that Vim
4197 doesn't know where a file name starts or ends when doing completion.
4198 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199
4200 Note that on systems using a backslash as path separator, Vim tries to
4201 do its best to make it work as you would expect. That is a bit
4202 tricky, since Vi originally used the backslash to escape special
4203 characters. Vim will not remove a backslash in front of a normal file
4204 name character on these systems, but it will on Unix and alikes. The
4205 '&' and '^' are not included by default, because these are special for
4206 cmd.exe.
4207
4208 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004209 Each part can be a single character number or a range. A range is two
4210 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 decimal number between 0 and 255 or the ASCII character itself (does
4212 not work for digits). Example:
4213 "_,-,128-140,#-43" (include '_' and '-' and the range
4214 128 to 140 and '#' to 43)
4215 If a part starts with '^', the following character number or range
4216 will be excluded from the option. The option is interpreted from left
4217 to right. Put the excluded character after the range where it is
4218 included. To include '^' itself use it as the last character of the
4219 option or the end of a range. Example:
4220 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4221 If the character is '@', all characters where isalpha() returns TRUE
4222 are included. Normally these are the characters a to z and A to Z,
4223 plus accented characters. To include '@' itself use "@-@". Examples:
4224 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004225 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 "a-z,A-Z,@-@" All letters plus the '@' character.
4227 A comma can be included by using it where a character number is
4228 expected. Example:
4229 "48-57,,,_" Digits, comma and underscore.
4230 A comma can be excluded by prepending a '^'. Example:
4231 " -~,^,,9" All characters from space to '~', excluding
4232 comma, plus <Tab>.
4233 See |option-backslash| about including spaces and backslashes.
4234
4235 *'isident'* *'isi'*
4236'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4237 "@,48-57,_,128-167,224-235"
4238 otherwise: "@,48-57,_,192-255")
4239 global
4240 {not in Vi}
4241 The characters given by this option are included in identifiers.
4242 Identifiers are used in recognizing environment variables and after a
4243 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004244 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 option.
4246 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004247 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4249
4250 *'iskeyword'* *'isk'*
4251'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4252 "@,48-57,_,128-167,224-235"
4253 otherwise: "@,48-57,_,192-255"
4254 Vi default: "@,48-57,_")
4255 local to buffer
4256 {not in Vi}
4257 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004258 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 'isfname' for a description of the format of this option. For C
4260 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4261 For a help file it is set to all non-blank printable characters except
4262 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4263 command).
4264 When the 'lisp' option is on the '-' character is always included.
4265 NOTE: This option is set to the Vi default value when 'compatible' is
4266 set and to the Vim default value when 'compatible' is reset.
4267
4268 *'isprint'* *'isp'*
4269'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4270 "@,~-255"; otherwise: "@,161-255")
4271 global
4272 {not in Vi}
4273 The characters given by this option are displayed directly on the
4274 screen. It is also used for "\p" in a |pattern|. The characters from
4275 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4276 even when they are not included in 'isprint' or excluded. See
4277 'isfname' for a description of the format of this option.
4278
4279 Non-printable characters are displayed with two characters:
4280 0 - 31 "^@" - "^_"
4281 32 - 126 always single characters
4282 127 "^?"
4283 128 - 159 "~@" - "~_"
4284 160 - 254 "| " - "|~"
4285 255 "~?"
4286 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4287 displayed as <xx>, with the hexadecimal value of the byte.
4288 When 'display' contains "uhex" all unprintable characters are
4289 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004290 The SpecialKey highlighting will be used for unprintable characters.
4291 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292
4293 Multi-byte characters 256 and above are always included, only the
4294 characters up to 255 are specified with this option. When a character
4295 is printable but it is not available in the current font, a
4296 replacement character will be shown.
4297 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4298 There is no option to specify these characters.
4299
4300 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4301'joinspaces' 'js' boolean (default on)
4302 global
4303 {not in Vi}
4304 Insert two spaces after a '.', '?' and '!' with a join command.
4305 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4306 Otherwise only one space is inserted.
4307 NOTE: This option is set when 'compatible' is set.
4308
4309 *'key'*
4310'key' string (default "")
4311 local to buffer
4312 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004313 {only available when compiled with the |+cryptv|
4314 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004316 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 Careful: Do not set the key value by hand, someone might see the typed
4318 key. Use the |:X| command. But you can make 'key' empty: >
4319 :set key=
4320< It is not possible to get the value of this option with ":set key" or
4321 "echo &key". This is to avoid showing it to someone who shouldn't
4322 know. It also means you cannot see it yourself once you have set it,
4323 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004324 You can use "&key" in an expression to detect whether encryption is
4325 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326
4327 *'keymap'* *'kmp'* *E544*
4328'keymap' 'kmp' string (default "")
4329 local to buffer
4330 {not in Vi}
4331 {only available when compiled with the |+keymap|
4332 feature}
4333 Name of a keyboard mapping. See |mbyte-keymap|.
4334 Setting this option to a valid keymap name has the side effect of
4335 setting 'iminsert' to one, so that the keymap becomes effective.
4336 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004337 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338
4339 *'keymodel'* *'km'*
4340'keymodel' 'km' string (default "")
4341 global
4342 {not in Vi}
4343 List of comma separated words, which enable special things that keys
4344 can do. These values can be used:
4345 startsel Using a shifted special key starts selection (either
4346 Select mode or Visual mode, depending on "key" being
4347 present in 'selectmode').
4348 stopsel Using a not-shifted special key stops selection.
4349 Special keys in this context are the cursor keys, <End>, <Home>,
4350 <PageUp> and <PageDown>.
4351 The 'keymodel' option is set by the |:behave| command.
4352
4353 *'keywordprg'* *'kp'*
4354'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4355 OS/2: "view /", VMS: "help")
4356 global or local to buffer |global-local|
4357 {not in Vi}
4358 Program to use for the |K| command. Environment variables are
4359 expanded |:set_env|. ":help" may be used to access the Vim internal
4360 help. (Note that previously setting the global option to the empty
4361 value did this, which is now deprecated.)
4362 When "man" is used, Vim will automatically translate a count for the
4363 "K" command to a section number. Also for "man -s", in which case the
4364 "-s" is removed when there is no count.
4365 See |option-backslash| about including spaces and backslashes.
4366 Example: >
4367 :set keywordprg=man\ -s
4368< This option cannot be set from a |modeline| or in the |sandbox|, for
4369 security reasons.
4370
4371 *'langmap'* *'lmap'* *E357* *E358*
4372'langmap' 'lmap' string (default "")
4373 global
4374 {not in Vi}
4375 {only available when compiled with the |+langmap|
4376 feature}
4377 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004378 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 inserted directly. When in command mode the 'langmap' option takes
4380 care of translating these special characters to the original meaning
4381 of the key. This means you don't have to change the keyboard mode to
4382 be able to execute Normal mode commands.
4383 This is the opposite of the 'keymap' option, where characters are
4384 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004386 Example (for Greek, in UTF-8): *greek* >
4387 :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 +00004388< Example (exchanges meaning of z and y for commands): >
4389 :set langmap=zy,yz,ZY,YZ
4390<
4391 The 'langmap' option is a list of parts, separated with commas. Each
4392 part can be in one of two forms:
4393 1. A list of pairs. Each pair is a "from" character immediately
4394 followed by the "to" character. Examples: "aA", "aAbBcC".
4395 2. A list of "from" characters, a semi-colon and a list of "to"
4396 characters. Example: "abc;ABC"
4397 Example: "aA,fgh;FGH,cCdDeE"
4398 Special characters need to be preceded with a backslash. These are
4399 ";", ',' and backslash itself.
4400
4401 This will allow you to activate vim actions without having to switch
4402 back and forth between the languages. Your language characters will
4403 be understood as normal vim English characters (according to the
4404 langmap mappings) in the following cases:
4405 o Normal/Visual mode (commands, buffer/register names, user mappings)
4406 o Insert/Replace Mode: Register names after CTRL-R
4407 o Insert/Replace Mode: Mappings
4408 Characters entered in Command-line mode will NOT be affected by
4409 this option. Note that this option can be changed at any time
4410 allowing to switch between mappings for different languages/encodings.
4411 Use a mapping to avoid having to type it each time!
4412
4413 *'langmenu'* *'lm'*
4414'langmenu' 'lm' string (default "")
4415 global
4416 {not in Vi}
4417 {only available when compiled with the |+menu| and
4418 |+multi_lang| features}
4419 Language to use for menu translation. Tells which file is loaded
4420 from the "lang" directory in 'runtimepath': >
4421 "lang/menu_" . &langmenu . ".vim"
4422< (without the spaces). For example, to always use the Dutch menus, no
4423 matter what $LANG is set to: >
4424 :set langmenu=nl_NL.ISO_8859-1
4425< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004426 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 If your $LANG is set to a non-English language but you do want to use
4428 the English menus: >
4429 :set langmenu=none
4430< This option must be set before loading menus, switching on filetype
4431 detection or syntax highlighting. Once the menus are defined setting
4432 this option has no effect. But you could do this: >
4433 :source $VIMRUNTIME/delmenu.vim
4434 :set langmenu=de_DE.ISO_8859-1
4435 :source $VIMRUNTIME/menu.vim
4436< Warning: This deletes all menus that you defined yourself!
4437
4438 *'laststatus'* *'ls'*
4439'laststatus' 'ls' number (default 1)
4440 global
4441 {not in Vi}
4442 The value of this option influences when the last window will have a
4443 status line:
4444 0: never
4445 1: only if there are at least two windows
4446 2: always
4447 The screen looks nicer with a status line if you have several
4448 windows, but it takes another screen line. |status-line|
4449
4450 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4451'lazyredraw' 'lz' boolean (default off)
4452 global
4453 {not in Vi}
4454 When this option is set, the screen will not be redrawn while
4455 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004456 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 update use |:redraw|.
4458
4459 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4460'linebreak' 'lbr' boolean (default off)
4461 local to window
4462 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004463 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 feature}
4465 If on Vim will wrap long lines at a character in 'breakat' rather
4466 than at the last character that fits on the screen. Unlike
4467 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4468 it only affects the way the file is displayed, not its contents. The
4469 value of 'showbreak' is used to put in front of wrapped lines.
4470 This option is not used when the 'wrap' option is off or 'list' is on.
4471 Note that <Tab> characters after an <EOL> are mostly not displayed
4472 with the right amount of white space.
4473
4474 *'lines'* *E593*
4475'lines' number (default 24 or terminal height)
4476 global
4477 Number of lines of the Vim window.
4478 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004479 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 When Vim is running in the GUI or in a resizable window, setting this
4481 option will cause the window size to be changed. When you only want
4482 to use the size for the GUI, put the command in your |gvimrc| file.
4483 Vim limits the number of lines to what fits on the screen. You can
4484 use this command to get the tallest window possible: >
4485 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004486< Minimum value is 2, maximum value is 1000.
4487 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 When you set this option and Vim is unable to change the physical
4489 number of lines of the display, the display may be messed up.
4490
4491 *'linespace'* *'lsp'*
4492'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4493 global
4494 {not in Vi}
4495 {only in the GUI}
4496 Number of pixel lines inserted between characters. Useful if the font
4497 uses the full character cell height, making lines touch each other.
4498 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004499 With some fonts there can be too much room between lines (to have
4500 space for ascents and descents). Then it makes sense to set
4501 'linespace' to a negative value. This may cause display problems
4502 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503
4504 *'lisp'* *'nolisp'*
4505'lisp' boolean (default off)
4506 local to buffer
4507 {not available when compiled without the |+lispindent|
4508 feature}
4509 Lisp mode: When <Enter> is typed in insert mode set the indent for
4510 the next line to Lisp standards (well, sort of). Also happens with
4511 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4512 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4513 better. Also see 'lispwords'.
4514 The '-' character is included in keyword characters. Redefines the
4515 "=" operator to use this same indentation algorithm rather than
4516 calling an external program if 'equalprg' is empty.
4517 This option is not used when 'paste' is set.
4518 {Vi: Does it a little bit differently}
4519
4520 *'lispwords'* *'lw'*
4521'lispwords' 'lw' string (default is very long)
4522 global
4523 {not in Vi}
4524 {not available when compiled without the |+lispindent|
4525 feature}
4526 Comma separated list of words that influence the Lisp indenting.
4527 |'lisp'|
4528
4529 *'list'* *'nolist'*
4530'list' boolean (default off)
4531 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004532 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4533 line. Useful to see the difference between tabs and spaces and for
4534 trailing blanks. Further changed by the 'listchars' option.
4535
4536 The cursor is displayed at the start of the space a Tab character
4537 occupies, not at the end as usual in Normal mode. To get this cursor
4538 position while displaying Tabs with spaces, use: >
4539 :set list lcs=tab\ \
4540<
4541 Note that list mode will also affect formatting (set with 'textwidth'
4542 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 changing the way tabs are displayed.
4544
4545 *'listchars'* *'lcs'*
4546'listchars' 'lcs' string (default "eol:$")
4547 global
4548 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004549 Strings to use in 'list' mode and for the |:list| command. It is a
4550 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 eol:c Character to show at the end of each line. When
4552 omitted, there is no extra character at the end of the
4553 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004554 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004556 fill the space that the tab normally occupies.
4557 "tab:>-" will show a tab that takes four spaces as
4558 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004559 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 trailing spaces are blank.
4561 extends:c Character to show in the last column, when 'wrap' is
4562 off and the line continues beyond the right of the
4563 screen.
4564 precedes:c Character to show in the first column, when 'wrap'
4565 is off and there is text preceding the character
4566 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004567 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004568 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004569 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004570 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004572 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004574 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575
4576 Examples: >
4577 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004578 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 :set lcs=extends:>,precedes:<
4580< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004581 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004582 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583
4584 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4585'loadplugins' 'lpl' boolean (default on)
4586 global
4587 {not in Vi}
4588 When on the plugin scripts are loaded when starting up |load-plugins|.
4589 This option can be reset in your |vimrc| file to disable the loading
4590 of plugins.
4591 Note that using the "-u NONE" and "--noplugin" command line arguments
4592 reset this option. |-u| |--noplugin|
4593
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004594 *'macatsui'* *'nomacatsui'*
4595'macatsui' boolean (default on)
4596 global
4597 {only available in Mac GUI version}
4598 This is a workaround for when drawing doesn't work properly. When set
4599 and compiled with multi-byte support ATSUI text drawing is used. When
4600 not set ATSUI text drawing is not used. Switch this option off when
4601 you experience drawing problems. In a future version the problems may
4602 be solved and this option becomes obsolete. Therefore use this method
4603 to unset it: >
4604 if exists('&macatsui')
4605 set nomacatsui
4606 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004607< Another option to check if you have drawing problems is
4608 'termencoding'.
4609
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 *'magic'* *'nomagic'*
4611'magic' boolean (default on)
4612 global
4613 Changes the special characters that can be used in search patterns.
4614 See |pattern|.
4615 NOTE: To avoid portability problems with using patterns, always keep
4616 this option at the default "on". Only switch it off when working with
4617 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004618 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619
4620 *'makeef'* *'mef'*
4621'makeef' 'mef' string (default: "")
4622 global
4623 {not in Vi}
4624 {not available when compiled without the |+quickfix|
4625 feature}
4626 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4627 and the |:grep| command.
4628 When it is empty, an internally generated temp file will be used.
4629 When "##" is included, it is replaced by a number to make the name
4630 unique. This makes sure that the ":make" command doesn't overwrite an
4631 existing file.
4632 NOT used for the ":cf" command. See 'errorfile' for that.
4633 Environment variables are expanded |:set_env|.
4634 See |option-backslash| about including spaces and backslashes.
4635 This option cannot be set from a |modeline| or in the |sandbox|, for
4636 security reasons.
4637
4638 *'makeprg'* *'mp'*
4639'makeprg' 'mp' string (default "make", VMS: "MMS")
4640 global or local to buffer |global-local|
4641 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004642 Program to use for the ":make" command. See |:make_makeprg|.
4643 This option may contain '%' and '#' characters, which are expanded to
4644 the current and alternate file name. |:_%| |:_#|
4645 Environment variables are expanded |:set_env|. See |option-backslash|
4646 about including spaces and backslashes.
4647 Note that a '|' must be escaped twice: once for ":set" and once for
4648 the interpretation of a command. When you use a filter called
4649 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 :set makeprg=gmake\ \\\|\ myfilter
4651< The placeholder "$*" can be given (even multiple times) to specify
4652 where the arguments will be included, for example: >
4653 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4654< This option cannot be set from a |modeline| or in the |sandbox|, for
4655 security reasons.
4656
4657 *'matchpairs'* *'mps'*
4658'matchpairs' 'mps' string (default "(:),{:},[:]")
4659 local to buffer
4660 {not in Vi}
4661 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004662 other. Currently only single byte character pairs are allowed, and
4663 they must be different. The characters must be separated by a colon.
4664 The pairs must be separated by a comma. Example for including '<' and
4665 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 :set mps+=<:>
4667
4668< A more exotic example, to jump between the '=' and ';' in an
4669 assignment, useful for languages like C and Java: >
4670 :au FileType c,cpp,java set mps+==:;
4671
4672< For a more advanced way of using "%", see the matchit.vim plugin in
4673 the $VIMRUNTIME/macros directory. |add-local-help|
4674
4675 *'matchtime'* *'mat'*
4676'matchtime' 'mat' number (default 5)
4677 global
4678 {not in Vi}{in Nvi}
4679 Tenths of a second to show the matching paren, when 'showmatch' is
4680 set. Note that this is not in milliseconds, like other options that
4681 set a time. This is to be compatible with Nvi.
4682
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004683 *'maxcombine'* *'mco'*
4684'maxcombine' 'mco' number (default 2)
4685 global
4686 {not in Vi}
4687 {only available when compiled with the |+multi_byte|
4688 feature}
4689 The maximum number of combining characters supported for displaying.
4690 Only used when 'encoding' is "utf-8".
4691 The default is OK for most languages. Hebrew may require 4.
4692 Maximum value is 6.
4693 Even when this option is set to 2 you can still edit text with more
4694 combining characters, you just can't see them. Use |g8| or |ga|.
4695 See |mbyte-combining|.
4696
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 *'maxfuncdepth'* *'mfd'*
4698'maxfuncdepth' 'mfd' number (default 100)
4699 global
4700 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004701 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004702 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 Maximum depth of function calls for user functions. This normally
4704 catches endless recursion. When using a recursive function with
4705 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4706 more memory, there is the danger of failing when memory is exhausted.
4707 See also |:function|.
4708
4709 *'maxmapdepth'* *'mmd'* *E223*
4710'maxmapdepth' 'mmd' number (default 1000)
4711 global
4712 {not in Vi}
4713 Maximum number of times a mapping is done without resulting in a
4714 character to be used. This normally catches endless mappings, like
4715 ":map x y" with ":map y x". It still does not catch ":map g wg",
4716 because the 'w' is used before the next mapping is done. See also
4717 |key-mapping|.
4718
4719 *'maxmem'* *'mm'*
4720'maxmem' 'mm' number (default between 256 to 5120 (system
4721 dependent) or half the amount of memory
4722 available)
4723 global
4724 {not in Vi}
4725 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4726 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004727 other memory to be freed. The maximum usable value is about 2000000.
4728 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004730 *'maxmempattern'* *'mmp'*
4731'maxmempattern' 'mmp' number (default 1000)
4732 global
4733 {not in Vi}
4734 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004735 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004736 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004737 When Vim runs into the limit it gives an error message and mostly
4738 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004739 Running into the limit often means that the pattern is very
4740 inefficient or too complex. This may already happen with the pattern
4741 "\(.\)*" on a very long line. ".*" works much better.
4742 Vim may run out of memory before hitting the 'maxmempattern' limit.
4743
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 *'maxmemtot'* *'mmt'*
4745'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4746 dependent) or half the amount of memory
4747 available)
4748 global
4749 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004750 Maximum amount of memory in Kbyte to use for all buffers together.
4751 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4752 without a limit. On 64 bit machines higher values might work. But
4753 hey, do you really need more than 2 Gbyte for text editing?
4754 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755
4756 *'menuitems'* *'mis'*
4757'menuitems' 'mis' number (default 25)
4758 global
4759 {not in Vi}
4760 {not available when compiled without the |+menu|
4761 feature}
4762 Maximum number of items to use in a menu. Used for menus that are
4763 generated from a list of items, e.g., the Buffers menu. Changing this
4764 option has no direct effect, the menu must be refreshed first.
4765
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004766 *'mkspellmem'* *'msm'*
4767'mkspellmem' 'msm' string (default "460000,2000,500")
4768 global
4769 {not in Vi}
4770 {not available when compiled without the |+syntax|
4771 feature}
4772 Parameters for |:mkspell|. This tunes when to start compressing the
4773 word tree. Compression can be slow when there are many words, but
4774 it's needed to avoid running out of memory. The amount of memory used
4775 per word depends very much on how similar the words are, that's why
4776 this tuning is complicated.
4777
4778 There are three numbers, separated by commas:
4779 {start},{inc},{added}
4780
4781 For most languages the uncompressed word tree fits in memory. {start}
4782 gives the amount of memory in Kbyte that can be used before any
4783 compression is done. It should be a bit smaller than the amount of
4784 memory that is available to Vim.
4785
4786 When going over the {start} limit the {inc} number specifies the
4787 amount of memory in Kbyte that can be allocated before another
4788 compression is done. A low number means compression is done after
4789 less words are added, which is slow. A high number means more memory
4790 will be allocated.
4791
4792 After doing compression, {added} times 1024 words can be added before
4793 the {inc} limit is ignored and compression is done when any extra
4794 amount of memory is needed. A low number means there is a smaller
4795 chance of hitting the {inc} limit, less memory is used but it's
4796 slower.
4797
4798 The languages for which these numbers are important are Italian and
4799 Hungarian. The default works for when you have about 512 Mbyte. If
4800 you have 1 Gbyte you could use: >
4801 :set mkspellmem=900000,3000,800
4802< If you have less than 512 Mbyte |:mkspell| may fail for some
4803 languages, no matter what you set 'mkspellmem' to.
4804
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004806'modeline' 'ml' boolean (Vim default: on (off for root),
4807 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 local to buffer
4809 *'modelines'* *'mls'*
4810'modelines' 'mls' number (default 5)
4811 global
4812 {not in Vi}
4813 If 'modeline' is on 'modelines' gives the number of lines that is
4814 checked for set commands. If 'modeline' is off or 'modelines' is zero
4815 no lines are checked. See |modeline|.
4816 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4817 set and to the Vim default value when 'compatible' is reset.
4818
4819 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4820'modifiable' 'ma' boolean (default on)
4821 local to buffer
4822 {not in Vi} *E21*
4823 When off the buffer contents cannot be changed. The 'fileformat' and
4824 'fileencoding' options also can't be changed.
4825 Can be reset with the |-M| command line argument.
4826
4827 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4828'modified' 'mod' boolean (default off)
4829 local to buffer
4830 {not in Vi}
4831 When on, the buffer is considered to be modified. This option is set
4832 when:
4833 1. A change was made to the text since it was last written. Using the
4834 |undo| command to go back to the original text will reset the
4835 option. But undoing changes that were made before writing the
4836 buffer will set the option again, since the text is different from
4837 when it was written.
4838 2. 'fileformat' or 'fileencoding' is different from its original
4839 value. The original value is set when the buffer is read or
4840 written. A ":set nomodified" command also resets the original
4841 values to the current values and the 'modified' option will be
4842 reset.
4843 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4844 will be ignored.
4845
4846 *'more'* *'nomore'*
4847'more' boolean (Vim default: on, Vi default: off)
4848 global
4849 {not in Vi}
4850 When on, listings pause when the whole screen is filled. You will get
4851 the |more-prompt|. When this option is off there are no pauses, the
4852 listing continues until finished.
4853 NOTE: This option is set to the Vi default value when 'compatible' is
4854 set and to the Vim default value when 'compatible' is reset.
4855
4856 *'mouse'* *E538*
4857'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4858 global
4859 {not in Vi}
4860 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004861 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4862 sysmouse and Linux console with gpm). For using the mouse in the
4863 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 The mouse can be enabled for different modes:
4865 n Normal mode
4866 v Visual mode
4867 i Insert mode
4868 c Command-line mode
4869 h all previous modes when editing a help file
4870 a all previous modes
4871 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 Normally you would enable the mouse in all four modes with: >
4873 :set mouse=a
4874< When the mouse is not enabled, the GUI will still use the mouse for
4875 modeless selection. This doesn't move the text cursor.
4876
4877 See |mouse-using|. Also see |'clipboard'|.
4878
4879 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004880 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 the mouse buttons can still be used by keeping the shift key pressed.
4882 Also see the 'clipboard' option.
4883
4884 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4885'mousefocus' 'mousef' boolean (default off)
4886 global
4887 {not in Vi}
4888 {only works in the GUI}
4889 The window that the mouse pointer is on is automatically activated.
4890 When changing the window layout or window focus in another way, the
4891 mouse pointer is moved to the window with keyboard focus. Off is the
4892 default because it makes using the pull down menus a little goofy, as
4893 a pointer transit may activate a window unintentionally.
4894
4895 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4896'mousehide' 'mh' boolean (default on)
4897 global
4898 {not in Vi}
4899 {only works in the GUI}
4900 When on, the mouse pointer is hidden when characters are typed.
4901 The mouse pointer is restored when the mouse is moved.
4902
4903 *'mousemodel'* *'mousem'*
4904'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4905 global
4906 {not in Vi}
4907 Sets the model to use for the mouse. The name mostly specifies what
4908 the right mouse button is used for:
4909 extend Right mouse button extends a selection. This works
4910 like in an xterm.
4911 popup Right mouse button pops up a menu. The shifted left
4912 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004913 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 popup_setpos Like "popup", but the cursor will be moved to the
4915 position where the mouse was clicked, and thus the
4916 selected operation will act upon the clicked object.
4917 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004918 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 course, that right clicking outside a selection will
4920 end Visual mode.
4921 Overview of what button does what for each model:
4922 mouse extend popup(_setpos) ~
4923 left click place cursor place cursor
4924 left drag start selection start selection
4925 shift-left search word extend selection
4926 right click extend selection popup menu (place cursor)
4927 right drag extend selection -
4928 middle click paste paste
4929
4930 In the "popup" model the right mouse button produces a pop-up menu.
4931 You need to define this first, see |popup-menu|.
4932
4933 Note that you can further refine the meaning of buttons with mappings.
4934 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4935 selection (because that's handled in the GUI code directly).
4936
4937 The 'mousemodel' option is set by the |:behave| command.
4938
4939 *'mouseshape'* *'mouses'* *E547*
4940'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004941 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 global
4943 {not in Vi}
4944 {only available when compiled with the |+mouseshape|
4945 feature}
4946 This option tells Vim what the mouse pointer should look like in
4947 different modes. The option is a comma separated list of parts, much
4948 like used for 'guicursor'. Each part consist of a mode/location-list
4949 and an argument-list:
4950 mode-list:shape,mode-list:shape,..
4951 The mode-list is a dash separated list of these modes/locations:
4952 In a normal window: ~
4953 n Normal mode
4954 v Visual mode
4955 ve Visual mode with 'selection' "exclusive" (same as 'v',
4956 if not specified)
4957 o Operator-pending mode
4958 i Insert mode
4959 r Replace mode
4960
4961 Others: ~
4962 c appending to the command-line
4963 ci inserting in the command-line
4964 cr replacing in the command-line
4965 m at the 'Hit ENTER' or 'More' prompts
4966 ml idem, but cursor in the last line
4967 e any mode, pointer below last window
4968 s any mode, pointer on a status line
4969 sd any mode, while dragging a status line
4970 vs any mode, pointer on a vertical separator line
4971 vd any mode, while dragging a vertical separator line
4972 a everywhere
4973
4974 The shape is one of the following:
4975 avail name looks like ~
4976 w x arrow Normal mouse pointer
4977 w x blank no pointer at all (use with care!)
4978 w x beam I-beam
4979 w x updown up-down sizing arrows
4980 w x leftright left-right sizing arrows
4981 w x busy The system's usual busy pointer
4982 w x no The system's usual 'no input' pointer
4983 x udsizing indicates up-down resizing
4984 x lrsizing indicates left-right resizing
4985 x crosshair like a big thin +
4986 x hand1 black hand
4987 x hand2 white hand
4988 x pencil what you write with
4989 x question big ?
4990 x rightup-arrow arrow pointing right-up
4991 w x up-arrow arrow pointing up
4992 x <number> any X11 pointer number (see X11/cursorfont.h)
4993
4994 The "avail" column contains a 'w' if the shape is available for Win32,
4995 x for X11.
4996 Any modes not specified or shapes not available use the normal mouse
4997 pointer.
4998
4999 Example: >
5000 :set mouseshape=s:udsizing,m:no
5001< will make the mouse turn to a sizing arrow over the status lines and
5002 indicate no input when the hit-enter prompt is displayed (since
5003 clicking the mouse has no effect in this state.)
5004
5005 *'mousetime'* *'mouset'*
5006'mousetime' 'mouset' number (default 500)
5007 global
5008 {not in Vi}
5009 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5010 time in msec between two mouse clicks for the second click to be
5011 recognized as a multi click.
5012
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005013 *'mzquantum'* *'mzq'*
5014'mzquantum' 'mzq' number (default 100)
5015 global
5016 {not in Vi}
5017 {not available when compiled without the |+mzscheme|
5018 feature}
5019 The number of milliseconds between polls for MzScheme threads.
5020 Negative or zero value means no thread scheduling.
5021
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 *'nrformats'* *'nf'*
5023'nrformats' 'nf' string (default "octal,hex")
5024 local to buffer
5025 {not in Vi}
5026 This defines what bases Vim will consider for numbers when using the
5027 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5028 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005029 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02005031 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005032 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005034 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 considered to be hexadecimal. Example: Using CTRL-X on
5036 "0x100" results in "0x0ff".
5037 Numbers which simply begin with a digit in the range 1-9 are always
5038 considered decimal. This also happens for numbers that are not
5039 recognized as octal or hex.
5040
5041 *'number'* *'nu'* *'nonumber'* *'nonu'*
5042'number' 'nu' boolean (default off)
5043 local to window
5044 Print the line number in front of each line. When the 'n' option is
5045 excluded from 'cpoptions' a wrapped line will not use the column of
5046 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005047 The 'numberwidth' option can be used to set the room used for the line
5048 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 When a long, wrapped line doesn't start with the first character, '-'
5050 characters are put before the number.
5051 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005052 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005054 *'numberwidth'* *'nuw'*
5055'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5056 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005057 {not in Vi}
5058 {only available when compiled with the |+linebreak|
5059 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005060 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005061 when the 'number' or 'relativenumber' option is set or printing lines
5062 with a line number. Since one space is always between the number and
5063 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005064 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005065 fit the highest line number in the buffer respectively the number of
5066 rows in the window, depending on whether 'number' or 'relativenumber'
5067 is set. Thus with the Vim default of 4 there is room for a line number
5068 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005069 The minimum value is 1, the maximum value is 10.
5070 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5071
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005072 *'omnifunc'* *'ofu'*
5073'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005074 local to buffer
5075 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005076 {not available when compiled without the |+eval|
5077 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005078 This option specifies a function to be used for Insert mode omni
5079 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005080 See |complete-functions| for an explanation of how the function is
5081 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005082 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005083 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005084
5085
Bram Moolenaar02467872007-05-06 13:22:01 +00005086 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005087'opendevice' 'odev' boolean (default off)
5088 global
5089 {not in Vi}
5090 {only for MS-DOS, MS-Windows and OS/2}
5091 Enable reading and writing from devices. This may get Vim stuck on a
5092 device that can be opened but doesn't actually do the I/O. Therefore
5093 it is off by default.
5094 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5095 result in editing a device.
5096
5097
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005098 *'operatorfunc'* *'opfunc'*
5099'operatorfunc' 'opfunc' string (default: empty)
5100 global
5101 {not in Vi}
5102 This option specifies a function to be called by the |g@| operator.
5103 See |:map-operator| for more info and an example.
5104
5105 This option cannot be set from a |modeline| or in the |sandbox|, for
5106 security reasons.
5107
5108
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 *'osfiletype'* *'oft'* *E366*
5110'osfiletype' 'oft' string (RISC-OS default: "Text",
5111 others default: "")
5112 local to buffer
5113 {not in Vi}
5114 {only available when compiled with the |+osfiletype|
5115 feature}
5116 Some operating systems store extra information about files besides
5117 name, datestamp and permissions. This option contains the extra
5118 information, the nature of which will vary between systems.
5119 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005120 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 It can affect the pattern matching of the automatic commands.
5122 |autocmd-osfiletypes|
5123
5124 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005125'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 global
5127 Specifies the nroff macros that separate paragraphs. These are pairs
5128 of two letters (see |object-motions|).
5129
5130 *'paste'* *'nopaste'*
5131'paste' boolean (default off)
5132 global
5133 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005134 Put Vim in Paste mode. This is useful if you want to cut or copy
5135 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 unexpected effects.
5137 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005138 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 knows about pasting and will mostly do the right thing without 'paste'
5140 being set. The same is true for a terminal where Vim handles the
5141 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005142 This option is reset when starting the GUI. Thus if you set it in
5143 your .vimrc it will work in a terminal, but not in the GUI. Setting
5144 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5145 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 When the 'paste' option is switched on (also when it was already on):
5147 - mapping in Insert mode and Command-line mode is disabled
5148 - abbreviations are disabled
5149 - 'textwidth' is set to 0
5150 - 'wrapmargin' is set to 0
5151 - 'autoindent' is reset
5152 - 'smartindent' is reset
5153 - 'softtabstop' is set to 0
5154 - 'revins' is reset
5155 - 'ruler' is reset
5156 - 'showmatch' is reset
5157 - 'formatoptions' is used like it is empty
5158 These options keep their value, but their effect is disabled:
5159 - 'lisp'
5160 - 'indentexpr'
5161 - 'cindent'
5162 NOTE: When you start editing another file while the 'paste' option is
5163 on, settings from the modelines or autocommands may change the
5164 settings again, causing trouble when pasting text. You might want to
5165 set the 'paste' option again.
5166 When the 'paste' option is reset the mentioned options are restored to
5167 the value before the moment 'paste' was switched from off to on.
5168 Resetting 'paste' before ever setting it does not have any effect.
5169 Since mapping doesn't work while 'paste' is active, you need to use
5170 the 'pastetoggle' option to toggle the 'paste' option with some key.
5171
5172 *'pastetoggle'* *'pt'*
5173'pastetoggle' 'pt' string (default "")
5174 global
5175 {not in Vi}
5176 When non-empty, specifies the key sequence that toggles the 'paste'
5177 option. This is like specifying a mapping: >
5178 :map {keys} :set invpaste<CR>
5179< Where {keys} is the value of 'pastetoggle'.
5180 The difference is that it will work even when 'paste' is set.
5181 'pastetoggle' works in Insert mode and Normal mode, but not in
5182 Command-line mode.
5183 Mappings are checked first, thus overrule 'pastetoggle'. However,
5184 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5185 this: >
5186 :map <F10> :set paste<CR>
5187 :map <F11> :set nopaste<CR>
5188 :imap <F10> <C-O>:set paste<CR>
5189 :imap <F11> <nop>
5190 :set pastetoggle=<F11>
5191< This will make <F10> start paste mode and <F11> stop paste mode.
5192 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5193 mode everything is inserted literally, except the 'pastetoggle' key
5194 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005195 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196
5197 *'pex'* *'patchexpr'*
5198'patchexpr' 'pex' string (default "")
5199 global
5200 {not in Vi}
5201 {not available when compiled without the |+diff|
5202 feature}
5203 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005204 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
5206 *'patchmode'* *'pm'* *E206*
5207'patchmode' 'pm' string (default "")
5208 global
5209 {not in Vi}
5210 When non-empty the oldest version of a file is kept. This can be used
5211 to keep the original version of a file if you are changing files in a
5212 source distribution. Only the first time that a file is written a
5213 copy of the original file will be kept. The name of the copy is the
5214 name of the original file with the string in the 'patchmode' option
5215 appended. This option should start with a dot. Use a string like
5216 ".org". 'backupdir' must not be empty for this to work (Detail: The
5217 backup file is renamed to the patchmode file after the new file has
5218 been successfully written, that's why it must be possible to write a
5219 backup file). If there was no file to be backed up, an empty file is
5220 created.
5221 When the 'backupskip' pattern matches, a patchmode file is not made.
5222 Using 'patchmode' for compressed files appends the extension at the
5223 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5224 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005225 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226
5227 *'path'* *'pa'* *E343* *E345* *E347*
5228'path' 'pa' string (default on Unix: ".,/usr/include,,"
5229 on OS/2: ".,/emx/include,,"
5230 other systems: ".,,")
5231 global or local to buffer |global-local|
5232 {not in Vi}
5233 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005234 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5235 provided that the file being searched for has a relative path (not
5236 starting with "/", "./" or "../"). The directories in the 'path'
5237 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 - Use commas to separate directory names: >
5239 :set path=.,/usr/local/include,/usr/include
5240< - Spaces can also be used to separate directory names (for backwards
5241 compatibility with version 3.0). To have a space in a directory
5242 name, precede it with an extra backslash, and escape the space: >
5243 :set path=.,/dir/with\\\ space
5244< - To include a comma in a directory name precede it with an extra
5245 backslash: >
5246 :set path=.,/dir/with\\,comma
5247< - To search relative to the directory of the current file, use: >
5248 :set path=.
5249< - To search in the current directory use an empty string between two
5250 commas: >
5251 :set path=,,
5252< - A directory name may end in a ':' or '/'.
5253 - Environment variables are expanded |:set_env|.
5254 - When using |netrw.vim| URLs can be used. For example, adding
5255 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005256 - Search upwards and downwards in a directory tree using "*", "**" and
5257 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258 {not available when compiled without the |+path_extra| feature}
5259 - Careful with '\' characters, type two to get one in the option: >
5260 :set path=.,c:\\include
5261< Or just use '/' instead: >
5262 :set path=.,c:/include
5263< Don't forget "." or files won't even be found in the same directory as
5264 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005265 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 it is something like 256 or 1024 characters.
5267 You can check if all the include files are found, using the value of
5268 'path', see |:checkpath|.
5269 The use of |:set+=| and |:set-=| is preferred when adding or removing
5270 directories from the list. This avoids problems when a future version
5271 uses another default. To remove the current directory use: >
5272 :set path-=
5273< To add the current directory use: >
5274 :set path+=
5275< To use an environment variable, you probably need to replace the
5276 separator. Here is an example to append $INCL, in which directory
5277 names are separated with a semi-colon: >
5278 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5279< Replace the ';' with a ':' or whatever separator is used. Note that
5280 this doesn't work when $INCL contains a comma or white space.
5281
5282 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5283'preserveindent' 'pi' boolean (default off)
5284 local to buffer
5285 {not in Vi}
5286 When changing the indent of the current line, preserve as much of the
5287 indent structure as possible. Normally the indent is replaced by a
5288 series of tabs followed by spaces as required (unless |'expandtab'| is
5289 enabled, in which case only spaces are used). Enabling this option
5290 means the indent will preserve as many existing characters as possible
5291 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005292 'expandtab' does not apply to the preserved white space, a Tab remains
5293 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 NOTE: When using ">>" multiple times the resulting indent is a mix of
5295 tabs and spaces. You might not like this.
5296 NOTE: 'preserveindent' is reset when 'compatible' is set.
5297 Also see 'copyindent'.
5298 Use |:retab| to clean up white space.
5299
5300 *'previewheight'* *'pvh'*
5301'previewheight' 'pvh' number (default 12)
5302 global
5303 {not in Vi}
5304 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005305 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 Default height for a preview window. Used for |:ptag| and associated
5307 commands. Used for |CTRL-W_}| when no count is given.
5308
5309 *'previewwindow'* *'nopreviewwindow'*
5310 *'pvw'* *'nopvw'* *E590*
5311'previewwindow' 'pvw' boolean (default off)
5312 local to window
5313 {not in Vi}
5314 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005315 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005316 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317 set. It's normally not set directly, but by using one of the commands
5318 |:ptag|, |:pedit|, etc.
5319
5320 *'printdevice'* *'pdev'*
5321'printdevice' 'pdev' string (default empty)
5322 global
5323 {not in Vi}
5324 {only available when compiled with the |+printer|
5325 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005326 The name of the printer to be used for |:hardcopy|.
5327 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005328 This option cannot be set from a |modeline| or in the |sandbox|, for
5329 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330
Bram Moolenaar8299df92004-07-10 09:47:34 +00005331 *'printencoding'* *'penc'*
5332'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 global
5334 {not in Vi}
5335 {only available when compiled with the |+printer|
5336 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005337 Sets the character encoding used when printing.
5338 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339
5340 *'printexpr'* *'pexpr'*
5341'printexpr' 'pexpr' String (default: see below)
5342 global
5343 {not in Vi}
5344 {only available when compiled with the |+printer|
5345 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005346 Expression used to print the PostScript produced with |:hardcopy|.
5347 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348
Bram Moolenaar8299df92004-07-10 09:47:34 +00005349 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350'printfont' 'pfn' string (default "courier")
5351 global
5352 {not in Vi}
5353 {only available when compiled with the |+printer|
5354 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005355 The name of the font that will be used for |:hardcopy|.
5356 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357
5358 *'printheader'* *'pheader'*
5359'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5360 global
5361 {not in Vi}
5362 {only available when compiled with the |+printer|
5363 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005364 The format of the header produced in |:hardcopy| output.
5365 See |pheader-option|.
5366
5367 *'printmbcharset'* *'pmbcs'*
5368'printmbcharset' 'pmbcs' string (default "")
5369 global
5370 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005371 {only available when compiled with the |+printer|,
5372 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005373 The CJK character set to be used for CJK output from |:hardcopy|.
5374 See |pmbcs-option|.
5375
5376 *'printmbfont'* *'pmbfn'*
5377'printmbfont' 'pmbfn' string (default "")
5378 global
5379 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005380 {only available when compiled with the |+printer|,
5381 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005382 List of font names to be used for CJK output from |:hardcopy|.
5383 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384
5385 *'printoptions'* *'popt'*
5386'printoptions' 'popt' string (default "")
5387 global
5388 {not in Vi}
5389 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005390 List of items that control the format of the output of |:hardcopy|.
5391 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005393 *'prompt'* *'noprompt'*
5394'prompt' boolean (default on)
5395 global
5396 When on a ":" prompt is used in Ex mode.
5397
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005398 *'pumheight'* *'ph'*
5399'pumheight' 'ph' number (default 0)
5400 global
5401 {not available when compiled without the
5402 |+insert_expand| feature}
5403 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005404 Determines the maximum number of items to show in the popup menu for
5405 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005406 |ins-completion-menu|.
5407
5408
Bram Moolenaar677ee682005-01-27 14:41:15 +00005409 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005410'quoteescape' 'qe' string (default "\")
5411 local to buffer
5412 {not in Vi}
5413 The characters that are used to escape quotes in a string. Used for
5414 objects like a', a" and a` |a'|.
5415 When one of the characters in this option is found inside a string,
5416 the following character will be skipped. The default value makes the
5417 text "foo\"bar\\" considered to be one string.
5418
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5420'readonly' 'ro' boolean (default off)
5421 local to buffer
5422 If on, writes fail unless you use a '!'. Protects you from
5423 accidentally overwriting a file. Default on when Vim is started
5424 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005425 When using ":w!" the 'readonly' option is reset for the current
5426 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005428 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005430 *'redrawtime'* *'rdt'*
5431'redrawtime' 'rdt' number (default 2000)
5432 global
5433 {not in Vi}
5434 {only available when compiled with the |+reltime|
5435 feature}
5436 The time in milliseconds for redrawing the display. This applies to
5437 searching for patterns for 'hlsearch' and |:match| highlighting.
5438 When redrawing takes more than this many milliseconds no further
5439 matches will be highlighted. This is used to avoid that Vim hangs
5440 when using a very complicated pattern.
5441
Bram Moolenaar64486672010-05-16 15:46:46 +02005442 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5443'relativenumber' 'rnu' boolean (default off)
5444 local to window
5445 {not in Vi}
5446 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005447 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005448 precede some vertical motion commands (e.g. j k + -) with, without
5449 having to calculate it yourself. Especially useful in combination with
5450 other commands (e.g. y d c < > gq gw =).
5451 When the 'n' option is excluded from 'cpoptions' a wrapped
5452 line will not use the column of line numbers (this is the default when
5453 'compatible' isn't set).
5454 The 'numberwidth' option can be used to set the room used for the line
5455 number.
5456 When a long, wrapped line doesn't start with the first character, '-'
5457 characters are put before the number.
5458 See |hl-LineNr| for the highlighting used for the number.
5459 When setting this option, 'number' is reset.
5460
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 *'remap'* *'noremap'*
5462'remap' boolean (default on)
5463 global
5464 Allows for mappings to work recursively. If you do not want this for
5465 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005466 NOTE: To avoid portability problems with Vim scripts, always keep
5467 this option at the default "on". Only switch it off when working with
5468 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469
5470 *'report'*
5471'report' number (default 2)
5472 global
5473 Threshold for reporting number of lines changed. When the number of
5474 changed lines is more than 'report' a message will be given for most
5475 ":" commands. If you want it always, set 'report' to 0.
5476 For the ":substitute" command the number of substitutions is used
5477 instead of the number of lines.
5478
5479 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5480'restorescreen' 'rs' boolean (default on)
5481 global
5482 {not in Vi} {only in Windows 95/NT console version}
5483 When set, the screen contents is restored when exiting Vim. This also
5484 happens when executing external commands.
5485
5486 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5487 options in your .vimrc. To disable restoring:
5488 set t_ti= t_te=
5489 To enable restoring (for an xterm):
5490 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5491 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5492
5493 *'revins'* *'ri'* *'norevins'* *'nori'*
5494'revins' 'ri' boolean (default off)
5495 global
5496 {not in Vi}
5497 {only available when compiled with the |+rightleft|
5498 feature}
5499 Inserting characters in Insert mode will work backwards. See "typing
5500 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5501 command in Insert mode, when 'allowrevins' is set.
5502 NOTE: This option is reset when 'compatible' or 'paste' is set.
5503
5504 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5505'rightleft' 'rl' boolean (default off)
5506 local to window
5507 {not in Vi}
5508 {only available when compiled with the |+rightleft|
5509 feature}
5510 When on, display orientation becomes right-to-left, i.e., characters
5511 that are stored in the file appear from the right to the left.
5512 Using this option, it is possible to edit files for languages that
5513 are written from the right to the left such as Hebrew and Arabic.
5514 This option is per window, so it is possible to edit mixed files
5515 simultaneously, or to view the same file in both ways (this is
5516 useful whenever you have a mixed text file with both right-to-left
5517 and left-to-right strings so that both sets are displayed properly
5518 in different windows). Also see |rileft.txt|.
5519
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005520 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521'rightleftcmd' 'rlc' string (default "search")
5522 local to window
5523 {not in Vi}
5524 {only available when compiled with the |+rightleft|
5525 feature}
5526 Each word in this option enables the command line editing to work in
5527 right-to-left mode for a group of commands:
5528
5529 search "/" and "?" commands
5530
5531 This is useful for languages such as Hebrew, Arabic and Farsi.
5532 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5533
5534 *'ruler'* *'ru'* *'noruler'* *'noru'*
5535'ruler' 'ru' boolean (default off)
5536 global
5537 {not in Vi}
5538 {not available when compiled without the
5539 |+cmdline_info| feature}
5540 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005541 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 text in the file is shown on the far right:
5543 Top first line is visible
5544 Bot last line is visible
5545 All first and last line are visible
5546 45% relative position in the file
5547 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005548 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005550 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 this option takes precedence over 'ruler' and 'rulerformat'
5552 If the number of characters displayed is different from the number of
5553 bytes in the text (e.g., for a TAB or a multi-byte character), both
5554 the text column (byte number) and the screen column are shown,
5555 separated with a dash.
5556 For an empty line "0-1" is shown.
5557 For an empty buffer the line number will also be zero: "0,0-1".
5558 This option is reset when the 'paste' option is set.
5559 If you don't want to see the ruler all the time but want to know where
5560 you are, use "g CTRL-G" |g_CTRL-G|.
5561 NOTE: This option is reset when 'compatible' is set.
5562
5563 *'rulerformat'* *'ruf'*
5564'rulerformat' 'ruf' string (default empty)
5565 global
5566 {not in Vi}
5567 {not available when compiled without the |+statusline|
5568 feature}
5569 When this option is not empty, it determines the content of the ruler
5570 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005571 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 The default ruler width is 17 characters. To make the ruler 15
5573 characters wide, put "%15(" at the start and "%)" at the end.
5574 Example: >
5575 :set rulerformat=%15(%c%V\ %p%%%)
5576<
5577 *'runtimepath'* *'rtp'* *vimfiles*
5578'runtimepath' 'rtp' string (default:
5579 Unix: "$HOME/.vim,
5580 $VIM/vimfiles,
5581 $VIMRUNTIME,
5582 $VIM/vimfiles/after,
5583 $HOME/.vim/after"
5584 Amiga: "home:vimfiles,
5585 $VIM/vimfiles,
5586 $VIMRUNTIME,
5587 $VIM/vimfiles/after,
5588 home:vimfiles/after"
5589 PC, OS/2: "$HOME/vimfiles,
5590 $VIM/vimfiles,
5591 $VIMRUNTIME,
5592 $VIM/vimfiles/after,
5593 $HOME/vimfiles/after"
5594 Macintosh: "$VIM:vimfiles,
5595 $VIMRUNTIME,
5596 $VIM:vimfiles:after"
5597 RISC-OS: "Choices:vimfiles,
5598 $VIMRUNTIME,
5599 Choices:vimfiles/after"
5600 VMS: "sys$login:vimfiles,
5601 $VIM/vimfiles,
5602 $VIMRUNTIME,
5603 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005604 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605 global
5606 {not in Vi}
5607 This is a list of directories which will be searched for runtime
5608 files:
5609 filetype.vim filetypes by file name |new-filetype|
5610 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005611 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 colors/ color scheme files |:colorscheme|
5613 compiler/ compiler files |:compiler|
5614 doc/ documentation |write-local-help|
5615 ftplugin/ filetype plugins |write-filetype-plugin|
5616 indent/ indent scripts |indent-expression|
5617 keymap/ key mapping files |mbyte-keymap|
5618 lang/ menu translations |:menutrans|
5619 menu.vim GUI menus |menu.vim|
5620 plugin/ plugin scripts |write-plugin|
5621 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005622 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 syntax/ syntax files |mysyntaxfile|
5624 tutor/ files for vimtutor |tutor|
5625
5626 And any other file searched for with the |:runtime| command.
5627
5628 The defaults for most systems are setup to search five locations:
5629 1. In your home directory, for your personal preferences.
5630 2. In a system-wide Vim directory, for preferences from the system
5631 administrator.
5632 3. In $VIMRUNTIME, for files distributed with Vim.
5633 *after-directory*
5634 4. In the "after" directory in the system-wide Vim directory. This is
5635 for the system administrator to overrule or add to the distributed
5636 defaults (rarely needed)
5637 5. In the "after" directory in your home directory. This is for
5638 personal preferences to overrule or add to the distributed defaults
5639 or system-wide settings (rarely needed).
5640
5641 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5642 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005643 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 wildcards.
5645 See |:runtime|.
5646 Example: >
5647 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5648< This will use the directory "~/vimruntime" first (containing your
5649 personal Vim runtime files), then "/mygroup/vim" (shared between a
5650 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5651 files).
5652 You probably should always include $VIMRUNTIME somewhere, to use the
5653 distributed runtime files. You can put a directory before $VIMRUNTIME
5654 to find files which replace a distributed runtime files. You can put
5655 a directory after $VIMRUNTIME to find files which add to distributed
5656 runtime files.
5657 This option cannot be set from a |modeline| or in the |sandbox|, for
5658 security reasons.
5659
5660 *'scroll'* *'scr'*
5661'scroll' 'scr' number (default: half the window height)
5662 local to window
5663 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5664 set to half the number of lines in the window when the window size
5665 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005666 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5668 the number of screen lines instead of file lines, makes a difference
5669 when lines wrap}
5670
5671 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5672'scrollbind' 'scb' boolean (default off)
5673 local to window
5674 {not in Vi}
5675 {not available when compiled without the |+scrollbind|
5676 feature}
5677 See also |scroll-binding|. When this option is set, the current
5678 window scrolls as other scrollbind windows (windows that also have
5679 this option set) scroll. This option is useful for viewing the
5680 differences between two versions of a file, see 'diff'.
5681 See |'scrollopt'| for options that determine how this option should be
5682 interpreted.
5683 This option is mostly reset when splitting a window to edit another
5684 file. This means that ":split | edit file" results in two windows
5685 with scroll-binding, but ":split file" does not.
5686
5687 *'scrolljump'* *'sj'*
5688'scrolljump' 'sj' number (default 1)
5689 global
5690 {not in Vi}
5691 Minimal number of lines to scroll when the cursor gets off the
5692 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5693 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005694 When set to a negative number from -1 to -100 this is used as the
5695 percentage of the window height. Thus -50 scrolls half the window
5696 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 NOTE: This option is set to 1 when 'compatible' is set.
5698
5699 *'scrolloff'* *'so'*
5700'scrolloff' 'so' number (default 0)
5701 global
5702 {not in Vi}
5703 Minimal number of screen lines to keep above and below the cursor.
5704 This will make some context visible around where you are working. If
5705 you set it to a very large value (999) the cursor line will always be
5706 in the middle of the window (except at the start or end of the file or
5707 when long lines wrap).
5708 For scrolling horizontally see 'sidescrolloff'.
5709 NOTE: This option is set to 0 when 'compatible' is set.
5710
5711 *'scrollopt'* *'sbo'*
5712'scrollopt' 'sbo' string (default "ver,jump")
5713 global
5714 {not available when compiled without the |+scrollbind|
5715 feature}
5716 {not in Vi}
5717 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005718 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5719 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 The following words are available:
5721 ver Bind vertical scrolling for 'scrollbind' windows
5722 hor Bind horizontal scrolling for 'scrollbind' windows
5723 jump Applies to the offset between two windows for vertical
5724 scrolling. This offset is the difference in the first
5725 displayed line of the bound windows. When moving
5726 around in a window, another 'scrollbind' window may
5727 reach a position before the start or after the end of
5728 the buffer. The offset is not changed though, when
5729 moving back the 'scrollbind' window will try to scroll
5730 to the desired position when possible.
5731 When now making that window the current one, two
5732 things can be done with the relative offset:
5733 1. When "jump" is not included, the relative offset is
5734 adjusted for the scroll position in the new current
5735 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005736 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 2. When "jump" is included, the other windows are
5738 scrolled to keep the same relative offset. When
5739 going back to the other window, it still uses the
5740 same relative offset.
5741 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005742 When 'diff' mode is active there always is vertical scroll binding,
5743 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744
5745 *'sections'* *'sect'*
5746'sections' 'sect' string (default "SHNHH HUnhsh")
5747 global
5748 Specifies the nroff macros that separate sections. These are pairs of
5749 two letters (See |object-motions|). The default makes a section start
5750 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5751
5752 *'secure'* *'nosecure'* *E523*
5753'secure' boolean (default off)
5754 global
5755 {not in Vi}
5756 When on, ":autocmd", shell and write commands are not allowed in
5757 ".vimrc" and ".exrc" in the current directory and map commands are
5758 displayed. Switch it off only if you know that you will not run into
5759 problems, or when the 'exrc' option is off. On Unix this option is
5760 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005761 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 'secure' at the end of your ~/.vimrc then.
5763 This option cannot be set from a |modeline| or in the |sandbox|, for
5764 security reasons.
5765
5766 *'selection'* *'sel'*
5767'selection' 'sel' string (default "inclusive")
5768 global
5769 {not in Vi}
5770 This option defines the behavior of the selection. It is only used
5771 in Visual and Select mode.
5772 Possible values:
5773 value past line inclusive ~
5774 old no yes
5775 inclusive yes yes
5776 exclusive yes no
5777 "past line" means that the cursor is allowed to be positioned one
5778 character past the line.
5779 "inclusive" means that the last character of the selection is included
5780 in an operation. For example, when "x" is used to delete the
5781 selection.
5782 Note that when "exclusive" is used and selecting from the end
5783 backwards, you cannot include the last character of a line, when
5784 starting in Normal mode and 'virtualedit' empty.
5785
5786 The 'selection' option is set by the |:behave| command.
5787
5788 *'selectmode'* *'slm'*
5789'selectmode' 'slm' string (default "")
5790 global
5791 {not in Vi}
5792 This is a comma separated list of words, which specifies when to start
5793 Select mode instead of Visual mode, when a selection is started.
5794 Possible values:
5795 mouse when using the mouse
5796 key when using shifted special keys
5797 cmd when using "v", "V" or CTRL-V
5798 See |Select-mode|.
5799 The 'selectmode' option is set by the |:behave| command.
5800
5801 *'sessionoptions'* *'ssop'*
5802'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005803 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804 global
5805 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005806 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 feature}
5808 Changes the effect of the |:mksession| command. It is a comma
5809 separated list of words. Each word enables saving and restoring
5810 something:
5811 word save and restore ~
5812 blank empty windows
5813 buffers hidden and unloaded buffers, not just those in windows
5814 curdir the current directory
5815 folds manually created folds, opened/closed folds and local
5816 fold options
5817 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005818 and contain at least one lowercase letter. Only
5819 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 help the help window
5821 localoptions options and mappings local to a window or buffer (not
5822 global values for local options)
5823 options all options and mappings (also global values for local
5824 options)
5825 resize size of the Vim window: 'lines' and 'columns'
5826 sesdir the directory in which the session file is located
5827 will become the current directory (useful with
5828 projects accessed over a network from different
5829 systems)
5830 slash backslashes in file names replaced with forward
5831 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005832 tabpages all tab pages; without this only the current tab page
5833 is restored, so that you can make a session for each
5834 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 unix with Unix end-of-line format (single <NL>), even when
5836 on Windows or DOS
5837 winpos position of the whole Vim window
5838 winsize window sizes
5839
5840 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005841 When neither "curdir" nor "sesdir" is included, file names are stored
5842 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 "slash" and "unix" are useful on Windows when sharing session files
5844 with Unix. The Unix version of Vim cannot source dos format scripts,
5845 but the Windows version of Vim can source unix format scripts.
5846
5847 *'shell'* *'sh'* *E91*
5848'shell' 'sh' string (default $SHELL or "sh",
5849 MS-DOS and Win32: "command.com" or
5850 "cmd.exe", OS/2: "cmd")
5851 global
5852 Name of the shell to use for ! and :! commands. When changing the
5853 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5854 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005855 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 See |option-backslash| about including spaces and backslashes.
5857 Environment variables are expanded |:set_env|.
5858 If the name of the shell contains a space, you might need to enclose
5859 it in quotes. Example: >
5860 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5861< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005862 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 "-f" is not inside the quotes, because it is not part of the command
5864 name. And Vim automagically recognizes the backslashes that are path
5865 separators.
5866 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5867 variable to change the way external commands are executed. See the
5868 libc.inf file of DJGPP.
5869 Under MS-Windows, when the executable ends in ".com" it must be
5870 included. Thus setting the shell to "command.com" or "4dos.com"
5871 works, but "command" and "4dos" do not work for all commands (e.g.,
5872 filtering).
5873 For unknown reasons, when using "4dos.com" the current directory is
5874 changed to "C:\". To avoid this set 'shell' like this: >
5875 :set shell=command.com\ /c\ 4dos
5876< This option cannot be set from a |modeline| or in the |sandbox|, for
5877 security reasons.
5878
5879 *'shellcmdflag'* *'shcf'*
5880'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5881 does not contain "sh" somewhere: "/c")
5882 global
5883 {not in Vi}
5884 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5885 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5886 systems, the default is set according to the value of 'shell', to
5887 reduce the need to set this option by the user. It's not used for
5888 OS/2 (EMX figures this out itself). See |option-backslash| about
5889 including spaces and backslashes. See |dos-shell|.
5890 This option cannot be set from a |modeline| or in the |sandbox|, for
5891 security reasons.
5892
5893 *'shellpipe'* *'sp'*
5894'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5895 global
5896 {not in Vi}
5897 {not available when compiled without the |+quickfix|
5898 feature}
5899 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005900 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 including spaces and backslashes.
5902 The name of the temporary file can be represented by "%s" if necessary
5903 (the file name is appended automatically if no %s appears in the value
5904 of this option).
5905 For the Amiga and MS-DOS the default is ">". The output is directly
5906 saved in a file and not echoed to the screen.
5907 For Unix the default it "| tee". The stdout of the compiler is saved
5908 in a file and echoed to the screen. If the 'shell' option is "csh" or
5909 "tcsh" after initializations, the default becomes "|& tee". If the
5910 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005911 "2>&1| tee". This means that stderr is also included. Before using
5912 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 The initialization of this option is done after reading the ".vimrc"
5914 and the other initializations, so that when the 'shell' option is set
5915 there, the 'shellpipe' option changes automatically, unless it was
5916 explicitly set before.
5917 When 'shellpipe' is set to an empty string, no redirection of the
5918 ":make" output will be done. This is useful if you use a 'makeprg'
5919 that writes to 'makeef' by itself. If you want no piping, but do
5920 want to include the 'makeef', set 'shellpipe' to a single space.
5921 Don't forget to precede the space with a backslash: ":set sp=\ ".
5922 In the future pipes may be used for filtering and this option will
5923 become obsolete (at least for Unix).
5924 This option cannot be set from a |modeline| or in the |sandbox|, for
5925 security reasons.
5926
5927 *'shellquote'* *'shq'*
5928'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5929 contains "sh" somewhere: "\"")
5930 global
5931 {not in Vi}
5932 Quoting character(s), put around the command passed to the shell, for
5933 the "!" and ":!" commands. The redirection is kept outside of the
5934 quoting. See 'shellxquote' to include the redirection. It's
5935 probably not useful to set both options.
5936 This is an empty string by default. Only known to be useful for
5937 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5938 or bash, where it should be "\"". The default is adjusted according
5939 the value of 'shell', to reduce the need to set this option by the
5940 user. See |dos-shell|.
5941 This option cannot be set from a |modeline| or in the |sandbox|, for
5942 security reasons.
5943
5944 *'shellredir'* *'srr'*
5945'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5946 global
5947 {not in Vi}
5948 String to be used to put the output of a filter command in a temporary
5949 file. See also |:!|. See |option-backslash| about including spaces
5950 and backslashes.
5951 The name of the temporary file can be represented by "%s" if necessary
5952 (the file name is appended automatically if no %s appears in the value
5953 of this option).
5954 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5955 or "zsh" during initializations, the default becomes ">&". If the
5956 'shell' option is "sh", "ksh" or "bash" the default becomes
5957 ">%s 2>&1". This means that stderr is also included.
5958 For Win32, the Unix checks are done and additionally "cmd" is checked
5959 for, which makes the default ">%s 2>&1". Also, the same names with
5960 ".exe" appended are checked for.
5961 The initialization of this option is done after reading the ".vimrc"
5962 and the other initializations, so that when the 'shell' option is set
5963 there, the 'shellredir' option changes automatically unless it was
5964 explicitly set before.
5965 In the future pipes may be used for filtering and this option will
5966 become obsolete (at least for Unix).
5967 This option cannot be set from a |modeline| or in the |sandbox|, for
5968 security reasons.
5969
5970 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5971'shellslash' 'ssl' boolean (default off)
5972 global
5973 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5974 When set, a forward slash is used when expanding file names. This is
5975 useful when a Unix-like shell is used instead of command.com or
5976 cmd.exe. Backward slashes can still be typed, but they are changed to
5977 forward slashes by Vim.
5978 Note that setting or resetting this option has no effect for some
5979 existing file names, thus this option needs to be set before opening
5980 any file for best results. This might change in the future.
5981 'shellslash' only works when a backslash can be used as a path
5982 separator. To test if this is so use: >
5983 if exists('+shellslash')
5984<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005985 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5986'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5987 global
5988 {not in Vi}
5989 When on, use temp files for shell commands. When off use a pipe.
5990 When using a pipe is not possible temp files are used anyway.
5991 Currently a pipe is only supported on Unix. You can check it with: >
5992 :if has("filterpipe")
5993< The advantage of using a pipe is that nobody can read the temp file
5994 and the 'shell' command does not need to support redirection.
5995 The advantage of using a temp file is that the file type and encoding
5996 can be detected.
5997 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5998 |FilterWritePost| autocommands event are not triggered when
5999 'shelltemp' is off.
6000
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 *'shelltype'* *'st'*
6002'shelltype' 'st' number (default 0)
6003 global
6004 {not in Vi} {only for the Amiga}
6005 On the Amiga this option influences the way how the commands work
6006 which use a shell.
6007 0 and 1: always use the shell
6008 2 and 3: use the shell only to filter lines
6009 4 and 5: use shell only for ':sh' command
6010 When not using the shell, the command is executed directly.
6011
6012 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6013 1 and 3: use "shell cmd" to start external commands
6014
6015 *'shellxquote'* *'sxq'*
6016'shellxquote' 'sxq' string (default: "";
6017 for Win32, when 'shell' contains "sh"
6018 somewhere: "\""
6019 for Unix, when using system(): "\"")
6020 global
6021 {not in Vi}
6022 Quoting character(s), put around the command passed to the shell, for
6023 the "!" and ":!" commands. Includes the redirection. See
6024 'shellquote' to exclude the redirection. It's probably not useful
6025 to set both options.
6026 This is an empty string by default. Known to be useful for
6027 third-party shells when using the Win32 version, such as the MKS Korn
6028 Shell or bash, where it should be "\"". The default is adjusted
6029 according the value of 'shell', to reduce the need to set this option
6030 by the user. See |dos-shell|.
6031 This option cannot be set from a |modeline| or in the |sandbox|, for
6032 security reasons.
6033
6034 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6035'shiftround' 'sr' boolean (default off)
6036 global
6037 {not in Vi}
6038 Round indent to multiple of 'shiftwidth'. Applies to > and <
6039 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6040 a multiple of 'shiftwidth' (this is Vi compatible).
6041 NOTE: This option is reset when 'compatible' is set.
6042
6043 *'shiftwidth'* *'sw'*
6044'shiftwidth' 'sw' number (default 8)
6045 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006046 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047 |'cindent'|, |>>|, |<<|, etc.
6048
6049 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006050'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6051 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 global
6053 {not in Vi}
6054 This option helps to avoid all the |hit-enter| prompts caused by file
6055 messages, for example with CTRL-G, and to avoid some other messages.
6056 It is a list of flags:
6057 flag meaning when present ~
6058 f use "(3 of 5)" instead of "(file 3 of 5)"
6059 i use "[noeol]" instead of "[Incomplete last line]"
6060 l use "999L, 888C" instead of "999 lines, 888 characters"
6061 m use "[+]" instead of "[Modified]"
6062 n use "[New]" instead of "[New File]"
6063 r use "[RO]" instead of "[readonly]"
6064 w use "[w]" instead of "written" for file write message
6065 and "[a]" instead of "appended" for ':w >> file' command
6066 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6067 "[unix format]" and "[mac]" instead of "[mac format]".
6068 a all of the above abbreviations
6069
6070 o overwrite message for writing a file with subsequent message
6071 for reading a file (useful for ":wn" or when 'autowrite' on)
6072 O message for reading a file overwrites any previous message.
6073 Also for quickfix message (e.g., ":cn").
6074 s don't give "search hit BOTTOM, continuing at TOP" or "search
6075 hit TOP, continuing at BOTTOM" messages
6076 t truncate file message at the start if it is too long to fit
6077 on the command-line, "<" will appear in the left most column.
6078 Ignored in Ex mode.
6079 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006080 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 Ignored in Ex mode.
6082 W don't give "written" or "[w]" when writing a file
6083 A don't give the "ATTENTION" message when an existing swap file
6084 is found.
6085 I don't give the intro message when starting Vim |:intro|.
6086
6087 This gives you the opportunity to avoid that a change between buffers
6088 requires you to hit <Enter>, but still gives as useful a message as
6089 possible for the space available. To get the whole message that you
6090 would have got with 'shm' empty, use ":file!"
6091 Useful values:
6092 shm= No abbreviation of message.
6093 shm=a Abbreviation, but no loss of information.
6094 shm=at Abbreviation, and truncate message when necessary.
6095
6096 NOTE: This option is set to the Vi default value when 'compatible' is
6097 set and to the Vim default value when 'compatible' is reset.
6098
6099 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6100'shortname' 'sn' boolean (default off)
6101 local to buffer
6102 {not in Vi, not in MS-DOS versions}
6103 Filenames are assumed to be 8 characters plus one extension of 3
6104 characters. Multiple dots in file names are not allowed. When this
6105 option is on, dots in file names are replaced with underscores when
6106 adding an extension (".~" or ".swp"). This option is not available
6107 for MS-DOS, because then it would always be on. This option is useful
6108 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6109 or crossdos. When running the Win32 GUI version under Win32s, this
6110 option is always on by default.
6111
6112 *'showbreak'* *'sbr'* *E595*
6113'showbreak' 'sbr' string (default "")
6114 global
6115 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006116 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 feature}
6118 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006119 values are "> " or "+++ ": >
6120 :set showbreak=>\
6121< Note the backslash to escape the trailing space. It's easier like
6122 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006123 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006124< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 comma (in a future version the comma might be used to separate the
6126 part that is shown at the end and at the start of a line).
6127 The characters are highlighted according to the '@' flag in
6128 'highlight'.
6129 Note that tabs after the showbreak will be displayed differently.
6130 If you want the 'showbreak' to appear in between line numbers, add the
6131 "n" flag to 'cpoptions'.
6132
6133 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6134'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6135 off)
6136 global
6137 {not in Vi}
6138 {not available when compiled without the
6139 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006140 Show (partial) command in the last line of the screen. Set this
6141 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 In Visual mode the size of the selected area is shown:
6143 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006144 If the number of bytes is different it is also displayed: "2-6"
6145 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006147 - When selecting a block, the size in screen characters:
6148 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 NOTE: This option is set to the Vi default value when 'compatible' is
6150 set and to the Vim default value when 'compatible' is reset.
6151
6152 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6153'showfulltag' 'sft' boolean (default off)
6154 global
6155 {not in Vi}
6156 When completing a word in insert mode (see |ins-completion|) from the
6157 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006158 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 matched a C function, you can see a template for what arguments are
6160 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006161 Note that this doesn't work well together with having "longest" in
6162 'completeopt', because the completion from the search pattern may not
6163 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164
6165 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6166'showmatch' 'sm' boolean (default off)
6167 global
6168 When a bracket is inserted, briefly jump to the matching one. The
6169 jump is only done if the match can be seen on the screen. The time to
6170 show the match can be set with 'matchtime'.
6171 A Beep is given if there is no match (no matter if the match can be
6172 seen or not). This option is reset when the 'paste' option is set.
6173 When the 'm' flag is not included in 'cpoptions', typing a character
6174 will immediately move the cursor back to where it belongs.
6175 See the "sm" field in 'guicursor' for setting the cursor shape and
6176 blinking when showing the match.
6177 The 'matchpairs' option can be used to specify the characters to show
6178 matches for. 'rightleft' and 'revins' are used to look for opposite
6179 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006180 Also see the matchparen plugin for highlighting the match when moving
6181 around |pi_paren.txt|.
6182 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183
6184 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6185'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6186 global
6187 If in Insert, Replace or Visual mode put a message on the last line.
6188 Use the 'M' flag in 'highlight' to set the type of highlighting for
6189 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006190 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 doesn't mean XIM is really active, especially when 'imactivatekey' is
6192 not set.
6193 NOTE: This option is set to the Vi default value when 'compatible' is
6194 set and to the Vim default value when 'compatible' is reset.
6195
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006196 *'showtabline'* *'stal'*
6197'showtabline' 'stal' number (default 1)
6198 global
6199 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006200 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006201 feature}
6202 The value of this option specifies when the line with tab page labels
6203 will be displayed:
6204 0: never
6205 1: only if there are at least two tab pages
6206 2: always
6207 This is both for the GUI and non-GUI implementation of the tab pages
6208 line.
6209 See |tab-page| for more information about tab pages.
6210
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 *'sidescroll'* *'ss'*
6212'sidescroll' 'ss' number (default 0)
6213 global
6214 {not in Vi}
6215 The minimal number of columns to scroll horizontally. Used only when
6216 the 'wrap' option is off and the cursor is moved off of the screen.
6217 When it is zero the cursor will be put in the middle of the screen.
6218 When using a slow terminal set it to a large number or 0. When using
6219 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6220 commands.
6221
6222 *'sidescrolloff'* *'siso'*
6223'sidescrolloff' 'siso' number (default 0)
6224 global
6225 {not in Vi}
6226 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006227 right of the cursor if 'nowrap' is set. Setting this option to a
6228 value greater than 0 while having |'sidescroll'| also at a non-zero
6229 value makes some context visible in the line you are scrolling in
6230 horizontally (except at beginning of the line). Setting this option
6231 to a large value (like 999) has the effect of keeping the cursor
6232 horizontally centered in the window, as long as one does not come too
6233 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 NOTE: This option is set to 0 when 'compatible' is set.
6235
6236 Example: Try this together with 'sidescroll' and 'listchars' as
6237 in the following example to never allow the cursor to move
6238 onto the "extends" character:
6239
6240 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6241 :set sidescrolloff=1
6242
6243
6244 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6245'smartcase' 'scs' boolean (default off)
6246 global
6247 {not in Vi}
6248 Override the 'ignorecase' option if the search pattern contains upper
6249 case characters. Only used when the search pattern is typed and
6250 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006251 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6253 recalling the search pattern from history and hitting <Enter>.
6254 NOTE: This option is reset when 'compatible' is set.
6255
6256 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6257'smartindent' 'si' boolean (default off)
6258 local to buffer
6259 {not in Vi}
6260 {not available when compiled without the
6261 |+smartindent| feature}
6262 Do smart autoindenting when starting a new line. Works for C-like
6263 programs, but can also be used for other languages. 'cindent' does
6264 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006265 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006266 setting 'si' has no effect. 'indentexpr' is a more advanced
6267 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 Normally 'autoindent' should also be on when using 'smartindent'.
6269 An indent is automatically inserted:
6270 - After a line ending in '{'.
6271 - After a line starting with a keyword from 'cinwords'.
6272 - Before a line starting with '}' (only with the "O" command).
6273 When typing '}' as the first character in a new line, that line is
6274 given the same indent as the matching '{'.
6275 When typing '#' as the first character in a new line, the indent for
6276 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006277 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6279 When using the ">>" command, lines starting with '#' are not shifted
6280 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006281 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 is set smart indenting is disabled.
6283
6284 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6285'smarttab' 'sta' boolean (default off)
6286 global
6287 {not in Vi}
6288 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006289 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6290 <BS> will delete a 'shiftwidth' worth of space at the start of the
6291 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006292 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006293 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6294 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006295 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006297 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 NOTE: This option is reset when 'compatible' is set.
6299
6300 *'softtabstop'* *'sts'*
6301'softtabstop' 'sts' number (default 0)
6302 local to buffer
6303 {not in Vi}
6304 Number of spaces that a <Tab> counts for while performing editing
6305 operations, like inserting a <Tab> or using <BS>. It "feels" like
6306 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6307 used. This is useful to keep the 'ts' setting at its standard value
6308 of 8, while being able to edit like it is set to 'sts'. However,
6309 commands like "x" still work on the actual characters.
6310 When 'sts' is zero, this feature is off.
6311 'softtabstop' is set to 0 when the 'paste' option is set.
6312 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6313 spaces is minimized by using <Tab>s.
6314 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6315 set.
6316 NOTE: This option is set to 0 when 'compatible' is set.
6317
Bram Moolenaar217ad922005-03-20 22:37:15 +00006318 *'spell'* *'nospell'*
6319'spell' boolean (default off)
6320 local to window
6321 {not in Vi}
6322 {not available when compiled without the |+syntax|
6323 feature}
6324 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006325 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006326
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006327 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006328'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006329 local to buffer
6330 {not in Vi}
6331 {not available when compiled without the |+syntax|
6332 feature}
6333 Pattern to locate the end of a sentence. The following word will be
6334 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006335 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006336 When this check is not wanted make this option empty.
6337 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006338 Be careful with special characters, see |option-backslash| about
6339 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006340 To set this option automatically depending on the language, see
6341 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006342
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006343 *'spellfile'* *'spf'*
6344'spellfile' 'spf' string (default empty)
6345 local to buffer
6346 {not in Vi}
6347 {not available when compiled without the |+syntax|
6348 feature}
6349 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006350 commands. It must end in ".{encoding}.add". You need to include the
6351 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006352 *E765*
6353 It may also be a comma separated list of names. A count before the
6354 |zg| and |zw| commands can be used to access each. This allows using
6355 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006356 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006357 you: Using the first directory in 'runtimepath' that is writable. If
6358 there is no "spell" directory yet it will be created. For the file
6359 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006360 ignoring the region.
6361 The resulting ".spl" file will be used for spell checking, it does not
6362 have to appear in 'spelllang'.
6363 Normally one file is used for all regions, but you can add the region
6364 name if you want to. However, it will then only be used when
6365 'spellfile' is set to it, for entries in 'spelllang' only files
6366 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006367 This option cannot be set from a |modeline| or in the |sandbox|, for
6368 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006369
Bram Moolenaar217ad922005-03-20 22:37:15 +00006370 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006371'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006372 local to buffer
6373 {not in Vi}
6374 {not available when compiled without the |+syntax|
6375 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006376 A comma separated list of word list names. When the 'spell' option is
6377 on spellchecking will be done for these languages. Example: >
6378 set spelllang=en_us,nl,medical
6379< This means US English, Dutch and medical words are recognized. Words
6380 that are not recognized will be highlighted.
6381 The word list name must not include a comma or dot. Using a dash is
6382 recommended to separate the two letter language name from a
6383 specification. Thus "en-rare" is used for rare English words.
6384 A region name must come last and have the form "_xx", where "xx" is
6385 the two-letter, lower case region name. You can use more than one
6386 region by listing them: "en_us,en_ca" supports both US and Canadian
6387 English, but not words specific for Australia, New Zealand or Great
6388 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006389 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006390 As a special case the name of a .spl file can be given as-is. The
6391 first "_xx" in the name is removed and used as the region name
6392 (_xx is an underscore, two letters and followed by a non-letter).
6393 This is mainly for testing purposes. You must make sure the correct
6394 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006395 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006396 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6397 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006398 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006399
Bram Moolenaar98692072006-02-04 00:57:42 +00006400 If the |spellfile.vim| plugin is active and you use a language name
6401 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6402 will ask you if you want to download the file.
6403
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006404 After this option has been set successfully, Vim will source the files
6405 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006406 up to the first comma, dot or underscore.
6407 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006408
6409
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006410 *'spellsuggest'* *'sps'*
6411'spellsuggest' 'sps' string (default "best")
6412 global
6413 {not in Vi}
6414 {not available when compiled without the |+syntax|
6415 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006416 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006417 the |spellsuggest()| function. This is a comma-separated list of
6418 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006419
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006420 best Internal method that works best for English. Finds
6421 changes like "fast" and uses a bit of sound-a-like
6422 scoring to improve the ordering.
6423
6424 double Internal method that uses two methods and mixes the
6425 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006426 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006427 word. That only works when the language specifies
6428 sound folding. Can be slow and doesn't always give
6429 better results.
6430
6431 fast Internal method that only checks for simple changes:
6432 character inserts/deletes/swaps. Works well for
6433 simple typing mistakes.
6434
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006435 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006436 Not used for |spellsuggest()|. The number of
6437 suggestions is never more than the value of 'lines'
6438 minus two.
6439
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006440 file:{filename} Read file {filename}, which must have two columns,
6441 separated by a slash. The first column contains the
6442 bad word, the second column the suggested good word.
6443 Example:
6444 theribal/terrible ~
6445 Use this for common mistakes that do not appear at the
6446 top of the suggestion list with the internal methods.
6447 Lines without a slash are ignored, use this for
6448 comments.
6449 The file is used for all languages.
6450
6451 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6452 trouble with spaces. |v:val| holds the badly spelled
6453 word. The expression must evaluate to a List of
6454 Lists, each with a suggestion and a score.
6455 Example:
6456 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006457 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006458 internal methods use. A lower score is better.
6459 This may invoke |spellsuggest()| if you temporarily
6460 set 'spellsuggest' to exclude the "expr:" part.
6461 Errors are silently ignored, unless you set the
6462 'verbose' option to a non-zero value.
6463
6464 Only one of "best", "double" or "fast" may be used. The others may
6465 appear several times in any order. Example: >
6466 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6467<
6468 This option cannot be set from a |modeline| or in the |sandbox|, for
6469 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006470
6471
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6473'splitbelow' 'sb' boolean (default off)
6474 global
6475 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006476 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 feature}
6478 When on, splitting a window will put the new window below the current
6479 one. |:split|
6480
6481 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6482'splitright' 'spr' boolean (default off)
6483 global
6484 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006485 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 feature}
6487 When on, splitting a window will put the new window right of the
6488 current one. |:vsplit|
6489
6490 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6491'startofline' 'sol' boolean (default on)
6492 global
6493 {not in Vi}
6494 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006495 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006496 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006497 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 with a linewise operator, with "%" with a count and to buffer changing
6499 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6500 only has a line number, e.g., ":25" or ":+".
6501 In case of buffer changing commands the cursor is placed at the column
6502 where it was the last time the buffer was edited.
6503 NOTE: This option is set when 'compatible' is set.
6504
Bram Moolenaar00654022011-02-25 14:42:19 +01006505 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006507 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 {not in Vi}
6509 {not available when compiled without the |+statusline|
6510 feature}
6511 When nonempty, this option determines the content of the status line.
6512 Also see |status-line|.
6513
6514 The option consists of printf style '%' items interspersed with
6515 normal text. Each status line item is of the form:
6516 %-0{minwid}.{maxwid}{item}
6517 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006518 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519
Bram Moolenaar238a5642006-02-21 22:12:05 +00006520 When the option starts with "%!" then it is used as an expression,
6521 evaluated and the result is used as the option value. Example: >
6522 :set statusline=%!MyStatusLine()
6523< The result can contain %{} items that will be evaluated too.
6524
6525 When there is error while evaluating the option then it will be made
6526 empty to avoid further errors. Otherwise screen updating would loop.
6527
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 Note that the only effect of 'ruler' when this option is set (and
6529 'laststatus' is 2) is controlling the output of |CTRL-G|.
6530
6531 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006532 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006534 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 minwid Minimum width of the item, padding as set by '-' & '0'.
6536 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006537 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 on the left for text items. Numeric items will be
6539 shifted down to maxwid-2 digits followed by '>'number
6540 where number is the amount of missing digits, much like
6541 an exponential notation.
6542 item A one letter code as described below.
6543
6544 Following is a description of the possible statusline items. The
6545 second character in "item" is the type:
6546 N for number
6547 S for string
6548 F for flags as described below
6549 - not applicable
6550
6551 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006552 f S Path to the file in the buffer, as typed or relative to current
6553 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 F S Full path to the file in the buffer.
6555 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006556 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006558 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006560 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006562 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006564 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6566 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006567 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6569 being used: "<keymap>"
6570 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006571 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572 B N As above, in hexadecimal.
6573 o N Byte number in file of byte under cursor, first byte is 1.
6574 Mnemonic: Offset from start of file (with one added)
6575 {not available when compiled without |+byte_offset| feature}
6576 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006577 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 l N Line number.
6579 L N Number of lines in buffer.
6580 c N Column number.
6581 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006582 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 p N Percentage through file in lines as in |CTRL-G|.
6584 P S Percentage through file of displayed window. This is like the
6585 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006586 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006588 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006589 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 ( - Start of item group. Can be used for setting the width and
6591 alignment of a section. Must be followed by %) somewhere.
6592 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006593 T N For 'tabline': start of tab page N label. Use %T after the last
6594 label. This information is used for mouse clicks.
6595 X N For 'tabline': start of close tab N label. Use %X after the
6596 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6597 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 < - Where to truncate line if too long. Default is at the start.
6599 No width fields allowed.
6600 = - Separation point between left and right aligned items.
6601 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006602 # - Set highlight group. The name must follow and then a # again.
6603 Thus use %#HLname# for highlight group HLname. The same
6604 highlighting is used, also for the statusline of non-current
6605 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006607 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 The difference between User{N} and StatusLine will be applied
6609 to StatusLineNC for the statusline of non-current windows.
6610 The number N must be between 1 and 9. See |hl-User1..9|
6611
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006612 When displaying a flag, Vim removes the leading comma, if any, when
6613 that flag comes right after plaintext. This will make a nice display
6614 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615
Bram Moolenaar582fd852005-03-28 20:58:01 +00006616 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 not set) and a minwid is not set for the group, the whole group will
6618 become empty. This will make a group like the following disappear
6619 completely from the statusline when none of the flags are set. >
6620 :set statusline=...%(\ [%M%R%H]%)...
6621<
6622 Beware that an expression is evaluated each and every time the status
6623 line is displayed. The current buffer and current window will be set
6624 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006625 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006627 real current buffer.
6628
6629 The 'statusline' option may be evaluated in the |sandbox|, see
6630 |sandbox-option|.
6631
6632 It is not allowed to change text or jump to another window while
6633 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634
6635 If the statusline is not updated when you want it (e.g., after setting
6636 a variable that's used in an expression), you can force an update by
6637 setting an option without changing its value. Example: >
6638 :let &ro = &ro
6639
6640< A result of all digits is regarded a number for display purposes.
6641 Otherwise the result is taken as flag text and applied to the rules
6642 described above.
6643
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006644 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6646 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6647
6648 Examples:
6649 Emulate standard status line with 'ruler' set >
6650 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6651< Similar, but add ASCII value of char under the cursor (like "ga") >
6652 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6653< Display byte count and byte value, modified flag in red. >
6654 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6655 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6656< Display a ,GZ flag if a compressed file is loaded >
6657 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6658< In the |:autocmd|'s: >
6659 :let b:gzflag = 1
6660< And: >
6661 :unlet b:gzflag
6662< And define this function: >
6663 :function VarExists(var, val)
6664 : if exists(a:var) | return a:val | else | return '' | endif
6665 :endfunction
6666<
6667 *'suffixes'* *'su'*
6668'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6669 global
6670 {not in Vi}
6671 Files with these suffixes get a lower priority when multiple files
6672 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006673 suffixes. Spaces after the comma are ignored. A dot is also seen as
6674 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 separator, precede it with a backslash (see |option-backslash| about
6676 including spaces and backslashes).
6677 See 'wildignore' for completely ignoring files.
6678 The use of |:set+=| and |:set-=| is preferred when adding or removing
6679 suffixes from the list. This avoids problems when a future version
6680 uses another default.
6681
6682 *'suffixesadd'* *'sua'*
6683'suffixesadd' 'sua' string (default "")
6684 local to buffer
6685 {not in Vi}
6686 {not available when compiled without the
6687 |+file_in_path| feature}
6688 Comma separated list of suffixes, which are used when searching for a
6689 file for the "gf", "[I", etc. commands. Example: >
6690 :set suffixesadd=.java
6691<
6692 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6693'swapfile' 'swf' boolean (default on)
6694 local to buffer
6695 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006696 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 swapfile is not wanted for a specific buffer. For example, with
6698 confidential information that even root must not be able to access.
6699 Careful: All text will be in memory:
6700 - Don't use this for big files.
6701 - Recovery will be impossible!
6702 A swapfile will only be present when |'updatecount'| is non-zero and
6703 'swapfile' is set.
6704 When 'swapfile' is reset, the swap file for the current buffer is
6705 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6706 non-zero, a swap file is immediately created.
6707 Also see |swap-file| and |'swapsync'|.
6708
6709 This option is used together with 'bufhidden' and 'buftype' to
6710 specify special kinds of buffers. See |special-buffers|.
6711
6712 *'swapsync'* *'sws'*
6713'swapsync' 'sws' string (default "fsync")
6714 global
6715 {not in Vi}
6716 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006717 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 When this option is empty parts of the swap file may be in memory and
6719 not written to disk. When the system crashes you may lose more work.
6720 On Unix the system does a sync now and then without Vim asking for it,
6721 so the disadvantage of setting this option off is small. On some
6722 systems the swap file will not be written at all. For a unix system
6723 setting it to "sync" will use the sync() call instead of the default
6724 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006725 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726
6727 *'switchbuf'* *'swb'*
6728'switchbuf' 'swb' string (default "")
6729 global
6730 {not in Vi}
6731 This option controls the behavior when switching between buffers.
6732 Possible values (comma separated list):
6733 useopen If included, jump to the first open window that
6734 contains the specified buffer (if there is one).
6735 Otherwise: Do not examine other windows.
6736 This setting is checked with |quickfix| commands, when
6737 jumping to errors (":cc", ":cn", "cp", etc.). It is
6738 also used in all buffer related split commands, for
6739 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006740 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006741 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006743 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006745 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006746 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006748 *'synmaxcol'* *'smc'*
6749'synmaxcol' 'smc' number (default 3000)
6750 local to buffer
6751 {not in Vi}
6752 {not available when compiled without the |+syntax|
6753 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006754 Maximum column in which to search for syntax items. In long lines the
6755 text after this column is not highlighted and following lines may not
6756 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006757 This helps to avoid very slow redrawing for an XML file that is one
6758 long line.
6759 Set to zero to remove the limit.
6760
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 *'syntax'* *'syn'*
6762'syntax' 'syn' string (default empty)
6763 local to buffer
6764 {not in Vi}
6765 {not available when compiled without the |+syntax|
6766 feature}
6767 When this option is set, the syntax with this name is loaded, unless
6768 syntax highlighting has been switched off with ":syntax off".
6769 Otherwise this option does not always reflect the current syntax (the
6770 b:current_syntax variable does).
6771 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006772 not automatically recognized. Example, in an IDL file:
6773 /* vim: set syntax=idl : */ ~
6774 When a dot appears in the value then this separates two filetype
6775 names. Example:
6776 /* vim: set syntax=c.doxygen : */ ~
6777 This will use the "c" syntax first, then the "doxygen" syntax.
6778 Note that the second one must be prepared to be loaded as an addition,
6779 otherwise it will be skipped. More than one dot may appear.
6780 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 :set syntax=OFF
6782< To switch syntax highlighting on according to the current value of the
6783 'filetype' option: >
6784 :set syntax=ON
6785< What actually happens when setting the 'syntax' option is that the
6786 Syntax autocommand event is triggered with the value as argument.
6787 This option is not copied to another buffer, independent of the 's' or
6788 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006789 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006791 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006792'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006793 global
6794 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006795 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006796 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006797 When nonempty, this option determines the content of the tab pages
6798 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006799 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006800
6801 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006802 option and only when there is no GUI tab line. When 'e' is in
6803 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006804 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006805
6806 The value is evaluated like with 'statusline'. You can use
6807 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006808 the text to be displayed. Use "%1T" for the first label, "%2T" for
6809 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006810
6811 Keep in mind that only one of the tab pages is the current one, others
6812 are invisible and you can't jump to their windows.
6813
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006814
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006815 *'tabpagemax'* *'tpm'*
6816'tabpagemax' 'tpm' number (default 10)
6817 global
6818 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006819 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006820 feature}
6821 Maximum number of tab pages to be opened by the |-p| command line
6822 argument or the ":tab all" command. |tabpage|
6823
6824
6825 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826'tabstop' 'ts' number (default 8)
6827 local to buffer
6828 Number of spaces that a <Tab> in the file counts for. Also see
6829 |:retab| command, and 'softtabstop' option.
6830
6831 Note: Setting 'tabstop' to any other value than 8 can make your file
6832 appear wrong in many places (e.g., when printing it).
6833
6834 There are four main ways to use tabs in Vim:
6835 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6836 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006837 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 behave like a tab appears every 4 (or 3) characters.
6839 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6840 'expandtab'. This way you will always insert spaces. The
6841 formatting will never be messed up when 'tabstop' is changed.
6842 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006843 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 works when using Vim to edit the file.
6845 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6846 'noexpandtab'. This should then work (for initial indents only)
6847 for any tabstop setting that people use. It might be nice to have
6848 tabs after the first non-blank inserted as spaces if you do this
6849 though. Otherwise aligned comments will be wrong when 'tabstop' is
6850 changed.
6851
6852 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6853'tagbsearch' 'tbs' boolean (default on)
6854 global
6855 {not in Vi}
6856 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006857 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 searching makes searching for a tag a LOT faster, but a linear search
6859 will find more tags if the tags file wasn't properly sorted.
6860 Vim normally assumes that your tags files are sorted, or indicate that
6861 they are not sorted. Only when this is not the case does the
6862 'tagbsearch' option need to be switched off.
6863
6864 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006865 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 certain files, or retry all files with a linear search. When
6867 'tagbsearch' is off, only a linear search is done.
6868
6869 Linear searching is done anyway, for one file, when Vim finds a line
6870 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006871 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872< [The whitespace before and after the '0' must be a single <Tab>]
6873
6874 When a binary search was done and no match was found in any of the
6875 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6876 instead of a normal tag name, a retry is done with a linear search.
6877 Tags in unsorted tags files, and matches with different case will only
6878 be found in the retry.
6879
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006880 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 linear search can be avoided for the 'ignorecase' case. Use a value
6882 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6883 case-fold sorted with the -f switch to "sort" in most unices, as in
6884 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006885 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6886 for this as well. Note that case must be folded to uppercase for this
6887 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888
6889 When 'tagbsearch' is off, tags searching is slower when a full match
6890 exists, but faster when no full match exists. Tags in unsorted tags
6891 files may only be found with 'tagbsearch' off.
6892 When the tags file is not sorted, or sorted in a wrong way (not on
6893 ASCII byte value), 'tagbsearch' should be off, or the line given above
6894 must be included in the tags file.
6895 This option doesn't affect commands that find all matching tags (e.g.,
6896 command-line completion and ":help").
6897 {Vi: always uses binary search in some versions}
6898
6899 *'taglength'* *'tl'*
6900'taglength' 'tl' number (default 0)
6901 global
6902 If non-zero, tags are significant up to this number of characters.
6903
6904 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6905'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6906 global
6907 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006908 If on and using a tags file in another directory, file names in that
6909 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 NOTE: This option is set to the Vi default value when 'compatible' is
6911 set and to the Vim default value when 'compatible' is reset.
6912
6913 *'tags'* *'tag'* *E433*
6914'tags' 'tag' string (default "./tags,tags", when compiled with
6915 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6916 global or local to buffer |global-local|
6917 Filenames for the tag command, separated by spaces or commas. To
6918 include a space or comma in a file name, precede it with a backslash
6919 (see |option-backslash| about including spaces and backslashes).
6920 When a file name starts with "./", the '.' is replaced with the path
6921 of the current file. But only when the 'd' flag is not included in
6922 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6923 |tags-option|.
6924 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006925 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6926 find all files named "tags" below "/lib". The filename itself cannot
6927 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6928 files called "tags?". {not available when compiled without the
6929 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006930 The |tagfiles()| function can be used to get a list of the file names
6931 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6933 files are also supported. They are automatically recognized. The
6934 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6935 differences are ignored (MS-Windows). |emacs-tags|
6936 The use of |:set+=| and |:set-=| is preferred when adding or removing
6937 file names from the list. This avoids problems when a future version
6938 uses another default.
6939 {Vi: default is "tags /usr/lib/tags"}
6940
6941 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6942'tagstack' 'tgst' boolean (default on)
6943 global
6944 {not in all versions of Vi}
6945 When on, the |tagstack| is used normally. When off, a ":tag" or
6946 ":tselect" command with an argument will not push the tag onto the
6947 tagstack. A following ":tag" without an argument, a ":pop" command or
6948 any other command that uses the tagstack will use the unmodified
6949 tagstack, but does change the pointer to the active entry.
6950 Resetting this option is useful when using a ":tag" command in a
6951 mapping which should not change the tagstack.
6952
6953 *'term'* *E529* *E530* *E531*
6954'term' string (default is $TERM, if that fails:
6955 in the GUI: "builtin_gui"
6956 on Amiga: "amiga"
6957 on BeOS: "beos-ansi"
6958 on Mac: "mac-ansi"
6959 on MiNT: "vt52"
6960 on MS-DOS: "pcterm"
6961 on OS/2: "os2ansi"
6962 on Unix: "ansi"
6963 on VMS: "ansi"
6964 on Win 32: "win32")
6965 global
6966 Name of the terminal. Used for choosing the terminal control
6967 characters. Environment variables are expanded |:set_env|.
6968 For example: >
6969 :set term=$TERM
6970< See |termcap|.
6971
6972 *'termbidi'* *'tbidi'*
6973 *'notermbidi'* *'notbidi'*
6974'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6975 global
6976 {not in Vi}
6977 {only available when compiled with the |+arabic|
6978 feature}
6979 The terminal is in charge of Bi-directionality of text (as specified
6980 by Unicode). The terminal is also expected to do the required shaping
6981 that some languages (such as Arabic) require.
6982 Setting this option implies that 'rightleft' will not be set when
6983 'arabic' is set and the value of 'arabicshape' will be ignored.
6984 Note that setting 'termbidi' has the immediate effect that
6985 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6986 This option is reset when the GUI is started.
6987 For further details see |arabic.txt|.
6988
6989 *'termencoding'* *'tenc'*
6990'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6991 Macintosh GUI: "macroman")
6992 global
6993 {only available when compiled with the |+multi_byte|
6994 feature}
6995 {not in Vi}
6996 Encoding used for the terminal. This specifies what character
6997 encoding the keyboard produces and the display will understand. For
6998 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006999 display). Except for the Mac when 'macatsui' is off, then
7000 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 In the Win32 console version the default value is the console codepage
7002 when it differs from the ANSI codepage.
7003 *E617*
7004 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7005 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7006 Any attempts to set a different value will be rejected, and an error
7007 message is shown.
7008 For the Win32 GUI 'termencoding' is not used for typed characters,
7009 because the Win32 system always passes Unicode characters.
7010 When empty, the same encoding is used as for the 'encoding' option.
7011 This is the normal value.
7012 Not all combinations for 'termencoding' and 'encoding' are valid. See
7013 |encoding-table|.
7014 The value for this option must be supported by internal conversions or
7015 iconv(). When this is not possible no conversion will be done and you
7016 will probably experience problems with non-ASCII characters.
7017 Example: You are working with the locale set to euc-jp (Japanese) and
7018 want to edit a UTF-8 file: >
7019 :let &termencoding = &encoding
7020 :set encoding=utf-8
7021< You need to do this when your system has no locale support for UTF-8.
7022
7023 *'terse'* *'noterse'*
7024'terse' boolean (default off)
7025 global
7026 When set: Add 's' flag to 'shortmess' option (this makes the message
7027 for a search that hits the start or end of the file not being
7028 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7029 shortens a lot of messages}
7030
7031 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7032'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7033 global
7034 {not in Vi}
7035 This option is obsolete. Use 'fileformats'.
7036 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7037 set to the default value for the current system. When 'textauto' is
7038 reset, 'fileformats' is made empty.
7039 NOTE: This option is set to the Vi default value when 'compatible' is
7040 set and to the Vim default value when 'compatible' is reset.
7041
7042 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7043'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7044 others: default off)
7045 local to buffer
7046 {not in Vi}
7047 This option is obsolete. Use 'fileformat'.
7048 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7049 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7050 "unix".
7051
7052 *'textwidth'* *'tw'*
7053'textwidth' 'tw' number (default 0)
7054 local to buffer
7055 {not in Vi}
7056 Maximum width of text that is being inserted. A longer line will be
7057 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007058 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7059 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007061 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 NOTE: This option is set to 0 when 'compatible' is set.
7063
7064 *'thesaurus'* *'tsr'*
7065'thesaurus' 'tsr' string (default "")
7066 global or local to buffer |global-local|
7067 {not in Vi}
7068 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007069 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 the file should contain words with similar meaning, separated by
7071 non-keyword characters (white space is preferred). Maximum line
7072 length is 510 bytes.
7073 To obtain a file to be used here, check out the wordlist FAQ at
7074 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007075 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 after a comma are ignored, otherwise spaces are included in the file
7077 name. See |option-backslash| about using backslashes.
7078 The use of |:set+=| and |:set-=| is preferred when adding or removing
7079 directories from the list. This avoids problems when a future version
7080 uses another default.
7081 Backticks cannot be used in this option for security reasons.
7082
7083 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7084'tildeop' 'top' boolean (default off)
7085 global
7086 {not in Vi}
7087 When on: The tilde command "~" behaves like an operator.
7088 NOTE: This option is reset when 'compatible' is set.
7089
7090 *'timeout'* *'to'* *'notimeout'* *'noto'*
7091'timeout' 'to' boolean (default on)
7092 global
7093 *'ttimeout'* *'nottimeout'*
7094'ttimeout' boolean (default off)
7095 global
7096 {not in Vi}
7097 These two options together determine the behavior when part of a
7098 mapped key sequence or keyboard code has been received:
7099
7100 'timeout' 'ttimeout' action ~
7101 off off do not time out
7102 on on or off time out on :mappings and key codes
7103 off on time out on key codes
7104
7105 If both options are off, Vim will wait until either the complete
7106 mapping or key sequence has been received, or it is clear that there
7107 is no mapping or key sequence for the received characters. For
7108 example: if you have mapped "vl" and Vim has received 'v', the next
7109 character is needed to see if the 'v' is followed by an 'l'.
7110 When one of the options is on, Vim will wait for about 1 second for
7111 the next character to arrive. After that the already received
7112 characters are interpreted as single characters. The waiting time can
7113 be changed with the 'timeoutlen' option.
7114 On slow terminals or very busy systems timing out may cause
7115 malfunctioning cursor keys. If both options are off, Vim waits
7116 forever after an entered <Esc> if there are key codes that start
7117 with <Esc>. You will have to type <Esc> twice. If you do not have
7118 problems with key codes, but would like to have :mapped key
7119 sequences not timing out in 1 second, set the 'ttimeout' option and
7120 reset the 'timeout' option.
7121
7122 NOTE: 'ttimeout' is reset when 'compatible' is set.
7123
7124 *'timeoutlen'* *'tm'*
7125'timeoutlen' 'tm' number (default 1000)
7126 global
7127 {not in all versions of Vi}
7128 *'ttimeoutlen'* *'ttm'*
7129'ttimeoutlen' 'ttm' number (default -1)
7130 global
7131 {not in Vi}
7132 The time in milliseconds that is waited for a key code or mapped key
7133 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7134 when part of a command has been typed.
7135 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7136 different timeout value for key codes is desired set 'ttimeoutlen' to
7137 a non-negative number.
7138
7139 ttimeoutlen mapping delay key code delay ~
7140 < 0 'timeoutlen' 'timeoutlen'
7141 >= 0 'timeoutlen' 'ttimeoutlen'
7142
7143 The timeout only happens when the 'timeout' and 'ttimeout' options
7144 tell so. A useful setting would be >
7145 :set timeout timeoutlen=3000 ttimeoutlen=100
7146< (time out on mapping after three seconds, time out on key codes after
7147 a tenth of a second).
7148
7149 *'title'* *'notitle'*
7150'title' boolean (default off, on when title can be restored)
7151 global
7152 {not in Vi}
7153 {not available when compiled without the |+title|
7154 feature}
7155 When on, the title of the window will be set to the value of
7156 'titlestring' (if it is not empty), or to:
7157 filename [+=-] (path) - VIM
7158 Where:
7159 filename the name of the file being edited
7160 - indicates the file cannot be modified, 'ma' off
7161 + indicates the file was modified
7162 = indicates the file is read-only
7163 =+ indicates the file is read-only and modified
7164 (path) is the path of the file being edited
7165 - VIM the server name |v:servername| or "VIM"
7166 Only works if the terminal supports setting window titles
7167 (currently Amiga console, Win32 console, all GUI versions and
7168 terminals with a non- empty 't_ts' option - these are Unix xterm and
7169 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7170 *X11*
7171 When Vim was compiled with HAVE_X11 defined, the original title will
7172 be restored if possible. The output of ":version" will include "+X11"
7173 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7174 works for the icon name |'icon'|.
7175 But: When Vim was started with the |-X| argument, restoring the title
7176 will not work (except in the GUI).
7177 If the title cannot be restored, it is set to the value of 'titleold'.
7178 You might want to restore the title outside of Vim then.
7179 When using an xterm from a remote machine you can use this command:
7180 rsh machine_name xterm -display $DISPLAY &
7181 then the WINDOWID environment variable should be inherited and the
7182 title of the window should change back to what it should be after
7183 exiting Vim.
7184
7185 *'titlelen'*
7186'titlelen' number (default 85)
7187 global
7188 {not in Vi}
7189 {not available when compiled without the |+title|
7190 feature}
7191 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007192 title. When the title is longer, only the end of the path name is
7193 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 Using a percentage makes this adapt to the width of the window. But
7195 it won't work perfectly, because the actual number of characters
7196 available also depends on the font used and other things in the title
7197 bar. When 'titlelen' is zero the full path is used. Otherwise,
7198 values from 1 to 30000 percent can be used.
7199 'titlelen' is also used for the 'titlestring' option.
7200
7201 *'titleold'*
7202'titleold' string (default "Thanks for flying Vim")
7203 global
7204 {not in Vi}
7205 {only available when compiled with the |+title|
7206 feature}
7207 This option will be used for the window title when exiting Vim if the
7208 original title cannot be restored. Only happens if 'title' is on or
7209 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007210 This option cannot be set from a |modeline| or in the |sandbox|, for
7211 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 *'titlestring'*
7213'titlestring' string (default "")
7214 global
7215 {not in Vi}
7216 {not available when compiled without the |+title|
7217 feature}
7218 When this option is not empty, it will be used for the title of the
7219 window. This happens only when the 'title' option is on.
7220 Only works if the terminal supports setting window titles (currently
7221 Amiga console, Win32 console, all GUI versions and terminals with a
7222 non-empty 't_ts' option).
7223 When Vim was compiled with HAVE_X11 defined, the original title will
7224 be restored if possible |X11|.
7225 When this option contains printf-style '%' items, they will be
7226 expanded according to the rules used for 'statusline'.
7227 Example: >
7228 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7229 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7230< The value of 'titlelen' is used to align items in the middle or right
7231 of the available space.
7232 Some people prefer to have the file name first: >
7233 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7234< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007235 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 separating space only when needed.
7237 NOTE: Use of special characters in 'titlestring' may cause the display
7238 to be garbled (e.g., when it contains a CR or NL character).
7239 {not available when compiled without the |+statusline| feature}
7240
7241 *'toolbar'* *'tb'*
7242'toolbar' 'tb' string (default "icons,tooltips")
7243 global
7244 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7245 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007246 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 possible values are:
7248 icons Toolbar buttons are shown with icons.
7249 text Toolbar buttons shown with text.
7250 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007251 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 tooltips Tooltips are active for toolbar buttons.
7253 Tooltips refer to the popup help text which appears after the mouse
7254 cursor is placed over a toolbar button for a brief moment.
7255
7256 If you want the toolbar to be shown with icons as well as text, do the
7257 following: >
7258 :set tb=icons,text
7259< Motif and Athena cannot display icons and text at the same time. They
7260 will show icons if both are requested.
7261
7262 If none of the strings specified in 'toolbar' are valid or if
7263 'toolbar' is empty, this option is ignored. If you want to disable
7264 the toolbar, you need to set the 'guioptions' option. For example: >
7265 :set guioptions-=T
7266< Also see |gui-toolbar|.
7267
7268 *'toolbariconsize'* *'tbis'*
7269'toolbariconsize' 'tbis' string (default "small")
7270 global
7271 {not in Vi}
7272 {only in the GTK+ 2 GUI}
7273 Controls the size of toolbar icons. The possible values are:
7274 tiny Use tiny toolbar icons.
7275 small Use small toolbar icons (default).
7276 medium Use medium-sized toolbar icons.
7277 large Use large toolbar icons.
7278 The exact dimensions in pixels of the various icon sizes depend on
7279 the current theme. Common dimensions are large=32x32, medium=24x24,
7280 small=20x20 and tiny=16x16.
7281
7282 If 'toolbariconsize' is empty, the global default size as determined
7283 by user preferences or the current theme is used.
7284
7285 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7286'ttybuiltin' 'tbi' boolean (default on)
7287 global
7288 {not in Vi}
7289 When on, the builtin termcaps are searched before the external ones.
7290 When off the builtin termcaps are searched after the external ones.
7291 When this option is changed, you should set the 'term' option next for
7292 the change to take effect, for example: >
7293 :set notbi term=$TERM
7294< See also |termcap|.
7295 Rationale: The default for this option is "on", because the builtin
7296 termcap entries are generally better (many systems contain faulty
7297 xterm entries...).
7298
7299 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7300'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7301 sun-cmd, screen, rxvt, dtterm or
7302 iris-ansi; also on when running Vim in
7303 a DOS console)
7304 global
7305 {not in Vi}
7306 Indicates a fast terminal connection. More characters will be sent to
7307 the screen for redrawing, instead of using insert/delete line
7308 commands. Improves smoothness of redrawing when there are multiple
7309 windows and the terminal does not support a scrolling region.
7310 Also enables the extra writing of characters at the end of each screen
7311 line for lines that wrap. This helps when using copy/paste with the
7312 mouse in an xterm and other terminals.
7313
7314 *'ttymouse'* *'ttym'*
7315'ttymouse' 'ttym' string (default depends on 'term')
7316 global
7317 {not in Vi}
7318 {only in Unix and VMS, doesn't work in the GUI; not
7319 available when compiled without |+mouse|}
7320 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007321 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 *xterm-mouse*
7323 xterm xterm-like mouse handling. The mouse generates
7324 "<Esc>[Mscr", where "scr" is three bytes:
7325 "s" = button state
7326 "c" = column plus 33
7327 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007328 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007329 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 xterm2 Works like "xterm", but with the xterm reporting the
7331 mouse position while the mouse is dragged. This works
7332 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007333 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 work. See below for how Vim detects this
7335 automatically.
7336 *netterm-mouse*
7337 netterm NetTerm mouse handling. The mouse generates
7338 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7339 for the row and column.
7340 *dec-mouse*
7341 dec DEC terminal mouse handling. The mouse generates a
7342 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007343 This is also available for an Xterm, if it was
7344 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345 *jsbterm-mouse*
7346 jsbterm JSB term mouse handling.
7347 *pterm-mouse*
7348 pterm QNX pterm mouse handling.
7349
7350 The mouse handling must be enabled at compile time |+mouse_xterm|
7351 |+mouse_dec| |+mouse_netterm|.
7352 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7353 recognized, if enabled at compile time. DEC terminal mouse codes
7354 are recognized if enabled at compile time, and 'ttymouse' is not
7355 "xterm" (because the xterm and dec mouse codes conflict).
7356 This option is automatically set to "xterm", when the 'term' option is
7357 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7358 or "xterm2" already. The main use of this option is to set it to
7359 "xterm", when the terminal name doesn't start with "xterm", but it can
7360 handle xterm mouse codes.
7361 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007362 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 feature and if |t_RV| is set to the escape sequence to request the
7364 xterm version number. Otherwise "xterm2" must be set explicitly.
7365 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7366 t_RV to an empty string: >
7367 :set t_RV=
7368<
7369 *'ttyscroll'* *'tsl'*
7370'ttyscroll' 'tsl' number (default 999)
7371 global
7372 Maximum number of lines to scroll the screen. If there are more lines
7373 to scroll the window is redrawn. For terminals where scrolling is
7374 very slow and redrawing is not slow this can be set to a small number,
7375 e.g., 3, to speed up displaying.
7376
7377 *'ttytype'* *'tty'*
7378'ttytype' 'tty' string (default from $TERM)
7379 global
7380 Alias for 'term', see above.
7381
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007382 *'undodir'* *'udir'*
7383'undodir' 'udir' string (default ".")
7384 global
7385 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007386 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007387 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007388 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007389 "." means using the directory of the file. The undo file name for
7390 "file.txt" is ".file.txt.un~".
7391 For other directories the file name is the full path of the edited
7392 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007393 When writing: The first directory that exists is used. "." always
7394 works, no directories after "." will be used for writing.
7395 When reading all entries are tried to find an undo file. The first
7396 undo file that exists is used. When it cannot be read an error is
7397 given, no further entry is used.
7398 See |undo-persistence|.
7399
7400 *'undofile'* *'udf'*
7401'undofile' 'udf' boolean (default off)
7402 local to buffer
7403 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007404 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007405 When on, Vim automatically saves undo history to an undo file when
7406 writing a buffer to a file, and restores undo history from the same
7407 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007408 The directory where the undo file is stored is specified by 'undodir'.
7409 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007410 The undo file is not read when 'undoreload' causes the buffer from
7411 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007412 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007413
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 *'undolevels'* *'ul'*
7415'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7416 Win32 and OS/2)
7417 global
7418 {not in Vi}
7419 Maximum number of changes that can be undone. Since undo information
7420 is kept in memory, higher numbers will cause more memory to be used
7421 (nevertheless, a single change can use an unlimited amount of memory).
7422 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7423 itself: >
7424 set ul=0
7425< But you can also get Vi compatibility by including the 'u' flag in
7426 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007427 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 Set to a negative number for no undo at all: >
7429 set ul=-1
7430< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007431 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007433 *'undoreload'* *'ur'*
7434'undoreload' 'ur' number (default 10000)
7435 global
7436 {not in Vi}
7437 Save the whole buffer for undo when reloading it. This applies to the
7438 ":e!" command and reloading for when the buffer changed outside of
7439 Vim. |FileChangedShell|
7440 The save only happens when this options is negative or when the number
7441 of lines is smaller than the value of this option.
7442 Set this option to zero to disable undo for a reload.
7443
7444 When saving undo for a reload, any undo file is not read.
7445
7446 Note that this causes the whole buffer to be stored in memory. Set
7447 this option to a lower value if you run out of memory.
7448
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 *'updatecount'* *'uc'*
7450'updatecount' 'uc' number (default: 200)
7451 global
7452 {not in Vi}
7453 After typing this many characters the swap file will be written to
7454 disk. When zero, no swap file will be created at all (see chapter on
7455 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7456 Vim with the "-n" option, see |startup|. When editing in readonly
7457 mode this option will be initialized to 10000.
7458 The swapfile can be disabled per buffer with |'swapfile'|.
7459 When 'updatecount' is set from zero to non-zero, swap files are
7460 created for all buffers that have 'swapfile' set. When 'updatecount'
7461 is set to zero, existing swap files are not deleted.
7462 Also see |'swapsync'|.
7463 This option has no meaning in buffers where |'buftype'| is "nofile"
7464 or "nowrite".
7465
7466 *'updatetime'* *'ut'*
7467'updatetime' 'ut' number (default 4000)
7468 global
7469 {not in Vi}
7470 If this many milliseconds nothing is typed the swap file will be
7471 written to disk (see |crash-recovery|). Also used for the
7472 |CursorHold| autocommand event.
7473
7474 *'verbose'* *'vbs'*
7475'verbose' 'vbs' number (default 0)
7476 global
7477 {not in Vi, although some versions have a boolean
7478 verbose option}
7479 When bigger than zero, Vim will give messages about what it is doing.
7480 Currently, these messages are given:
7481 >= 1 When the viminfo file is read or written.
7482 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007483 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 >= 8 Files for which a group of autocommands is executed.
7485 >= 9 Every executed autocommand.
7486 >= 12 Every executed function.
7487 >= 13 When an exception is thrown, caught, finished, or discarded.
7488 >= 14 Anything pending in a ":finally" clause.
7489 >= 15 Every executed Ex command (truncated at 200 characters).
7490
7491 This option can also be set with the "-V" argument. See |-V|.
7492 This option is also set by the |:verbose| command.
7493
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007494 When the 'verbosefile' option is set then the verbose messages are not
7495 displayed.
7496
7497 *'verbosefile'* *'vfile'*
7498'verbosefile' 'vfile' string (default empty)
7499 global
7500 {not in Vi}
7501 When not empty all messages are written in a file with this name.
7502 When the file exists messages are appended.
7503 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007504 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007505 Setting 'verbosefile' to a new value is like making it empty first.
7506 The difference with |:redir| is that verbose messages are not
7507 displayed when 'verbosefile' is set.
7508
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 *'viewdir'* *'vdir'*
7510'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7511 "$VIM/vimfiles/view",
7512 for Unix: "~/.vim/view",
7513 for Macintosh: "$VIM:vimfiles:view"
7514 for VMS: "sys$login:vimfiles/view"
7515 for RiscOS: "Choices:vimfiles/view")
7516 global
7517 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007518 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 feature}
7520 Name of the directory where to store files for |:mkview|.
7521 This option cannot be set from a |modeline| or in the |sandbox|, for
7522 security reasons.
7523
7524 *'viewoptions'* *'vop'*
7525'viewoptions' 'vop' string (default: "folds,options,cursor")
7526 global
7527 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007528 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 feature}
7530 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007531 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 word save and restore ~
7533 cursor cursor position in file and in window
7534 folds manually created folds, opened/closed folds and local
7535 fold options
7536 options options and mappings local to a window or buffer (not
7537 global values for local options)
7538 slash backslashes in file names replaced with forward
7539 slashes
7540 unix with Unix end-of-line format (single <NL>), even when
7541 on Windows or DOS
7542
7543 "slash" and "unix" are useful on Windows when sharing view files
7544 with Unix. The Unix version of Vim cannot source dos format scripts,
7545 but the Windows version of Vim can source unix format scripts.
7546
7547 *'viminfo'* *'vi'* *E526* *E527* *E528*
7548'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007549 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7550 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7551 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 global
7553 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007554 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 feature}
7556 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007557 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 separated list of parameters, each consisting of a single character
7559 identifying the particular parameter, followed by a number or string
7560 which specifies the value of that parameter. If a particular
7561 character is left out, then the default value is used for that
7562 parameter. The following is a list of the identifying characters and
7563 the effect of their value.
7564 CHAR VALUE ~
7565 ! When included, save and restore global variables that start
7566 with an uppercase letter, and don't contain a lowercase
7567 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007568 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007569 read back correctly, you end up with an empty item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570 " Maximum number of lines saved for each register. Old name of
7571 the '<' item, with the disadvantage that you need to put a
7572 backslash before the ", otherwise it will be recognized as the
7573 start of a comment!
7574 % When included, save and restore the buffer list. If Vim is
7575 started with a file name argument, the buffer list is not
7576 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007577 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 without a file name and buffers for help files are not written
7579 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007580 When followed by a number, the number specifies the maximum
7581 number of buffers that are stored. Without a number all
7582 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 ' Maximum number of previously edited files for which the marks
7584 are remembered. This parameter must always be included when
7585 'viminfo' is non-empty.
7586 Including this item also means that the |jumplist| and the
7587 |changelist| are stored in the viminfo file.
7588 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007589 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 patterns are also saved. When not included, the value of
7591 'history' is used.
7592 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007593 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007594 < Maximum number of lines saved for each register. If zero then
7595 registers are not saved. When not included, all lines are
7596 saved. '"' is the old name for this item.
7597 Also see the 's' item below: limit specified in Kbyte.
7598 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007599 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 c When included, convert the text in the viminfo file from the
7601 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007602 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 f Whether file marks need to be stored. If zero, file marks ('0
7604 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007605 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 cursor position (when exiting or when doing ":wviminfo").
7607 h Disable the effect of 'hlsearch' when loading the viminfo
7608 file. When not included, it depends on whether ":nohlsearch"
7609 has been used since the last search command.
7610 n Name of the viminfo file. The name must immediately follow
7611 the 'n'. Must be the last one! If the "-i" argument was
7612 given when starting Vim, that file name overrides the one
7613 given here with 'viminfo'. Environment variables are expanded
7614 when opening the file, not when setting the option.
7615 r Removable media. The argument is a string (up to the next
7616 ','). This parameter can be given several times. Each
7617 specifies the start of a path for which no marks will be
7618 stored. This is to avoid removable media. For MS-DOS you
7619 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7620 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7621 ignored. Maximum length of each 'r' argument is 50
7622 characters.
7623 s Maximum size of an item in Kbyte. If zero then registers are
7624 not saved. Currently only applies to registers. The default
7625 "s10" will exclude registers with more than 10 Kbyte of text.
7626 Also see the '<' item above: line count limit.
7627
7628 Example: >
7629 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7630<
7631 '50 Marks will be remembered for the last 50 files you
7632 edited.
7633 <1000 Contents of registers (up to 1000 lines each) will be
7634 remembered.
7635 s100 Registers with more than 100 Kbyte text are skipped.
7636 :0 Command-line history will not be saved.
7637 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7638 no / Since '/' is not specified, the default will be used,
7639 that is, save all of the search history, and also the
7640 previous search and substitute patterns.
7641 no % The buffer list will not be saved nor read back.
7642 no h 'hlsearch' highlighting will be restored.
7643
7644 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7645 load the contents of the file, this is not done automatically.
7646
7647 This option cannot be set from a |modeline| or in the |sandbox|, for
7648 security reasons.
7649
7650 *'virtualedit'* *'ve'*
7651'virtualedit' 've' string (default "")
7652 global
7653 {not in Vi}
7654 {not available when compiled without the
7655 |+virtualedit| feature}
7656 A comma separated list of these words:
7657 block Allow virtual editing in Visual block mode.
7658 insert Allow virtual editing in Insert mode.
7659 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007660 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007661
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007663 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 of the line. Useful for selecting a rectangle in Visual mode and
7665 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007666 "onemore" is not the same, it will only allow moving the cursor just
7667 after the last character of the line. This makes some commands more
7668 consistent. Previously the cursor was always past the end of the line
7669 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007670 break some plugins or Vim scripts. For example because |l| can move
7671 the cursor after the last character. Use with care!
7672 Using the |$| command will move to the last character in the line, not
7673 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007674 It doesn't make sense to combine "all" with "onemore", but you will
7675 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676
7677 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7678'visualbell' 'vb' boolean (default off)
7679 global
7680 {not in Vi}
7681 Use visual bell instead of beeping. The terminal code to display the
7682 visual bell is given with 't_vb'. When no beep or flash is wanted,
7683 use ":set vb t_vb=".
7684 Note: When the GUI starts, 't_vb' is reset to its default value. You
7685 might want to set it again in your |gvimrc|.
7686 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7687 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7688 where 40 is the time in msec.
7689 Does not work on the Amiga, you always get a screen flash.
7690 Also see 'errorbells'.
7691
7692 *'warn'* *'nowarn'*
7693'warn' boolean (default on)
7694 global
7695 Give a warning message when a shell command is used while the buffer
7696 has been changed.
7697
7698 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7699'weirdinvert' 'wiv' boolean (default off)
7700 global
7701 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007702 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 It is provided for backwards compatibility with version 4.x.
7704 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7705 vice versa. Has no effect when the GUI is running.
7706
7707 *'whichwrap'* *'ww'*
7708'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7709 global
7710 {not in Vi}
7711 Allow specified keys that move the cursor left/right to move to the
7712 previous/next line when the cursor is on the first/last character in
7713 the line. Concatenate characters to allow this for these keys:
7714 char key mode ~
7715 b <BS> Normal and Visual
7716 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007717 h "h" Normal and Visual (not recommended)
7718 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 < <Left> Normal and Visual
7720 > <Right> Normal and Visual
7721 ~ "~" Normal
7722 [ <Left> Insert and Replace
7723 ] <Right> Insert and Replace
7724 For example: >
7725 :set ww=<,>,[,]
7726< allows wrap only when cursor keys are used.
7727 When the movement keys are used in combination with a delete or change
7728 operator, the <EOL> also counts for a character. This makes "3h"
7729 different from "3dh" when the cursor crosses the end of a line. This
7730 is also true for "x" and "X", because they do the same as "dl" and
7731 "dh". If you use this, you may also want to use the mapping
7732 ":map <BS> X" to make backspace delete the character in front of the
7733 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007734 When 'l' is included and it is used after an operator at the end of a
7735 line then it will not move to the next line. This makes "dl", "cl",
7736 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 NOTE: This option is set to the Vi default value when 'compatible' is
7738 set and to the Vim default value when 'compatible' is reset.
7739
7740 *'wildchar'* *'wc'*
7741'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7742 global
7743 {not in Vi}
7744 Character you have to type to start wildcard expansion in the
7745 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007746 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 The character is not recognized when used inside a macro. See
7748 'wildcharm' for that.
7749 Although 'wc' is a number option, you can set it to a special key: >
7750 :set wc=<Esc>
7751< NOTE: This option is set to the Vi default value when 'compatible' is
7752 set and to the Vim default value when 'compatible' is reset.
7753
7754 *'wildcharm'* *'wcm'*
7755'wildcharm' 'wcm' number (default: none (0))
7756 global
7757 {not in Vi}
7758 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007759 recognized when used inside a macro. You can find "spare" command-line
7760 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 you'll never actually type 'wildcharm', just use it in mappings that
7762 automatically invoke completion mode, e.g.: >
7763 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007764 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765< Then after typing :ss you can use CTRL-P & CTRL-N.
7766
7767 *'wildignore'* *'wig'*
7768'wildignore' 'wig' string (default "")
7769 global
7770 {not in Vi}
7771 {not available when compiled without the |+wildignore|
7772 feature}
7773 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007774 patterns is ignored when completing file or directory names, and
7775 influences the result of |expand()|, |glob()| and |globpath()| unless
7776 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7778 Also see 'suffixes'.
7779 Example: >
7780 :set wildignore=*.o,*.obj
7781< The use of |:set+=| and |:set-=| is preferred when adding or removing
7782 a pattern from the list. This avoids problems when a future version
7783 uses another default.
7784
Bram Moolenaar94950a92010-12-02 16:01:29 +01007785
Bram Moolenaar81af9252010-12-10 20:35:50 +01007786 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007787'wildignorecase' 'wic' boolean (default off)
7788 global
7789 {not in Vi}
7790 When set case is ignored when completing file names and directories.
7791 Has no effect on systems where file name case is generally ignored.
7792 Does not apply when the shell is used to expand wildcards, which
7793 happens when there are special characters.
7794
7795
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7797'wildmenu' 'wmnu' boolean (default off)
7798 global
7799 {not in Vi}
7800 {not available if compiled without the |+wildmenu|
7801 feature}
7802 When 'wildmenu' is on, command-line completion operates in an enhanced
7803 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7804 the possible matches are shown just above the command line, with the
7805 first match highlighted (overwriting the status line, if there is
7806 one). Keys that show the previous/next match, such as <Tab> or
7807 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7808 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7809 specified. "longest" and "list" do not start "wildmenu" mode.
7810 If there are more matches than can fit in the line, a ">" is shown on
7811 the right and/or a "<" is shown on the left. The status line scrolls
7812 as needed.
7813 The "wildmenu" mode is abandoned when a key is hit that is not used
7814 for selecting a completion.
7815 While the "wildmenu" is active the following keys have special
7816 meanings:
7817
7818 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7819 <Down> - in filename/menu name completion: move into a
7820 subdirectory or submenu.
7821 <CR> - in menu completion, when the cursor is just after a
7822 dot: move into a submenu.
7823 <Up> - in filename/menu name completion: move up into
7824 parent directory or parent menu.
7825
7826 This makes the menus accessible from the console |console-menus|.
7827
7828 If you prefer the <Left> and <Right> keys to move the cursor instead
7829 of selecting a different match, use this: >
7830 :cnoremap <Left> <Space><BS><Left>
7831 :cnoremap <Right> <Space><BS><Right>
7832<
7833 The "WildMenu" highlighting is used for displaying the current match
7834 |hl-WildMenu|.
7835
7836 *'wildmode'* *'wim'*
7837'wildmode' 'wim' string (Vim default: "full")
7838 global
7839 {not in Vi}
7840 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007841 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007842 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 first part specifies the behavior for the first use of 'wildchar',
7844 The second part for the second use, etc.
7845 These are the possible values for each part:
7846 "" Complete only the first match.
7847 "full" Complete the next full match. After the last match,
7848 the original string is used and then the first match
7849 again.
7850 "longest" Complete till longest common string. If this doesn't
7851 result in a longer string, use the next part.
7852 "longest:full" Like "longest", but also start 'wildmenu' if it is
7853 enabled.
7854 "list" When more than one match, list all matches.
7855 "list:full" When more than one match, list all matches and
7856 complete first match.
7857 "list:longest" When more than one match, list all matches and
7858 complete till longest common string.
7859 When there is only a single match, it is fully completed in all cases.
7860
7861 Examples: >
7862 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007863< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 :set wildmode=longest,full
7865< Complete longest common string, then each full match >
7866 :set wildmode=list:full
7867< List all matches and complete each full match >
7868 :set wildmode=list,full
7869< List all matches without completing, then each full match >
7870 :set wildmode=longest,list
7871< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007872 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007874 *'wildoptions'* *'wop'*
7875'wildoptions' 'wop' string (default "")
7876 global
7877 {not in Vi}
7878 {not available when compiled without the |+wildignore|
7879 feature}
7880 A list of words that change how command line completion is done.
7881 Currently only one word is allowed:
7882 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007883 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007884 is displayed per line. Often used tag kinds are:
7885 d #define
7886 f function
7887 Also see |cmdline-completion|.
7888
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 *'winaltkeys'* *'wak'*
7890'winaltkeys' 'wak' string (default "menu")
7891 global
7892 {not in Vi}
7893 {only used in Win32, Motif, GTK and Photon GUI}
7894 Some GUI versions allow the access to menu entries by using the ALT
7895 key in combination with a character that appears underlined in the
7896 menu. This conflicts with the use of the ALT key for mappings and
7897 entering special characters. This option tells what to do:
7898 no Don't use ALT keys for menus. ALT key combinations can be
7899 mapped, but there is no automatic handling. This can then be
7900 done with the |:simalt| command.
7901 yes ALT key handling is done by the windowing system. ALT key
7902 combinations cannot be mapped.
7903 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007904 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 keys can be mapped.
7906 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7907 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007908 This option is not used for <F10>; on Win32 and with GTK <F10> will
7909 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007911 *'window'* *'wi'*
7912'window' 'wi' number (default screen height - 1)
7913 global
7914 Window height. Do not confuse this with the height of the Vim window,
7915 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007916 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7917 value is smaller than 'lines' minus one. The screen will scroll
7918 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007919 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7920 in a much smarter way, taking care of wrapping lines.
7921 When resizing the Vim window, the value is smaller than 1 or more than
7922 or equal to 'lines' it will be set to 'lines' minus 1.
7923 {Vi also uses the option to specify the number of displayed lines}
7924
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 *'winheight'* *'wh'* *E591*
7926'winheight' 'wh' number (default 1)
7927 global
7928 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007929 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 feature}
7931 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007932 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007933 focus goes to a window that is smaller, its size is increased, at the
7934 cost of the height of other windows.
7935 Set 'winheight' to a small number for normal editing.
7936 Set it to 999 to make the current window fill most of the screen.
7937 Other windows will be only 'winminheight' high. This has the drawback
7938 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7939 to create only two windows, set the option after startup is done,
7940 using the |VimEnter| event: >
7941 au VimEnter * set winheight=999
7942< Minimum value is 1.
7943 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944 height of the current window.
7945 'winheight' applies to the current window. Use 'winminheight' to set
7946 the minimal height for other windows.
7947
7948 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7949'winfixheight' 'wfh' boolean (default off)
7950 local to window
7951 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007952 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 feature}
7954 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007955 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7956 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 The height may be changed anyway when running out of room.
7958
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007959 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7960'winfixwidth' 'wfw' boolean (default off)
7961 local to window
7962 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007963 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007964 feature}
7965 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007966 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007967 The width may be changed anyway when running out of room.
7968
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 *'winminheight'* *'wmh'*
7970'winminheight' 'wmh' number (default 1)
7971 global
7972 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007973 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 feature}
7975 The minimal height of a window, when it's not the current window.
7976 This is a hard minimum, windows will never become smaller.
7977 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7978 status bar) if necessary. They will return to at least one line when
7979 they become active (since the cursor has to have somewhere to go.)
7980 Use 'winheight' to set the minimal height of the current window.
7981 This option is only checked when making a window smaller. Don't use a
7982 large number, it will cause errors when opening more than a few
7983 windows. A value of 0 to 3 is reasonable.
7984
7985 *'winminwidth'* *'wmw'*
7986'winminwidth' 'wmw' number (default 1)
7987 global
7988 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007989 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 feature}
7991 The minimal width of a window, when it's not the current window.
7992 This is a hard minimum, windows will never become smaller.
7993 When set to zero, windows may be "squashed" to zero columns (i.e. just
7994 a vertical separator) if necessary. They will return to at least one
7995 line when they become active (since the cursor has to have somewhere
7996 to go.)
7997 Use 'winwidth' to set the minimal width of the current window.
7998 This option is only checked when making a window smaller. Don't use a
7999 large number, it will cause errors when opening more than a few
8000 windows. A value of 0 to 12 is reasonable.
8001
8002 *'winwidth'* *'wiw'* *E592*
8003'winwidth' 'wiw' number (default 20)
8004 global
8005 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008006 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 feature}
8008 Minimal number of columns for the current window. This is not a hard
8009 minimum, Vim will use fewer columns if there is not enough room. If
8010 the current window is smaller, its size is increased, at the cost of
8011 the width of other windows. Set it to 999 to make the current window
8012 always fill the screen. Set it to a small number for normal editing.
8013 The width is not adjusted after one of the commands to change the
8014 width of the current window.
8015 'winwidth' applies to the current window. Use 'winminwidth' to set
8016 the minimal width for other windows.
8017
8018 *'wrap'* *'nowrap'*
8019'wrap' boolean (default on)
8020 local to window
8021 {not in Vi}
8022 This option changes how text is displayed. It doesn't change the text
8023 in the buffer, see 'textwidth' for that.
8024 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008025 displaying continues on the next line. When off lines will not wrap
8026 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 moved to a part that is not shown, the screen will scroll
8028 horizontally.
8029 The line will be broken in the middle of a word if necessary. See
8030 'linebreak' to get the break at a word boundary.
8031 To make scrolling horizontally a bit more useful, try this: >
8032 :set sidescroll=5
8033 :set listchars+=precedes:<,extends:>
8034< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008035 This option can't be set from a |modeline| when the 'diff' option is
8036 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037
8038 *'wrapmargin'* *'wm'*
8039'wrapmargin' 'wm' number (default 0)
8040 local to buffer
8041 Number of characters from the right window border where wrapping
8042 starts. When typing text beyond this limit, an <EOL> will be inserted
8043 and inserting continues on the next line.
8044 Options that add a margin, such as 'number' and 'foldcolumn', cause
8045 the text width to be further reduced. This is Vi compatible.
8046 When 'textwidth' is non-zero, this option is not used.
8047 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8048 and less usefully}
8049
8050 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8051'wrapscan' 'ws' boolean (default on) *E384* *E385*
8052 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008053 Searches wrap around the end of the file. Also applies to |]s| and
8054 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055
8056 *'write'* *'nowrite'*
8057'write' boolean (default on)
8058 global
8059 {not in Vi}
8060 Allows writing files. When not set, writing a file is not allowed.
8061 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008062 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 argument. Filtering text is still possible, even though this requires
8064 writing a temporary file.
8065
8066 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8067'writeany' 'wa' boolean (default off)
8068 global
8069 Allows writing to any file with no need for "!" override.
8070
8071 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8072'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8073 otherwise)
8074 global
8075 {not in Vi}
8076 Make a backup before overwriting a file. The backup is removed after
8077 the file was successfully written, unless the 'backup' option is
8078 also on. Reset this option if your file system is almost full. See
8079 |backup-table| for another explanation.
8080 When the 'backupskip' pattern matches, a backup is not made anyway.
8081 NOTE: This option is set to the default value when 'compatible' is
8082 set.
8083
8084 *'writedelay'* *'wd'*
8085'writedelay' 'wd' number (default 0)
8086 global
8087 {not in Vi}
8088 The number of microseconds to wait for each character sent to the
8089 screen. When non-zero, characters are sent to the terminal one by
8090 one. For MS-DOS pcterm this does not work. For debugging purposes.
8091
8092 vim:tw=78:ts=8:ft=help:norl: