blob: 91623c10fe6bdc656aebd18174f520975645e547 [file] [log] [blame]
Bram Moolenaar251e1912011-06-19 05:09:16 +02001*options.txt* For Vim version 7.3. Last change: 2011 Jun 12
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
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'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200818'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 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").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200852
853 For MS-DOS, Windows and OS/2 the default is "dark".
854 For other systems "dark" is used when 'term' is "linux",
855 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
856 background. Otherwise the default is "light".
857
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858 Normally this option would be set in the .vimrc file. Possibly
859 depending on the terminal name. Example: >
860 :if &term == "pcterm"
861 : set background=dark
862 :endif
863< When this option is set, the default settings for the highlight groups
864 will change. To use other settings, place ":highlight" commands AFTER
865 the setting of the 'background' option.
866 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
867 to select the colors for syntax highlighting. After changing this
868 option, you must load syntax.vim again to see the result. This can be
869 done with ":syntax on".
870
871 *'backspace'* *'bs'*
872'backspace' 'bs' string (default "")
873 global
874 {not in Vi}
875 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
876 mode. This is a list of items, separated by commas. Each item allows
877 a way to backspace over something:
878 value effect ~
879 indent allow backspacing over autoindent
880 eol allow backspacing over line breaks (join lines)
881 start allow backspacing over the start of insert; CTRL-W and CTRL-U
882 stop once at the start of insert.
883
884 When the value is empty, Vi compatible backspacing is used.
885
886 For backwards compatibility with version 5.4 and earlier:
887 value effect ~
888 0 same as ":set backspace=" (Vi compatible)
889 1 same as ":set backspace=indent,eol"
890 2 same as ":set backspace=indent,eol,start"
891
892 See |:fixdel| if your <BS> or <Del> key does not do what you want.
893 NOTE: This option is set to "" when 'compatible' is set.
894
895 *'backup'* *'bk'* *'nobackup'* *'nobk'*
896'backup' 'bk' boolean (default off)
897 global
898 {not in Vi}
899 Make a backup before overwriting a file. Leave it around after the
900 file has been successfully written. If you do not want to keep the
901 backup file, but you do want a backup while the file is being
902 written, reset this option and set the 'writebackup' option (this is
903 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000904 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905 |backup-table| for more explanations.
906 When the 'backupskip' pattern matches, a backup is not made anyway.
907 When 'patchmode' is set, the backup may be renamed to become the
908 oldest version of a file.
909 NOTE: This option is reset when 'compatible' is set.
910
911 *'backupcopy'* *'bkc'*
912'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
913 global
914 {not in Vi}
915 When writing a file and a backup is made, this option tells how it's
916 done. This is a comma separated list of words.
917
918 The main values are:
919 "yes" make a copy of the file and overwrite the original one
920 "no" rename the file and write a new one
921 "auto" one of the previous, what works best
922
923 Extra values that can be combined with the ones above are:
924 "breaksymlink" always break symlinks when writing
925 "breakhardlink" always break hardlinks when writing
926
927 Making a copy and overwriting the original file:
928 - Takes extra time to copy the file.
929 + When the file has special attributes, is a (hard/symbolic) link or
930 has a resource fork, all this is preserved.
931 - When the file is a link the backup will have the name of the link,
932 not of the real file.
933
934 Renaming the file and writing a new one:
935 + It's fast.
936 - Sometimes not all attributes of the file can be copied to the new
937 file.
938 - When the file is a link the new file will not be a link.
939
940 The "auto" value is the middle way: When Vim sees that renaming file
941 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000942 the file is not a link) that is used. When problems are expected, a
943 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944
945 The "breaksymlink" and "breakhardlink" values can be used in
946 combination with any of "yes", "no" and "auto". When included, they
947 force Vim to always break either symbolic or hard links by doing
948 exactly what the "no" option does, renaming the original file to
949 become the backup and writing a new file in its place. This can be
950 useful for example in source trees where all the files are symbolic or
951 hard links and any changes should stay in the local source tree, not
952 be propagated back to the original source.
953 *crontab*
954 One situation where "no" and "auto" will cause problems: A program
955 that opens a file, invokes Vim to edit that file, and then tests if
956 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000957 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958 example.
959
960 When a copy is made, the original file is truncated and then filled
961 with the new text. This means that protection bits, owner and
962 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000963 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964 group of the backup is set to the group of the original file. If this
965 fails, the protection bits for the group are made the same as for
966 others.
967
968 When the file is renamed this is the other way around: The backup has
969 the same attributes of the original file, and the newly written file
970 is owned by the current user. When the file was a (hard/symbolic)
971 link, the new file will not! That's why the "auto" value doesn't
972 rename when the file is a link. The owner and group of the newly
973 written file will be set to the same ones as the original file, but
974 the system may refuse to do this. In that case the "auto" value will
975 again not rename the file.
976
977 *'backupdir'* *'bdir'*
978'backupdir' 'bdir' string (default for Amiga: ".,t:",
979 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
980 for Unix: ".,~/tmp,~/")
981 global
982 {not in Vi}
983 List of directories for the backup file, separated with commas.
984 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100985 where this is possible. The directory must exist, Vim will not
986 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 - Empty means that no backup file will be created ('patchmode' is
988 impossible!). Writing may fail because of this.
989 - A directory "." means to put the backup file in the same directory
990 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000991 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 put the backup file relative to where the edited file is. The
993 leading "." is replaced with the path name of the edited file.
994 ("." inside a directory name has no special meaning).
995 - Spaces after the comma are ignored, other spaces are considered part
996 of the directory name. To have a space at the start of a directory
997 name, precede it with a backslash.
998 - To include a comma in a directory name precede it with a backslash.
999 - A directory name may end in an '/'.
1000 - Environment variables are expanded |:set_env|.
1001 - Careful with '\' characters, type one before a space, type two to
1002 get one in the option (see |option-backslash|), for example: >
1003 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1004< - For backwards compatibility with Vim version 3.0 a '>' at the start
1005 of the option is removed.
1006 See also 'backup' and 'writebackup' options.
1007 If you want to hide your backup files on Unix, consider this value: >
1008 :set backupdir=./.backup,~/.backup,.,/tmp
1009< You must create a ".backup" directory in each directory and in your
1010 home directory for this to work properly.
1011 The use of |:set+=| and |:set-=| is preferred when adding or removing
1012 directories from the list. This avoids problems when a future version
1013 uses another default.
1014 This option cannot be set from a |modeline| or in the |sandbox|, for
1015 security reasons.
1016
1017 *'backupext'* *'bex'* *E589*
1018'backupext' 'bex' string (default "~", for VMS: "_")
1019 global
1020 {not in Vi}
1021 String which is appended to a file name to make the name of the
1022 backup file. The default is quite unusual, because this avoids
1023 accidentally overwriting existing files with a backup file. You might
1024 prefer using ".bak", but make sure that you don't have files with
1025 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001026 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001028 If you like to keep a lot of backups, you could use a BufWritePre
1029 autocommand to change 'backupext' just before writing the file to
1030 include a timestamp. >
1031 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1032< Use 'backupdir' to put the backup in a different directory.
1033
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034 *'backupskip'* *'bsk'*
1035'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1036 global
1037 {not in Vi}
1038 {not available when compiled without the |+wildignore|
1039 feature}
1040 A list of file patterns. When one of the patterns matches with the
1041 name of the file which is written, no backup file is created. Both
1042 the specified file name and the full path name of the file are used.
1043 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1044 Watch out for special characters, see |option-backslash|.
1045 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001046 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001047
1048 Note that environment variables are not expanded. If you want to use
1049 $HOME you must expand it explicitly, e.g.: >
1050 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1051
1052< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001053 backup would be made by renaming the original file crontab won't see
1054 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055
1056 *'balloondelay'* *'bdlay'*
1057'balloondelay' 'bdlay' number (default: 600)
1058 global
1059 {not in Vi}
1060 {only available when compiled with the |+balloon_eval|
1061 feature}
1062 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1063
1064 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1065'ballooneval' 'beval' boolean (default off)
1066 global
1067 {not in Vi}
1068 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001069 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 Switch on the |balloon-eval| functionality.
1071
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001072 *'balloonexpr'* *'bexpr'*
1073'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001074 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001075 {not in Vi}
1076 {only available when compiled with the |+balloon_eval|
1077 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001078 Expression for text to show in evaluation balloon. It is only used
1079 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001080
1081 v:beval_bufnr number of the buffer in which balloon is going to show
1082 v:beval_winnr number of the window
1083 v:beval_lnum line number
1084 v:beval_col column number (byte index)
1085 v:beval_text word under or after the mouse pointer
1086
1087 The evaluation of the expression must not have side effects!
1088 Example: >
1089 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001090 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001091 \', column ' . v:beval_col .
1092 \ ' of file ' . bufname(v:beval_bufnr) .
1093 \ ' on word "' . v:beval_text . '"'
1094 endfunction
1095 set bexpr=MyBalloonExpr()
1096 set ballooneval
1097<
1098 NOTE: The balloon is displayed only if the cursor is on a text
1099 character. If the result of evaluating 'balloonexpr' is not empty,
1100 Vim does not try to send a message to an external debugger (Netbeans
1101 or Sun Workshop).
1102
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001103 The expression may be evaluated in the |sandbox|, see
1104 |sandbox-option|.
1105
1106 It is not allowed to change text or jump to another window while
1107 evaluating 'balloonexpr' |textlock|.
1108
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001109 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001110 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001111< When they are supported "\n" characters will start a new line. If the
1112 expression evaluates to a |List| this is equal to using each List item
1113 as a string and putting "\n" in between them.
1114
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1116'binary' 'bin' boolean (default off)
1117 local to buffer
1118 {not in Vi}
1119 This option should be set before editing a binary file. You can also
1120 use the |-b| Vim argument. When this option is switched on a few
1121 options will be changed (also when it already was on):
1122 'textwidth' will be set to 0
1123 'wrapmargin' will be set to 0
1124 'modeline' will be off
1125 'expandtab' will be off
1126 Also, 'fileformat' and 'fileformats' options will not be used, the
1127 file is read and written like 'fileformat' was "unix" (a single <NL>
1128 separates lines).
1129 The 'fileencoding' and 'fileencodings' options will not be used, the
1130 file is read without conversion.
1131 NOTE: When you start editing a(nother) file while the 'bin' option is
1132 on, settings from autocommands may change the settings again (e.g.,
1133 'textwidth'), causing trouble when editing. You might want to set
1134 'bin' again when the file has been loaded.
1135 The previous values of these options are remembered and restored when
1136 'bin' is switched from on to off. Each buffer has its own set of
1137 saved option values.
1138 To edit a file with 'binary' set you can use the |++bin| argument.
1139 This avoids you have to do ":set bin", which would have effect for all
1140 files you edit.
1141 When writing a file the <EOL> for the last line is only written if
1142 there was one in the original file (normally Vim appends an <EOL> to
1143 the last line if there is none; this would make the file longer). See
1144 the 'endofline' option.
1145
1146 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1147'bioskey' 'biosk' boolean (default on)
1148 global
1149 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001150 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151 better to detect CTRL-C, but only works for the console. When using a
1152 terminal over a serial port reset this option.
1153 Also see |'conskey'|.
1154
1155 *'bomb'* *'nobomb'*
1156'bomb' boolean (default off)
1157 local to buffer
1158 {not in Vi}
1159 {only available when compiled with the |+multi_byte|
1160 feature}
1161 When writing a file and the following conditions are met, a BOM (Byte
1162 Order Mark) is prepended to the file:
1163 - this option is on
1164 - the 'binary' option is off
1165 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1166 endian variants.
1167 Some applications use the BOM to recognize the encoding of the file.
1168 Often used for UCS-2 files on MS-Windows. For other applications it
1169 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001170 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1172 check for the presence of the BOM is done and 'bomb' set accordingly.
1173 Unless 'binary' is set, it is removed from the first line, so that you
1174 don't see it when editing. When you don't change the options, the BOM
1175 will be restored when writing the file.
1176
1177 *'breakat'* *'brk'*
1178'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1179 global
1180 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001181 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 feature}
1183 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001184 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1185 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186
1187 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001188'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001190 {not in Vi} {only for Motif, Athena, GTK, Mac and
1191 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001193 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001194 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 buffer Use the directory of the related buffer.
1196 current Use the current directory.
1197 {path} Use the specified directory
1198
1199 *'bufhidden'* *'bh'*
1200'bufhidden' 'bh' string (default: "")
1201 local to buffer
1202 {not in Vi}
1203 {not available when compiled without the |+quickfix|
1204 feature}
1205 This option specifies what happens when a buffer is no longer
1206 displayed in a window:
1207 <empty> follow the global 'hidden' option
1208 hide hide the buffer (don't unload it), also when 'hidden'
1209 is not set
1210 unload unload the buffer, also when 'hidden' is set or using
1211 |:hide|
1212 delete delete the buffer from the buffer list, also when
1213 'hidden' is set or using |:hide|, like using
1214 |:bdelete|
1215 wipe wipe out the buffer from the buffer list, also when
1216 'hidden' is set or using |:hide|, like using
1217 |:bwipeout|
1218
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001219 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1220 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 This option is used together with 'buftype' and 'swapfile' to specify
1222 special kinds of buffers. See |special-buffers|.
1223
1224 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1225'buflisted' 'bl' boolean (default: on)
1226 local to buffer
1227 {not in Vi}
1228 When this option is set, the buffer shows up in the buffer list. If
1229 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1230 This option is reset by Vim for buffers that are only used to remember
1231 a file name or marks. Vim sets it when starting to edit a buffer.
1232 But not when moving to a buffer with ":buffer".
1233
1234 *'buftype'* *'bt'* *E382*
1235'buftype' 'bt' string (default: "")
1236 local to buffer
1237 {not in Vi}
1238 {not available when compiled without the |+quickfix|
1239 feature}
1240 The value of this option specifies the type of a buffer:
1241 <empty> normal buffer
1242 nofile buffer which is not related to a file and will not be
1243 written
1244 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001245 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001246 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001247 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001249 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 help help buffer (you are not supposed to set this
1251 manually)
1252
1253 This option is used together with 'bufhidden' and 'swapfile' to
1254 specify special kinds of buffers. See |special-buffers|.
1255
1256 Be careful with changing this option, it can have many side effects!
1257
Bram Moolenaar280f1262006-01-30 00:14:18 +00001258 A "quickfix" buffer is only used for the error list and the location
1259 list. This value is set by the |:cwindow| and |:lwindow| commands and
1260 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261
1262 "nofile" and "nowrite" buffers are similar:
1263 both: The buffer is not to be written to disk, ":w" doesn't
1264 work (":w filename" does work though).
1265 both: The buffer is never considered to be |'modified'|.
1266 There is no warning when the changes will be lost, for
1267 example when you quit Vim.
1268 both: A swap file is only created when using too much memory
1269 (when 'swapfile' has been reset there is never a swap
1270 file).
1271 nofile only: The buffer name is fixed, it is not handled like a
1272 file name. It is not modified in response to a |:cd|
1273 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001274 *E676*
1275 "acwrite" implies that the buffer name is not related to a file, like
1276 "nofile", but it will be written. Thus, in contrast to "nofile" and
1277 "nowrite", ":w" does work and a modified buffer can't be abandoned
1278 without saving. For writing there must be matching |BufWriteCmd|,
1279 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280
1281 *'casemap'* *'cmp'*
1282'casemap' 'cmp' string (default: "internal,keepascii")
1283 global
1284 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001285 {only available when compiled with the |+multi_byte|
1286 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 Specifies details about changing the case of letters. It may contain
1288 these words, separated by a comma:
1289 internal Use internal case mapping functions, the current
1290 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001291 matters when 'encoding' is a Unicode encoding,
1292 "latin1" or "iso-8859-15". When "internal" is
1293 omitted, the towupper() and towlower() system library
1294 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1296 case mapping, the current locale is not effective.
1297 This probably only matters for Turkish.
1298
1299 *'cdpath'* *'cd'* *E344* *E346*
1300'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1301 global
1302 {not in Vi}
1303 {not available when compiled without the
1304 |+file_in_path| feature}
1305 This is a list of directories which will be searched when using the
1306 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001307 for has a relative path, not an absolute part starting with "/", "./"
1308 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309 The 'cdpath' option's value has the same form and semantics as
1310 |'path'|. Also see |file-searching|.
1311 The default value is taken from $CDPATH, with a "," prepended to look
1312 in the current directory first.
1313 If the default value taken from $CDPATH is not what you want, include
1314 a modified version of the following command in your vimrc file to
1315 override it: >
1316 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1317< This option cannot be set from a |modeline| or in the |sandbox|, for
1318 security reasons.
1319 (parts of 'cdpath' can be passed to the shell to expand file names).
1320
1321 *'cedit'*
1322'cedit' string (Vi default: "", Vim default: CTRL-F)
1323 global
1324 {not in Vi}
1325 {not available when compiled without the |+vertsplit|
1326 feature}
1327 The key used in Command-line Mode to open the command-line window.
1328 The default is CTRL-F when 'compatible' is off.
1329 Only non-printable keys are allowed.
1330 The key can be specified as a single character, but it is difficult to
1331 type. The preferred way is to use the <> notation. Examples: >
1332 :set cedit=<C-Y>
1333 :set cedit=<Esc>
1334< |Nvi| also has this option, but it only uses the first character.
1335 See |cmdwin|.
1336
1337 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1338'charconvert' 'ccv' string (default "")
1339 global
1340 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001341 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 {not in Vi}
1343 An expression that is used for character encoding conversion. It is
1344 evaluated when a file that is to be read or has been written has a
1345 different encoding from what is desired.
1346 'charconvert' is not used when the internal iconv() function is
1347 supported and is able to do the conversion. Using iconv() is
1348 preferred, because it is much faster.
1349 'charconvert' is not used when reading stdin |--|, because there is no
1350 file to convert from. You will have to save the text in a file first.
1351 The expression must return zero or an empty string for success,
1352 non-zero for failure.
1353 The possible encoding names encountered are in 'encoding'.
1354 Additionally, names given in 'fileencodings' and 'fileencoding' are
1355 used.
1356 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1357 is done internally by Vim, 'charconvert' is not used for this.
1358 'charconvert' is also used to convert the viminfo file, if the 'c'
1359 flag is present in 'viminfo'. Also used for Unicode conversion.
1360 Example: >
1361 set charconvert=CharConvert()
1362 fun CharConvert()
1363 system("recode "
1364 \ . v:charconvert_from . ".." . v:charconvert_to
1365 \ . " <" . v:fname_in . " >" v:fname_out)
1366 return v:shell_error
1367 endfun
1368< The related Vim variables are:
1369 v:charconvert_from name of the current encoding
1370 v:charconvert_to name of the desired encoding
1371 v:fname_in name of the input file
1372 v:fname_out name of the output file
1373 Note that v:fname_in and v:fname_out will never be the same.
1374 Note that v:charconvert_from and v:charconvert_to may be different
1375 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1376 Encryption is not done by Vim when using 'charconvert'. If you want
1377 to encrypt the file after conversion, 'charconvert' should take care
1378 of this.
1379 This option cannot be set from a |modeline| or in the |sandbox|, for
1380 security reasons.
1381
1382 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1383'cindent' 'cin' boolean (default off)
1384 local to buffer
1385 {not in Vi}
1386 {not available when compiled without the |+cindent|
1387 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001388 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 that trigger reindenting in insert mode and 'cinoptions' to set your
1390 preferred indent style.
1391 If 'indentexpr' is not empty, it overrules 'cindent'.
1392 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1393 the "=" operator indents using this algorithm rather than calling an
1394 external program.
1395 See |C-indenting|.
1396 When you don't like the way 'cindent' works, try the 'smartindent'
1397 option or 'indentexpr'.
1398 This option is not used when 'paste' is set.
1399 NOTE: This option is reset when 'compatible' is set.
1400
1401 *'cinkeys'* *'cink'*
1402'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1403 local to buffer
1404 {not in Vi}
1405 {not available when compiled without the |+cindent|
1406 feature}
1407 A list of keys that, when typed in Insert mode, cause reindenting of
1408 the current line. Only used if 'cindent' is on and 'indentexpr' is
1409 empty.
1410 For the format of this option see |cinkeys-format|.
1411 See |C-indenting|.
1412
1413 *'cinoptions'* *'cino'*
1414'cinoptions' 'cino' string (default "")
1415 local to buffer
1416 {not in Vi}
1417 {not available when compiled without the |+cindent|
1418 feature}
1419 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1420 program. See |cinoptions-values| for the values of this option, and
1421 |C-indenting| for info on C indenting in general.
1422
1423
1424 *'cinwords'* *'cinw'*
1425'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1426 local to buffer
1427 {not in Vi}
1428 {not available when compiled without both the
1429 |+cindent| and the |+smartindent| features}
1430 These keywords start an extra indent in the next line when
1431 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1432 an appropriate place (inside {}).
1433 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1434 matter, include the keyword both the uppercase and lowercase:
1435 "if,If,IF".
1436
1437 *'clipboard'* *'cb'*
1438'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1439 for X-windows, "" otherwise)
1440 global
1441 {not in Vi}
1442 {only in GUI versions or when the |+xterm_clipboard|
1443 feature is included}
1444 This option is a list of comma separated names.
1445 These names are recognized:
1446
1447 unnamed When included, Vim will use the clipboard register '*'
1448 for all yank, delete, change and put operations which
1449 would normally go to the unnamed register. When a
1450 register is explicitly specified, it will always be
1451 used regardless of whether "unnamed" is in 'clipboard'
1452 or not. The clipboard register can always be
1453 explicitly accessed using the "* notation. Also see
1454 |gui-clipboard|.
1455
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001456 unnamedplus A variant of "unnamed" flag which uses the clipboard
1457 register '+' (|quoteplus|) instead of register '*' for
1458 all operations except yank. Yank shall copy the text
1459 into register '+' and also into '*' when "unnamed" is
1460 included.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001461 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001462 Availability can be checked with: >
1463 if has('unnamedplus')
1464<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 autoselect Works like the 'a' flag in 'guioptions': If present,
1466 then whenever Visual mode is started, or the Visual
1467 area extended, Vim tries to become the owner of the
1468 windowing system's global selection or put the
1469 selected text on the clipboard used by the selection
1470 register "*. See |guioptions_a| and |quotestar| for
1471 details. When the GUI is active, the 'a' flag in
1472 'guioptions' is used, when the GUI is not active, this
1473 "autoselect" flag is used.
1474 Also applies to the modeless selection.
1475
1476 autoselectml Like "autoselect", but for the modeless selection
1477 only. Compare to the 'A' flag in 'guioptions'.
1478
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001479 html When the clipboard contains HTML, use this when
1480 pasting. When putting text on the clipboard, mark it
1481 as HTML. This works to copy rendered HTML from
1482 Firefox, paste it as raw HTML in Vim, select the HTML
1483 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001484 You probably want to add this only temporarily,
1485 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001486 Only supported for GTK version 2 and later.
1487 Only available with the |+multi_byte| feature.
1488
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 exclude:{pattern}
1490 Defines a pattern that is matched against the name of
1491 the terminal 'term'. If there is a match, no
1492 connection will be made to the X server. This is
1493 useful in this situation:
1494 - Running Vim in a console.
1495 - $DISPLAY is set to start applications on another
1496 display.
1497 - You do not want to connect to the X server in the
1498 console, but do want this in a terminal emulator.
1499 To never connect to the X server use: >
1500 exclude:.*
1501< This has the same effect as using the |-X| argument.
1502 Note that when there is no connection to the X server
1503 the window title won't be restored and the clipboard
1504 cannot be accessed.
1505 The value of 'magic' is ignored, {pattern} is
1506 interpreted as if 'magic' was on.
1507 The rest of the option value will be used for
1508 {pattern}, this must be the last entry.
1509
1510 *'cmdheight'* *'ch'*
1511'cmdheight' 'ch' number (default 1)
1512 global
1513 {not in Vi}
1514 Number of screen lines to use for the command-line. Helps avoiding
1515 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001516 The value of this option is stored with the tab page, so that each tab
1517 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518
1519 *'cmdwinheight'* *'cwh'*
1520'cmdwinheight' 'cwh' number (default 7)
1521 global
1522 {not in Vi}
1523 {not available when compiled without the |+vertsplit|
1524 feature}
1525 Number of screen lines to use for the command-line window. |cmdwin|
1526
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001527 *'colorcolumn'* *'cc'*
1528'colorcolumn' 'cc' string (default "")
1529 local to window
1530 {not in Vi}
1531 {not available when compiled without the |+syntax|
1532 feature}
1533 'colorcolumn' is a comma separated list of screen columns that are
1534 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1535 text. Will make screen redrawing slower.
1536 The screen column can be an absolute number, or a number preceded with
1537 '+' or '-', which is added to or subtracted from 'textwidth'. >
1538
1539 :set cc=+1 " highlight column after 'textwidth'
1540 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1541 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1542<
1543 When 'textwidth' is zero then the items with '-' and '+' are not used.
1544 A maximum of 256 columns are highlighted.
1545
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 *'columns'* *'co'* *E594*
1547'columns' 'co' number (default 80 or terminal width)
1548 global
1549 {not in Vi}
1550 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001551 initialization and does not have to be set by hand. Also see
1552 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 When Vim is running in the GUI or in a resizable window, setting this
1554 option will cause the window size to be changed. When you only want
1555 to use the size for the GUI, put the command in your |gvimrc| file.
1556 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001557 number of columns of the display, the display may be messed up. For
1558 the GUI it is always possible and Vim limits the number of columns to
1559 what fits on the screen. You can use this command to get the widest
1560 window possible: >
1561 :set columns=9999
1562< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563
1564 *'comments'* *'com'* *E524* *E525*
1565'comments' 'com' string (default
1566 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1567 local to buffer
1568 {not in Vi}
1569 {not available when compiled without the |+comments|
1570 feature}
1571 A comma separated list of strings that can start a comment line. See
1572 |format-comments|. See |option-backslash| about using backslashes to
1573 insert a space.
1574
1575 *'commentstring'* *'cms'* *E537*
1576'commentstring' 'cms' string (default "/*%s*/")
1577 local to buffer
1578 {not in Vi}
1579 {not available when compiled without the |+folding|
1580 feature}
1581 A template for a comment. The "%s" in the value is replaced with the
1582 comment text. Currently only used to add markers for folding, see
1583 |fold-marker|.
1584
1585 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001586'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1587 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 global
1589 {not in Vi}
1590 This option has the effect of making Vim either more Vi-compatible, or
1591 make Vim behave in a more useful way.
1592 This is a special kind of option, because when it's set or reset,
1593 other options are also changed as a side effect. CAREFUL: Setting or
1594 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001595 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 set this option in your vimrc file, you should probably put it at the
1597 very start.
1598 By default this option is on and the Vi defaults are used for the
1599 options. This default was chosen for those people who want to use Vim
1600 just like Vi, and don't even (want to) know about the 'compatible'
1601 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001602 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001603 this option is switched off, and all options that have not been
1604 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001605 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001606 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001607 happen for the system-wide vimrc or gvimrc file, nor for a file given
1608 with the |-u| argument). Also see |compatible-default| and
1609 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 You can also set this option with the "-C" argument, and reset it with
1611 "-N". See |-C| and |-N|.
1612 Switching this option off makes the Vim defaults be used for options
1613 that have a different Vi and Vim default value. See the options
1614 marked with a '+' below. Other options are not modified.
1615 At the moment this option is set, several other options will be set
1616 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001617 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 editing.
1619 See also 'cpoptions'.
1620
1621 option + set value effect ~
1622
1623 'allowrevins' off no CTRL-_ command
1624 'backupcopy' Unix: "yes" backup file is a copy
1625 others: "auto" copy or rename backup file
1626 'backspace' "" normal backspace
1627 'backup' off no backup file
1628 'cindent' off no C code indentation
1629 'cedit' + "" no key to open the |cmdwin|
1630 'cpoptions' + (all flags) Vi-compatible flags
1631 'cscopetag' off don't use cscope for ":tag"
1632 'cscopetagorder' 0 see |cscopetagorder|
1633 'cscopeverbose' off see |cscopeverbose|
1634 'digraph' off no digraphs
1635 'esckeys' + off no <Esc>-keys in Insert mode
1636 'expandtab' off tabs not expanded to spaces
1637 'fileformats' + "" no automatic file format detection,
1638 "dos,unix" except for DOS, Windows and OS/2
1639 'formatoptions' + "vt" Vi compatible formatting
1640 'gdefault' off no default 'g' flag for ":s"
1641 'history' + 0 no commandline history
1642 'hkmap' off no Hebrew keyboard mapping
1643 'hkmapp' off no phonetic Hebrew keyboard mapping
1644 'hlsearch' off no highlighting of search matches
1645 'incsearch' off no incremental searching
1646 'indentexpr' "" no indenting by expression
1647 'insertmode' off do not start in Insert mode
1648 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1649 characters and '_'
1650 'joinspaces' on insert 2 spaces after period
1651 'modeline' + off no modelines
1652 'more' + off no pauses in listings
1653 'revins' off no reverse insert
1654 'ruler' off no ruler
1655 'scrolljump' 1 no jump scroll
1656 'scrolloff' 0 no scroll offset
1657 'shiftround' off indent not rounded to shiftwidth
1658 'shortmess' + "" no shortening of messages
1659 'showcmd' + off command characters not shown
1660 'showmode' + off current mode not shown
1661 'smartcase' off no automatic ignore case switch
1662 'smartindent' off no smart indentation
1663 'smarttab' off no smart tab size
1664 'softtabstop' 0 tabs are always 'tabstop' positions
1665 'startofline' on goto startofline with some commands
1666 'tagrelative' + off tag file names are not relative
1667 'textauto' + off no automatic textmode detection
1668 'textwidth' 0 no automatic line wrap
1669 'tildeop' off tilde is not an operator
1670 'ttimeout' off no terminal timeout
1671 'whichwrap' + "" left-right movements don't wrap
1672 'wildchar' + CTRL-E only when the current value is <Tab>
1673 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001674 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675
1676 *'complete'* *'cpt'* *E535*
1677'complete' 'cpt' string (default: ".,w,b,u,t,i")
1678 local to buffer
1679 {not in Vi}
1680 This option specifies how keyword completion |ins-completion| works
1681 when CTRL-P or CTRL-N are used. It is also used for whole-line
1682 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1683 and the places to scan. It is a comma separated list of flags:
1684 . scan the current buffer ('wrapscan' is ignored)
1685 w scan buffers from other windows
1686 b scan other loaded buffers that are in the buffer list
1687 u scan the unloaded buffers that are in the buffer list
1688 U scan the buffers that are not in the buffer list
1689 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001690 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 k{dict} scan the file {dict}. Several "k" flags can be given,
1692 patterns are valid too. For example: >
1693 :set cpt=k/usr/dict/*,k~/spanish
1694< s scan the files given with the 'thesaurus' option
1695 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1696 are valid too.
1697 i scan current and included files
1698 d scan current and included files for defined name or macro
1699 |i_CTRL-X_CTRL-D|
1700 ] tag completion
1701 t same as "]"
1702
1703 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1704 not executed, this may lead to unexpected completions from some files
1705 (gzipped files for example). Unloaded buffers are not scanned for
1706 whole-line completion.
1707
1708 The default is ".,w,b,u,t,i", which means to scan:
1709 1. the current buffer
1710 2. buffers in other windows
1711 3. other loaded buffers
1712 4. unloaded buffers
1713 5. tags
1714 6. included files
1715
1716 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001717 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1718 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001720 *'completefunc'* *'cfu'*
1721'completefunc' 'cfu' string (default: empty)
1722 local to buffer
1723 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001724 {not available when compiled without the |+eval|
1725 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001726 This option specifies a function to be used for Insert mode completion
1727 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001728 See |complete-functions| for an explanation of how the function is
1729 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001730 This option cannot be set from a |modeline| or in the |sandbox|, for
1731 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001732
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001733 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001734'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001735 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001736 {not available when compiled without the
1737 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001738 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001739 A comma separated list of options for Insert mode completion
1740 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001741
1742 menu Use a popup menu to show the possible completions. The
1743 menu is only shown when there is more than one match and
1744 sufficient colors are available. |ins-completion-menu|
1745
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001746 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001747 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001748 match, e.g., what file it comes from.
1749
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001750 longest Only insert the longest common text of the matches. If
1751 the menu is displayed you can use CTRL-L to add more
1752 characters. Whether case is ignored depends on the kind
1753 of completion. For buffer text the 'ignorecase' option is
1754 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001755
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001756 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001757 completion in the preview window. Only works in
1758 combination with "menu" or "menuone".
1759
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001760
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001761 *'concealcursor'* *'cocu'*
1762'concealcursor' 'cocu' string (default: "")
1763 local to window
1764 {not in Vi}
1765 {not available when compiled without the |+conceal|
1766 feature}
1767 Sets the modes in which text in the cursor line can also be concealed.
1768 When the current mode is listed then concealing happens just like in
1769 other lines.
1770 n Normal mode
1771 v Visual mode
1772 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001773 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001774
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001775 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001776 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001777 are moving around text is concealed, but when starting to insert text
1778 or selecting a Visual area the concealed text is displayed, so that
1779 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001780 Keep in mind that the cursor position is not always where it's
1781 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001782
1783
1784'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001785 number (default 0)
1786 local to window
1787 {not in Vi}
1788 {not available when compiled without the |+conceal|
1789 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001790 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1791 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001792
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001793 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001794 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001795 1 Each block of concealed text is replaced with one
1796 character. If the syntax item does not have a custom
1797 replacement character defined (see |:syn-cchar|) the
1798 character defined in 'listchars' is used (default is a
1799 space).
1800 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001801 2 Concealed text is completely hidden unless it has a
1802 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001803 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001804 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001805
Bram Moolenaara7781e02010-07-19 20:13:22 +02001806 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001807 edit and copy the text. This can be changed with the 'concealcursor'
1808 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001809
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1811'confirm' 'cf' boolean (default off)
1812 global
1813 {not in Vi}
1814 When 'confirm' is on, certain operations that would normally
1815 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1816 instead raise a |dialog| asking if you wish to save the current
1817 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1818 If 'confirm' is off you can still activate confirmation for one
1819 command only (this is most useful in mappings) with the |:confirm|
1820 command.
1821 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1822
1823 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1824'conskey' 'consk' boolean (default off)
1825 global
1826 {not in Vi} {only for MS-DOS}
1827 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001828 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 three methods of console input are available:
1830 'conskey' 'bioskey' action ~
1831 on on or off direct console input
1832 off on BIOS
1833 off off STDIN
1834
1835 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1836'copyindent' 'ci' boolean (default off)
1837 local to buffer
1838 {not in Vi}
1839 Copy the structure of the existing lines indent when autoindenting a
1840 new line. Normally the new indent is reconstructed by a series of
1841 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1842 in which case only spaces are used). Enabling this option makes the
1843 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001844 existing line. 'expandtab' has no effect on these characters, a Tab
1845 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 line, the remaining space is filled in the normal manner.
1847 NOTE: 'copyindent' is reset when 'compatible' is set.
1848 Also see 'preserveindent'.
1849
1850 *'cpoptions'* *'cpo'*
1851'cpoptions' 'cpo' string (Vim default: "aABceFs",
1852 Vi default: all flags)
1853 global
1854 {not in Vi}
1855 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001856 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 not being vi-compatible is mostly or sometimes preferred.
1858 'cpoptions' stands for "compatible-options".
1859 Commas can be added for readability.
1860 To avoid problems with flags that are added in the future, use the
1861 "+=" and "-=" feature of ":set" |add-option-flags|.
1862 NOTE: This option is set to the Vi default value when 'compatible' is
1863 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001864 NOTE: This option is set to the POSIX default value at startup when
1865 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001866 variable exists |posix|. This means Vim tries to behave like the
1867 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868
1869 contains behavior ~
1870 *cpo-a*
1871 a When included, a ":read" command with a file name
1872 argument will set the alternate file name for the
1873 current window.
1874 *cpo-A*
1875 A When included, a ":write" command with a file name
1876 argument will set the alternate file name for the
1877 current window.
1878 *cpo-b*
1879 b "\|" in a ":map" command is recognized as the end of
1880 the map command. The '\' is included in the mapping,
1881 the text after the '|' is interpreted as the next
1882 command. Use a CTRL-V instead of a backslash to
1883 include the '|' in the mapping. Applies to all
1884 mapping, abbreviation, menu and autocmd commands.
1885 See also |map_bar|.
1886 *cpo-B*
1887 B A backslash has no special meaning in mappings,
1888 abbreviations and the "to" part of the menu commands.
1889 Remove this flag to be able to use a backslash like a
1890 CTRL-V. For example, the command ":map X \<Esc>"
1891 results in X being mapped to:
1892 'B' included: "\^[" (^[ is a real <Esc>)
1893 'B' excluded: "<Esc>" (5 characters)
1894 ('<' excluded in both cases)
1895 *cpo-c*
1896 c Searching continues at the end of any match at the
1897 cursor position, but not further than the start of the
1898 next line. When not present searching continues
1899 one character from the cursor position. With 'c'
1900 "abababababab" only gets three matches when repeating
1901 "/abab", without 'c' there are five matches.
1902 *cpo-C*
1903 C Do not concatenate sourced lines that start with a
1904 backslash. See |line-continuation|.
1905 *cpo-d*
1906 d Using "./" in the 'tags' option doesn't mean to use
1907 the tags file relative to the current file, but the
1908 tags file in the current directory.
1909 *cpo-D*
1910 D Can't use CTRL-K to enter a digraph after Normal mode
1911 commands with a character argument, like |r|, |f| and
1912 |t|.
1913 *cpo-e*
1914 e When executing a register with ":@r", always add a
1915 <CR> to the last line, also when the register is not
1916 linewise. If this flag is not present, the register
1917 is not linewise and the last line does not end in a
1918 <CR>, then the last line is put on the command-line
1919 and can be edited before hitting <CR>.
1920 *cpo-E*
1921 E It is an error when using "y", "d", "c", "g~", "gu" or
1922 "gU" on an Empty region. The operators only work when
1923 at least one character is to be operate on. Example:
1924 This makes "y0" fail in the first column.
1925 *cpo-f*
1926 f When included, a ":read" command with a file name
1927 argument will set the file name for the current buffer,
1928 if the current buffer doesn't have a file name yet.
1929 *cpo-F*
1930 F When included, a ":write" command with a file name
1931 argument will set the file name for the current
1932 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001933 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 *cpo-g*
1935 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001936 *cpo-H*
1937 H When using "I" on a line with only blanks, insert
1938 before the last blank. Without this flag insert after
1939 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 *cpo-i*
1941 i When included, interrupting the reading of a file will
1942 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001943 *cpo-I*
1944 I When moving the cursor up or down just after inserting
1945 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 *cpo-j*
1947 j When joining lines, only add two spaces after a '.',
1948 not after '!' or '?'. Also see 'joinspaces'.
1949 *cpo-J*
1950 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001951 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 white space.
1953 *cpo-k*
1954 k Disable the recognition of raw key codes in
1955 mappings, abbreviations, and the "to" part of menu
1956 commands. For example, if <Key> sends ^[OA (where ^[
1957 is <Esc>), the command ":map X ^[OA" results in X
1958 being mapped to:
1959 'k' included: "^[OA" (3 characters)
1960 'k' excluded: "<Key>" (one key code)
1961 Also see the '<' flag below.
1962 *cpo-K*
1963 K Don't wait for a key code to complete when it is
1964 halfway a mapping. This breaks mapping <F1><F1> when
1965 only part of the second <F1> has been read. It
1966 enables cancelling the mapping by typing <F1><Esc>.
1967 *cpo-l*
1968 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001969 literally, only "\]", "\^", "\-" and "\\" are special.
1970 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1972 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001973 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 *cpo-L*
1975 L When the 'list' option is set, 'wrapmargin',
1976 'textwidth', 'softtabstop' and Virtual Replace mode
1977 (see |gR|) count a <Tab> as two characters, instead of
1978 the normal behavior of a <Tab>.
1979 *cpo-m*
1980 m When included, a showmatch will always wait half a
1981 second. When not included, a showmatch will wait half
1982 a second or until a character is typed. |'showmatch'|
1983 *cpo-M*
1984 M When excluded, "%" matching will take backslashes into
1985 account. Thus in "( \( )" and "\( ( \)" the outer
1986 parenthesis match. When included "%" ignores
1987 backslashes, which is Vi compatible.
1988 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001989 n When included, the column used for 'number' and
1990 'relativenumber' will also be used for text of wrapped
1991 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 *cpo-o*
1993 o Line offset to search command is not remembered for
1994 next search.
1995 *cpo-O*
1996 O Don't complain if a file is being overwritten, even
1997 when it didn't exist when editing it. This is a
1998 protection against a file unexpectedly created by
1999 someone else. Vi didn't complain about this.
2000 *cpo-p*
2001 p Vi compatible Lisp indenting. When not present, a
2002 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002003 *cpo-P*
2004 P When included, a ":write" command that appends to a
2005 file will set the file name for the current buffer, if
2006 the current buffer doesn't have a file name yet and
2007 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002008 *cpo-q*
2009 q When joining multiple lines leave the cursor at the
2010 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 *cpo-r*
2012 r Redo ("." command) uses "/" to repeat a search
2013 command, instead of the actually used search string.
2014 *cpo-R*
2015 R Remove marks from filtered lines. Without this flag
2016 marks are kept like |:keepmarks| was used.
2017 *cpo-s*
2018 s Set buffer options when entering the buffer for the
2019 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002020 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 set when the buffer is created.
2022 *cpo-S*
2023 S Set buffer options always when entering a buffer
2024 (except 'readonly', 'fileformat', 'filetype' and
2025 'syntax'). This is the (most) Vi compatible setting.
2026 The options are set to the values in the current
2027 buffer. When you change an option and go to another
2028 buffer, the value is copied. Effectively makes the
2029 buffer options global to all buffers.
2030
2031 's' 'S' copy buffer options
2032 no no when buffer created
2033 yes no when buffer first entered (default)
2034 X yes each time when buffer entered (vi comp.)
2035 *cpo-t*
2036 t Search pattern for the tag command is remembered for
2037 "n" command. Otherwise Vim only puts the pattern in
2038 the history for search pattern, but doesn't change the
2039 last used search pattern.
2040 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002041 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 *cpo-v*
2043 v Backspaced characters remain visible on the screen in
2044 Insert mode. Without this flag the characters are
2045 erased from the screen right away. With this flag the
2046 screen newly typed text overwrites backspaced
2047 characters.
2048 *cpo-w*
2049 w When using "cw" on a blank character, only change one
2050 character and not all blanks until the start of the
2051 next word.
2052 *cpo-W*
2053 W Don't overwrite a readonly file. When omitted, ":w!"
2054 overwrites a readonly file, if possible.
2055 *cpo-x*
2056 x <Esc> on the command-line executes the command-line.
2057 The default in Vim is to abandon the command-line,
2058 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002059 *cpo-X*
2060 X When using a count with "R" the replaced text is
2061 deleted only once. Also when repeating "R" with "."
2062 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 *cpo-y*
2064 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002065 *cpo-Z*
2066 Z When using "w!" while the 'readonly' option is set,
2067 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 *cpo-!*
2069 ! When redoing a filter command, use the last used
2070 external command, whatever it was. Otherwise the last
2071 used -filter- command is used.
2072 *cpo-$*
2073 $ When making a change to one line, don't redisplay the
2074 line, but put a '$' at the end of the changed text.
2075 The changed text will be overwritten when you type the
2076 new text. The line is redisplayed if you type any
2077 command that moves the cursor from the insertion
2078 point.
2079 *cpo-%*
2080 % Vi-compatible matching is done for the "%" command.
2081 Does not recognize "#if", "#endif", etc.
2082 Does not recognize "/*" and "*/".
2083 Parens inside single and double quotes are also
2084 counted, causing a string that contains a paren to
2085 disturb the matching. For example, in a line like
2086 "if (strcmp("foo(", s))" the first paren does not
2087 match the last one. When this flag is not included,
2088 parens inside single and double quotes are treated
2089 specially. When matching a paren outside of quotes,
2090 everything inside quotes is ignored. When matching a
2091 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002092 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002093 This flag is also used for other features, such as
2094 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002095 *cpo--*
2096 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002097 it would go above the first line or below the last
2098 line. Without it the cursor moves to the first or
2099 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002100 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002101 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002102 *cpo-+*
2103 + When included, a ":write file" command will reset the
2104 'modified' flag of the buffer, even though the buffer
2105 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002106 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 * Use ":*" in the same way as ":@". When not included,
2108 ":*" is an alias for ":'<,'>", select the Visual area.
2109 *cpo-<*
2110 < Disable the recognition of special key codes in |<>|
2111 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002112 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113 ":map X <Tab>" results in X being mapped to:
2114 '<' included: "<Tab>" (5 characters)
2115 '<' excluded: "^I" (^I is a real <Tab>)
2116 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002117 *cpo->*
2118 > When appending to a register, put a line break before
2119 the appended text.
2120
2121 POSIX flags. These are not included in the Vi default value, except
2122 when $VIM_POSIX was set on startup. |posix|
2123
2124 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002125 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002126 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002127 *cpo-&*
2128 & When ":preserve" was used keep the swap file when
2129 exiting normally while this buffer is still loaded.
2130 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002131 *cpo-\*
2132 \ Backslash in a [] range in a search pattern is taken
2133 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002134 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2135 '\' excluded: "/[ \-]" finds <Space> and '-'
2136 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002137 *cpo-/*
2138 / When "%" is used as the replacement string in a |:s|
2139 command, use the previous replacement string. |:s%|
2140 *cpo-{*
2141 { The |{| and |}| commands also stop at a "{" character
2142 at the start of a line.
2143 *cpo-.*
2144 . The ":chdir" and ":cd" commands fail if the current
2145 buffer is modified, unless ! is used. Vim doesn't
2146 need this, since it remembers the full path of an
2147 opened file.
2148 *cpo-bar*
2149 | The value of the $LINES and $COLUMNS environment
2150 variables overrule the terminal size values obtained
2151 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002152
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002154 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002155'cryptmethod' string (default "zip")
2156 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002157 {not in Vi}
2158 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002159 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002160 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002161 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002162 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002163 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002164 or later, files can NOT be read by Vim 7.2 and older.
2165 This adds a "seed" to the file, every time you write
2166 the file the encrypted bytes will be different.
2167
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002168 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002169 to the detected method of the file being read. Thus if you write it
2170 without changing 'cryptmethod' the same method will be used.
2171 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002172 explicitly write it, you don't get a warning unless there are other
2173 modifications. Also see |:X|.
2174
2175 When setting the global value to an empty string, it will end up with
2176 the value "zip". When setting the local value to an empty string the
2177 buffer will use the global value.
2178
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002179 When a new encryption method is added in a later version of Vim, and
2180 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002181 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002182
2183
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 *'cscopepathcomp'* *'cspc'*
2185'cscopepathcomp' 'cspc' number (default 0)
2186 global
2187 {not available when compiled without the |+cscope|
2188 feature}
2189 {not in Vi}
2190 Determines how many components of the path to show in a list of tags.
2191 See |cscopepathcomp|.
2192
2193 *'cscopeprg'* *'csprg'*
2194'cscopeprg' 'csprg' string (default "cscope")
2195 global
2196 {not available when compiled without the |+cscope|
2197 feature}
2198 {not in Vi}
2199 Specifies the command to execute cscope. See |cscopeprg|.
2200 This option cannot be set from a |modeline| or in the |sandbox|, for
2201 security reasons.
2202
2203 *'cscopequickfix'* *'csqf'*
2204'cscopequickfix' 'csqf' string (default "")
2205 global
2206 {not available when compiled without the |+cscope|
2207 or |+quickfix| features}
2208 {not in Vi}
2209 Specifies whether to use quickfix window to show cscope results.
2210 See |cscopequickfix|.
2211
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002212 *'cscoperelative'* *'csre'*
2213'cscoperelative' 'csre' boolean (default off)
2214 global
2215 {not available when compiled without the |+cscope|
2216 feature}
2217 {not in Vi}
2218 In the absence of a prefix (-P) for cscope. setting this option enables
2219 to use the basename of cscope.out path as the prefix.
2220 See |cscoperelative|.
2221
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2223'cscopetag' 'cst' boolean (default off)
2224 global
2225 {not available when compiled without the |+cscope|
2226 feature}
2227 {not in Vi}
2228 Use cscope for tag commands. See |cscope-options|.
2229 NOTE: This option is reset when 'compatible' is set.
2230
2231 *'cscopetagorder'* *'csto'*
2232'cscopetagorder' 'csto' number (default 0)
2233 global
2234 {not available when compiled without the |+cscope|
2235 feature}
2236 {not in Vi}
2237 Determines the order in which ":cstag" performs a search. See
2238 |cscopetagorder|.
2239 NOTE: This option is set to 0 when 'compatible' is set.
2240
2241 *'cscopeverbose'* *'csverb'*
2242 *'nocscopeverbose'* *'nocsverb'*
2243'cscopeverbose' 'csverb' boolean (default off)
2244 global
2245 {not available when compiled without the |+cscope|
2246 feature}
2247 {not in Vi}
2248 Give messages when adding a cscope database. See |cscopeverbose|.
2249 NOTE: This option is reset when 'compatible' is set.
2250
Bram Moolenaar860cae12010-06-05 23:22:07 +02002251 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2252'cursorbind' 'crb' boolean (default off)
2253 local to window
2254 {not in Vi}
2255 {not available when compiled without the |+cursorbind|
2256 feature}
2257 When this option is set, as the cursor in the current
2258 window moves other cursorbound windows (windows that also have
2259 this option set) move their cursors to the corresponding line and
2260 column. This option is useful for viewing the
2261 differences between two versions of a file (see 'diff'); in diff mode,
2262 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002263 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002264
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002265
2266 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2267'cursorcolumn' 'cuc' boolean (default off)
2268 local to window
2269 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002270 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002271 feature}
2272 Highlight the screen column of the cursor with CursorColumn
2273 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2274 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002275 If you only want the highlighting in the current window you can use
2276 these autocommands: >
2277 au WinLeave * set nocursorline nocursorcolumn
2278 au WinEnter * set cursorline cursorcolumn
2279<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002280
2281 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2282'cursorline' 'cul' boolean (default off)
2283 local to window
2284 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002285 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002286 feature}
2287 Highlight the screen line of the cursor with CursorLine
2288 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2289 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002290 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002291 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002292
2293
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 *'debug'*
2295'debug' string (default "")
2296 global
2297 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002298 These values can be used:
2299 msg Error messages that would otherwise be omitted will be given
2300 anyway.
2301 throw Error messages that would otherwise be omitted will be given
2302 anyway and also throw an exception and set |v:errmsg|.
2303 beep A message will be given when otherwise only a beep would be
2304 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002305 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002306 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2307 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308
2309 *'define'* *'def'*
2310'define' 'def' string (default "^\s*#\s*define")
2311 global or local to buffer |global-local|
2312 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002313 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 pattern, just like for the "/" command. This option is used for the
2315 commands like "[i" and "[d" |include-search|. The 'isident' option is
2316 used to recognize the defined name after the match:
2317 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2318 See |option-backslash| about inserting backslashes to include a space
2319 or backslash.
2320 The default value is for C programs. For C++ this value would be
2321 useful, to include const type declarations: >
2322 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2323< When using the ":set" command, you need to double the backslashes!
2324
2325 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2326'delcombine' 'deco' boolean (default off)
2327 global
2328 {not in Vi}
2329 {only available when compiled with the |+multi_byte|
2330 feature}
2331 If editing Unicode and this option is set, backspace and Normal mode
2332 "x" delete each combining character on its own. When it is off (the
2333 default) the character along with its combining characters are
2334 deleted.
2335 Note: When 'delcombine' is set "xx" may work different from "2x"!
2336
2337 This is useful for Arabic, Hebrew and many other languages where one
2338 may have combining characters overtop of base characters, and want
2339 to remove only the combining ones.
2340
2341 *'dictionary'* *'dict'*
2342'dictionary' 'dict' string (default "")
2343 global or local to buffer |global-local|
2344 {not in Vi}
2345 List of file names, separated by commas, that are used to lookup words
2346 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2347 contain a list of words. This can be one word per line, or several
2348 words per line, separated by non-keyword characters (white space is
2349 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002350 When this option is empty, or an entry "spell" is present, spell
2351 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002352 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 after a comma are ignored, otherwise spaces are included in the file
2354 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002355 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 Where to find a list of words?
2357 - On FreeBSD, there is the file "/usr/share/dict/words".
2358 - In the Simtel archive, look in the "msdos/linguist" directory.
2359 - In "miscfiles" of the GNU collection.
2360 The use of |:set+=| and |:set-=| is preferred when adding or removing
2361 directories from the list. This avoids problems when a future version
2362 uses another default.
2363 Backticks cannot be used in this option for security reasons.
2364
2365 *'diff'* *'nodiff'*
2366'diff' boolean (default off)
2367 local to window
2368 {not in Vi}
2369 {not available when compiled without the |+diff|
2370 feature}
2371 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002372 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373
2374 *'dex'* *'diffexpr'*
2375'diffexpr' 'dex' string (default "")
2376 global
2377 {not in Vi}
2378 {not available when compiled without the |+diff|
2379 feature}
2380 Expression which is evaluated to obtain an ed-style diff file from two
2381 versions of a file. See |diff-diffexpr|.
2382 This option cannot be set from a |modeline| or in the |sandbox|, for
2383 security reasons.
2384
2385 *'dip'* *'diffopt'*
2386'diffopt' 'dip' string (default "filler")
2387 global
2388 {not in Vi}
2389 {not available when compiled without the |+diff|
2390 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002391 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 All are optional. Items must be separated by a comma.
2393
2394 filler Show filler lines, to keep the text
2395 synchronized with a window that has inserted
2396 lines at the same position. Mostly useful
2397 when windows are side-by-side and 'scrollbind'
2398 is set.
2399
2400 context:{n} Use a context of {n} lines between a change
2401 and a fold that contains unchanged lines.
2402 When omitted a context of six lines is used.
2403 See |fold-diff|.
2404
2405 icase Ignore changes in case of text. "a" and "A"
2406 are considered the same. Adds the "-i" flag
2407 to the "diff" command if 'diffexpr' is empty.
2408
2409 iwhite Ignore changes in amount of white space. Adds
2410 the "-b" flag to the "diff" command if
2411 'diffexpr' is empty. Check the documentation
2412 of the "diff" command for what this does
2413 exactly. It should ignore adding trailing
2414 white space, but not leading white space.
2415
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002416 horizontal Start diff mode with horizontal splits (unless
2417 explicitly specified otherwise).
2418
2419 vertical Start diff mode with vertical splits (unless
2420 explicitly specified otherwise).
2421
2422 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2423 starting diff mode. Without this 2 is used.
2424
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425 Examples: >
2426
2427 :set diffopt=filler,context:4
2428 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002429 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430<
2431 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2432'digraph' 'dg' boolean (default off)
2433 global
2434 {not in Vi}
2435 {not available when compiled without the |+digraphs|
2436 feature}
2437 Enable the entering of digraphs in Insert mode with {char1} <BS>
2438 {char2}. See |digraphs|.
2439 NOTE: This option is reset when 'compatible' is set.
2440
2441 *'directory'* *'dir'*
2442'directory' 'dir' string (default for Amiga: ".,t:",
2443 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2444 for Unix: ".,~/tmp,/var/tmp,/tmp")
2445 global
2446 List of directory names for the swap file, separated with commas.
2447 - The swap file will be created in the first directory where this is
2448 possible.
2449 - Empty means that no swap file will be used (recovery is
2450 impossible!).
2451 - A directory "." means to put the swap file in the same directory as
2452 the edited file. On Unix, a dot is prepended to the file name, so
2453 it doesn't show in a directory listing. On MS-Windows the "hidden"
2454 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002455 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 put the swap file relative to where the edited file is. The leading
2457 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002458 - For Unix and Win32, if a directory ends in two path separators "//"
2459 or "\\", the swap file name will be built from the complete path to
2460 the file with all path separators substituted to percent '%' signs.
2461 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002462 On Win32, when a separating comma is following, you must use "//",
2463 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 - Spaces after the comma are ignored, other spaces are considered part
2465 of the directory name. To have a space at the start of a directory
2466 name, precede it with a backslash.
2467 - To include a comma in a directory name precede it with a backslash.
2468 - A directory name may end in an ':' or '/'.
2469 - Environment variables are expanded |:set_env|.
2470 - Careful with '\' characters, type one before a space, type two to
2471 get one in the option (see |option-backslash|), for example: >
2472 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2473< - For backwards compatibility with Vim version 3.0 a '>' at the start
2474 of the option is removed.
2475 Using "." first in the list is recommended. This means that editing
2476 the same file twice will result in a warning. Using "/tmp" on Unix is
2477 discouraged: When the system crashes you lose the swap file.
2478 "/var/tmp" is often not cleared when rebooting, thus is a better
2479 choice than "/tmp". But it can contain a lot of files, your swap
2480 files get lost in the crowd. That is why a "tmp" directory in your
2481 home directory is tried first.
2482 The use of |:set+=| and |:set-=| is preferred when adding or removing
2483 directories from the list. This avoids problems when a future version
2484 uses another default.
2485 This option cannot be set from a |modeline| or in the |sandbox|, for
2486 security reasons.
2487 {Vi: directory to put temp file in, defaults to "/tmp"}
2488
2489 *'display'* *'dy'*
2490'display' 'dy' string (default "")
2491 global
2492 {not in Vi}
2493 Change the way text is displayed. This is comma separated list of
2494 flags:
2495 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002496 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 last line that doesn't fit is replaced with "@" lines.
2498 uhex Show unprintable characters hexadecimal as <xx>
2499 instead of using ^C and ~C.
2500
2501 *'eadirection'* *'ead'*
2502'eadirection' 'ead' string (default "both")
2503 global
2504 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002505 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 feature}
2507 Tells when the 'equalalways' option applies:
2508 ver vertically, width of windows is not affected
2509 hor horizontally, height of windows is not affected
2510 both width and height of windows is affected
2511
2512 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2513'edcompatible' 'ed' boolean (default off)
2514 global
2515 Makes the 'g' and 'c' flags of the ":substitute" command to be
2516 toggled each time the flag is given. See |complex-change|. See
2517 also 'gdefault' option.
2518 Switching this option on is discouraged!
2519
2520 *'encoding'* *'enc'* *E543*
2521'encoding' 'enc' string (default: "latin1" or value from $LANG)
2522 global
2523 {only available when compiled with the |+multi_byte|
2524 feature}
2525 {not in Vi}
2526 Sets the character encoding used inside Vim. It applies to text in
2527 the buffers, registers, Strings in expressions, text stored in the
2528 viminfo file, etc. It sets the kind of characters which Vim can work
2529 with. See |encoding-names| for the possible values.
2530
2531 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002532 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002534 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535
Bram Moolenaar865242e2010-07-14 21:12:05 +02002536 This option cannot be set from a |modeline|. It would most likely
2537 corrupt the text.
2538
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2540 "utf-8". Although care has been taken to allow different values of
2541 'encoding', "utf-8" is the natural choice for the environment and
2542 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002543 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 versions, and to avoid changing the encoding of newly created files
2545 without your knowledge (in case 'fileencodings' is empty).
2546
2547 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002548 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 iconv() or as specified with 'charconvert'.
2550
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002551 If you need to know whether 'encoding' is a multi-byte encoding, you
2552 can use: >
2553 if has("multi_byte_encoding")
2554<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 Normally 'encoding' will be equal to your current locale. This will
2556 be the default if Vim recognizes your environment settings. If
2557 'encoding' is not set to the current locale, 'termencoding' must be
2558 set to convert typed and displayed text. See |encoding-table|.
2559
2560 When you set this option, it fires the |EncodingChanged| autocommand
2561 event so that you can set up fonts if necessary.
2562
2563 When the option is set, the value is converted to lowercase. Thus
2564 you can set it with uppercase values too. Underscores are translated
2565 to '-' signs.
2566 When the encoding is recognized, it is changed to the standard name.
2567 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2568 "iso-8859-2" and "utf8" becomes "utf-8".
2569
2570 Note: "latin1" is also used when the encoding could not be detected.
2571 This only works when editing files in the same encoding! When the
2572 actual character set is not latin1, make sure 'fileencoding' and
2573 'fileencodings' are empty. When conversion is needed, switch to using
2574 utf-8.
2575
2576 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2577 You don't notice this while editing, but it does matter for the
2578 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2579 setting 'encoding' to one of these values instead of utf-8 only has
2580 effect for encoding used for files when 'fileencoding' is empty.
2581
Bram Moolenaar661b1822005-07-28 22:36:45 +00002582 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2583 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584
2585 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2586'endofline' 'eol' boolean (default on)
2587 local to buffer
2588 {not in Vi}
2589 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002590 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 option is automatically set when starting to edit a new file, unless
2592 the file does not have an <EOL> for the last line in the file, in
2593 which case it is reset. Normally you don't have to set or reset this
2594 option. When 'binary' is off the value is not used when writing the
2595 file. When 'binary' is on it is used to remember the presence of a
2596 <EOL> for the last line in the file, so that when you write the file
2597 the situation from the original file can be kept. But you can change
2598 it if you want to.
2599
2600 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2601'equalalways' 'ea' boolean (default on)
2602 global
2603 {not in Vi}
2604 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002605 splitting or closing a window. This also happens the moment the
2606 option is switched on. When off, splitting a window will reduce the
2607 size of the current window and leave the other windows the same. When
2608 closing a window the extra lines are given to the window next to it
2609 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610 When mixing vertically and horizontally split windows, a minimal size
2611 is computed and some windows may be larger if there is room. The
2612 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002613 Changing the height and width of a window can be avoided by setting
2614 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002615 If a window size is specified when creating a new window sizes are
2616 currently not equalized (it's complicated, but may be implemented in
2617 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618
2619 *'equalprg'* *'ep'*
2620'equalprg' 'ep' string (default "")
2621 global or local to buffer |global-local|
2622 {not in Vi}
2623 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002624 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002625 or 'indentexpr'. When Vim was compiled without internal formatting,
2626 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002627 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 about including spaces and backslashes.
2629 This option cannot be set from a |modeline| or in the |sandbox|, for
2630 security reasons.
2631
2632 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2633'errorbells' 'eb' boolean (default off)
2634 global
2635 Ring the bell (beep or screen flash) for error messages. This only
2636 makes a difference for error messages, the bell will be used always
2637 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002638 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 screen flash or do nothing.
2640
2641 *'errorfile'* *'ef'*
2642'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2643 others: "errors.err")
2644 global
2645 {not in Vi}
2646 {not available when compiled without the |+quickfix|
2647 feature}
2648 Name of the errorfile for the QuickFix mode (see |:cf|).
2649 When the "-q" command-line argument is used, 'errorfile' is set to the
2650 following argument. See |-q|.
2651 NOT used for the ":make" command. See 'makeef' for that.
2652 Environment variables are expanded |:set_env|.
2653 See |option-backslash| about including spaces and backslashes.
2654 This option cannot be set from a |modeline| or in the |sandbox|, for
2655 security reasons.
2656
2657 *'errorformat'* *'efm'*
2658'errorformat' 'efm' string (default is very long)
2659 global or local to buffer |global-local|
2660 {not in Vi}
2661 {not available when compiled without the |+quickfix|
2662 feature}
2663 Scanf-like description of the format for the lines in the error file
2664 (see |errorformat|).
2665
2666 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2667'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2668 global
2669 {not in Vi}
2670 Function keys that start with an <Esc> are recognized in Insert
2671 mode. When this option is off, the cursor and function keys cannot be
2672 used in Insert mode if they start with an <Esc>. The advantage of
2673 this is that the single <Esc> is recognized immediately, instead of
2674 after one second. Instead of resetting this option, you might want to
2675 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2676 when 'esckeys' is off, you can still map anything, but the cursor keys
2677 won't work by default.
2678 NOTE: This option is set to the Vi default value when 'compatible' is
2679 set and to the Vim default value when 'compatible' is reset.
2680
2681 *'eventignore'* *'ei'*
2682'eventignore' 'ei' string (default "")
2683 global
2684 {not in Vi}
2685 {not available when compiled without the |+autocmd|
2686 feature}
2687 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002688 When set to "all" or when "all" is one of the items, all autocommand
2689 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 Otherwise this is a comma separated list of event names. Example: >
2691 :set ei=WinEnter,WinLeave
2692<
2693 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2694'expandtab' 'et' boolean (default off)
2695 local to buffer
2696 {not in Vi}
2697 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002698 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2700 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2701 NOTE: This option is reset when 'compatible' is set.
2702
2703 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2704'exrc' 'ex' boolean (default off)
2705 global
2706 {not in Vi}
2707 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2708 directory. If you switch this option on you should also consider
2709 setting the 'secure' option (see |initialization|). Using a local
2710 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2711 also see |.vimrc| and |gui-init|.
2712 This option cannot be set from a |modeline| or in the |sandbox|, for
2713 security reasons.
2714
2715 *'fileencoding'* *'fenc'* *E213*
2716'fileencoding' 'fenc' string (default: "")
2717 local to buffer
2718 {only available when compiled with the |+multi_byte|
2719 feature}
2720 {not in Vi}
2721 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002722
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002724 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 When 'fileencoding' is empty, the same value as 'encoding' will be
2726 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002727 Conversion will also be done when 'encoding' and 'fileencoding' are
2728 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2729 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002731 'encoding' is "utf-8" or another Unicode encoding, conversion
2732 is most likely done in a way that the reverse conversion
2733 results in the same text. When 'encoding' is not "utf-8" some
2734 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002735
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 See 'encoding' for the possible values. Additionally, values may be
2737 specified that can be handled by the converter, see
2738 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002739
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 When reading a file 'fileencoding' will be set from 'fileencodings'.
2741 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002742 'fileencoding', use the |++enc| argument. One exception: when
2743 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002744 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002745
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2747 When the option is set, the value is converted to lowercase. Thus
2748 you can set it with uppercase values too. '_' characters are
2749 replaced with '-'. If a name is recognized from the list for
2750 'encoding', it is replaced by the standard name. For example
2751 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002752
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 When this option is set, after starting to edit a file, the 'modified'
2754 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002755
2756 Keep in mind that changing 'fenc' from a modeline happens
2757 AFTER the text has been read, thus it applies to when the file will be
2758 written. If you do set 'fenc' in a modeline, you might want to set
2759 'nomodified' to avoid not being able to ":q".
2760
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 This option can not be changed when 'modifiable' is off.
2762
2763 *'fe'*
2764 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002765 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 old short name was 'fe', which is no longer used.
2767
2768 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002769'fileencodings' 'fencs' string (default: "ucs-bom",
2770 "ucs-bom,utf-8,default,latin1" when
2771 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 global
2773 {only available when compiled with the |+multi_byte|
2774 feature}
2775 {not in Vi}
2776 This is a list of character encodings considered when starting to edit
2777 an existing file. When a file is read, Vim tries to use the first
2778 mentioned character encoding. If an error is detected, the next one
2779 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002780 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 an empty string, which means the value of 'encoding' is used.
2782 WARNING: Conversion can cause loss of information! When
2783 'encoding' is "utf-8" (or one of the other Unicode variants)
2784 conversion is most likely done in a way that the reverse
2785 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002786 "utf-8" some non-ASCII characters may be lost! You can use
2787 the |++bad| argument to specify what is done with characters
2788 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 For an empty file or a file with only ASCII characters most encodings
2790 will work and the first entry of 'fileencodings' will be used (except
2791 "ucs-bom", which requires the BOM to be present). If you prefer
2792 another encoding use an BufReadPost autocommand event to test if your
2793 preferred encoding is to be used. Example: >
2794 au BufReadPost * if search('\S', 'w') == 0 |
2795 \ set fenc=iso-2022-jp | endif
2796< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2797 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002798 When the |++enc| argument is used then the value of 'fileencodings' is
2799 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002800 Note that 'fileencodings' is not used for a new file, the global value
2801 of 'fileencoding' is used instead. You can set it with: >
2802 :setglobal fenc=iso-8859-2
2803< This means that a non-existing file may get a different encoding than
2804 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 The special value "ucs-bom" can be used to check for a Unicode BOM
2806 (Byte Order Mark) at the start of the file. It must not be preceded
2807 by "utf-8" or another Unicode encoding for this to work properly.
2808 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2809 because Vim cannot detect an error, thus the encoding is always
2810 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002811 The special value "default" can be used for the encoding from the
2812 environment. This is the default value for 'encoding'. It is useful
2813 when 'encoding' is set to "utf-8" and your environment uses a
2814 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002815 When 'encoding' is "utf-8" and a file contains an illegal byte
2816 sequence it won't be recognized as UTF-8. You can use the |8g8|
2817 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 WRONG VALUES: WHAT'S WRONG:
2819 latin1,utf-8 "latin1" will always be used
2820 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2821 file
2822 cp1250,latin1 "cp1250" will always be used
2823 If 'fileencodings' is empty, 'fileencoding' is not modified.
2824 See 'fileencoding' for the possible values.
2825 Setting this option does not have an effect until the next time a file
2826 is read.
2827
2828 *'fileformat'* *'ff'*
2829'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2830 Unix default: "unix",
2831 Macintosh default: "mac")
2832 local to buffer
2833 {not in Vi}
2834 This gives the <EOL> of the current buffer, which is used for
2835 reading/writing the buffer from/to a file:
2836 dos <CR> <NL>
2837 unix <NL>
2838 mac <CR>
2839 When "dos" is used, CTRL-Z at the end of a file is ignored.
2840 See |file-formats| and |file-read|.
2841 For the character encoding of the file see 'fileencoding'.
2842 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2843 works like it was set to "unix'.
2844 This option is set automatically when starting to edit a file and
2845 'fileformats' is not empty and 'binary' is off.
2846 When this option is set, after starting to edit a file, the 'modified'
2847 option is set, because the file would be different when written.
2848 This option can not be changed when 'modifiable' is off.
2849 For backwards compatibility: When this option is set to "dos",
2850 'textmode' is set, otherwise 'textmode' is reset.
2851
2852 *'fileformats'* *'ffs'*
2853'fileformats' 'ffs' string (default:
2854 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2855 Vim Unix: "unix,dos",
2856 Vim Mac: "mac,unix,dos",
2857 Vi Cygwin: "unix,dos",
2858 Vi others: "")
2859 global
2860 {not in Vi}
2861 This gives the end-of-line (<EOL>) formats that will be tried when
2862 starting to edit a new buffer and when reading a file into an existing
2863 buffer:
2864 - When empty, the format defined with 'fileformat' will be used
2865 always. It is not set automatically.
2866 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002867 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 'fileformats' name will be used when a file is read into an existing
2869 buffer, no matter what 'fileformat' for that buffer is set to.
2870 - When more than one name is present, separated by commas, automatic
2871 <EOL> detection will be done when reading a file. When starting to
2872 edit a file, a check is done for the <EOL>:
2873 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2874 'fileformat' is set to "dos".
2875 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002876 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002878 3. If 'fileformat' has not yet been set, and if 'fileformats'
2879 includes "mac", 'fileformat' is set to "mac".
2880 This means that "mac" is only chosen when:
2881 "unix" is not present or no <NL> is found in the file, and
2882 "dos" is not present or no <CR><NL> is found in the file.
2883 Except: if "unix" was chosen, but there is a <CR> before
2884 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002885 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 4. If 'fileformat' is still not set, the first name from
2887 'fileformats' is used.
2888 When reading a file into an existing buffer, the same is done, but
2889 this happens like 'fileformat' has been set appropriately for that
2890 file only, the option is not changed.
2891 When 'binary' is set, the value of 'fileformats' is not used.
2892
Bram Moolenaar81af9252010-12-10 20:35:50 +01002893 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002894 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002895
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2897 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2898 done:
2899 - When 'fileformats' is empty, there is no automatic detection. Dos
2900 format will be used.
2901 - When 'fileformats' is set to one or more names, automatic detection
2902 is done. This is based on the first <NL> in the file: If there is a
2903 <CR> in front of it, Dos format is used, otherwise Unix format is
2904 used.
2905 Also see |file-formats|.
2906 For backwards compatibility: When this option is set to an empty
2907 string or one format (no comma is included), 'textauto' is reset,
2908 otherwise 'textauto' is set.
2909 NOTE: This option is set to the Vi default value when 'compatible' is
2910 set and to the Vim default value when 'compatible' is reset.
2911
2912 *'filetype'* *'ft'*
2913'filetype' 'ft' string (default: "")
2914 local to buffer
2915 {not in Vi}
2916 {not available when compiled without the |+autocmd|
2917 feature}
2918 When this option is set, the FileType autocommand event is triggered.
2919 All autocommands that match with the value of this option will be
2920 executed. Thus the value of 'filetype' is used in place of the file
2921 name.
2922 Otherwise this option does not always reflect the current file type.
2923 This option is normally set when the file type is detected. To enable
2924 this use the ":filetype on" command. |:filetype|
2925 Setting this option to a different value is most useful in a modeline,
2926 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002927 Example, for in an IDL file:
2928 /* vim: set filetype=idl : */ ~
2929 |FileType| |filetypes|
2930 When a dot appears in the value then this separates two filetype
2931 names. Example:
2932 /* vim: set filetype=c.doxygen : */ ~
2933 This will use the "c" filetype first, then the "doxygen" filetype.
2934 This works both for filetype plugins and for syntax files. More than
2935 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 This option is not copied to another buffer, independent of the 's' or
2937 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002938 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939
2940 *'fillchars'* *'fcs'*
2941'fillchars' 'fcs' string (default "vert:|,fold:-")
2942 global
2943 {not in Vi}
2944 {not available when compiled without the |+windows|
2945 and |+folding| features}
2946 Characters to fill the statuslines and vertical separators.
2947 It is a comma separated list of items:
2948
2949 item default Used for ~
2950 stl:c ' ' or '^' statusline of the current window
2951 stlnc:c ' ' or '-' statusline of the non-current windows
2952 vert:c '|' vertical separators |:vsplit|
2953 fold:c '-' filling 'foldtext'
2954 diff:c '-' deleted lines of the 'diff' option
2955
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002956 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 "stlnc" the space will be used when there is highlighting, '^' or '-'
2958 otherwise.
2959
2960 Example: >
2961 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2962< This is similar to the default, except that these characters will also
2963 be used when there is highlighting.
2964
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002965 for "stl" and "stlnc" only single-byte values are supported.
2966
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 The highlighting used for these items:
2968 item highlight group ~
2969 stl:c StatusLine |hl-StatusLine|
2970 stlnc:c StatusLineNC |hl-StatusLineNC|
2971 vert:c VertSplit |hl-VertSplit|
2972 fold:c Folded |hl-Folded|
2973 diff:c DiffDelete |hl-DiffDelete|
2974
2975 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2976'fkmap' 'fk' boolean (default off) *E198*
2977 global
2978 {not in Vi}
2979 {only available when compiled with the |+rightleft|
2980 feature}
2981 When on, the keyboard is mapped for the Farsi character set.
2982 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002983 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984
2985 *'foldclose'* *'fcl'*
2986'foldclose' 'fcl' string (default "")
2987 global
2988 {not in Vi}
2989 {not available when compiled without the |+folding|
2990 feature}
2991 When set to "all", a fold is closed when the cursor isn't in it and
2992 its level is higher than 'foldlevel'. Useful if you want folds to
2993 automatically close when moving out of them.
2994
2995 *'foldcolumn'* *'fdc'*
2996'foldcolumn' 'fdc' number (default 0)
2997 local to window
2998 {not in Vi}
2999 {not available when compiled without the |+folding|
3000 feature}
3001 When non-zero, a column with the specified width is shown at the side
3002 of the window which indicates open and closed folds. The maximum
3003 value is 12.
3004 See |folding|.
3005
3006 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3007'foldenable' 'fen' boolean (default on)
3008 local to window
3009 {not in Vi}
3010 {not available when compiled without the |+folding|
3011 feature}
3012 When off, all folds are open. This option can be used to quickly
3013 switch between showing all text unfolded and viewing the text with
3014 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003015 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 'foldenable' is off.
3017 This option is set by commands that create a new fold or close a fold.
3018 See |folding|.
3019
3020 *'foldexpr'* *'fde'*
3021'foldexpr' 'fde' string (default: "0")
3022 local to window
3023 {not in Vi}
3024 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003025 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003027 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003028
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003029 The expression may be evaluated in the |sandbox|, see
3030 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003031 This option can't be set from a |modeline| when the 'diff' option is
3032 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003033
3034 It is not allowed to change text or jump to another window while
3035 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036
3037 *'foldignore'* *'fdi'*
3038'foldignore' 'fdi' string (default: "#")
3039 local to window
3040 {not in Vi}
3041 {not available when compiled without the |+folding|
3042 feature}
3043 Used only when 'foldmethod' is "indent". Lines starting with
3044 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003045 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 The default "#" works well for C programs. See |fold-indent|.
3047
3048 *'foldlevel'* *'fdl'*
3049'foldlevel' 'fdl' number (default: 0)
3050 local to window
3051 {not in Vi}
3052 {not available when compiled without the |+folding|
3053 feature}
3054 Sets the fold level: Folds with a higher level will be closed.
3055 Setting this option to zero will close all folds. Higher numbers will
3056 close fewer folds.
3057 This option is set by commands like |zm|, |zM| and |zR|.
3058 See |fold-foldlevel|.
3059
3060 *'foldlevelstart'* *'fdls'*
3061'foldlevelstart' 'fdls' number (default: -1)
3062 global
3063 {not in Vi}
3064 {not available when compiled without the |+folding|
3065 feature}
3066 Sets 'foldlevel' when starting to edit another buffer in a window.
3067 Useful to always start editing with all folds closed (value zero),
3068 some folds closed (one) or no folds closed (99).
3069 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003070 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 ignores this option and closes all folds.
3072 It is also done before BufReadPre autocommands, to allow an autocmd to
3073 overrule the 'foldlevel' value for specific files.
3074 When the value is negative, it is not used.
3075
3076 *'foldmarker'* *'fmr'* *E536*
3077'foldmarker' 'fmr' string (default: "{{{,}}}")
3078 local to window
3079 {not in Vi}
3080 {not available when compiled without the |+folding|
3081 feature}
3082 The start and end marker used when 'foldmethod' is "marker". There
3083 must be one comma, which separates the start and end marker. The
3084 marker is a literal string (a regular expression would be too slow).
3085 See |fold-marker|.
3086
3087 *'foldmethod'* *'fdm'*
3088'foldmethod' 'fdm' string (default: "manual")
3089 local to window
3090 {not in Vi}
3091 {not available when compiled without the |+folding|
3092 feature}
3093 The kind of folding used for the current window. Possible values:
3094 |fold-manual| manual Folds are created manually.
3095 |fold-indent| indent Lines with equal indent form a fold.
3096 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3097 |fold-marker| marker Markers are used to specify folds.
3098 |fold-syntax| syntax Syntax highlighting items specify folds.
3099 |fold-diff| diff Fold text that is not changed.
3100
3101 *'foldminlines'* *'fml'*
3102'foldminlines' 'fml' number (default: 1)
3103 local to window
3104 {not in Vi}
3105 {not available when compiled without the |+folding|
3106 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003107 Sets the number of screen lines above which a fold can be displayed
3108 closed. Also for manually closed folds. With the default value of
3109 one a fold can only be closed if it takes up two or more screen lines.
3110 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003111 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 "zc" to close a fold, which is displayed open because it's smaller
3113 than 'foldminlines', a following "zc" may close a containing fold.
3114
3115 *'foldnestmax'* *'fdn'*
3116'foldnestmax' 'fdn' number (default: 20)
3117 local to window
3118 {not in Vi}
3119 {not available when compiled without the |+folding|
3120 feature}
3121 Sets the maximum nesting of folds for the "indent" and "syntax"
3122 methods. This avoids that too many folds will be created. Using more
3123 than 20 doesn't work, because the internal limit is 20.
3124
3125 *'foldopen'* *'fdo'*
3126'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3127 search,tag,undo")
3128 global
3129 {not in Vi}
3130 {not available when compiled without the |+folding|
3131 feature}
3132 Specifies for which type of commands folds will be opened, if the
3133 command moves the cursor into a closed fold. It is a comma separated
3134 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003135 NOTE: When the command is part of a mapping this option is not used.
3136 Add the |zv| command to the mapping to get the same effect.
3137 (rationale: the mapping may want to control opening folds itself)
3138
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 item commands ~
3140 all any
3141 block "(", "{", "[[", "[{", etc.
3142 hor horizontal movements: "l", "w", "fx", etc.
3143 insert any command in Insert mode
3144 jump far jumps: "G", "gg", etc.
3145 mark jumping to a mark: "'m", CTRL-O, etc.
3146 percent "%"
3147 quickfix ":cn", ":crew", ":make", etc.
3148 search search for a pattern: "/", "n", "*", "gd", etc.
3149 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003150 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 tag jumping to a tag: ":ta", CTRL-T, etc.
3152 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 When a movement command is used for an operator (e.g., "dl" or "y%")
3154 this option is not used. This means the operator will include the
3155 whole closed fold.
3156 Note that vertical movements are not here, because it would make it
3157 very difficult to move onto a closed fold.
3158 In insert mode the folds containing the cursor will always be open
3159 when text is inserted.
3160 To close folds you can re-apply 'foldlevel' with the |zx| command or
3161 set the 'foldclose' option to "all".
3162
3163 *'foldtext'* *'fdt'*
3164'foldtext' 'fdt' string (default: "foldtext()")
3165 local to window
3166 {not in Vi}
3167 {not available when compiled without the |+folding|
3168 feature}
3169 An expression which is used to specify the text displayed for a closed
3170 fold. See |fold-foldtext|.
3171
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003172 The expression may be evaluated in the |sandbox|, see
3173 |sandbox-option|.
3174
3175 It is not allowed to change text or jump to another window while
3176 evaluating 'foldtext' |textlock|.
3177
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 *'formatoptions'* *'fo'*
3179'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3180 local to buffer
3181 {not in Vi}
3182 This is a sequence of letters which describes how automatic
3183 formatting is to be done. See |fo-table|. When the 'paste' option is
3184 on, no formatting is done (like 'formatoptions' is empty). Commas can
3185 be inserted for readability.
3186 To avoid problems with flags that are added in the future, use the
3187 "+=" and "-=" feature of ":set" |add-option-flags|.
3188 NOTE: This option is set to the Vi default value when 'compatible' is
3189 set and to the Vim default value when 'compatible' is reset.
3190
Bram Moolenaar86b68352004-12-27 21:59:20 +00003191 *'formatlistpat'* *'flp'*
3192'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3193 local to buffer
3194 {not in Vi}
3195 A pattern that is used to recognize a list header. This is used for
3196 the "n" flag in 'formatoptions'.
3197 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003198 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003199 while still checking more characters. There must be a character
3200 following the pattern, when it matches the whole line it is handled
3201 like there is no match.
3202 The default recognizes a number, followed by an optional punctuation
3203 character and white space.
3204
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 *'formatprg'* *'fp'*
3206'formatprg' 'fp' string (default "")
3207 global
3208 {not in Vi}
3209 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003210 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003212 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003213 If the 'formatexpr' option is not empty it will be used instead.
3214 Otherwise, if 'formatprg' option is an empty string, the internal
3215 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003216 Environment variables are expanded |:set_env|. See |option-backslash|
3217 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003218 The expression may be evaluated in the |sandbox|, see
3219 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003221 *'formatexpr'* *'fex'*
3222'formatexpr' 'fex' string (default "")
3223 local to buffer
3224 {not in Vi}
3225 {not available when compiled without the |+eval|
3226 feature}
3227 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003228 operator or automatic formatting (see 'formatoptions'). When this
3229 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003230
3231 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003232 The |v:count| variable holds the number of lines to be formatted.
3233 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003234 inserted if the expression is being evaluated due to
3235 automatic formatting. This can be empty. Don't insert
3236 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003237
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003238 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003239 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003240< This will invoke the mylang#Format() function in the
3241 autoload/mylang.vim file in 'runtimepath'. |autoload|
3242
3243 The expression is also evaluated when 'textwidth' is set and adding
3244 text beyond that limit. This happens under the same conditions as
3245 when internal formatting is used. Make sure the cursor is kept in the
3246 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003247 return "i" or "R" in this situation.
3248
3249 When the expression evaluates to non-zero Vim will fall back to using
3250 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003251
3252 The expression may be evaluated in the |sandbox|, see
Bram Moolenaar81af9252010-12-10 20:35:50 +01003253 |sandbox-option|. That stops the option from working, since changing
3254 the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003255
3256 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003257'fsync' 'fs' boolean (default on)
3258 global
3259 {not in Vi}
3260 When on, the library function fsync() will be called after writing a
3261 file. This will flush a file to disk, ensuring that it is safely
3262 written even on filesystems which do metadata-only journaling. This
3263 will force the harddrive to spin up on Linux systems running in laptop
3264 mode, so it may be undesirable in some situations. Be warned that
3265 turning this off increases the chances of data loss after a crash. On
3266 systems without an fsync() implementation, this variable is always
3267 off.
3268 Also see 'swapsync' for controlling fsync() on swap files.
3269
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3271'gdefault' 'gd' boolean (default off)
3272 global
3273 {not in Vi}
3274 When on, the ":substitute" flag 'g' is default on. This means that
3275 all matches in a line are substituted instead of one. When a 'g' flag
3276 is given to a ":substitute" command, this will toggle the substitution
3277 of all or one match. See |complex-change|.
3278
3279 command 'gdefault' on 'gdefault' off ~
3280 :s/// subst. all subst. one
3281 :s///g subst. one subst. all
3282 :s///gg subst. all subst. one
3283
3284 NOTE: This option is reset when 'compatible' is set.
3285
3286 *'grepformat'* *'gfm'*
3287'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3288 global
3289 {not in Vi}
3290 Format to recognize for the ":grep" command output.
3291 This is a scanf-like string that uses the same format as the
3292 'errorformat' option: see |errorformat|.
3293
3294 *'grepprg'* *'gp'*
3295'grepprg' 'gp' string (default "grep -n ",
3296 Unix: "grep -n $* /dev/null",
3297 Win32: "findstr /n" or "grep -n",
3298 VMS: "SEARCH/NUMBERS ")
3299 global or local to buffer |global-local|
3300 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003301 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 and '#' characters, which are expanded like when used in a command-
3303 line. The placeholder "$*" is allowed to specify where the arguments
3304 will be included. Environment variables are expanded |:set_env|. See
3305 |option-backslash| about including spaces and backslashes.
3306 When your "grep" accepts the "-H" argument, use this to make ":grep"
3307 also work well with a single file: >
3308 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003309< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003310 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3311 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003312 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 apply equally to 'grepprg'.
3314 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3315 otherwise it's "grep -n".
3316 This option cannot be set from a |modeline| or in the |sandbox|, for
3317 security reasons.
3318
3319 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3320'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3321 ve:ver35-Cursor,
3322 o:hor50-Cursor,
3323 i-ci:ver25-Cursor/lCursor,
3324 r-cr:hor20-Cursor/lCursor,
3325 sm:block-Cursor
3326 -blinkwait175-blinkoff150-blinkon175",
3327 for MS-DOS and Win32 console:
3328 "n-v-c:block,o:hor50,i-ci:hor15,
3329 r-cr:hor30,sm:block")
3330 global
3331 {not in Vi}
3332 {only available when compiled with GUI enabled, and
3333 for MS-DOS and Win32 console}
3334 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003335 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 the height of the cursor can be changed. This can be done by
3337 specifying a block cursor, or a percentage for a vertical or
3338 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003339 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003341 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 mode-list and an argument-list:
3343 mode-list:argument-list,mode-list:argument-list,..
3344 The mode-list is a dash separated list of these modes:
3345 n Normal mode
3346 v Visual mode
3347 ve Visual mode with 'selection' "exclusive" (same as 'v',
3348 if not specified)
3349 o Operator-pending mode
3350 i Insert mode
3351 r Replace mode
3352 c Command-line Normal (append) mode
3353 ci Command-line Insert mode
3354 cr Command-line Replace mode
3355 sm showmatch in Insert mode
3356 a all modes
3357 The argument-list is a dash separated list of these arguments:
3358 hor{N} horizontal bar, {N} percent of the character height
3359 ver{N} vertical bar, {N} percent of the character width
3360 block block cursor, fills the whole character
3361 [only one of the above three should be present]
3362 blinkwait{N} *cursor-blinking*
3363 blinkon{N}
3364 blinkoff{N}
3365 blink times for cursor: blinkwait is the delay before
3366 the cursor starts blinking, blinkon is the time that
3367 the cursor is shown and blinkoff is the time that the
3368 cursor is not shown. The times are in msec. When one
3369 of the numbers is zero, there is no blinking. The
3370 default is: "blinkwait700-blinkon400-blinkoff250".
3371 These numbers are used for a missing entry. This
3372 means that blinking is enabled by default. To switch
3373 blinking off you can use "blinkon0". The cursor only
3374 blinks when Vim is waiting for input, not while
3375 executing a command.
3376 To make the cursor blink in an xterm, see
3377 |xterm-blink|.
3378 {group-name}
3379 a highlight group name, that sets the color and font
3380 for the cursor
3381 {group-name}/{group-name}
3382 Two highlight group names, the first is used when
3383 no language mappings are used, the other when they
3384 are. |language-mapping|
3385
3386 Examples of parts:
3387 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3388 block cursor with colors from the "nCursor"
3389 highlight group
3390 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3391 In Insert and Command-line Insert mode, use a
3392 30% vertical bar cursor with colors from the
3393 "iCursor" highlight group. Blink a bit
3394 faster.
3395
3396 The 'a' mode is different. It will set the given argument-list for
3397 all modes. It does not reset anything to defaults. This can be used
3398 to do a common setting for all modes. For example, to switch off
3399 blinking: "a:blinkon0"
3400
3401 Examples of cursor highlighting: >
3402 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3403 :highlight Cursor gui=NONE guifg=bg guibg=fg
3404<
3405 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003406 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407'guifont' 'gfn' string (default "")
3408 global
3409 {not in Vi}
3410 {only available when compiled with GUI enabled}
3411 This is a list of fonts which will be used for the GUI version of Vim.
3412 In its simplest form the value is just one font name. When
3413 the font cannot be found you will get an error message. To try other
3414 font names a list can be specified, font names separated with commas.
3415 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003416
Bram Moolenaar05159a02005-02-26 23:04:13 +00003417 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3418 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003419
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 Spaces after a comma are ignored. To include a comma in a font name
3421 precede it with a backslash. Setting an option requires an extra
3422 backslash before a space and a backslash. See also
3423 |option-backslash|. For example: >
3424 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003425< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003427
3428 If none of the fonts can be loaded, Vim will keep the current setting.
3429 If an empty font list is given, Vim will try using other resource
3430 settings (for X, it will use the Vim.font resource), and finally it
3431 will try some builtin default which should always be there ("7x13" in
3432 the case of X). The font names given should be "normal" fonts. Vim
3433 will try to find the related bold and italic fonts.
3434
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003435 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003436 :set guifont=*
3437< will bring up a font requester, where you can pick the font you want.
3438
3439 The font name depends on the GUI used. See |setting-guifont| for a
3440 way to set 'guifont' for various systems.
3441
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 For the GTK+ 2 GUI the font name looks like this: >
3443 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003444< That's all. XLFDs are not used. For Chinese this is reported to work
3445 well: >
3446 if has("gui_gtk2")
3447 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3448 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3449 endif
3450<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003451 For Mac OSX you can use something like this: >
3452 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003453< Also see 'macatsui', it can help fix display problems.
3454 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003456 width). An exception is GTK 2: all fonts are accepted, but
3457 mono-spaced fonts look best.
3458
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 To preview a font on X11, you might be able to use the "xfontsel"
3460 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003461
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 For the Win32 GUI *E244* *E245*
3463 - takes these options in the font name:
3464 hXX - height is XX (points, can be floating-point)
3465 wXX - width is XX (points, can be floating-point)
3466 b - bold
3467 i - italic
3468 u - underline
3469 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003470 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3472 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3473 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003474 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475
3476 Use a ':' to separate the options.
3477 - A '_' can be used in the place of a space, so you don't need to use
3478 backslashes to escape the spaces.
3479 - Examples: >
3480 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3481 :set guifont=Andale_Mono:h7.5:w4.5
3482< See also |font-sizes|.
3483
3484 *'guifontset'* *'gfs'*
3485 *E250* *E252* *E234* *E597* *E598*
3486'guifontset' 'gfs' string (default "")
3487 global
3488 {not in Vi}
3489 {only available when compiled with GUI enabled and
3490 with the |+xfontset| feature}
3491 {not available in the GTK+ 2 GUI}
3492 When not empty, specifies two (or more) fonts to be used. The first
3493 one for normal English, the second one for your special language. See
3494 |xfontset|.
3495 Setting this option also means that all font names will be handled as
3496 a fontset name. Also the ones used for the "font" argument of the
3497 |:highlight| command.
3498 The fonts must match with the current locale. If fonts for the
3499 character sets that the current locale uses are not included, setting
3500 'guifontset' will fail.
3501 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3502 the comma-separated names are alternative names, one of which will be
3503 used. In 'guifontset' the whole string is one fontset name,
3504 including the commas. It is not possible to specify alternative
3505 fontset names.
3506 This example works on many X11 systems: >
3507 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3508<
3509 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3510'guifontwide' 'gfw' string (default "")
3511 global
3512 {not in Vi}
3513 {only available when compiled with GUI enabled}
3514 When not empty, specifies a comma-separated list of fonts to be used
3515 for double-width characters. The first font that can be loaded is
3516 used.
3517 Note: The size of these fonts must be exactly twice as wide as the one
3518 specified with 'guifont' and the same height.
3519
3520 All GUI versions but GTK+ 2:
3521
3522 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3523 'guifontset' is empty or invalid.
3524 When 'guifont' is set and a valid font is found in it and
3525 'guifontwide' is empty Vim will attempt to find a matching
3526 double-width font and set 'guifontwide' to it.
3527
3528 GTK+ 2 GUI only: *guifontwide_gtk2*
3529
3530 If set and valid, 'guifontwide' is always used for double width
3531 characters, even if 'encoding' is not set to "utf-8".
3532 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003533 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 font for characters not available in 'guifont'. Thus you do not need
3535 to set 'guifontwide' at all unless you want to override the choice
3536 made by Pango/Xft.
3537
3538 *'guiheadroom'* *'ghr'*
3539'guiheadroom' 'ghr' number (default 50)
3540 global
3541 {not in Vi} {only for GTK and X11 GUI}
3542 The number of pixels subtracted from the screen height when fitting
3543 the GUI window on the screen. Set this before the GUI is started,
3544 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003545 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 lines will be left for window decorations and other items on the
3547 screen. Set it to a negative value to allow windows taller than the
3548 screen.
3549
3550 *'guioptions'* *'go'*
3551'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003552 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 global
3554 {not in Vi}
3555 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003556 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 sequence of letters which describes what components and options of the
3558 GUI should be used.
3559 To avoid problems with flags that are added in the future, use the
3560 "+=" and "-=" feature of ":set" |add-option-flags|.
3561
3562 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003563 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 'a' Autoselect: If present, then whenever VISUAL mode is started,
3565 or the Visual area extended, Vim tries to become the owner of
3566 the windowing system's global selection. This means that the
3567 Visually highlighted text is available for pasting into other
3568 applications as well as into Vim itself. When the Visual mode
3569 ends, possibly due to an operation on the text, or when an
3570 application wants to paste the selection, the highlighted text
3571 is automatically yanked into the "* selection register.
3572 Thus the selection is still available for pasting into other
3573 applications after the VISUAL mode has ended.
3574 If not present, then Vim won't become the owner of the
3575 windowing system's global selection unless explicitly told to
3576 by a yank or delete operation for the "* register.
3577 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003578 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003579 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 applies to the modeless selection.
3581
3582 'guioptions' autoselect Visual autoselect modeless ~
3583 "" - -
3584 "a" yes yes
3585 "A" - yes
3586 "aA" yes yes
3587
Bram Moolenaar02467872007-05-06 13:22:01 +00003588 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 'c' Use console dialogs instead of popup dialogs for simple
3590 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003591 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003592 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003593 'guitablabel' can be used to change the text in the labels.
3594 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003595 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003596 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003597 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 'f' Foreground: Don't use fork() to detach the GUI from the shell
3599 where it was started. Use this for programs that wait for the
3600 editor to finish (e.g., an e-mail program). Alternatively you
3601 can use "gvim -f" or ":gui -f" to start the GUI in the
3602 foreground. |gui-fork|
3603 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003604 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003605 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3607 corner of the window. It's black&white on non-GTK, because of
3608 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003609 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003611 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003612 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003614 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 file is sourced the system menu has already been loaded; the
3616 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003617 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 'g' Grey menu items: Make menu items that are not active grey. If
3619 'g' is not included inactive menu items are not shown at all.
3620 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003621 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 't' Include tearoff menu items. Currently only works for Win32,
3623 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003624 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003625 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003626 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003627 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003629 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 'R' Right-hand scrollbar is present when there is a vertically
3631 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003632 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003634 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 'L' Left-hand scrollbar is present when there is a vertically
3636 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003637 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3639 the longest visible line, or on the cursor line if the 'h'
3640 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003641 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 'h' Limit horizontal scrollbar size to the length of the cursor
3643 line. Reduces computations. |gui-horiz-scroll|
3644
3645 And yes, you may even have scrollbars on the left AND the right if
3646 you really want to :-). See |gui-scrollbars| for more information.
3647
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003648 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 'v' Use a vertical button layout for dialogs. When not included,
3650 a horizontal layout is preferred, but when it doesn't fit a
3651 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003652 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 'p' Use Pointer callbacks for X11 GUI. This is required for some
3654 window managers. If the cursor is not blinking or hollow at
3655 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003656 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003658 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003659 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660
Bram Moolenaar02467872007-05-06 13:22:01 +00003661
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 *'guipty'* *'noguipty'*
3663'guipty' boolean (default on)
3664 global
3665 {not in Vi}
3666 {only available when compiled with GUI enabled}
3667 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3668 I/O to/from shell commands. See |gui-pty|.
3669
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003670 *'guitablabel'* *'gtl'*
3671'guitablabel' 'gtl' string (default empty)
3672 global
3673 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003674 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003675 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003676 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003677 pages line. When empty and when the result is empty Vim will use a
3678 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003679
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003680 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003681 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003682
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003683 Only used when the GUI tab pages line is displayed. 'e' must be
3684 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3685 used.
3686
Bram Moolenaar57657d82006-04-21 22:12:41 +00003687 *'guitabtooltip'* *'gtt'*
3688'guitabtooltip' 'gtt' string (default empty)
3689 global
3690 {not in Vi}
3691 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003692 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003693 When nonempty describes the text to use in a tooltip for the GUI tab
3694 pages line. When empty Vim will use a default tooltip.
3695 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003696 You can include a line break. Simplest method is to use |:let|: >
3697 :let &guitabtooltip = "line one\nline two"
3698<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003699
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 *'helpfile'* *'hf'*
3701'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3702 (others) "$VIMRUNTIME/doc/help.txt")
3703 global
3704 {not in Vi}
3705 Name of the main help file. All distributed help files should be
3706 placed together in one directory. Additionally, all "doc" directories
3707 in 'runtimepath' will be used.
3708 Environment variables are expanded |:set_env|. For example:
3709 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003710 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 spaces and backslashes.
3712 This option cannot be set from a |modeline| or in the |sandbox|, for
3713 security reasons.
3714
3715 *'helpheight'* *'hh'*
3716'helpheight' 'hh' number (default 20)
3717 global
3718 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003719 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 feature}
3721 Minimal initial height of the help window when it is opened with the
3722 ":help" command. The initial height of the help window is half of the
3723 current window, or (when the 'ea' option is on) the same as other
3724 windows. When the height is less than 'helpheight', the height is
3725 set to 'helpheight'. Set to zero to disable.
3726
3727 *'helplang'* *'hlg'*
3728'helplang' 'hlg' string (default: messages language or empty)
3729 global
3730 {only available when compiled with the |+multi_lang|
3731 feature}
3732 {not in Vi}
3733 Comma separated list of languages. Vim will use the first language
3734 for which the desired help can be found. The English help will always
3735 be used as a last resort. You can add "en" to prefer English over
3736 another language, but that will only find tags that exist in that
3737 language and not in the English help.
3738 Example: >
3739 :set helplang=de,it
3740< This will first search German, then Italian and finally English help
3741 files.
3742 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3743 try to find the tag in the current language before using this option.
3744 See |help-translated|.
3745
3746 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3747'hidden' 'hid' boolean (default off)
3748 global
3749 {not in Vi}
3750 When off a buffer is unloaded when it is |abandon|ed. When on a
3751 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3752 displayed in another window, it does not become hidden, of course.
3753 The commands that move through the buffer list sometimes make a buffer
3754 hidden although the 'hidden' option is off: When the buffer is
3755 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003756 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003757 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 This option is set for one command with ":hide {command}" |:hide|.
3759 WARNING: It's easy to forget that you have changes in hidden buffers.
3760 Think twice when using ":q!" or ":qa!".
3761
3762 *'highlight'* *'hl'*
3763'highlight' 'hl' string (default (as a single string):
3764 "8:SpecialKey,@:NonText,d:Directory,
3765 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3766 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003767 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3769 f:Folded,F:FoldColumn,A:DiffAdd,
3770 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003771 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003772 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003773 +:Pmenu,=:PmenuSel,
3774 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 global
3776 {not in Vi}
3777 This option can be used to set highlighting mode for various
3778 occasions. It is a comma separated list of character pairs. The
3779 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003780 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3782 |hl-NonText| @ '~' and '@' at the end of the window and
3783 characters from 'showbreak'
3784 |hl-Directory| d directories in CTRL-D listing and other special
3785 things in listings
3786 |hl-ErrorMsg| e error messages
3787 h (obsolete, ignored)
3788 |hl-IncSearch| i 'incsearch' highlighting
3789 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3790 |hl-MoreMsg| m |more-prompt|
3791 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003792 |hl-LineNr| n line number for ":number" and ":#" commands, and
3793 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 |hl-Question| r |hit-enter| prompt and yes/no questions
3795 |hl-StatusLine| s status line of current window |status-line|
3796 |hl-StatusLineNC| S status lines of not-current windows
3797 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3798 |hl-VertSplit| c column used to separate vertically split windows
3799 |hl-Visual| v Visual mode
3800 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3801 Selection" Only X11 Gui's |gui-x11| and
3802 |xterm-clipboard|.
3803 |hl-WarningMsg| w warning messages
3804 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3805 |hl-Folded| f line used for closed folds
3806 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003807 |hl-DiffAdd| A added line in diff mode
3808 |hl-DiffChange| C changed line in diff mode
3809 |hl-DiffDelete| D deleted line in diff mode
3810 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003812 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003813 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003814 |hl-SpellRare| R rare word |spell|
3815 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003816 |hl-Conceal| - the placeholders used for concealed characters
3817 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003818 |hl-Pmenu| + popup menu normal line
3819 |hl-PmenuSel| = popup menu normal line
3820 |hl-PmenuSbar| x popup menu scrollbar
3821 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822
3823 The display modes are:
3824 r reverse (termcap entry "mr" and "me")
3825 i italic (termcap entry "ZH" and "ZR")
3826 b bold (termcap entry "md" and "me")
3827 s standout (termcap entry "so" and "se")
3828 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003829 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 n no highlighting
3831 - no highlighting
3832 : use a highlight group
3833 The default is used for occasions that are not included.
3834 If you want to change what the display modes do, see |dos-colors|
3835 for an example.
3836 When using the ':' display mode, this must be followed by the name of
3837 a highlight group. A highlight group can be used to define any type
3838 of highlighting, including using color. See |:highlight| on how to
3839 define one. The default uses a different group for each occasion.
3840 See |highlight-default| for the default highlight groups.
3841
3842 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3843'hlsearch' 'hls' boolean (default off)
3844 global
3845 {not in Vi}
3846 {not available when compiled without the
3847 |+extra_search| feature}
3848 When there is a previous search pattern, highlight all its matches.
3849 The type of highlighting used can be set with the 'l' occasion in the
3850 'highlight' option. This uses the "Search" highlight group by
3851 default. Note that only the matching text is highlighted, any offsets
3852 are not applied.
3853 See also: 'incsearch' and |:match|.
3854 When you get bored looking at the highlighted matches, you can turn it
3855 off with |:nohlsearch|. As soon as you use a search command, the
3856 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003857 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 When the search pattern can match an end-of-line, Vim will try to
3859 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003860 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003862 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 NOTE: This option is reset when 'compatible' is set.
3864
3865 *'history'* *'hi'*
3866'history' 'hi' number (Vim default: 20, Vi default: 0)
3867 global
3868 {not in Vi}
3869 A history of ":" commands, and a history of previous search patterns
3870 are remembered. This option decides how many entries may be stored in
3871 each of these histories (see |cmdline-editing|).
3872 NOTE: This option is set to the Vi default value when 'compatible' is
3873 set and to the Vim default value when 'compatible' is reset.
3874
3875 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3876'hkmap' 'hk' boolean (default off)
3877 global
3878 {not in Vi}
3879 {only available when compiled with the |+rightleft|
3880 feature}
3881 When on, the keyboard is mapped for the Hebrew character set.
3882 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3883 toggle this option. See |rileft.txt|.
3884 NOTE: This option is reset when 'compatible' is set.
3885
3886 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3887'hkmapp' 'hkp' boolean (default off)
3888 global
3889 {not in Vi}
3890 {only available when compiled with the |+rightleft|
3891 feature}
3892 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3893 This is useful if you have a non-Hebrew keyboard.
3894 See |rileft.txt|.
3895 NOTE: This option is reset when 'compatible' is set.
3896
3897 *'icon'* *'noicon'*
3898'icon' boolean (default off, on when title can be restored)
3899 global
3900 {not in Vi}
3901 {not available when compiled without the |+title|
3902 feature}
3903 When on, the icon text of the window will be set to the value of
3904 'iconstring' (if it is not empty), or to the name of the file
3905 currently being edited. Only the last part of the name is used.
3906 Overridden by the 'iconstring' option.
3907 Only works if the terminal supports setting window icons (currently
3908 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3909 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3910 builtin termcap).
3911 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003912 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 X11.
3914
3915 *'iconstring'*
3916'iconstring' string (default "")
3917 global
3918 {not in Vi}
3919 {not available when compiled without the |+title|
3920 feature}
3921 When this option is not empty, it will be used for the icon text of
3922 the window. This happens only when the 'icon' option is on.
3923 Only works if the terminal supports setting window icon text
3924 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3925 Does not work for MS Windows.
3926 When Vim was compiled with HAVE_X11 defined, the original icon will be
3927 restored if possible |X11|.
3928 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003929 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 'titlestring' for example settings.
3931 {not available when compiled without the |+statusline| feature}
3932
3933 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3934'ignorecase' 'ic' boolean (default off)
3935 global
3936 Ignore case in search patterns. Also used when searching in the tags
3937 file.
3938 Also see 'smartcase'.
3939 Can be overruled by using "\c" or "\C" in the pattern, see
3940 |/ignorecase|.
3941
3942 *'imactivatekey'* *'imak'*
3943'imactivatekey' 'imak' string (default "")
3944 global
3945 {not in Vi}
3946 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003947 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 Specifies the key that your Input Method in X-Windows uses for
3949 activation. When this is specified correctly, vim can fully control
3950 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3951 You can't use this option to change the activation key, the option
3952 tells Vim what the key is.
3953 Format:
3954 [MODIFIER_FLAG-]KEY_STRING
3955
3956 These characters can be used for MODIFIER_FLAG (case is ignored):
3957 S Shift key
3958 L Lock key
3959 C Control key
3960 1 Mod1 key
3961 2 Mod2 key
3962 3 Mod3 key
3963 4 Mod4 key
3964 5 Mod5 key
3965 Combinations are allowed, for example "S-C-space" or "SC-space" are
3966 both shift+ctrl+space.
3967 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3968
3969 Example: >
3970 :set imactivatekey=S-space
3971< "S-space" means shift+space. This is the activation key for kinput2 +
3972 canna (Japanese), and ami (Korean).
3973
3974 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3975'imcmdline' 'imc' boolean (default off)
3976 global
3977 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003978 {only available when compiled with the |+xim|,
3979 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 When set the Input Method is always on when starting to edit a command
3981 line, unless entering a search pattern (see 'imsearch' for that).
3982 Setting this option is useful when your input method allows entering
3983 English characters directly, e.g., when it's used to type accented
3984 characters with dead keys.
3985
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003986 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3988 global
3989 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003990 {only available when compiled with the |+xim|,
3991 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 When set the Input Method is never used. This is useful to disable
3993 the IM when it doesn't work properly.
3994 Currently this option is on by default for SGI/IRIX machines. This
3995 may change in later releases.
3996
3997 *'iminsert'* *'imi'*
3998'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3999 local to buffer
4000 {not in Vi}
4001 Specifies whether :lmap or an Input Method (IM) is to be used in
4002 Insert mode. Valid values:
4003 0 :lmap is off and IM is off
4004 1 :lmap is ON and IM is off
4005 2 :lmap is off and IM is ON
4006 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4007 or |global-ime|.
4008 To always reset the option to zero when leaving Insert mode with <Esc>
4009 this can be used: >
4010 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4011< This makes :lmap and IM turn off automatically when leaving Insert
4012 mode.
4013 Note that this option changes when using CTRL-^ in Insert mode
4014 |i_CTRL-^|.
4015 The value is set to 1 when setting 'keymap' to a valid keymap name.
4016 It is also used for the argument of commands like "r" and "f".
4017 The value 0 may not work correctly with Athena and Motif with some XIM
4018 methods. Use 'imdisable' to disable XIM then.
4019
4020 *'imsearch'* *'ims'*
4021'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4022 local to buffer
4023 {not in Vi}
4024 Specifies whether :lmap or an Input Method (IM) is to be used when
4025 entering a search pattern. Valid values:
4026 -1 the value of 'iminsert' is used, makes it look like
4027 'iminsert' is also used when typing a search pattern
4028 0 :lmap is off and IM is off
4029 1 :lmap is ON and IM is off
4030 2 :lmap is off and IM is ON
4031 Note that this option changes when using CTRL-^ in Command-line mode
4032 |c_CTRL-^|.
4033 The value is set to 1 when it is not -1 and setting the 'keymap'
4034 option to a valid keymap name.
4035 The value 0 may not work correctly with Athena and Motif with some XIM
4036 methods. Use 'imdisable' to disable XIM then.
4037
4038 *'include'* *'inc'*
4039'include' 'inc' string (default "^\s*#\s*include")
4040 global or local to buffer |global-local|
4041 {not in Vi}
4042 {not available when compiled without the
4043 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004044 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 pattern, just like for the "/" command (See |pattern|). The default
4046 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004047 "]I", "[d", etc.
4048 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004049 comes after the matched pattern. But if "\zs" appears in the pattern
4050 then the text matched from "\zs" to the end, or until "\ze" if it
4051 appears, is used as the file name. Use this to include characters
4052 that are not in 'isfname', such as a space. You can then use
4053 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004054 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055
4056 *'includeexpr'* *'inex'*
4057'includeexpr' 'inex' string (default "")
4058 local to buffer
4059 {not in Vi}
4060 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004061 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004063 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064 :set includeexpr=substitute(v:fname,'\\.','/','g')
4065< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004066
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004068 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 Also used for |<cfile>|.
4070
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004071 The expression may be evaluated in the |sandbox|, see
4072 |sandbox-option|.
4073
4074 It is not allowed to change text or jump to another window while
4075 evaluating 'includeexpr' |textlock|.
4076
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4078'incsearch' 'is' boolean (default off)
4079 global
4080 {not in Vi}
4081 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004082 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004083 While typing a search command, show where the pattern, as it was typed
4084 so far, matches. The matched string is highlighted. If the pattern
4085 is invalid or not found, nothing is shown. The screen will be updated
4086 often, this is only useful on fast terminals.
4087 Note that the match will be shown, but the cursor will return to its
4088 original position when no match is found and when pressing <Esc>. You
4089 still need to finish the search command with <Enter> to move the
4090 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004091 When compiled with the |+reltime| feature Vim only searches for about
4092 half a second. With a complicated pattern and/or a lot of text the
4093 match may not be found. This is to avoid that Vim hangs while you
4094 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004095 The highlighting can be set with the 'i' flag in 'highlight'.
4096 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004097 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004098 to the command line. If 'ignorecase' and 'smartcase' are set and the
4099 command line has no uppercase characters, the added character is
4100 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004101 CTRL-R CTRL-W can be used to add the word at the end of the current
4102 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 NOTE: This option is reset when 'compatible' is set.
4104
4105 *'indentexpr'* *'inde'*
4106'indentexpr' 'inde' string (default "")
4107 local to buffer
4108 {not in Vi}
4109 {not available when compiled without the |+cindent|
4110 or |+eval| features}
4111 Expression which is evaluated to obtain the proper indent for a line.
4112 It is used when a new line is created, for the |=| operator and
4113 in Insert mode as specified with the 'indentkeys' option.
4114 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004115 'smartindent' indenting. When 'lisp' is set, this option is
4116 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 When 'paste' is set this option is not used for indenting.
4118 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004119 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 when the expression is evaluated (but it may be moved around).
4121 The expression must return the number of spaces worth of indent. It
4122 can return "-1" to keep the current indent (this means 'autoindent' is
4123 used for the indent).
4124 Functions useful for computing the indent are |indent()|, |cindent()|
4125 and |lispindent()|.
4126 The evaluation of the expression must not have side effects! It must
4127 not change the text, jump to another window, etc. Afterwards the
4128 cursor position is always restored, thus the cursor may be moved.
4129 Normally this option would be set to call a function: >
4130 :set indentexpr=GetMyIndent()
4131< Error messages will be suppressed, unless the 'debug' option contains
4132 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004133 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 NOTE: This option is made empty when 'compatible' is set.
4135
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004136 The expression may be evaluated in the |sandbox|, see
4137 |sandbox-option|.
4138
4139 It is not allowed to change text or jump to another window while
4140 evaluating 'indentexpr' |textlock|.
4141
4142
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 *'indentkeys'* *'indk'*
4144'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4145 local to buffer
4146 {not in Vi}
4147 {not available when compiled without the |+cindent|
4148 feature}
4149 A list of keys that, when typed in Insert mode, cause reindenting of
4150 the current line. Only happens if 'indentexpr' isn't empty.
4151 The format is identical to 'cinkeys', see |indentkeys-format|.
4152 See |C-indenting| and |indent-expression|.
4153
4154 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4155'infercase' 'inf' boolean (default off)
4156 local to buffer
4157 {not in Vi}
4158 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004159 'ignorecase' is also on, the case of the match is adjusted depending
4160 on the typed text. If the typed text contains a lowercase letter
4161 where the match has an upper case letter, the completed part is made
4162 lowercase. If the typed text has no lowercase letters and the match
4163 has a lowercase letter where the typed text has an uppercase letter,
4164 and there is a letter before it, the completed part is made uppercase.
4165 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166
4167 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4168'insertmode' 'im' boolean (default off)
4169 global
4170 {not in Vi}
4171 Makes Vim work in a way that Insert mode is the default mode. Useful
4172 if you want to use Vim as a modeless editor. Used for |evim|.
4173 These Insert mode commands will be useful:
4174 - Use the cursor keys to move around.
4175 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4176 this is a mapping, it is executed as if 'insertmode' was off.
4177 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004179 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4180 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181
4182 These items change when 'insertmode' is set:
4183 - when starting to edit of a file, Vim goes to Insert mode.
4184 - <Esc> in Insert mode is a no-op and beeps.
4185 - <Esc> in Normal mode makes Vim go to Insert mode.
4186 - CTRL-L in Insert mode is a command, it is not inserted.
4187 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4188 However, when <Esc> is used inside a mapping, it behaves like
4189 'insertmode' was not set. This was done to be able to use the same
4190 mappings with 'insertmode' set or not set.
4191 When executing commands with |:normal| 'insertmode' is not used.
4192
4193 NOTE: This option is reset when 'compatible' is set.
4194
4195 *'isfname'* *'isf'*
4196'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4197 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4198 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4199 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4200 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4201 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4202 global
4203 {not in Vi}
4204 The characters specified by this option are included in file names and
4205 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004206 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 Multi-byte characters 256 and above are always included, only the
4208 characters up to 255 are specified with this option.
4209 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004210 Think twice before adding white space to this option. Although a
4211 space may appear inside a file name, the effect will be that Vim
4212 doesn't know where a file name starts or ends when doing completion.
4213 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214
4215 Note that on systems using a backslash as path separator, Vim tries to
4216 do its best to make it work as you would expect. That is a bit
4217 tricky, since Vi originally used the backslash to escape special
4218 characters. Vim will not remove a backslash in front of a normal file
4219 name character on these systems, but it will on Unix and alikes. The
4220 '&' and '^' are not included by default, because these are special for
4221 cmd.exe.
4222
4223 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004224 Each part can be a single character number or a range. A range is two
4225 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 decimal number between 0 and 255 or the ASCII character itself (does
4227 not work for digits). Example:
4228 "_,-,128-140,#-43" (include '_' and '-' and the range
4229 128 to 140 and '#' to 43)
4230 If a part starts with '^', the following character number or range
4231 will be excluded from the option. The option is interpreted from left
4232 to right. Put the excluded character after the range where it is
4233 included. To include '^' itself use it as the last character of the
4234 option or the end of a range. Example:
4235 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4236 If the character is '@', all characters where isalpha() returns TRUE
4237 are included. Normally these are the characters a to z and A to Z,
4238 plus accented characters. To include '@' itself use "@-@". Examples:
4239 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004240 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241 "a-z,A-Z,@-@" All letters plus the '@' character.
4242 A comma can be included by using it where a character number is
4243 expected. Example:
4244 "48-57,,,_" Digits, comma and underscore.
4245 A comma can be excluded by prepending a '^'. Example:
4246 " -~,^,,9" All characters from space to '~', excluding
4247 comma, plus <Tab>.
4248 See |option-backslash| about including spaces and backslashes.
4249
4250 *'isident'* *'isi'*
4251'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4252 "@,48-57,_,128-167,224-235"
4253 otherwise: "@,48-57,_,192-255")
4254 global
4255 {not in Vi}
4256 The characters given by this option are included in identifiers.
4257 Identifiers are used in recognizing environment variables and after a
4258 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004259 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 option.
4261 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004262 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4264
4265 *'iskeyword'* *'isk'*
4266'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4267 "@,48-57,_,128-167,224-235"
4268 otherwise: "@,48-57,_,192-255"
4269 Vi default: "@,48-57,_")
4270 local to buffer
4271 {not in Vi}
4272 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004273 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 'isfname' for a description of the format of this option. For C
4275 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4276 For a help file it is set to all non-blank printable characters except
4277 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4278 command).
4279 When the 'lisp' option is on the '-' character is always included.
4280 NOTE: This option is set to the Vi default value when 'compatible' is
4281 set and to the Vim default value when 'compatible' is reset.
4282
4283 *'isprint'* *'isp'*
4284'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4285 "@,~-255"; otherwise: "@,161-255")
4286 global
4287 {not in Vi}
4288 The characters given by this option are displayed directly on the
4289 screen. It is also used for "\p" in a |pattern|. The characters from
4290 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4291 even when they are not included in 'isprint' or excluded. See
4292 'isfname' for a description of the format of this option.
4293
4294 Non-printable characters are displayed with two characters:
4295 0 - 31 "^@" - "^_"
4296 32 - 126 always single characters
4297 127 "^?"
4298 128 - 159 "~@" - "~_"
4299 160 - 254 "| " - "|~"
4300 255 "~?"
4301 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4302 displayed as <xx>, with the hexadecimal value of the byte.
4303 When 'display' contains "uhex" all unprintable characters are
4304 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004305 The SpecialKey highlighting will be used for unprintable characters.
4306 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307
4308 Multi-byte characters 256 and above are always included, only the
4309 characters up to 255 are specified with this option. When a character
4310 is printable but it is not available in the current font, a
4311 replacement character will be shown.
4312 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4313 There is no option to specify these characters.
4314
4315 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4316'joinspaces' 'js' boolean (default on)
4317 global
4318 {not in Vi}
4319 Insert two spaces after a '.', '?' and '!' with a join command.
4320 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4321 Otherwise only one space is inserted.
4322 NOTE: This option is set when 'compatible' is set.
4323
4324 *'key'*
4325'key' string (default "")
4326 local to buffer
4327 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004328 {only available when compiled with the |+cryptv|
4329 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004331 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 Careful: Do not set the key value by hand, someone might see the typed
4333 key. Use the |:X| command. But you can make 'key' empty: >
4334 :set key=
4335< It is not possible to get the value of this option with ":set key" or
4336 "echo &key". This is to avoid showing it to someone who shouldn't
4337 know. It also means you cannot see it yourself once you have set it,
4338 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004339 You can use "&key" in an expression to detect whether encryption is
4340 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341
4342 *'keymap'* *'kmp'* *E544*
4343'keymap' 'kmp' string (default "")
4344 local to buffer
4345 {not in Vi}
4346 {only available when compiled with the |+keymap|
4347 feature}
4348 Name of a keyboard mapping. See |mbyte-keymap|.
4349 Setting this option to a valid keymap name has the side effect of
4350 setting 'iminsert' to one, so that the keymap becomes effective.
4351 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004352 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353
4354 *'keymodel'* *'km'*
4355'keymodel' 'km' string (default "")
4356 global
4357 {not in Vi}
4358 List of comma separated words, which enable special things that keys
4359 can do. These values can be used:
4360 startsel Using a shifted special key starts selection (either
4361 Select mode or Visual mode, depending on "key" being
4362 present in 'selectmode').
4363 stopsel Using a not-shifted special key stops selection.
4364 Special keys in this context are the cursor keys, <End>, <Home>,
4365 <PageUp> and <PageDown>.
4366 The 'keymodel' option is set by the |:behave| command.
4367
4368 *'keywordprg'* *'kp'*
4369'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4370 OS/2: "view /", VMS: "help")
4371 global or local to buffer |global-local|
4372 {not in Vi}
4373 Program to use for the |K| command. Environment variables are
4374 expanded |:set_env|. ":help" may be used to access the Vim internal
4375 help. (Note that previously setting the global option to the empty
4376 value did this, which is now deprecated.)
4377 When "man" is used, Vim will automatically translate a count for the
4378 "K" command to a section number. Also for "man -s", in which case the
4379 "-s" is removed when there is no count.
4380 See |option-backslash| about including spaces and backslashes.
4381 Example: >
4382 :set keywordprg=man\ -s
4383< This option cannot be set from a |modeline| or in the |sandbox|, for
4384 security reasons.
4385
4386 *'langmap'* *'lmap'* *E357* *E358*
4387'langmap' 'lmap' string (default "")
4388 global
4389 {not in Vi}
4390 {only available when compiled with the |+langmap|
4391 feature}
4392 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004393 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 inserted directly. When in command mode the 'langmap' option takes
4395 care of translating these special characters to the original meaning
4396 of the key. This means you don't have to change the keyboard mode to
4397 be able to execute Normal mode commands.
4398 This is the opposite of the 'keymap' option, where characters are
4399 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004401 Example (for Greek, in UTF-8): *greek* >
4402 :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 +00004403< Example (exchanges meaning of z and y for commands): >
4404 :set langmap=zy,yz,ZY,YZ
4405<
4406 The 'langmap' option is a list of parts, separated with commas. Each
4407 part can be in one of two forms:
4408 1. A list of pairs. Each pair is a "from" character immediately
4409 followed by the "to" character. Examples: "aA", "aAbBcC".
4410 2. A list of "from" characters, a semi-colon and a list of "to"
4411 characters. Example: "abc;ABC"
4412 Example: "aA,fgh;FGH,cCdDeE"
4413 Special characters need to be preceded with a backslash. These are
4414 ";", ',' and backslash itself.
4415
4416 This will allow you to activate vim actions without having to switch
4417 back and forth between the languages. Your language characters will
4418 be understood as normal vim English characters (according to the
4419 langmap mappings) in the following cases:
4420 o Normal/Visual mode (commands, buffer/register names, user mappings)
4421 o Insert/Replace Mode: Register names after CTRL-R
4422 o Insert/Replace Mode: Mappings
4423 Characters entered in Command-line mode will NOT be affected by
4424 this option. Note that this option can be changed at any time
4425 allowing to switch between mappings for different languages/encodings.
4426 Use a mapping to avoid having to type it each time!
4427
4428 *'langmenu'* *'lm'*
4429'langmenu' 'lm' string (default "")
4430 global
4431 {not in Vi}
4432 {only available when compiled with the |+menu| and
4433 |+multi_lang| features}
4434 Language to use for menu translation. Tells which file is loaded
4435 from the "lang" directory in 'runtimepath': >
4436 "lang/menu_" . &langmenu . ".vim"
4437< (without the spaces). For example, to always use the Dutch menus, no
4438 matter what $LANG is set to: >
4439 :set langmenu=nl_NL.ISO_8859-1
4440< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004441 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 If your $LANG is set to a non-English language but you do want to use
4443 the English menus: >
4444 :set langmenu=none
4445< This option must be set before loading menus, switching on filetype
4446 detection or syntax highlighting. Once the menus are defined setting
4447 this option has no effect. But you could do this: >
4448 :source $VIMRUNTIME/delmenu.vim
4449 :set langmenu=de_DE.ISO_8859-1
4450 :source $VIMRUNTIME/menu.vim
4451< Warning: This deletes all menus that you defined yourself!
4452
4453 *'laststatus'* *'ls'*
4454'laststatus' 'ls' number (default 1)
4455 global
4456 {not in Vi}
4457 The value of this option influences when the last window will have a
4458 status line:
4459 0: never
4460 1: only if there are at least two windows
4461 2: always
4462 The screen looks nicer with a status line if you have several
4463 windows, but it takes another screen line. |status-line|
4464
4465 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4466'lazyredraw' 'lz' boolean (default off)
4467 global
4468 {not in Vi}
4469 When this option is set, the screen will not be redrawn while
4470 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004471 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 update use |:redraw|.
4473
4474 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4475'linebreak' 'lbr' boolean (default off)
4476 local to window
4477 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004478 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 feature}
4480 If on Vim will wrap long lines at a character in 'breakat' rather
4481 than at the last character that fits on the screen. Unlike
4482 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4483 it only affects the way the file is displayed, not its contents. The
4484 value of 'showbreak' is used to put in front of wrapped lines.
4485 This option is not used when the 'wrap' option is off or 'list' is on.
4486 Note that <Tab> characters after an <EOL> are mostly not displayed
4487 with the right amount of white space.
4488
4489 *'lines'* *E593*
4490'lines' number (default 24 or terminal height)
4491 global
4492 Number of lines of the Vim window.
4493 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004494 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 When Vim is running in the GUI or in a resizable window, setting this
4496 option will cause the window size to be changed. When you only want
4497 to use the size for the GUI, put the command in your |gvimrc| file.
4498 Vim limits the number of lines to what fits on the screen. You can
4499 use this command to get the tallest window possible: >
4500 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004501< Minimum value is 2, maximum value is 1000.
4502 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 When you set this option and Vim is unable to change the physical
4504 number of lines of the display, the display may be messed up.
4505
4506 *'linespace'* *'lsp'*
4507'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4508 global
4509 {not in Vi}
4510 {only in the GUI}
4511 Number of pixel lines inserted between characters. Useful if the font
4512 uses the full character cell height, making lines touch each other.
4513 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004514 With some fonts there can be too much room between lines (to have
4515 space for ascents and descents). Then it makes sense to set
4516 'linespace' to a negative value. This may cause display problems
4517 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518
4519 *'lisp'* *'nolisp'*
4520'lisp' boolean (default off)
4521 local to buffer
4522 {not available when compiled without the |+lispindent|
4523 feature}
4524 Lisp mode: When <Enter> is typed in insert mode set the indent for
4525 the next line to Lisp standards (well, sort of). Also happens with
4526 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4527 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4528 better. Also see 'lispwords'.
4529 The '-' character is included in keyword characters. Redefines the
4530 "=" operator to use this same indentation algorithm rather than
4531 calling an external program if 'equalprg' is empty.
4532 This option is not used when 'paste' is set.
4533 {Vi: Does it a little bit differently}
4534
4535 *'lispwords'* *'lw'*
4536'lispwords' 'lw' string (default is very long)
4537 global
4538 {not in Vi}
4539 {not available when compiled without the |+lispindent|
4540 feature}
4541 Comma separated list of words that influence the Lisp indenting.
4542 |'lisp'|
4543
4544 *'list'* *'nolist'*
4545'list' boolean (default off)
4546 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004547 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4548 line. Useful to see the difference between tabs and spaces and for
4549 trailing blanks. Further changed by the 'listchars' option.
4550
4551 The cursor is displayed at the start of the space a Tab character
4552 occupies, not at the end as usual in Normal mode. To get this cursor
4553 position while displaying Tabs with spaces, use: >
4554 :set list lcs=tab\ \
4555<
4556 Note that list mode will also affect formatting (set with 'textwidth'
4557 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 changing the way tabs are displayed.
4559
4560 *'listchars'* *'lcs'*
4561'listchars' 'lcs' string (default "eol:$")
4562 global
4563 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004564 Strings to use in 'list' mode and for the |:list| command. It is a
4565 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 eol:c Character to show at the end of each line. When
4567 omitted, there is no extra character at the end of the
4568 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004569 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004571 fill the space that the tab normally occupies.
4572 "tab:>-" will show a tab that takes four spaces as
4573 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004574 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 trailing spaces are blank.
4576 extends:c Character to show in the last column, when 'wrap' is
4577 off and the line continues beyond the right of the
4578 screen.
4579 precedes:c Character to show in the first column, when 'wrap'
4580 is off and there is text preceding the character
4581 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004582 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004583 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004584 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004585 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004587 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004589 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590
4591 Examples: >
4592 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004593 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 :set lcs=extends:>,precedes:<
4595< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004596 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004597 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598
4599 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4600'loadplugins' 'lpl' boolean (default on)
4601 global
4602 {not in Vi}
4603 When on the plugin scripts are loaded when starting up |load-plugins|.
4604 This option can be reset in your |vimrc| file to disable the loading
4605 of plugins.
4606 Note that using the "-u NONE" and "--noplugin" command line arguments
4607 reset this option. |-u| |--noplugin|
4608
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004609 *'macatsui'* *'nomacatsui'*
4610'macatsui' boolean (default on)
4611 global
4612 {only available in Mac GUI version}
4613 This is a workaround for when drawing doesn't work properly. When set
4614 and compiled with multi-byte support ATSUI text drawing is used. When
4615 not set ATSUI text drawing is not used. Switch this option off when
4616 you experience drawing problems. In a future version the problems may
4617 be solved and this option becomes obsolete. Therefore use this method
4618 to unset it: >
4619 if exists('&macatsui')
4620 set nomacatsui
4621 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004622< Another option to check if you have drawing problems is
4623 'termencoding'.
4624
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 *'magic'* *'nomagic'*
4626'magic' boolean (default on)
4627 global
4628 Changes the special characters that can be used in search patterns.
4629 See |pattern|.
4630 NOTE: To avoid portability problems with using patterns, always keep
4631 this option at the default "on". Only switch it off when working with
4632 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004633 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634
4635 *'makeef'* *'mef'*
4636'makeef' 'mef' string (default: "")
4637 global
4638 {not in Vi}
4639 {not available when compiled without the |+quickfix|
4640 feature}
4641 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4642 and the |:grep| command.
4643 When it is empty, an internally generated temp file will be used.
4644 When "##" is included, it is replaced by a number to make the name
4645 unique. This makes sure that the ":make" command doesn't overwrite an
4646 existing file.
4647 NOT used for the ":cf" command. See 'errorfile' for that.
4648 Environment variables are expanded |:set_env|.
4649 See |option-backslash| about including spaces and backslashes.
4650 This option cannot be set from a |modeline| or in the |sandbox|, for
4651 security reasons.
4652
4653 *'makeprg'* *'mp'*
4654'makeprg' 'mp' string (default "make", VMS: "MMS")
4655 global or local to buffer |global-local|
4656 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004657 Program to use for the ":make" command. See |:make_makeprg|.
4658 This option may contain '%' and '#' characters, which are expanded to
4659 the current and alternate file name. |:_%| |:_#|
4660 Environment variables are expanded |:set_env|. See |option-backslash|
4661 about including spaces and backslashes.
4662 Note that a '|' must be escaped twice: once for ":set" and once for
4663 the interpretation of a command. When you use a filter called
4664 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 :set makeprg=gmake\ \\\|\ myfilter
4666< The placeholder "$*" can be given (even multiple times) to specify
4667 where the arguments will be included, for example: >
4668 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4669< This option cannot be set from a |modeline| or in the |sandbox|, for
4670 security reasons.
4671
4672 *'matchpairs'* *'mps'*
4673'matchpairs' 'mps' string (default "(:),{:},[:]")
4674 local to buffer
4675 {not in Vi}
4676 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004677 other. Currently only single byte character pairs are allowed, and
4678 they must be different. The characters must be separated by a colon.
4679 The pairs must be separated by a comma. Example for including '<' and
4680 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 :set mps+=<:>
4682
4683< A more exotic example, to jump between the '=' and ';' in an
4684 assignment, useful for languages like C and Java: >
4685 :au FileType c,cpp,java set mps+==:;
4686
4687< For a more advanced way of using "%", see the matchit.vim plugin in
4688 the $VIMRUNTIME/macros directory. |add-local-help|
4689
4690 *'matchtime'* *'mat'*
4691'matchtime' 'mat' number (default 5)
4692 global
4693 {not in Vi}{in Nvi}
4694 Tenths of a second to show the matching paren, when 'showmatch' is
4695 set. Note that this is not in milliseconds, like other options that
4696 set a time. This is to be compatible with Nvi.
4697
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004698 *'maxcombine'* *'mco'*
4699'maxcombine' 'mco' number (default 2)
4700 global
4701 {not in Vi}
4702 {only available when compiled with the |+multi_byte|
4703 feature}
4704 The maximum number of combining characters supported for displaying.
4705 Only used when 'encoding' is "utf-8".
4706 The default is OK for most languages. Hebrew may require 4.
4707 Maximum value is 6.
4708 Even when this option is set to 2 you can still edit text with more
4709 combining characters, you just can't see them. Use |g8| or |ga|.
4710 See |mbyte-combining|.
4711
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 *'maxfuncdepth'* *'mfd'*
4713'maxfuncdepth' 'mfd' number (default 100)
4714 global
4715 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004716 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004717 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 Maximum depth of function calls for user functions. This normally
4719 catches endless recursion. When using a recursive function with
4720 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4721 more memory, there is the danger of failing when memory is exhausted.
4722 See also |:function|.
4723
4724 *'maxmapdepth'* *'mmd'* *E223*
4725'maxmapdepth' 'mmd' number (default 1000)
4726 global
4727 {not in Vi}
4728 Maximum number of times a mapping is done without resulting in a
4729 character to be used. This normally catches endless mappings, like
4730 ":map x y" with ":map y x". It still does not catch ":map g wg",
4731 because the 'w' is used before the next mapping is done. See also
4732 |key-mapping|.
4733
4734 *'maxmem'* *'mm'*
4735'maxmem' 'mm' number (default between 256 to 5120 (system
4736 dependent) or half the amount of memory
4737 available)
4738 global
4739 {not in Vi}
4740 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4741 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004742 other memory to be freed. The maximum usable value is about 2000000.
4743 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004745 *'maxmempattern'* *'mmp'*
4746'maxmempattern' 'mmp' number (default 1000)
4747 global
4748 {not in Vi}
4749 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004750 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004751 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004752 When Vim runs into the limit it gives an error message and mostly
4753 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004754 Running into the limit often means that the pattern is very
4755 inefficient or too complex. This may already happen with the pattern
4756 "\(.\)*" on a very long line. ".*" works much better.
4757 Vim may run out of memory before hitting the 'maxmempattern' limit.
4758
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 *'maxmemtot'* *'mmt'*
4760'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4761 dependent) or half the amount of memory
4762 available)
4763 global
4764 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004765 Maximum amount of memory in Kbyte to use for all buffers together.
4766 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4767 without a limit. On 64 bit machines higher values might work. But
4768 hey, do you really need more than 2 Gbyte for text editing?
4769 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770
4771 *'menuitems'* *'mis'*
4772'menuitems' 'mis' number (default 25)
4773 global
4774 {not in Vi}
4775 {not available when compiled without the |+menu|
4776 feature}
4777 Maximum number of items to use in a menu. Used for menus that are
4778 generated from a list of items, e.g., the Buffers menu. Changing this
4779 option has no direct effect, the menu must be refreshed first.
4780
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004781 *'mkspellmem'* *'msm'*
4782'mkspellmem' 'msm' string (default "460000,2000,500")
4783 global
4784 {not in Vi}
4785 {not available when compiled without the |+syntax|
4786 feature}
4787 Parameters for |:mkspell|. This tunes when to start compressing the
4788 word tree. Compression can be slow when there are many words, but
4789 it's needed to avoid running out of memory. The amount of memory used
4790 per word depends very much on how similar the words are, that's why
4791 this tuning is complicated.
4792
4793 There are three numbers, separated by commas:
4794 {start},{inc},{added}
4795
4796 For most languages the uncompressed word tree fits in memory. {start}
4797 gives the amount of memory in Kbyte that can be used before any
4798 compression is done. It should be a bit smaller than the amount of
4799 memory that is available to Vim.
4800
4801 When going over the {start} limit the {inc} number specifies the
4802 amount of memory in Kbyte that can be allocated before another
4803 compression is done. A low number means compression is done after
4804 less words are added, which is slow. A high number means more memory
4805 will be allocated.
4806
4807 After doing compression, {added} times 1024 words can be added before
4808 the {inc} limit is ignored and compression is done when any extra
4809 amount of memory is needed. A low number means there is a smaller
4810 chance of hitting the {inc} limit, less memory is used but it's
4811 slower.
4812
4813 The languages for which these numbers are important are Italian and
4814 Hungarian. The default works for when you have about 512 Mbyte. If
4815 you have 1 Gbyte you could use: >
4816 :set mkspellmem=900000,3000,800
4817< If you have less than 512 Mbyte |:mkspell| may fail for some
4818 languages, no matter what you set 'mkspellmem' to.
4819
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004821'modeline' 'ml' boolean (Vim default: on (off for root),
4822 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 local to buffer
4824 *'modelines'* *'mls'*
4825'modelines' 'mls' number (default 5)
4826 global
4827 {not in Vi}
4828 If 'modeline' is on 'modelines' gives the number of lines that is
4829 checked for set commands. If 'modeline' is off or 'modelines' is zero
4830 no lines are checked. See |modeline|.
4831 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4832 set and to the Vim default value when 'compatible' is reset.
4833
4834 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4835'modifiable' 'ma' boolean (default on)
4836 local to buffer
4837 {not in Vi} *E21*
4838 When off the buffer contents cannot be changed. The 'fileformat' and
4839 'fileencoding' options also can't be changed.
4840 Can be reset with the |-M| command line argument.
4841
4842 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4843'modified' 'mod' boolean (default off)
4844 local to buffer
4845 {not in Vi}
4846 When on, the buffer is considered to be modified. This option is set
4847 when:
4848 1. A change was made to the text since it was last written. Using the
4849 |undo| command to go back to the original text will reset the
4850 option. But undoing changes that were made before writing the
4851 buffer will set the option again, since the text is different from
4852 when it was written.
4853 2. 'fileformat' or 'fileencoding' is different from its original
4854 value. The original value is set when the buffer is read or
4855 written. A ":set nomodified" command also resets the original
4856 values to the current values and the 'modified' option will be
4857 reset.
4858 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4859 will be ignored.
4860
4861 *'more'* *'nomore'*
4862'more' boolean (Vim default: on, Vi default: off)
4863 global
4864 {not in Vi}
4865 When on, listings pause when the whole screen is filled. You will get
4866 the |more-prompt|. When this option is off there are no pauses, the
4867 listing continues until finished.
4868 NOTE: This option is set to the Vi default value when 'compatible' is
4869 set and to the Vim default value when 'compatible' is reset.
4870
4871 *'mouse'* *E538*
4872'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4873 global
4874 {not in Vi}
4875 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004876 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4877 sysmouse and Linux console with gpm). For using the mouse in the
4878 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 The mouse can be enabled for different modes:
4880 n Normal mode
4881 v Visual mode
4882 i Insert mode
4883 c Command-line mode
4884 h all previous modes when editing a help file
4885 a all previous modes
4886 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 Normally you would enable the mouse in all four modes with: >
4888 :set mouse=a
4889< When the mouse is not enabled, the GUI will still use the mouse for
4890 modeless selection. This doesn't move the text cursor.
4891
4892 See |mouse-using|. Also see |'clipboard'|.
4893
4894 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004895 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 the mouse buttons can still be used by keeping the shift key pressed.
4897 Also see the 'clipboard' option.
4898
4899 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4900'mousefocus' 'mousef' boolean (default off)
4901 global
4902 {not in Vi}
4903 {only works in the GUI}
4904 The window that the mouse pointer is on is automatically activated.
4905 When changing the window layout or window focus in another way, the
4906 mouse pointer is moved to the window with keyboard focus. Off is the
4907 default because it makes using the pull down menus a little goofy, as
4908 a pointer transit may activate a window unintentionally.
4909
4910 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4911'mousehide' 'mh' boolean (default on)
4912 global
4913 {not in Vi}
4914 {only works in the GUI}
4915 When on, the mouse pointer is hidden when characters are typed.
4916 The mouse pointer is restored when the mouse is moved.
4917
4918 *'mousemodel'* *'mousem'*
4919'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4920 global
4921 {not in Vi}
4922 Sets the model to use for the mouse. The name mostly specifies what
4923 the right mouse button is used for:
4924 extend Right mouse button extends a selection. This works
4925 like in an xterm.
4926 popup Right mouse button pops up a menu. The shifted left
4927 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004928 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 popup_setpos Like "popup", but the cursor will be moved to the
4930 position where the mouse was clicked, and thus the
4931 selected operation will act upon the clicked object.
4932 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004933 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 course, that right clicking outside a selection will
4935 end Visual mode.
4936 Overview of what button does what for each model:
4937 mouse extend popup(_setpos) ~
4938 left click place cursor place cursor
4939 left drag start selection start selection
4940 shift-left search word extend selection
4941 right click extend selection popup menu (place cursor)
4942 right drag extend selection -
4943 middle click paste paste
4944
4945 In the "popup" model the right mouse button produces a pop-up menu.
4946 You need to define this first, see |popup-menu|.
4947
4948 Note that you can further refine the meaning of buttons with mappings.
4949 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4950 selection (because that's handled in the GUI code directly).
4951
4952 The 'mousemodel' option is set by the |:behave| command.
4953
4954 *'mouseshape'* *'mouses'* *E547*
4955'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004956 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 global
4958 {not in Vi}
4959 {only available when compiled with the |+mouseshape|
4960 feature}
4961 This option tells Vim what the mouse pointer should look like in
4962 different modes. The option is a comma separated list of parts, much
4963 like used for 'guicursor'. Each part consist of a mode/location-list
4964 and an argument-list:
4965 mode-list:shape,mode-list:shape,..
4966 The mode-list is a dash separated list of these modes/locations:
4967 In a normal window: ~
4968 n Normal mode
4969 v Visual mode
4970 ve Visual mode with 'selection' "exclusive" (same as 'v',
4971 if not specified)
4972 o Operator-pending mode
4973 i Insert mode
4974 r Replace mode
4975
4976 Others: ~
4977 c appending to the command-line
4978 ci inserting in the command-line
4979 cr replacing in the command-line
4980 m at the 'Hit ENTER' or 'More' prompts
4981 ml idem, but cursor in the last line
4982 e any mode, pointer below last window
4983 s any mode, pointer on a status line
4984 sd any mode, while dragging a status line
4985 vs any mode, pointer on a vertical separator line
4986 vd any mode, while dragging a vertical separator line
4987 a everywhere
4988
4989 The shape is one of the following:
4990 avail name looks like ~
4991 w x arrow Normal mouse pointer
4992 w x blank no pointer at all (use with care!)
4993 w x beam I-beam
4994 w x updown up-down sizing arrows
4995 w x leftright left-right sizing arrows
4996 w x busy The system's usual busy pointer
4997 w x no The system's usual 'no input' pointer
4998 x udsizing indicates up-down resizing
4999 x lrsizing indicates left-right resizing
5000 x crosshair like a big thin +
5001 x hand1 black hand
5002 x hand2 white hand
5003 x pencil what you write with
5004 x question big ?
5005 x rightup-arrow arrow pointing right-up
5006 w x up-arrow arrow pointing up
5007 x <number> any X11 pointer number (see X11/cursorfont.h)
5008
5009 The "avail" column contains a 'w' if the shape is available for Win32,
5010 x for X11.
5011 Any modes not specified or shapes not available use the normal mouse
5012 pointer.
5013
5014 Example: >
5015 :set mouseshape=s:udsizing,m:no
5016< will make the mouse turn to a sizing arrow over the status lines and
5017 indicate no input when the hit-enter prompt is displayed (since
5018 clicking the mouse has no effect in this state.)
5019
5020 *'mousetime'* *'mouset'*
5021'mousetime' 'mouset' number (default 500)
5022 global
5023 {not in Vi}
5024 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5025 time in msec between two mouse clicks for the second click to be
5026 recognized as a multi click.
5027
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005028 *'mzquantum'* *'mzq'*
5029'mzquantum' 'mzq' number (default 100)
5030 global
5031 {not in Vi}
5032 {not available when compiled without the |+mzscheme|
5033 feature}
5034 The number of milliseconds between polls for MzScheme threads.
5035 Negative or zero value means no thread scheduling.
5036
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 *'nrformats'* *'nf'*
5038'nrformats' 'nf' string (default "octal,hex")
5039 local to buffer
5040 {not in Vi}
5041 This defines what bases Vim will consider for numbers when using the
5042 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5043 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005044 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02005046 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005047 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005049 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 considered to be hexadecimal. Example: Using CTRL-X on
5051 "0x100" results in "0x0ff".
5052 Numbers which simply begin with a digit in the range 1-9 are always
5053 considered decimal. This also happens for numbers that are not
5054 recognized as octal or hex.
5055
5056 *'number'* *'nu'* *'nonumber'* *'nonu'*
5057'number' 'nu' boolean (default off)
5058 local to window
5059 Print the line number in front of each line. When the 'n' option is
5060 excluded from 'cpoptions' a wrapped line will not use the column of
5061 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005062 The 'numberwidth' option can be used to set the room used for the line
5063 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 When a long, wrapped line doesn't start with the first character, '-'
5065 characters are put before the number.
5066 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005067 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005069 *'numberwidth'* *'nuw'*
5070'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5071 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005072 {not in Vi}
5073 {only available when compiled with the |+linebreak|
5074 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005075 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005076 when the 'number' or 'relativenumber' option is set or printing lines
5077 with a line number. Since one space is always between the number and
5078 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005079 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005080 fit the highest line number in the buffer respectively the number of
5081 rows in the window, depending on whether 'number' or 'relativenumber'
5082 is set. Thus with the Vim default of 4 there is room for a line number
5083 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005084 The minimum value is 1, the maximum value is 10.
5085 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5086
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005087 *'omnifunc'* *'ofu'*
5088'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005089 local to buffer
5090 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005091 {not available when compiled without the |+eval|
5092 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005093 This option specifies a function to be used for Insert mode omni
5094 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005095 See |complete-functions| for an explanation of how the function is
5096 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005097 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005098 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005099
5100
Bram Moolenaar02467872007-05-06 13:22:01 +00005101 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005102'opendevice' 'odev' boolean (default off)
5103 global
5104 {not in Vi}
5105 {only for MS-DOS, MS-Windows and OS/2}
5106 Enable reading and writing from devices. This may get Vim stuck on a
5107 device that can be opened but doesn't actually do the I/O. Therefore
5108 it is off by default.
5109 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5110 result in editing a device.
5111
5112
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005113 *'operatorfunc'* *'opfunc'*
5114'operatorfunc' 'opfunc' string (default: empty)
5115 global
5116 {not in Vi}
5117 This option specifies a function to be called by the |g@| operator.
5118 See |:map-operator| for more info and an example.
5119
5120 This option cannot be set from a |modeline| or in the |sandbox|, for
5121 security reasons.
5122
5123
Bram Moolenaar251e1912011-06-19 05:09:16 +02005124 *'osfiletype'* *'oft'*
5125'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 local to buffer
5127 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005128 This option was supported on RISC OS, which has been removed.
5129
Bram Moolenaar071d4272004-06-13 20:20:40 +00005130
5131 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005132'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 global
5134 Specifies the nroff macros that separate paragraphs. These are pairs
5135 of two letters (see |object-motions|).
5136
5137 *'paste'* *'nopaste'*
5138'paste' boolean (default off)
5139 global
5140 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005141 Put Vim in Paste mode. This is useful if you want to cut or copy
5142 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 unexpected effects.
5144 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005145 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146 knows about pasting and will mostly do the right thing without 'paste'
5147 being set. The same is true for a terminal where Vim handles the
5148 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005149 This option is reset when starting the GUI. Thus if you set it in
5150 your .vimrc it will work in a terminal, but not in the GUI. Setting
5151 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5152 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 When the 'paste' option is switched on (also when it was already on):
5154 - mapping in Insert mode and Command-line mode is disabled
5155 - abbreviations are disabled
5156 - 'textwidth' is set to 0
5157 - 'wrapmargin' is set to 0
5158 - 'autoindent' is reset
5159 - 'smartindent' is reset
5160 - 'softtabstop' is set to 0
5161 - 'revins' is reset
5162 - 'ruler' is reset
5163 - 'showmatch' is reset
5164 - 'formatoptions' is used like it is empty
5165 These options keep their value, but their effect is disabled:
5166 - 'lisp'
5167 - 'indentexpr'
5168 - 'cindent'
5169 NOTE: When you start editing another file while the 'paste' option is
5170 on, settings from the modelines or autocommands may change the
5171 settings again, causing trouble when pasting text. You might want to
5172 set the 'paste' option again.
5173 When the 'paste' option is reset the mentioned options are restored to
5174 the value before the moment 'paste' was switched from off to on.
5175 Resetting 'paste' before ever setting it does not have any effect.
5176 Since mapping doesn't work while 'paste' is active, you need to use
5177 the 'pastetoggle' option to toggle the 'paste' option with some key.
5178
5179 *'pastetoggle'* *'pt'*
5180'pastetoggle' 'pt' string (default "")
5181 global
5182 {not in Vi}
5183 When non-empty, specifies the key sequence that toggles the 'paste'
5184 option. This is like specifying a mapping: >
5185 :map {keys} :set invpaste<CR>
5186< Where {keys} is the value of 'pastetoggle'.
5187 The difference is that it will work even when 'paste' is set.
5188 'pastetoggle' works in Insert mode and Normal mode, but not in
5189 Command-line mode.
5190 Mappings are checked first, thus overrule 'pastetoggle'. However,
5191 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5192 this: >
5193 :map <F10> :set paste<CR>
5194 :map <F11> :set nopaste<CR>
5195 :imap <F10> <C-O>:set paste<CR>
5196 :imap <F11> <nop>
5197 :set pastetoggle=<F11>
5198< This will make <F10> start paste mode and <F11> stop paste mode.
5199 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5200 mode everything is inserted literally, except the 'pastetoggle' key
5201 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005202 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203
5204 *'pex'* *'patchexpr'*
5205'patchexpr' 'pex' string (default "")
5206 global
5207 {not in Vi}
5208 {not available when compiled without the |+diff|
5209 feature}
5210 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005211 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212
5213 *'patchmode'* *'pm'* *E206*
5214'patchmode' 'pm' string (default "")
5215 global
5216 {not in Vi}
5217 When non-empty the oldest version of a file is kept. This can be used
5218 to keep the original version of a file if you are changing files in a
5219 source distribution. Only the first time that a file is written a
5220 copy of the original file will be kept. The name of the copy is the
5221 name of the original file with the string in the 'patchmode' option
5222 appended. This option should start with a dot. Use a string like
5223 ".org". 'backupdir' must not be empty for this to work (Detail: The
5224 backup file is renamed to the patchmode file after the new file has
5225 been successfully written, that's why it must be possible to write a
5226 backup file). If there was no file to be backed up, an empty file is
5227 created.
5228 When the 'backupskip' pattern matches, a patchmode file is not made.
5229 Using 'patchmode' for compressed files appends the extension at the
5230 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5231 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005232 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233
5234 *'path'* *'pa'* *E343* *E345* *E347*
5235'path' 'pa' string (default on Unix: ".,/usr/include,,"
5236 on OS/2: ".,/emx/include,,"
5237 other systems: ".,,")
5238 global or local to buffer |global-local|
5239 {not in Vi}
5240 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005241 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5242 provided that the file being searched for has a relative path (not
5243 starting with "/", "./" or "../"). The directories in the 'path'
5244 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 - Use commas to separate directory names: >
5246 :set path=.,/usr/local/include,/usr/include
5247< - Spaces can also be used to separate directory names (for backwards
5248 compatibility with version 3.0). To have a space in a directory
5249 name, precede it with an extra backslash, and escape the space: >
5250 :set path=.,/dir/with\\\ space
5251< - To include a comma in a directory name precede it with an extra
5252 backslash: >
5253 :set path=.,/dir/with\\,comma
5254< - To search relative to the directory of the current file, use: >
5255 :set path=.
5256< - To search in the current directory use an empty string between two
5257 commas: >
5258 :set path=,,
5259< - A directory name may end in a ':' or '/'.
5260 - Environment variables are expanded |:set_env|.
5261 - When using |netrw.vim| URLs can be used. For example, adding
5262 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005263 - Search upwards and downwards in a directory tree using "*", "**" and
5264 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 {not available when compiled without the |+path_extra| feature}
5266 - Careful with '\' characters, type two to get one in the option: >
5267 :set path=.,c:\\include
5268< Or just use '/' instead: >
5269 :set path=.,c:/include
5270< Don't forget "." or files won't even be found in the same directory as
5271 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005272 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 it is something like 256 or 1024 characters.
5274 You can check if all the include files are found, using the value of
5275 'path', see |:checkpath|.
5276 The use of |:set+=| and |:set-=| is preferred when adding or removing
5277 directories from the list. This avoids problems when a future version
5278 uses another default. To remove the current directory use: >
5279 :set path-=
5280< To add the current directory use: >
5281 :set path+=
5282< To use an environment variable, you probably need to replace the
5283 separator. Here is an example to append $INCL, in which directory
5284 names are separated with a semi-colon: >
5285 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5286< Replace the ';' with a ':' or whatever separator is used. Note that
5287 this doesn't work when $INCL contains a comma or white space.
5288
5289 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5290'preserveindent' 'pi' boolean (default off)
5291 local to buffer
5292 {not in Vi}
5293 When changing the indent of the current line, preserve as much of the
5294 indent structure as possible. Normally the indent is replaced by a
5295 series of tabs followed by spaces as required (unless |'expandtab'| is
5296 enabled, in which case only spaces are used). Enabling this option
5297 means the indent will preserve as many existing characters as possible
5298 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005299 'expandtab' does not apply to the preserved white space, a Tab remains
5300 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 NOTE: When using ">>" multiple times the resulting indent is a mix of
5302 tabs and spaces. You might not like this.
5303 NOTE: 'preserveindent' is reset when 'compatible' is set.
5304 Also see 'copyindent'.
5305 Use |:retab| to clean up white space.
5306
5307 *'previewheight'* *'pvh'*
5308'previewheight' 'pvh' number (default 12)
5309 global
5310 {not in Vi}
5311 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005312 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 Default height for a preview window. Used for |:ptag| and associated
5314 commands. Used for |CTRL-W_}| when no count is given.
5315
5316 *'previewwindow'* *'nopreviewwindow'*
5317 *'pvw'* *'nopvw'* *E590*
5318'previewwindow' 'pvw' boolean (default off)
5319 local to window
5320 {not in Vi}
5321 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005322 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005323 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 set. It's normally not set directly, but by using one of the commands
5325 |:ptag|, |:pedit|, etc.
5326
5327 *'printdevice'* *'pdev'*
5328'printdevice' 'pdev' string (default empty)
5329 global
5330 {not in Vi}
5331 {only available when compiled with the |+printer|
5332 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005333 The name of the printer to be used for |:hardcopy|.
5334 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005335 This option cannot be set from a |modeline| or in the |sandbox|, for
5336 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337
Bram Moolenaar8299df92004-07-10 09:47:34 +00005338 *'printencoding'* *'penc'*
5339'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 global
5341 {not in Vi}
5342 {only available when compiled with the |+printer|
5343 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005344 Sets the character encoding used when printing.
5345 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346
5347 *'printexpr'* *'pexpr'*
5348'printexpr' 'pexpr' String (default: see below)
5349 global
5350 {not in Vi}
5351 {only available when compiled with the |+printer|
5352 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005353 Expression used to print the PostScript produced with |:hardcopy|.
5354 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355
Bram Moolenaar8299df92004-07-10 09:47:34 +00005356 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357'printfont' 'pfn' string (default "courier")
5358 global
5359 {not in Vi}
5360 {only available when compiled with the |+printer|
5361 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005362 The name of the font that will be used for |:hardcopy|.
5363 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364
5365 *'printheader'* *'pheader'*
5366'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5367 global
5368 {not in Vi}
5369 {only available when compiled with the |+printer|
5370 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005371 The format of the header produced in |:hardcopy| output.
5372 See |pheader-option|.
5373
5374 *'printmbcharset'* *'pmbcs'*
5375'printmbcharset' 'pmbcs' string (default "")
5376 global
5377 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005378 {only available when compiled with the |+printer|,
5379 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005380 The CJK character set to be used for CJK output from |:hardcopy|.
5381 See |pmbcs-option|.
5382
5383 *'printmbfont'* *'pmbfn'*
5384'printmbfont' 'pmbfn' string (default "")
5385 global
5386 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005387 {only available when compiled with the |+printer|,
5388 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005389 List of font names to be used for CJK output from |:hardcopy|.
5390 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391
5392 *'printoptions'* *'popt'*
5393'printoptions' 'popt' string (default "")
5394 global
5395 {not in Vi}
5396 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005397 List of items that control the format of the output of |:hardcopy|.
5398 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005400 *'prompt'* *'noprompt'*
5401'prompt' boolean (default on)
5402 global
5403 When on a ":" prompt is used in Ex mode.
5404
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005405 *'pumheight'* *'ph'*
5406'pumheight' 'ph' number (default 0)
5407 global
5408 {not available when compiled without the
5409 |+insert_expand| feature}
5410 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005411 Determines the maximum number of items to show in the popup menu for
5412 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005413 |ins-completion-menu|.
5414
5415
Bram Moolenaar677ee682005-01-27 14:41:15 +00005416 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005417'quoteescape' 'qe' string (default "\")
5418 local to buffer
5419 {not in Vi}
5420 The characters that are used to escape quotes in a string. Used for
5421 objects like a', a" and a` |a'|.
5422 When one of the characters in this option is found inside a string,
5423 the following character will be skipped. The default value makes the
5424 text "foo\"bar\\" considered to be one string.
5425
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5427'readonly' 'ro' boolean (default off)
5428 local to buffer
5429 If on, writes fail unless you use a '!'. Protects you from
5430 accidentally overwriting a file. Default on when Vim is started
5431 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005432 When using ":w!" the 'readonly' option is reset for the current
5433 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005435 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005437 *'redrawtime'* *'rdt'*
5438'redrawtime' 'rdt' number (default 2000)
5439 global
5440 {not in Vi}
5441 {only available when compiled with the |+reltime|
5442 feature}
5443 The time in milliseconds for redrawing the display. This applies to
5444 searching for patterns for 'hlsearch' and |:match| highlighting.
5445 When redrawing takes more than this many milliseconds no further
5446 matches will be highlighted. This is used to avoid that Vim hangs
5447 when using a very complicated pattern.
5448
Bram Moolenaar64486672010-05-16 15:46:46 +02005449 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5450'relativenumber' 'rnu' boolean (default off)
5451 local to window
5452 {not in Vi}
5453 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005454 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005455 precede some vertical motion commands (e.g. j k + -) with, without
5456 having to calculate it yourself. Especially useful in combination with
5457 other commands (e.g. y d c < > gq gw =).
5458 When the 'n' option is excluded from 'cpoptions' a wrapped
5459 line will not use the column of line numbers (this is the default when
5460 'compatible' isn't set).
5461 The 'numberwidth' option can be used to set the room used for the line
5462 number.
5463 When a long, wrapped line doesn't start with the first character, '-'
5464 characters are put before the number.
5465 See |hl-LineNr| for the highlighting used for the number.
5466 When setting this option, 'number' is reset.
5467
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 *'remap'* *'noremap'*
5469'remap' boolean (default on)
5470 global
5471 Allows for mappings to work recursively. If you do not want this for
5472 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005473 NOTE: To avoid portability problems with Vim scripts, always keep
5474 this option at the default "on". Only switch it off when working with
5475 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476
5477 *'report'*
5478'report' number (default 2)
5479 global
5480 Threshold for reporting number of lines changed. When the number of
5481 changed lines is more than 'report' a message will be given for most
5482 ":" commands. If you want it always, set 'report' to 0.
5483 For the ":substitute" command the number of substitutions is used
5484 instead of the number of lines.
5485
5486 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5487'restorescreen' 'rs' boolean (default on)
5488 global
5489 {not in Vi} {only in Windows 95/NT console version}
5490 When set, the screen contents is restored when exiting Vim. This also
5491 happens when executing external commands.
5492
5493 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5494 options in your .vimrc. To disable restoring:
5495 set t_ti= t_te=
5496 To enable restoring (for an xterm):
5497 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5498 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5499
5500 *'revins'* *'ri'* *'norevins'* *'nori'*
5501'revins' 'ri' boolean (default off)
5502 global
5503 {not in Vi}
5504 {only available when compiled with the |+rightleft|
5505 feature}
5506 Inserting characters in Insert mode will work backwards. See "typing
5507 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5508 command in Insert mode, when 'allowrevins' is set.
5509 NOTE: This option is reset when 'compatible' or 'paste' is set.
5510
5511 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5512'rightleft' 'rl' boolean (default off)
5513 local to window
5514 {not in Vi}
5515 {only available when compiled with the |+rightleft|
5516 feature}
5517 When on, display orientation becomes right-to-left, i.e., characters
5518 that are stored in the file appear from the right to the left.
5519 Using this option, it is possible to edit files for languages that
5520 are written from the right to the left such as Hebrew and Arabic.
5521 This option is per window, so it is possible to edit mixed files
5522 simultaneously, or to view the same file in both ways (this is
5523 useful whenever you have a mixed text file with both right-to-left
5524 and left-to-right strings so that both sets are displayed properly
5525 in different windows). Also see |rileft.txt|.
5526
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005527 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528'rightleftcmd' 'rlc' string (default "search")
5529 local to window
5530 {not in Vi}
5531 {only available when compiled with the |+rightleft|
5532 feature}
5533 Each word in this option enables the command line editing to work in
5534 right-to-left mode for a group of commands:
5535
5536 search "/" and "?" commands
5537
5538 This is useful for languages such as Hebrew, Arabic and Farsi.
5539 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5540
5541 *'ruler'* *'ru'* *'noruler'* *'noru'*
5542'ruler' 'ru' boolean (default off)
5543 global
5544 {not in Vi}
5545 {not available when compiled without the
5546 |+cmdline_info| feature}
5547 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005548 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 text in the file is shown on the far right:
5550 Top first line is visible
5551 Bot last line is visible
5552 All first and last line are visible
5553 45% relative position in the file
5554 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005555 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005557 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558 this option takes precedence over 'ruler' and 'rulerformat'
5559 If the number of characters displayed is different from the number of
5560 bytes in the text (e.g., for a TAB or a multi-byte character), both
5561 the text column (byte number) and the screen column are shown,
5562 separated with a dash.
5563 For an empty line "0-1" is shown.
5564 For an empty buffer the line number will also be zero: "0,0-1".
5565 This option is reset when the 'paste' option is set.
5566 If you don't want to see the ruler all the time but want to know where
5567 you are, use "g CTRL-G" |g_CTRL-G|.
5568 NOTE: This option is reset when 'compatible' is set.
5569
5570 *'rulerformat'* *'ruf'*
5571'rulerformat' 'ruf' string (default empty)
5572 global
5573 {not in Vi}
5574 {not available when compiled without the |+statusline|
5575 feature}
5576 When this option is not empty, it determines the content of the ruler
5577 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005578 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 The default ruler width is 17 characters. To make the ruler 15
5580 characters wide, put "%15(" at the start and "%)" at the end.
5581 Example: >
5582 :set rulerformat=%15(%c%V\ %p%%%)
5583<
5584 *'runtimepath'* *'rtp'* *vimfiles*
5585'runtimepath' 'rtp' string (default:
5586 Unix: "$HOME/.vim,
5587 $VIM/vimfiles,
5588 $VIMRUNTIME,
5589 $VIM/vimfiles/after,
5590 $HOME/.vim/after"
5591 Amiga: "home:vimfiles,
5592 $VIM/vimfiles,
5593 $VIMRUNTIME,
5594 $VIM/vimfiles/after,
5595 home:vimfiles/after"
5596 PC, OS/2: "$HOME/vimfiles,
5597 $VIM/vimfiles,
5598 $VIMRUNTIME,
5599 $VIM/vimfiles/after,
5600 $HOME/vimfiles/after"
5601 Macintosh: "$VIM:vimfiles,
5602 $VIMRUNTIME,
5603 $VIM:vimfiles:after"
5604 RISC-OS: "Choices:vimfiles,
5605 $VIMRUNTIME,
5606 Choices:vimfiles/after"
5607 VMS: "sys$login:vimfiles,
5608 $VIM/vimfiles,
5609 $VIMRUNTIME,
5610 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005611 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 global
5613 {not in Vi}
5614 This is a list of directories which will be searched for runtime
5615 files:
5616 filetype.vim filetypes by file name |new-filetype|
5617 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005618 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 colors/ color scheme files |:colorscheme|
5620 compiler/ compiler files |:compiler|
5621 doc/ documentation |write-local-help|
5622 ftplugin/ filetype plugins |write-filetype-plugin|
5623 indent/ indent scripts |indent-expression|
5624 keymap/ key mapping files |mbyte-keymap|
5625 lang/ menu translations |:menutrans|
5626 menu.vim GUI menus |menu.vim|
5627 plugin/ plugin scripts |write-plugin|
5628 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005629 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 syntax/ syntax files |mysyntaxfile|
5631 tutor/ files for vimtutor |tutor|
5632
5633 And any other file searched for with the |:runtime| command.
5634
5635 The defaults for most systems are setup to search five locations:
5636 1. In your home directory, for your personal preferences.
5637 2. In a system-wide Vim directory, for preferences from the system
5638 administrator.
5639 3. In $VIMRUNTIME, for files distributed with Vim.
5640 *after-directory*
5641 4. In the "after" directory in the system-wide Vim directory. This is
5642 for the system administrator to overrule or add to the distributed
5643 defaults (rarely needed)
5644 5. In the "after" directory in your home directory. This is for
5645 personal preferences to overrule or add to the distributed defaults
5646 or system-wide settings (rarely needed).
5647
5648 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5649 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005650 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005651 wildcards.
5652 See |:runtime|.
5653 Example: >
5654 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5655< This will use the directory "~/vimruntime" first (containing your
5656 personal Vim runtime files), then "/mygroup/vim" (shared between a
5657 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5658 files).
5659 You probably should always include $VIMRUNTIME somewhere, to use the
5660 distributed runtime files. You can put a directory before $VIMRUNTIME
5661 to find files which replace a distributed runtime files. You can put
5662 a directory after $VIMRUNTIME to find files which add to distributed
5663 runtime files.
5664 This option cannot be set from a |modeline| or in the |sandbox|, for
5665 security reasons.
5666
5667 *'scroll'* *'scr'*
5668'scroll' 'scr' number (default: half the window height)
5669 local to window
5670 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5671 set to half the number of lines in the window when the window size
5672 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005673 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5675 the number of screen lines instead of file lines, makes a difference
5676 when lines wrap}
5677
5678 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5679'scrollbind' 'scb' boolean (default off)
5680 local to window
5681 {not in Vi}
5682 {not available when compiled without the |+scrollbind|
5683 feature}
5684 See also |scroll-binding|. When this option is set, the current
5685 window scrolls as other scrollbind windows (windows that also have
5686 this option set) scroll. This option is useful for viewing the
5687 differences between two versions of a file, see 'diff'.
5688 See |'scrollopt'| for options that determine how this option should be
5689 interpreted.
5690 This option is mostly reset when splitting a window to edit another
5691 file. This means that ":split | edit file" results in two windows
5692 with scroll-binding, but ":split file" does not.
5693
5694 *'scrolljump'* *'sj'*
5695'scrolljump' 'sj' number (default 1)
5696 global
5697 {not in Vi}
5698 Minimal number of lines to scroll when the cursor gets off the
5699 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5700 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005701 When set to a negative number from -1 to -100 this is used as the
5702 percentage of the window height. Thus -50 scrolls half the window
5703 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 NOTE: This option is set to 1 when 'compatible' is set.
5705
5706 *'scrolloff'* *'so'*
5707'scrolloff' 'so' number (default 0)
5708 global
5709 {not in Vi}
5710 Minimal number of screen lines to keep above and below the cursor.
5711 This will make some context visible around where you are working. If
5712 you set it to a very large value (999) the cursor line will always be
5713 in the middle of the window (except at the start or end of the file or
5714 when long lines wrap).
5715 For scrolling horizontally see 'sidescrolloff'.
5716 NOTE: This option is set to 0 when 'compatible' is set.
5717
5718 *'scrollopt'* *'sbo'*
5719'scrollopt' 'sbo' string (default "ver,jump")
5720 global
5721 {not available when compiled without the |+scrollbind|
5722 feature}
5723 {not in Vi}
5724 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005725 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5726 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 The following words are available:
5728 ver Bind vertical scrolling for 'scrollbind' windows
5729 hor Bind horizontal scrolling for 'scrollbind' windows
5730 jump Applies to the offset between two windows for vertical
5731 scrolling. This offset is the difference in the first
5732 displayed line of the bound windows. When moving
5733 around in a window, another 'scrollbind' window may
5734 reach a position before the start or after the end of
5735 the buffer. The offset is not changed though, when
5736 moving back the 'scrollbind' window will try to scroll
5737 to the desired position when possible.
5738 When now making that window the current one, two
5739 things can be done with the relative offset:
5740 1. When "jump" is not included, the relative offset is
5741 adjusted for the scroll position in the new current
5742 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005743 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 2. When "jump" is included, the other windows are
5745 scrolled to keep the same relative offset. When
5746 going back to the other window, it still uses the
5747 same relative offset.
5748 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005749 When 'diff' mode is active there always is vertical scroll binding,
5750 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751
5752 *'sections'* *'sect'*
5753'sections' 'sect' string (default "SHNHH HUnhsh")
5754 global
5755 Specifies the nroff macros that separate sections. These are pairs of
5756 two letters (See |object-motions|). The default makes a section start
5757 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5758
5759 *'secure'* *'nosecure'* *E523*
5760'secure' boolean (default off)
5761 global
5762 {not in Vi}
5763 When on, ":autocmd", shell and write commands are not allowed in
5764 ".vimrc" and ".exrc" in the current directory and map commands are
5765 displayed. Switch it off only if you know that you will not run into
5766 problems, or when the 'exrc' option is off. On Unix this option is
5767 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005768 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 'secure' at the end of your ~/.vimrc then.
5770 This option cannot be set from a |modeline| or in the |sandbox|, for
5771 security reasons.
5772
5773 *'selection'* *'sel'*
5774'selection' 'sel' string (default "inclusive")
5775 global
5776 {not in Vi}
5777 This option defines the behavior of the selection. It is only used
5778 in Visual and Select mode.
5779 Possible values:
5780 value past line inclusive ~
5781 old no yes
5782 inclusive yes yes
5783 exclusive yes no
5784 "past line" means that the cursor is allowed to be positioned one
5785 character past the line.
5786 "inclusive" means that the last character of the selection is included
5787 in an operation. For example, when "x" is used to delete the
5788 selection.
5789 Note that when "exclusive" is used and selecting from the end
5790 backwards, you cannot include the last character of a line, when
5791 starting in Normal mode and 'virtualedit' empty.
5792
5793 The 'selection' option is set by the |:behave| command.
5794
5795 *'selectmode'* *'slm'*
5796'selectmode' 'slm' string (default "")
5797 global
5798 {not in Vi}
5799 This is a comma separated list of words, which specifies when to start
5800 Select mode instead of Visual mode, when a selection is started.
5801 Possible values:
5802 mouse when using the mouse
5803 key when using shifted special keys
5804 cmd when using "v", "V" or CTRL-V
5805 See |Select-mode|.
5806 The 'selectmode' option is set by the |:behave| command.
5807
5808 *'sessionoptions'* *'ssop'*
5809'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005810 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 global
5812 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005813 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 feature}
5815 Changes the effect of the |:mksession| command. It is a comma
5816 separated list of words. Each word enables saving and restoring
5817 something:
5818 word save and restore ~
5819 blank empty windows
5820 buffers hidden and unloaded buffers, not just those in windows
5821 curdir the current directory
5822 folds manually created folds, opened/closed folds and local
5823 fold options
5824 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005825 and contain at least one lowercase letter. Only
5826 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 help the help window
5828 localoptions options and mappings local to a window or buffer (not
5829 global values for local options)
5830 options all options and mappings (also global values for local
5831 options)
5832 resize size of the Vim window: 'lines' and 'columns'
5833 sesdir the directory in which the session file is located
5834 will become the current directory (useful with
5835 projects accessed over a network from different
5836 systems)
5837 slash backslashes in file names replaced with forward
5838 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005839 tabpages all tab pages; without this only the current tab page
5840 is restored, so that you can make a session for each
5841 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 unix with Unix end-of-line format (single <NL>), even when
5843 on Windows or DOS
5844 winpos position of the whole Vim window
5845 winsize window sizes
5846
5847 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005848 When neither "curdir" nor "sesdir" is included, file names are stored
5849 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 "slash" and "unix" are useful on Windows when sharing session files
5851 with Unix. The Unix version of Vim cannot source dos format scripts,
5852 but the Windows version of Vim can source unix format scripts.
5853
5854 *'shell'* *'sh'* *E91*
5855'shell' 'sh' string (default $SHELL or "sh",
5856 MS-DOS and Win32: "command.com" or
5857 "cmd.exe", OS/2: "cmd")
5858 global
5859 Name of the shell to use for ! and :! commands. When changing the
5860 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5861 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005862 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 See |option-backslash| about including spaces and backslashes.
5864 Environment variables are expanded |:set_env|.
5865 If the name of the shell contains a space, you might need to enclose
5866 it in quotes. Example: >
5867 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5868< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005869 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 "-f" is not inside the quotes, because it is not part of the command
5871 name. And Vim automagically recognizes the backslashes that are path
5872 separators.
5873 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5874 variable to change the way external commands are executed. See the
5875 libc.inf file of DJGPP.
5876 Under MS-Windows, when the executable ends in ".com" it must be
5877 included. Thus setting the shell to "command.com" or "4dos.com"
5878 works, but "command" and "4dos" do not work for all commands (e.g.,
5879 filtering).
5880 For unknown reasons, when using "4dos.com" the current directory is
5881 changed to "C:\". To avoid this set 'shell' like this: >
5882 :set shell=command.com\ /c\ 4dos
5883< This option cannot be set from a |modeline| or in the |sandbox|, for
5884 security reasons.
5885
5886 *'shellcmdflag'* *'shcf'*
5887'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5888 does not contain "sh" somewhere: "/c")
5889 global
5890 {not in Vi}
5891 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5892 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5893 systems, the default is set according to the value of 'shell', to
5894 reduce the need to set this option by the user. It's not used for
5895 OS/2 (EMX figures this out itself). See |option-backslash| about
5896 including spaces and backslashes. See |dos-shell|.
5897 This option cannot be set from a |modeline| or in the |sandbox|, for
5898 security reasons.
5899
5900 *'shellpipe'* *'sp'*
5901'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5902 global
5903 {not in Vi}
5904 {not available when compiled without the |+quickfix|
5905 feature}
5906 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005907 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 including spaces and backslashes.
5909 The name of the temporary file can be represented by "%s" if necessary
5910 (the file name is appended automatically if no %s appears in the value
5911 of this option).
5912 For the Amiga and MS-DOS the default is ">". The output is directly
5913 saved in a file and not echoed to the screen.
5914 For Unix the default it "| tee". The stdout of the compiler is saved
5915 in a file and echoed to the screen. If the 'shell' option is "csh" or
5916 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02005917 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
5918 default becomes "2>&1| tee". This means that stderr is also included.
5919 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
5920 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 The initialization of this option is done after reading the ".vimrc"
5922 and the other initializations, so that when the 'shell' option is set
5923 there, the 'shellpipe' option changes automatically, unless it was
5924 explicitly set before.
5925 When 'shellpipe' is set to an empty string, no redirection of the
5926 ":make" output will be done. This is useful if you use a 'makeprg'
5927 that writes to 'makeef' by itself. If you want no piping, but do
5928 want to include the 'makeef', set 'shellpipe' to a single space.
5929 Don't forget to precede the space with a backslash: ":set sp=\ ".
5930 In the future pipes may be used for filtering and this option will
5931 become obsolete (at least for Unix).
5932 This option cannot be set from a |modeline| or in the |sandbox|, for
5933 security reasons.
5934
5935 *'shellquote'* *'shq'*
5936'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5937 contains "sh" somewhere: "\"")
5938 global
5939 {not in Vi}
5940 Quoting character(s), put around the command passed to the shell, for
5941 the "!" and ":!" commands. The redirection is kept outside of the
5942 quoting. See 'shellxquote' to include the redirection. It's
5943 probably not useful to set both options.
5944 This is an empty string by default. Only known to be useful for
5945 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5946 or bash, where it should be "\"". The default is adjusted according
5947 the value of 'shell', to reduce the need to set this option by the
5948 user. See |dos-shell|.
5949 This option cannot be set from a |modeline| or in the |sandbox|, for
5950 security reasons.
5951
5952 *'shellredir'* *'srr'*
5953'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5954 global
5955 {not in Vi}
5956 String to be used to put the output of a filter command in a temporary
5957 file. See also |:!|. See |option-backslash| about including spaces
5958 and backslashes.
5959 The name of the temporary file can be represented by "%s" if necessary
5960 (the file name is appended automatically if no %s appears in the value
5961 of this option).
5962 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5963 or "zsh" during initializations, the default becomes ">&". If the
5964 'shell' option is "sh", "ksh" or "bash" the default becomes
5965 ">%s 2>&1". This means that stderr is also included.
5966 For Win32, the Unix checks are done and additionally "cmd" is checked
5967 for, which makes the default ">%s 2>&1". Also, the same names with
5968 ".exe" appended are checked for.
5969 The initialization of this option is done after reading the ".vimrc"
5970 and the other initializations, so that when the 'shell' option is set
5971 there, the 'shellredir' option changes automatically unless it was
5972 explicitly set before.
5973 In the future pipes may be used for filtering and this option will
5974 become obsolete (at least for Unix).
5975 This option cannot be set from a |modeline| or in the |sandbox|, for
5976 security reasons.
5977
5978 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5979'shellslash' 'ssl' boolean (default off)
5980 global
5981 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5982 When set, a forward slash is used when expanding file names. This is
5983 useful when a Unix-like shell is used instead of command.com or
5984 cmd.exe. Backward slashes can still be typed, but they are changed to
5985 forward slashes by Vim.
5986 Note that setting or resetting this option has no effect for some
5987 existing file names, thus this option needs to be set before opening
5988 any file for best results. This might change in the future.
5989 'shellslash' only works when a backslash can be used as a path
5990 separator. To test if this is so use: >
5991 if exists('+shellslash')
5992<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005993 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5994'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5995 global
5996 {not in Vi}
5997 When on, use temp files for shell commands. When off use a pipe.
5998 When using a pipe is not possible temp files are used anyway.
5999 Currently a pipe is only supported on Unix. You can check it with: >
6000 :if has("filterpipe")
6001< The advantage of using a pipe is that nobody can read the temp file
6002 and the 'shell' command does not need to support redirection.
6003 The advantage of using a temp file is that the file type and encoding
6004 can be detected.
6005 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6006 |FilterWritePost| autocommands event are not triggered when
6007 'shelltemp' is off.
6008
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 *'shelltype'* *'st'*
6010'shelltype' 'st' number (default 0)
6011 global
6012 {not in Vi} {only for the Amiga}
6013 On the Amiga this option influences the way how the commands work
6014 which use a shell.
6015 0 and 1: always use the shell
6016 2 and 3: use the shell only to filter lines
6017 4 and 5: use shell only for ':sh' command
6018 When not using the shell, the command is executed directly.
6019
6020 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6021 1 and 3: use "shell cmd" to start external commands
6022
6023 *'shellxquote'* *'sxq'*
6024'shellxquote' 'sxq' string (default: "";
6025 for Win32, when 'shell' contains "sh"
6026 somewhere: "\""
6027 for Unix, when using system(): "\"")
6028 global
6029 {not in Vi}
6030 Quoting character(s), put around the command passed to the shell, for
6031 the "!" and ":!" commands. Includes the redirection. See
6032 'shellquote' to exclude the redirection. It's probably not useful
6033 to set both options.
6034 This is an empty string by default. Known to be useful for
6035 third-party shells when using the Win32 version, such as the MKS Korn
6036 Shell or bash, where it should be "\"". The default is adjusted
6037 according the value of 'shell', to reduce the need to set this option
6038 by the user. See |dos-shell|.
6039 This option cannot be set from a |modeline| or in the |sandbox|, for
6040 security reasons.
6041
6042 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6043'shiftround' 'sr' boolean (default off)
6044 global
6045 {not in Vi}
6046 Round indent to multiple of 'shiftwidth'. Applies to > and <
6047 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6048 a multiple of 'shiftwidth' (this is Vi compatible).
6049 NOTE: This option is reset when 'compatible' is set.
6050
6051 *'shiftwidth'* *'sw'*
6052'shiftwidth' 'sw' number (default 8)
6053 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006054 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 |'cindent'|, |>>|, |<<|, etc.
6056
6057 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006058'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6059 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060 global
6061 {not in Vi}
6062 This option helps to avoid all the |hit-enter| prompts caused by file
6063 messages, for example with CTRL-G, and to avoid some other messages.
6064 It is a list of flags:
6065 flag meaning when present ~
6066 f use "(3 of 5)" instead of "(file 3 of 5)"
6067 i use "[noeol]" instead of "[Incomplete last line]"
6068 l use "999L, 888C" instead of "999 lines, 888 characters"
6069 m use "[+]" instead of "[Modified]"
6070 n use "[New]" instead of "[New File]"
6071 r use "[RO]" instead of "[readonly]"
6072 w use "[w]" instead of "written" for file write message
6073 and "[a]" instead of "appended" for ':w >> file' command
6074 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6075 "[unix format]" and "[mac]" instead of "[mac format]".
6076 a all of the above abbreviations
6077
6078 o overwrite message for writing a file with subsequent message
6079 for reading a file (useful for ":wn" or when 'autowrite' on)
6080 O message for reading a file overwrites any previous message.
6081 Also for quickfix message (e.g., ":cn").
6082 s don't give "search hit BOTTOM, continuing at TOP" or "search
6083 hit TOP, continuing at BOTTOM" messages
6084 t truncate file message at the start if it is too long to fit
6085 on the command-line, "<" will appear in the left most column.
6086 Ignored in Ex mode.
6087 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006088 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 Ignored in Ex mode.
6090 W don't give "written" or "[w]" when writing a file
6091 A don't give the "ATTENTION" message when an existing swap file
6092 is found.
6093 I don't give the intro message when starting Vim |:intro|.
6094
6095 This gives you the opportunity to avoid that a change between buffers
6096 requires you to hit <Enter>, but still gives as useful a message as
6097 possible for the space available. To get the whole message that you
6098 would have got with 'shm' empty, use ":file!"
6099 Useful values:
6100 shm= No abbreviation of message.
6101 shm=a Abbreviation, but no loss of information.
6102 shm=at Abbreviation, and truncate message when necessary.
6103
6104 NOTE: This option is set to the Vi default value when 'compatible' is
6105 set and to the Vim default value when 'compatible' is reset.
6106
6107 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6108'shortname' 'sn' boolean (default off)
6109 local to buffer
6110 {not in Vi, not in MS-DOS versions}
6111 Filenames are assumed to be 8 characters plus one extension of 3
6112 characters. Multiple dots in file names are not allowed. When this
6113 option is on, dots in file names are replaced with underscores when
6114 adding an extension (".~" or ".swp"). This option is not available
6115 for MS-DOS, because then it would always be on. This option is useful
6116 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6117 or crossdos. When running the Win32 GUI version under Win32s, this
6118 option is always on by default.
6119
6120 *'showbreak'* *'sbr'* *E595*
6121'showbreak' 'sbr' string (default "")
6122 global
6123 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006124 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 feature}
6126 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006127 values are "> " or "+++ ": >
6128 :set showbreak=>\
6129< Note the backslash to escape the trailing space. It's easier like
6130 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006131 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006132< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 comma (in a future version the comma might be used to separate the
6134 part that is shown at the end and at the start of a line).
6135 The characters are highlighted according to the '@' flag in
6136 'highlight'.
6137 Note that tabs after the showbreak will be displayed differently.
6138 If you want the 'showbreak' to appear in between line numbers, add the
6139 "n" flag to 'cpoptions'.
6140
6141 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6142'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6143 off)
6144 global
6145 {not in Vi}
6146 {not available when compiled without the
6147 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006148 Show (partial) command in the last line of the screen. Set this
6149 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 In Visual mode the size of the selected area is shown:
6151 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006152 If the number of bytes is different it is also displayed: "2-6"
6153 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006155 - When selecting a block, the size in screen characters:
6156 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 NOTE: This option is set to the Vi default value when 'compatible' is
6158 set and to the Vim default value when 'compatible' is reset.
6159
6160 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6161'showfulltag' 'sft' boolean (default off)
6162 global
6163 {not in Vi}
6164 When completing a word in insert mode (see |ins-completion|) from the
6165 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006166 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 matched a C function, you can see a template for what arguments are
6168 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006169 Note that this doesn't work well together with having "longest" in
6170 'completeopt', because the completion from the search pattern may not
6171 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172
6173 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6174'showmatch' 'sm' boolean (default off)
6175 global
6176 When a bracket is inserted, briefly jump to the matching one. The
6177 jump is only done if the match can be seen on the screen. The time to
6178 show the match can be set with 'matchtime'.
6179 A Beep is given if there is no match (no matter if the match can be
6180 seen or not). This option is reset when the 'paste' option is set.
6181 When the 'm' flag is not included in 'cpoptions', typing a character
6182 will immediately move the cursor back to where it belongs.
6183 See the "sm" field in 'guicursor' for setting the cursor shape and
6184 blinking when showing the match.
6185 The 'matchpairs' option can be used to specify the characters to show
6186 matches for. 'rightleft' and 'revins' are used to look for opposite
6187 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006188 Also see the matchparen plugin for highlighting the match when moving
6189 around |pi_paren.txt|.
6190 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191
6192 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6193'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6194 global
6195 If in Insert, Replace or Visual mode put a message on the last line.
6196 Use the 'M' flag in 'highlight' to set the type of highlighting for
6197 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006198 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 doesn't mean XIM is really active, especially when 'imactivatekey' is
6200 not set.
6201 NOTE: This option is set to the Vi default value when 'compatible' is
6202 set and to the Vim default value when 'compatible' is reset.
6203
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006204 *'showtabline'* *'stal'*
6205'showtabline' 'stal' number (default 1)
6206 global
6207 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006208 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006209 feature}
6210 The value of this option specifies when the line with tab page labels
6211 will be displayed:
6212 0: never
6213 1: only if there are at least two tab pages
6214 2: always
6215 This is both for the GUI and non-GUI implementation of the tab pages
6216 line.
6217 See |tab-page| for more information about tab pages.
6218
Bram Moolenaar071d4272004-06-13 20:20:40 +00006219 *'sidescroll'* *'ss'*
6220'sidescroll' 'ss' number (default 0)
6221 global
6222 {not in Vi}
6223 The minimal number of columns to scroll horizontally. Used only when
6224 the 'wrap' option is off and the cursor is moved off of the screen.
6225 When it is zero the cursor will be put in the middle of the screen.
6226 When using a slow terminal set it to a large number or 0. When using
6227 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6228 commands.
6229
6230 *'sidescrolloff'* *'siso'*
6231'sidescrolloff' 'siso' number (default 0)
6232 global
6233 {not in Vi}
6234 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006235 right of the cursor if 'nowrap' is set. Setting this option to a
6236 value greater than 0 while having |'sidescroll'| also at a non-zero
6237 value makes some context visible in the line you are scrolling in
6238 horizontally (except at beginning of the line). Setting this option
6239 to a large value (like 999) has the effect of keeping the cursor
6240 horizontally centered in the window, as long as one does not come too
6241 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 NOTE: This option is set to 0 when 'compatible' is set.
6243
6244 Example: Try this together with 'sidescroll' and 'listchars' as
6245 in the following example to never allow the cursor to move
6246 onto the "extends" character:
6247
6248 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6249 :set sidescrolloff=1
6250
6251
6252 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6253'smartcase' 'scs' boolean (default off)
6254 global
6255 {not in Vi}
6256 Override the 'ignorecase' option if the search pattern contains upper
6257 case characters. Only used when the search pattern is typed and
6258 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006259 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6261 recalling the search pattern from history and hitting <Enter>.
6262 NOTE: This option is reset when 'compatible' is set.
6263
6264 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6265'smartindent' 'si' boolean (default off)
6266 local to buffer
6267 {not in Vi}
6268 {not available when compiled without the
6269 |+smartindent| feature}
6270 Do smart autoindenting when starting a new line. Works for C-like
6271 programs, but can also be used for other languages. 'cindent' does
6272 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006273 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006274 setting 'si' has no effect. 'indentexpr' is a more advanced
6275 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 Normally 'autoindent' should also be on when using 'smartindent'.
6277 An indent is automatically inserted:
6278 - After a line ending in '{'.
6279 - After a line starting with a keyword from 'cinwords'.
6280 - Before a line starting with '}' (only with the "O" command).
6281 When typing '}' as the first character in a new line, that line is
6282 given the same indent as the matching '{'.
6283 When typing '#' as the first character in a new line, the indent for
6284 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006285 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6287 When using the ">>" command, lines starting with '#' are not shifted
6288 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006289 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 is set smart indenting is disabled.
6291
6292 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6293'smarttab' 'sta' boolean (default off)
6294 global
6295 {not in Vi}
6296 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006297 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6298 <BS> will delete a 'shiftwidth' worth of space at the start of the
6299 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006300 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006301 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6302 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006303 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006305 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 NOTE: This option is reset when 'compatible' is set.
6307
6308 *'softtabstop'* *'sts'*
6309'softtabstop' 'sts' number (default 0)
6310 local to buffer
6311 {not in Vi}
6312 Number of spaces that a <Tab> counts for while performing editing
6313 operations, like inserting a <Tab> or using <BS>. It "feels" like
6314 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6315 used. This is useful to keep the 'ts' setting at its standard value
6316 of 8, while being able to edit like it is set to 'sts'. However,
6317 commands like "x" still work on the actual characters.
6318 When 'sts' is zero, this feature is off.
6319 'softtabstop' is set to 0 when the 'paste' option is set.
6320 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6321 spaces is minimized by using <Tab>s.
6322 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6323 set.
6324 NOTE: This option is set to 0 when 'compatible' is set.
6325
Bram Moolenaar217ad922005-03-20 22:37:15 +00006326 *'spell'* *'nospell'*
6327'spell' boolean (default off)
6328 local to window
6329 {not in Vi}
6330 {not available when compiled without the |+syntax|
6331 feature}
6332 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006333 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006334
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006335 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006336'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006337 local to buffer
6338 {not in Vi}
6339 {not available when compiled without the |+syntax|
6340 feature}
6341 Pattern to locate the end of a sentence. The following word will be
6342 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006343 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006344 When this check is not wanted make this option empty.
6345 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006346 Be careful with special characters, see |option-backslash| about
6347 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006348 To set this option automatically depending on the language, see
6349 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006350
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006351 *'spellfile'* *'spf'*
6352'spellfile' 'spf' string (default empty)
6353 local to buffer
6354 {not in Vi}
6355 {not available when compiled without the |+syntax|
6356 feature}
6357 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006358 commands. It must end in ".{encoding}.add". You need to include the
6359 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006360 *E765*
6361 It may also be a comma separated list of names. A count before the
6362 |zg| and |zw| commands can be used to access each. This allows using
6363 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006364 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006365 you: Using the first directory in 'runtimepath' that is writable. If
6366 there is no "spell" directory yet it will be created. For the file
6367 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006368 ignoring the region.
6369 The resulting ".spl" file will be used for spell checking, it does not
6370 have to appear in 'spelllang'.
6371 Normally one file is used for all regions, but you can add the region
6372 name if you want to. However, it will then only be used when
6373 'spellfile' is set to it, for entries in 'spelllang' only files
6374 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006375 This option cannot be set from a |modeline| or in the |sandbox|, for
6376 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006377
Bram Moolenaar217ad922005-03-20 22:37:15 +00006378 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006379'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006380 local to buffer
6381 {not in Vi}
6382 {not available when compiled without the |+syntax|
6383 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006384 A comma separated list of word list names. When the 'spell' option is
6385 on spellchecking will be done for these languages. Example: >
6386 set spelllang=en_us,nl,medical
6387< This means US English, Dutch and medical words are recognized. Words
6388 that are not recognized will be highlighted.
6389 The word list name must not include a comma or dot. Using a dash is
6390 recommended to separate the two letter language name from a
6391 specification. Thus "en-rare" is used for rare English words.
6392 A region name must come last and have the form "_xx", where "xx" is
6393 the two-letter, lower case region name. You can use more than one
6394 region by listing them: "en_us,en_ca" supports both US and Canadian
6395 English, but not words specific for Australia, New Zealand or Great
6396 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006397 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006398 As a special case the name of a .spl file can be given as-is. The
6399 first "_xx" in the name is removed and used as the region name
6400 (_xx is an underscore, two letters and followed by a non-letter).
6401 This is mainly for testing purposes. You must make sure the correct
6402 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006403 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006404 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6405 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006406 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006407
Bram Moolenaar98692072006-02-04 00:57:42 +00006408 If the |spellfile.vim| plugin is active and you use a language name
6409 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6410 will ask you if you want to download the file.
6411
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006412 After this option has been set successfully, Vim will source the files
6413 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006414 up to the first comma, dot or underscore.
6415 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006416
6417
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006418 *'spellsuggest'* *'sps'*
6419'spellsuggest' 'sps' string (default "best")
6420 global
6421 {not in Vi}
6422 {not available when compiled without the |+syntax|
6423 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006424 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006425 the |spellsuggest()| function. This is a comma-separated list of
6426 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006427
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006428 best Internal method that works best for English. Finds
6429 changes like "fast" and uses a bit of sound-a-like
6430 scoring to improve the ordering.
6431
6432 double Internal method that uses two methods and mixes the
6433 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006434 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006435 word. That only works when the language specifies
6436 sound folding. Can be slow and doesn't always give
6437 better results.
6438
6439 fast Internal method that only checks for simple changes:
6440 character inserts/deletes/swaps. Works well for
6441 simple typing mistakes.
6442
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006443 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006444 Not used for |spellsuggest()|. The number of
6445 suggestions is never more than the value of 'lines'
6446 minus two.
6447
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006448 file:{filename} Read file {filename}, which must have two columns,
6449 separated by a slash. The first column contains the
6450 bad word, the second column the suggested good word.
6451 Example:
6452 theribal/terrible ~
6453 Use this for common mistakes that do not appear at the
6454 top of the suggestion list with the internal methods.
6455 Lines without a slash are ignored, use this for
6456 comments.
6457 The file is used for all languages.
6458
6459 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6460 trouble with spaces. |v:val| holds the badly spelled
6461 word. The expression must evaluate to a List of
6462 Lists, each with a suggestion and a score.
6463 Example:
6464 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006465 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006466 internal methods use. A lower score is better.
6467 This may invoke |spellsuggest()| if you temporarily
6468 set 'spellsuggest' to exclude the "expr:" part.
6469 Errors are silently ignored, unless you set the
6470 'verbose' option to a non-zero value.
6471
6472 Only one of "best", "double" or "fast" may be used. The others may
6473 appear several times in any order. Example: >
6474 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6475<
6476 This option cannot be set from a |modeline| or in the |sandbox|, for
6477 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006478
6479
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6481'splitbelow' 'sb' boolean (default off)
6482 global
6483 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006484 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 feature}
6486 When on, splitting a window will put the new window below the current
6487 one. |:split|
6488
6489 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6490'splitright' 'spr' boolean (default off)
6491 global
6492 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006493 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 feature}
6495 When on, splitting a window will put the new window right of the
6496 current one. |:vsplit|
6497
6498 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6499'startofline' 'sol' boolean (default on)
6500 global
6501 {not in Vi}
6502 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006503 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006504 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006505 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 with a linewise operator, with "%" with a count and to buffer changing
6507 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6508 only has a line number, e.g., ":25" or ":+".
6509 In case of buffer changing commands the cursor is placed at the column
6510 where it was the last time the buffer was edited.
6511 NOTE: This option is set when 'compatible' is set.
6512
Bram Moolenaar00654022011-02-25 14:42:19 +01006513 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006515 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 {not in Vi}
6517 {not available when compiled without the |+statusline|
6518 feature}
6519 When nonempty, this option determines the content of the status line.
6520 Also see |status-line|.
6521
6522 The option consists of printf style '%' items interspersed with
6523 normal text. Each status line item is of the form:
6524 %-0{minwid}.{maxwid}{item}
6525 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006526 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527
Bram Moolenaar238a5642006-02-21 22:12:05 +00006528 When the option starts with "%!" then it is used as an expression,
6529 evaluated and the result is used as the option value. Example: >
6530 :set statusline=%!MyStatusLine()
6531< The result can contain %{} items that will be evaluated too.
6532
6533 When there is error while evaluating the option then it will be made
6534 empty to avoid further errors. Otherwise screen updating would loop.
6535
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 Note that the only effect of 'ruler' when this option is set (and
6537 'laststatus' is 2) is controlling the output of |CTRL-G|.
6538
6539 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006540 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006542 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 minwid Minimum width of the item, padding as set by '-' & '0'.
6544 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006545 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 on the left for text items. Numeric items will be
6547 shifted down to maxwid-2 digits followed by '>'number
6548 where number is the amount of missing digits, much like
6549 an exponential notation.
6550 item A one letter code as described below.
6551
6552 Following is a description of the possible statusline items. The
6553 second character in "item" is the type:
6554 N for number
6555 S for string
6556 F for flags as described below
6557 - not applicable
6558
6559 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006560 f S Path to the file in the buffer, as typed or relative to current
6561 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 F S Full path to the file in the buffer.
6563 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006564 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006566 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006568 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006570 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006572 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6574 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006575 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6577 being used: "<keymap>"
6578 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006579 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 B N As above, in hexadecimal.
6581 o N Byte number in file of byte under cursor, first byte is 1.
6582 Mnemonic: Offset from start of file (with one added)
6583 {not available when compiled without |+byte_offset| feature}
6584 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006585 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 l N Line number.
6587 L N Number of lines in buffer.
6588 c N Column number.
6589 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006590 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 p N Percentage through file in lines as in |CTRL-G|.
6592 P S Percentage through file of displayed window. This is like the
6593 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006594 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006596 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006597 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 ( - Start of item group. Can be used for setting the width and
6599 alignment of a section. Must be followed by %) somewhere.
6600 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006601 T N For 'tabline': start of tab page N label. Use %T after the last
6602 label. This information is used for mouse clicks.
6603 X N For 'tabline': start of close tab N label. Use %X after the
6604 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6605 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 < - Where to truncate line if too long. Default is at the start.
6607 No width fields allowed.
6608 = - Separation point between left and right aligned items.
6609 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006610 # - Set highlight group. The name must follow and then a # again.
6611 Thus use %#HLname# for highlight group HLname. The same
6612 highlighting is used, also for the statusline of non-current
6613 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006615 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 The difference between User{N} and StatusLine will be applied
6617 to StatusLineNC for the statusline of non-current windows.
6618 The number N must be between 1 and 9. See |hl-User1..9|
6619
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006620 When displaying a flag, Vim removes the leading comma, if any, when
6621 that flag comes right after plaintext. This will make a nice display
6622 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623
Bram Moolenaar582fd852005-03-28 20:58:01 +00006624 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 not set) and a minwid is not set for the group, the whole group will
6626 become empty. This will make a group like the following disappear
6627 completely from the statusline when none of the flags are set. >
6628 :set statusline=...%(\ [%M%R%H]%)...
6629<
6630 Beware that an expression is evaluated each and every time the status
6631 line is displayed. The current buffer and current window will be set
6632 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006633 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006635 real current buffer.
6636
6637 The 'statusline' option may be evaluated in the |sandbox|, see
6638 |sandbox-option|.
6639
6640 It is not allowed to change text or jump to another window while
6641 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642
6643 If the statusline is not updated when you want it (e.g., after setting
6644 a variable that's used in an expression), you can force an update by
6645 setting an option without changing its value. Example: >
6646 :let &ro = &ro
6647
6648< A result of all digits is regarded a number for display purposes.
6649 Otherwise the result is taken as flag text and applied to the rules
6650 described above.
6651
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006652 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6654 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6655
6656 Examples:
6657 Emulate standard status line with 'ruler' set >
6658 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6659< Similar, but add ASCII value of char under the cursor (like "ga") >
6660 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6661< Display byte count and byte value, modified flag in red. >
6662 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6663 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6664< Display a ,GZ flag if a compressed file is loaded >
6665 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6666< In the |:autocmd|'s: >
6667 :let b:gzflag = 1
6668< And: >
6669 :unlet b:gzflag
6670< And define this function: >
6671 :function VarExists(var, val)
6672 : if exists(a:var) | return a:val | else | return '' | endif
6673 :endfunction
6674<
6675 *'suffixes'* *'su'*
6676'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6677 global
6678 {not in Vi}
6679 Files with these suffixes get a lower priority when multiple files
6680 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006681 suffixes. Spaces after the comma are ignored. A dot is also seen as
6682 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 separator, precede it with a backslash (see |option-backslash| about
6684 including spaces and backslashes).
6685 See 'wildignore' for completely ignoring files.
6686 The use of |:set+=| and |:set-=| is preferred when adding or removing
6687 suffixes from the list. This avoids problems when a future version
6688 uses another default.
6689
6690 *'suffixesadd'* *'sua'*
6691'suffixesadd' 'sua' string (default "")
6692 local to buffer
6693 {not in Vi}
6694 {not available when compiled without the
6695 |+file_in_path| feature}
6696 Comma separated list of suffixes, which are used when searching for a
6697 file for the "gf", "[I", etc. commands. Example: >
6698 :set suffixesadd=.java
6699<
6700 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6701'swapfile' 'swf' boolean (default on)
6702 local to buffer
6703 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006704 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 swapfile is not wanted for a specific buffer. For example, with
6706 confidential information that even root must not be able to access.
6707 Careful: All text will be in memory:
6708 - Don't use this for big files.
6709 - Recovery will be impossible!
6710 A swapfile will only be present when |'updatecount'| is non-zero and
6711 'swapfile' is set.
6712 When 'swapfile' is reset, the swap file for the current buffer is
6713 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6714 non-zero, a swap file is immediately created.
6715 Also see |swap-file| and |'swapsync'|.
6716
6717 This option is used together with 'bufhidden' and 'buftype' to
6718 specify special kinds of buffers. See |special-buffers|.
6719
6720 *'swapsync'* *'sws'*
6721'swapsync' 'sws' string (default "fsync")
6722 global
6723 {not in Vi}
6724 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006725 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 When this option is empty parts of the swap file may be in memory and
6727 not written to disk. When the system crashes you may lose more work.
6728 On Unix the system does a sync now and then without Vim asking for it,
6729 so the disadvantage of setting this option off is small. On some
6730 systems the swap file will not be written at all. For a unix system
6731 setting it to "sync" will use the sync() call instead of the default
6732 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006733 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734
6735 *'switchbuf'* *'swb'*
6736'switchbuf' 'swb' string (default "")
6737 global
6738 {not in Vi}
6739 This option controls the behavior when switching between buffers.
6740 Possible values (comma separated list):
6741 useopen If included, jump to the first open window that
6742 contains the specified buffer (if there is one).
6743 Otherwise: Do not examine other windows.
6744 This setting is checked with |quickfix| commands, when
6745 jumping to errors (":cc", ":cn", "cp", etc.). It is
6746 also used in all buffer related split commands, for
6747 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006748 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006749 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006751 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006753 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006754 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006756 *'synmaxcol'* *'smc'*
6757'synmaxcol' 'smc' number (default 3000)
6758 local to buffer
6759 {not in Vi}
6760 {not available when compiled without the |+syntax|
6761 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006762 Maximum column in which to search for syntax items. In long lines the
6763 text after this column is not highlighted and following lines may not
6764 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006765 This helps to avoid very slow redrawing for an XML file that is one
6766 long line.
6767 Set to zero to remove the limit.
6768
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 *'syntax'* *'syn'*
6770'syntax' 'syn' string (default empty)
6771 local to buffer
6772 {not in Vi}
6773 {not available when compiled without the |+syntax|
6774 feature}
6775 When this option is set, the syntax with this name is loaded, unless
6776 syntax highlighting has been switched off with ":syntax off".
6777 Otherwise this option does not always reflect the current syntax (the
6778 b:current_syntax variable does).
6779 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006780 not automatically recognized. Example, in an IDL file:
6781 /* vim: set syntax=idl : */ ~
6782 When a dot appears in the value then this separates two filetype
6783 names. Example:
6784 /* vim: set syntax=c.doxygen : */ ~
6785 This will use the "c" syntax first, then the "doxygen" syntax.
6786 Note that the second one must be prepared to be loaded as an addition,
6787 otherwise it will be skipped. More than one dot may appear.
6788 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 :set syntax=OFF
6790< To switch syntax highlighting on according to the current value of the
6791 'filetype' option: >
6792 :set syntax=ON
6793< What actually happens when setting the 'syntax' option is that the
6794 Syntax autocommand event is triggered with the value as argument.
6795 This option is not copied to another buffer, independent of the 's' or
6796 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006797 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006799 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006800'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006801 global
6802 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006803 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006804 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006805 When nonempty, this option determines the content of the tab pages
6806 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006807 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006808
6809 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006810 option and only when there is no GUI tab line. When 'e' is in
6811 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006812 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006813
6814 The value is evaluated like with 'statusline'. You can use
6815 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006816 the text to be displayed. Use "%1T" for the first label, "%2T" for
6817 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006818
6819 Keep in mind that only one of the tab pages is the current one, others
6820 are invisible and you can't jump to their windows.
6821
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006822
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006823 *'tabpagemax'* *'tpm'*
6824'tabpagemax' 'tpm' number (default 10)
6825 global
6826 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006827 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006828 feature}
6829 Maximum number of tab pages to be opened by the |-p| command line
6830 argument or the ":tab all" command. |tabpage|
6831
6832
6833 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834'tabstop' 'ts' number (default 8)
6835 local to buffer
6836 Number of spaces that a <Tab> in the file counts for. Also see
6837 |:retab| command, and 'softtabstop' option.
6838
6839 Note: Setting 'tabstop' to any other value than 8 can make your file
6840 appear wrong in many places (e.g., when printing it).
6841
6842 There are four main ways to use tabs in Vim:
6843 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6844 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006845 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 behave like a tab appears every 4 (or 3) characters.
6847 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6848 'expandtab'. This way you will always insert spaces. The
6849 formatting will never be messed up when 'tabstop' is changed.
6850 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006851 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 works when using Vim to edit the file.
6853 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6854 'noexpandtab'. This should then work (for initial indents only)
6855 for any tabstop setting that people use. It might be nice to have
6856 tabs after the first non-blank inserted as spaces if you do this
6857 though. Otherwise aligned comments will be wrong when 'tabstop' is
6858 changed.
6859
6860 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6861'tagbsearch' 'tbs' boolean (default on)
6862 global
6863 {not in Vi}
6864 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006865 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 searching makes searching for a tag a LOT faster, but a linear search
6867 will find more tags if the tags file wasn't properly sorted.
6868 Vim normally assumes that your tags files are sorted, or indicate that
6869 they are not sorted. Only when this is not the case does the
6870 'tagbsearch' option need to be switched off.
6871
6872 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006873 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 certain files, or retry all files with a linear search. When
6875 'tagbsearch' is off, only a linear search is done.
6876
6877 Linear searching is done anyway, for one file, when Vim finds a line
6878 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006879 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880< [The whitespace before and after the '0' must be a single <Tab>]
6881
6882 When a binary search was done and no match was found in any of the
6883 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6884 instead of a normal tag name, a retry is done with a linear search.
6885 Tags in unsorted tags files, and matches with different case will only
6886 be found in the retry.
6887
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006888 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 linear search can be avoided for the 'ignorecase' case. Use a value
6890 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6891 case-fold sorted with the -f switch to "sort" in most unices, as in
6892 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006893 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6894 for this as well. Note that case must be folded to uppercase for this
6895 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896
6897 When 'tagbsearch' is off, tags searching is slower when a full match
6898 exists, but faster when no full match exists. Tags in unsorted tags
6899 files may only be found with 'tagbsearch' off.
6900 When the tags file is not sorted, or sorted in a wrong way (not on
6901 ASCII byte value), 'tagbsearch' should be off, or the line given above
6902 must be included in the tags file.
6903 This option doesn't affect commands that find all matching tags (e.g.,
6904 command-line completion and ":help").
6905 {Vi: always uses binary search in some versions}
6906
6907 *'taglength'* *'tl'*
6908'taglength' 'tl' number (default 0)
6909 global
6910 If non-zero, tags are significant up to this number of characters.
6911
6912 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6913'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6914 global
6915 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006916 If on and using a tags file in another directory, file names in that
6917 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 NOTE: This option is set to the Vi default value when 'compatible' is
6919 set and to the Vim default value when 'compatible' is reset.
6920
6921 *'tags'* *'tag'* *E433*
6922'tags' 'tag' string (default "./tags,tags", when compiled with
6923 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6924 global or local to buffer |global-local|
6925 Filenames for the tag command, separated by spaces or commas. To
6926 include a space or comma in a file name, precede it with a backslash
6927 (see |option-backslash| about including spaces and backslashes).
6928 When a file name starts with "./", the '.' is replaced with the path
6929 of the current file. But only when the 'd' flag is not included in
6930 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6931 |tags-option|.
6932 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006933 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6934 find all files named "tags" below "/lib". The filename itself cannot
6935 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6936 files called "tags?". {not available when compiled without the
6937 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006938 The |tagfiles()| function can be used to get a list of the file names
6939 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6941 files are also supported. They are automatically recognized. The
6942 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6943 differences are ignored (MS-Windows). |emacs-tags|
6944 The use of |:set+=| and |:set-=| is preferred when adding or removing
6945 file names from the list. This avoids problems when a future version
6946 uses another default.
6947 {Vi: default is "tags /usr/lib/tags"}
6948
6949 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6950'tagstack' 'tgst' boolean (default on)
6951 global
6952 {not in all versions of Vi}
6953 When on, the |tagstack| is used normally. When off, a ":tag" or
6954 ":tselect" command with an argument will not push the tag onto the
6955 tagstack. A following ":tag" without an argument, a ":pop" command or
6956 any other command that uses the tagstack will use the unmodified
6957 tagstack, but does change the pointer to the active entry.
6958 Resetting this option is useful when using a ":tag" command in a
6959 mapping which should not change the tagstack.
6960
6961 *'term'* *E529* *E530* *E531*
6962'term' string (default is $TERM, if that fails:
6963 in the GUI: "builtin_gui"
6964 on Amiga: "amiga"
6965 on BeOS: "beos-ansi"
6966 on Mac: "mac-ansi"
6967 on MiNT: "vt52"
6968 on MS-DOS: "pcterm"
6969 on OS/2: "os2ansi"
6970 on Unix: "ansi"
6971 on VMS: "ansi"
6972 on Win 32: "win32")
6973 global
6974 Name of the terminal. Used for choosing the terminal control
6975 characters. Environment variables are expanded |:set_env|.
6976 For example: >
6977 :set term=$TERM
6978< See |termcap|.
6979
6980 *'termbidi'* *'tbidi'*
6981 *'notermbidi'* *'notbidi'*
6982'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6983 global
6984 {not in Vi}
6985 {only available when compiled with the |+arabic|
6986 feature}
6987 The terminal is in charge of Bi-directionality of text (as specified
6988 by Unicode). The terminal is also expected to do the required shaping
6989 that some languages (such as Arabic) require.
6990 Setting this option implies that 'rightleft' will not be set when
6991 'arabic' is set and the value of 'arabicshape' will be ignored.
6992 Note that setting 'termbidi' has the immediate effect that
6993 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6994 This option is reset when the GUI is started.
6995 For further details see |arabic.txt|.
6996
6997 *'termencoding'* *'tenc'*
6998'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6999 Macintosh GUI: "macroman")
7000 global
7001 {only available when compiled with the |+multi_byte|
7002 feature}
7003 {not in Vi}
7004 Encoding used for the terminal. This specifies what character
7005 encoding the keyboard produces and the display will understand. For
7006 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007007 display). Except for the Mac when 'macatsui' is off, then
7008 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 In the Win32 console version the default value is the console codepage
7010 when it differs from the ANSI codepage.
7011 *E617*
7012 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7013 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7014 Any attempts to set a different value will be rejected, and an error
7015 message is shown.
7016 For the Win32 GUI 'termencoding' is not used for typed characters,
7017 because the Win32 system always passes Unicode characters.
7018 When empty, the same encoding is used as for the 'encoding' option.
7019 This is the normal value.
7020 Not all combinations for 'termencoding' and 'encoding' are valid. See
7021 |encoding-table|.
7022 The value for this option must be supported by internal conversions or
7023 iconv(). When this is not possible no conversion will be done and you
7024 will probably experience problems with non-ASCII characters.
7025 Example: You are working with the locale set to euc-jp (Japanese) and
7026 want to edit a UTF-8 file: >
7027 :let &termencoding = &encoding
7028 :set encoding=utf-8
7029< You need to do this when your system has no locale support for UTF-8.
7030
7031 *'terse'* *'noterse'*
7032'terse' boolean (default off)
7033 global
7034 When set: Add 's' flag to 'shortmess' option (this makes the message
7035 for a search that hits the start or end of the file not being
7036 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7037 shortens a lot of messages}
7038
7039 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7040'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7041 global
7042 {not in Vi}
7043 This option is obsolete. Use 'fileformats'.
7044 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7045 set to the default value for the current system. When 'textauto' is
7046 reset, 'fileformats' is made empty.
7047 NOTE: This option is set to the Vi default value when 'compatible' is
7048 set and to the Vim default value when 'compatible' is reset.
7049
7050 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7051'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7052 others: default off)
7053 local to buffer
7054 {not in Vi}
7055 This option is obsolete. Use 'fileformat'.
7056 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7057 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7058 "unix".
7059
7060 *'textwidth'* *'tw'*
7061'textwidth' 'tw' number (default 0)
7062 local to buffer
7063 {not in Vi}
7064 Maximum width of text that is being inserted. A longer line will be
7065 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007066 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7067 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007069 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 NOTE: This option is set to 0 when 'compatible' is set.
7071
7072 *'thesaurus'* *'tsr'*
7073'thesaurus' 'tsr' string (default "")
7074 global or local to buffer |global-local|
7075 {not in Vi}
7076 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007077 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 the file should contain words with similar meaning, separated by
7079 non-keyword characters (white space is preferred). Maximum line
7080 length is 510 bytes.
7081 To obtain a file to be used here, check out the wordlist FAQ at
7082 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007083 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 after a comma are ignored, otherwise spaces are included in the file
7085 name. See |option-backslash| about using backslashes.
7086 The use of |:set+=| and |:set-=| is preferred when adding or removing
7087 directories from the list. This avoids problems when a future version
7088 uses another default.
7089 Backticks cannot be used in this option for security reasons.
7090
7091 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7092'tildeop' 'top' boolean (default off)
7093 global
7094 {not in Vi}
7095 When on: The tilde command "~" behaves like an operator.
7096 NOTE: This option is reset when 'compatible' is set.
7097
7098 *'timeout'* *'to'* *'notimeout'* *'noto'*
7099'timeout' 'to' boolean (default on)
7100 global
7101 *'ttimeout'* *'nottimeout'*
7102'ttimeout' boolean (default off)
7103 global
7104 {not in Vi}
7105 These two options together determine the behavior when part of a
7106 mapped key sequence or keyboard code has been received:
7107
7108 'timeout' 'ttimeout' action ~
7109 off off do not time out
7110 on on or off time out on :mappings and key codes
7111 off on time out on key codes
7112
7113 If both options are off, Vim will wait until either the complete
7114 mapping or key sequence has been received, or it is clear that there
7115 is no mapping or key sequence for the received characters. For
7116 example: if you have mapped "vl" and Vim has received 'v', the next
7117 character is needed to see if the 'v' is followed by an 'l'.
7118 When one of the options is on, Vim will wait for about 1 second for
7119 the next character to arrive. After that the already received
7120 characters are interpreted as single characters. The waiting time can
7121 be changed with the 'timeoutlen' option.
7122 On slow terminals or very busy systems timing out may cause
7123 malfunctioning cursor keys. If both options are off, Vim waits
7124 forever after an entered <Esc> if there are key codes that start
7125 with <Esc>. You will have to type <Esc> twice. If you do not have
7126 problems with key codes, but would like to have :mapped key
7127 sequences not timing out in 1 second, set the 'ttimeout' option and
7128 reset the 'timeout' option.
7129
7130 NOTE: 'ttimeout' is reset when 'compatible' is set.
7131
7132 *'timeoutlen'* *'tm'*
7133'timeoutlen' 'tm' number (default 1000)
7134 global
7135 {not in all versions of Vi}
7136 *'ttimeoutlen'* *'ttm'*
7137'ttimeoutlen' 'ttm' number (default -1)
7138 global
7139 {not in Vi}
7140 The time in milliseconds that is waited for a key code or mapped key
7141 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7142 when part of a command has been typed.
7143 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7144 different timeout value for key codes is desired set 'ttimeoutlen' to
7145 a non-negative number.
7146
7147 ttimeoutlen mapping delay key code delay ~
7148 < 0 'timeoutlen' 'timeoutlen'
7149 >= 0 'timeoutlen' 'ttimeoutlen'
7150
7151 The timeout only happens when the 'timeout' and 'ttimeout' options
7152 tell so. A useful setting would be >
7153 :set timeout timeoutlen=3000 ttimeoutlen=100
7154< (time out on mapping after three seconds, time out on key codes after
7155 a tenth of a second).
7156
7157 *'title'* *'notitle'*
7158'title' boolean (default off, on when title can be restored)
7159 global
7160 {not in Vi}
7161 {not available when compiled without the |+title|
7162 feature}
7163 When on, the title of the window will be set to the value of
7164 'titlestring' (if it is not empty), or to:
7165 filename [+=-] (path) - VIM
7166 Where:
7167 filename the name of the file being edited
7168 - indicates the file cannot be modified, 'ma' off
7169 + indicates the file was modified
7170 = indicates the file is read-only
7171 =+ indicates the file is read-only and modified
7172 (path) is the path of the file being edited
7173 - VIM the server name |v:servername| or "VIM"
7174 Only works if the terminal supports setting window titles
7175 (currently Amiga console, Win32 console, all GUI versions and
7176 terminals with a non- empty 't_ts' option - these are Unix xterm and
7177 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7178 *X11*
7179 When Vim was compiled with HAVE_X11 defined, the original title will
7180 be restored if possible. The output of ":version" will include "+X11"
7181 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7182 works for the icon name |'icon'|.
7183 But: When Vim was started with the |-X| argument, restoring the title
7184 will not work (except in the GUI).
7185 If the title cannot be restored, it is set to the value of 'titleold'.
7186 You might want to restore the title outside of Vim then.
7187 When using an xterm from a remote machine you can use this command:
7188 rsh machine_name xterm -display $DISPLAY &
7189 then the WINDOWID environment variable should be inherited and the
7190 title of the window should change back to what it should be after
7191 exiting Vim.
7192
7193 *'titlelen'*
7194'titlelen' number (default 85)
7195 global
7196 {not in Vi}
7197 {not available when compiled without the |+title|
7198 feature}
7199 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007200 title. When the title is longer, only the end of the path name is
7201 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 Using a percentage makes this adapt to the width of the window. But
7203 it won't work perfectly, because the actual number of characters
7204 available also depends on the font used and other things in the title
7205 bar. When 'titlelen' is zero the full path is used. Otherwise,
7206 values from 1 to 30000 percent can be used.
7207 'titlelen' is also used for the 'titlestring' option.
7208
7209 *'titleold'*
7210'titleold' string (default "Thanks for flying Vim")
7211 global
7212 {not in Vi}
7213 {only available when compiled with the |+title|
7214 feature}
7215 This option will be used for the window title when exiting Vim if the
7216 original title cannot be restored. Only happens if 'title' is on or
7217 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007218 This option cannot be set from a |modeline| or in the |sandbox|, for
7219 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 *'titlestring'*
7221'titlestring' string (default "")
7222 global
7223 {not in Vi}
7224 {not available when compiled without the |+title|
7225 feature}
7226 When this option is not empty, it will be used for the title of the
7227 window. This happens only when the 'title' option is on.
7228 Only works if the terminal supports setting window titles (currently
7229 Amiga console, Win32 console, all GUI versions and terminals with a
7230 non-empty 't_ts' option).
7231 When Vim was compiled with HAVE_X11 defined, the original title will
7232 be restored if possible |X11|.
7233 When this option contains printf-style '%' items, they will be
7234 expanded according to the rules used for 'statusline'.
7235 Example: >
7236 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7237 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7238< The value of 'titlelen' is used to align items in the middle or right
7239 of the available space.
7240 Some people prefer to have the file name first: >
7241 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7242< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007243 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 separating space only when needed.
7245 NOTE: Use of special characters in 'titlestring' may cause the display
7246 to be garbled (e.g., when it contains a CR or NL character).
7247 {not available when compiled without the |+statusline| feature}
7248
7249 *'toolbar'* *'tb'*
7250'toolbar' 'tb' string (default "icons,tooltips")
7251 global
7252 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7253 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007254 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 possible values are:
7256 icons Toolbar buttons are shown with icons.
7257 text Toolbar buttons shown with text.
7258 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007259 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 tooltips Tooltips are active for toolbar buttons.
7261 Tooltips refer to the popup help text which appears after the mouse
7262 cursor is placed over a toolbar button for a brief moment.
7263
7264 If you want the toolbar to be shown with icons as well as text, do the
7265 following: >
7266 :set tb=icons,text
7267< Motif and Athena cannot display icons and text at the same time. They
7268 will show icons if both are requested.
7269
7270 If none of the strings specified in 'toolbar' are valid or if
7271 'toolbar' is empty, this option is ignored. If you want to disable
7272 the toolbar, you need to set the 'guioptions' option. For example: >
7273 :set guioptions-=T
7274< Also see |gui-toolbar|.
7275
7276 *'toolbariconsize'* *'tbis'*
7277'toolbariconsize' 'tbis' string (default "small")
7278 global
7279 {not in Vi}
7280 {only in the GTK+ 2 GUI}
7281 Controls the size of toolbar icons. The possible values are:
7282 tiny Use tiny toolbar icons.
7283 small Use small toolbar icons (default).
7284 medium Use medium-sized toolbar icons.
7285 large Use large toolbar icons.
7286 The exact dimensions in pixels of the various icon sizes depend on
7287 the current theme. Common dimensions are large=32x32, medium=24x24,
7288 small=20x20 and tiny=16x16.
7289
7290 If 'toolbariconsize' is empty, the global default size as determined
7291 by user preferences or the current theme is used.
7292
7293 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7294'ttybuiltin' 'tbi' boolean (default on)
7295 global
7296 {not in Vi}
7297 When on, the builtin termcaps are searched before the external ones.
7298 When off the builtin termcaps are searched after the external ones.
7299 When this option is changed, you should set the 'term' option next for
7300 the change to take effect, for example: >
7301 :set notbi term=$TERM
7302< See also |termcap|.
7303 Rationale: The default for this option is "on", because the builtin
7304 termcap entries are generally better (many systems contain faulty
7305 xterm entries...).
7306
7307 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7308'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7309 sun-cmd, screen, rxvt, dtterm or
7310 iris-ansi; also on when running Vim in
7311 a DOS console)
7312 global
7313 {not in Vi}
7314 Indicates a fast terminal connection. More characters will be sent to
7315 the screen for redrawing, instead of using insert/delete line
7316 commands. Improves smoothness of redrawing when there are multiple
7317 windows and the terminal does not support a scrolling region.
7318 Also enables the extra writing of characters at the end of each screen
7319 line for lines that wrap. This helps when using copy/paste with the
7320 mouse in an xterm and other terminals.
7321
7322 *'ttymouse'* *'ttym'*
7323'ttymouse' 'ttym' string (default depends on 'term')
7324 global
7325 {not in Vi}
7326 {only in Unix and VMS, doesn't work in the GUI; not
7327 available when compiled without |+mouse|}
7328 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007329 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 *xterm-mouse*
7331 xterm xterm-like mouse handling. The mouse generates
7332 "<Esc>[Mscr", where "scr" is three bytes:
7333 "s" = button state
7334 "c" = column plus 33
7335 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007336 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007337 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 xterm2 Works like "xterm", but with the xterm reporting the
7339 mouse position while the mouse is dragged. This works
7340 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007341 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 work. See below for how Vim detects this
7343 automatically.
7344 *netterm-mouse*
7345 netterm NetTerm mouse handling. The mouse generates
7346 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7347 for the row and column.
7348 *dec-mouse*
7349 dec DEC terminal mouse handling. The mouse generates a
7350 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007351 This is also available for an Xterm, if it was
7352 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 *jsbterm-mouse*
7354 jsbterm JSB term mouse handling.
7355 *pterm-mouse*
7356 pterm QNX pterm mouse handling.
7357
7358 The mouse handling must be enabled at compile time |+mouse_xterm|
7359 |+mouse_dec| |+mouse_netterm|.
7360 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7361 recognized, if enabled at compile time. DEC terminal mouse codes
7362 are recognized if enabled at compile time, and 'ttymouse' is not
7363 "xterm" (because the xterm and dec mouse codes conflict).
7364 This option is automatically set to "xterm", when the 'term' option is
7365 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7366 or "xterm2" already. The main use of this option is to set it to
7367 "xterm", when the terminal name doesn't start with "xterm", but it can
7368 handle xterm mouse codes.
7369 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007370 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 feature and if |t_RV| is set to the escape sequence to request the
7372 xterm version number. Otherwise "xterm2" must be set explicitly.
7373 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7374 t_RV to an empty string: >
7375 :set t_RV=
7376<
7377 *'ttyscroll'* *'tsl'*
7378'ttyscroll' 'tsl' number (default 999)
7379 global
7380 Maximum number of lines to scroll the screen. If there are more lines
7381 to scroll the window is redrawn. For terminals where scrolling is
7382 very slow and redrawing is not slow this can be set to a small number,
7383 e.g., 3, to speed up displaying.
7384
7385 *'ttytype'* *'tty'*
7386'ttytype' 'tty' string (default from $TERM)
7387 global
7388 Alias for 'term', see above.
7389
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007390 *'undodir'* *'udir'*
7391'undodir' 'udir' string (default ".")
7392 global
7393 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007394 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007395 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007396 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007397 "." means using the directory of the file. The undo file name for
7398 "file.txt" is ".file.txt.un~".
7399 For other directories the file name is the full path of the edited
7400 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007401 When writing: The first directory that exists is used. "." always
7402 works, no directories after "." will be used for writing.
7403 When reading all entries are tried to find an undo file. The first
7404 undo file that exists is used. When it cannot be read an error is
7405 given, no further entry is used.
7406 See |undo-persistence|.
7407
7408 *'undofile'* *'udf'*
7409'undofile' 'udf' boolean (default off)
7410 local to buffer
7411 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007412 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007413 When on, Vim automatically saves undo history to an undo file when
7414 writing a buffer to a file, and restores undo history from the same
7415 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007416 The directory where the undo file is stored is specified by 'undodir'.
7417 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007418 The undo file is not read when 'undoreload' causes the buffer from
7419 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007420 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007421
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 *'undolevels'* *'ul'*
7423'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7424 Win32 and OS/2)
7425 global
7426 {not in Vi}
7427 Maximum number of changes that can be undone. Since undo information
7428 is kept in memory, higher numbers will cause more memory to be used
7429 (nevertheless, a single change can use an unlimited amount of memory).
7430 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7431 itself: >
7432 set ul=0
7433< But you can also get Vi compatibility by including the 'u' flag in
7434 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007435 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 Set to a negative number for no undo at all: >
7437 set ul=-1
7438< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007439 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007441 *'undoreload'* *'ur'*
7442'undoreload' 'ur' number (default 10000)
7443 global
7444 {not in Vi}
7445 Save the whole buffer for undo when reloading it. This applies to the
7446 ":e!" command and reloading for when the buffer changed outside of
7447 Vim. |FileChangedShell|
7448 The save only happens when this options is negative or when the number
7449 of lines is smaller than the value of this option.
7450 Set this option to zero to disable undo for a reload.
7451
7452 When saving undo for a reload, any undo file is not read.
7453
7454 Note that this causes the whole buffer to be stored in memory. Set
7455 this option to a lower value if you run out of memory.
7456
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 *'updatecount'* *'uc'*
7458'updatecount' 'uc' number (default: 200)
7459 global
7460 {not in Vi}
7461 After typing this many characters the swap file will be written to
7462 disk. When zero, no swap file will be created at all (see chapter on
7463 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7464 Vim with the "-n" option, see |startup|. When editing in readonly
7465 mode this option will be initialized to 10000.
7466 The swapfile can be disabled per buffer with |'swapfile'|.
7467 When 'updatecount' is set from zero to non-zero, swap files are
7468 created for all buffers that have 'swapfile' set. When 'updatecount'
7469 is set to zero, existing swap files are not deleted.
7470 Also see |'swapsync'|.
7471 This option has no meaning in buffers where |'buftype'| is "nofile"
7472 or "nowrite".
7473
7474 *'updatetime'* *'ut'*
7475'updatetime' 'ut' number (default 4000)
7476 global
7477 {not in Vi}
7478 If this many milliseconds nothing is typed the swap file will be
7479 written to disk (see |crash-recovery|). Also used for the
7480 |CursorHold| autocommand event.
7481
7482 *'verbose'* *'vbs'*
7483'verbose' 'vbs' number (default 0)
7484 global
7485 {not in Vi, although some versions have a boolean
7486 verbose option}
7487 When bigger than zero, Vim will give messages about what it is doing.
7488 Currently, these messages are given:
7489 >= 1 When the viminfo file is read or written.
7490 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007491 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 >= 8 Files for which a group of autocommands is executed.
7493 >= 9 Every executed autocommand.
7494 >= 12 Every executed function.
7495 >= 13 When an exception is thrown, caught, finished, or discarded.
7496 >= 14 Anything pending in a ":finally" clause.
7497 >= 15 Every executed Ex command (truncated at 200 characters).
7498
7499 This option can also be set with the "-V" argument. See |-V|.
7500 This option is also set by the |:verbose| command.
7501
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007502 When the 'verbosefile' option is set then the verbose messages are not
7503 displayed.
7504
7505 *'verbosefile'* *'vfile'*
7506'verbosefile' 'vfile' string (default empty)
7507 global
7508 {not in Vi}
7509 When not empty all messages are written in a file with this name.
7510 When the file exists messages are appended.
7511 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007512 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007513 Setting 'verbosefile' to a new value is like making it empty first.
7514 The difference with |:redir| is that verbose messages are not
7515 displayed when 'verbosefile' is set.
7516
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 *'viewdir'* *'vdir'*
7518'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7519 "$VIM/vimfiles/view",
7520 for Unix: "~/.vim/view",
7521 for Macintosh: "$VIM:vimfiles:view"
7522 for VMS: "sys$login:vimfiles/view"
7523 for RiscOS: "Choices:vimfiles/view")
7524 global
7525 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007526 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 feature}
7528 Name of the directory where to store files for |:mkview|.
7529 This option cannot be set from a |modeline| or in the |sandbox|, for
7530 security reasons.
7531
7532 *'viewoptions'* *'vop'*
7533'viewoptions' 'vop' string (default: "folds,options,cursor")
7534 global
7535 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007536 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 feature}
7538 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007539 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540 word save and restore ~
7541 cursor cursor position in file and in window
7542 folds manually created folds, opened/closed folds and local
7543 fold options
7544 options options and mappings local to a window or buffer (not
7545 global values for local options)
7546 slash backslashes in file names replaced with forward
7547 slashes
7548 unix with Unix end-of-line format (single <NL>), even when
7549 on Windows or DOS
7550
7551 "slash" and "unix" are useful on Windows when sharing view files
7552 with Unix. The Unix version of Vim cannot source dos format scripts,
7553 but the Windows version of Vim can source unix format scripts.
7554
7555 *'viminfo'* *'vi'* *E526* *E527* *E528*
7556'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007557 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7558 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7559 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 global
7561 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007562 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 feature}
7564 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007565 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 separated list of parameters, each consisting of a single character
7567 identifying the particular parameter, followed by a number or string
7568 which specifies the value of that parameter. If a particular
7569 character is left out, then the default value is used for that
7570 parameter. The following is a list of the identifying characters and
7571 the effect of their value.
7572 CHAR VALUE ~
7573 ! When included, save and restore global variables that start
7574 with an uppercase letter, and don't contain a lowercase
7575 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007576 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007577 read back correctly, you end up with an empty item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 " Maximum number of lines saved for each register. Old name of
7579 the '<' item, with the disadvantage that you need to put a
7580 backslash before the ", otherwise it will be recognized as the
7581 start of a comment!
7582 % When included, save and restore the buffer list. If Vim is
7583 started with a file name argument, the buffer list is not
7584 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007585 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 without a file name and buffers for help files are not written
7587 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007588 When followed by a number, the number specifies the maximum
7589 number of buffers that are stored. Without a number all
7590 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 ' Maximum number of previously edited files for which the marks
7592 are remembered. This parameter must always be included when
7593 'viminfo' is non-empty.
7594 Including this item also means that the |jumplist| and the
7595 |changelist| are stored in the viminfo file.
7596 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007597 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 patterns are also saved. When not included, the value of
7599 'history' is used.
7600 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007601 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 < Maximum number of lines saved for each register. If zero then
7603 registers are not saved. When not included, all lines are
7604 saved. '"' is the old name for this item.
7605 Also see the 's' item below: limit specified in Kbyte.
7606 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007607 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608 c When included, convert the text in the viminfo file from the
7609 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007610 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 f Whether file marks need to be stored. If zero, file marks ('0
7612 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007613 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 cursor position (when exiting or when doing ":wviminfo").
7615 h Disable the effect of 'hlsearch' when loading the viminfo
7616 file. When not included, it depends on whether ":nohlsearch"
7617 has been used since the last search command.
7618 n Name of the viminfo file. The name must immediately follow
7619 the 'n'. Must be the last one! If the "-i" argument was
7620 given when starting Vim, that file name overrides the one
7621 given here with 'viminfo'. Environment variables are expanded
7622 when opening the file, not when setting the option.
7623 r Removable media. The argument is a string (up to the next
7624 ','). This parameter can be given several times. Each
7625 specifies the start of a path for which no marks will be
7626 stored. This is to avoid removable media. For MS-DOS you
7627 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7628 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7629 ignored. Maximum length of each 'r' argument is 50
7630 characters.
7631 s Maximum size of an item in Kbyte. If zero then registers are
7632 not saved. Currently only applies to registers. The default
7633 "s10" will exclude registers with more than 10 Kbyte of text.
7634 Also see the '<' item above: line count limit.
7635
7636 Example: >
7637 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7638<
7639 '50 Marks will be remembered for the last 50 files you
7640 edited.
7641 <1000 Contents of registers (up to 1000 lines each) will be
7642 remembered.
7643 s100 Registers with more than 100 Kbyte text are skipped.
7644 :0 Command-line history will not be saved.
7645 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7646 no / Since '/' is not specified, the default will be used,
7647 that is, save all of the search history, and also the
7648 previous search and substitute patterns.
7649 no % The buffer list will not be saved nor read back.
7650 no h 'hlsearch' highlighting will be restored.
7651
7652 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7653 load the contents of the file, this is not done automatically.
7654
7655 This option cannot be set from a |modeline| or in the |sandbox|, for
7656 security reasons.
7657
7658 *'virtualedit'* *'ve'*
7659'virtualedit' 've' string (default "")
7660 global
7661 {not in Vi}
7662 {not available when compiled without the
7663 |+virtualedit| feature}
7664 A comma separated list of these words:
7665 block Allow virtual editing in Visual block mode.
7666 insert Allow virtual editing in Insert mode.
7667 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007668 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007669
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007671 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007672 of the line. Useful for selecting a rectangle in Visual mode and
7673 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007674 "onemore" is not the same, it will only allow moving the cursor just
7675 after the last character of the line. This makes some commands more
7676 consistent. Previously the cursor was always past the end of the line
7677 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007678 break some plugins or Vim scripts. For example because |l| can move
7679 the cursor after the last character. Use with care!
7680 Using the |$| command will move to the last character in the line, not
7681 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007682 It doesn't make sense to combine "all" with "onemore", but you will
7683 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684
7685 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7686'visualbell' 'vb' boolean (default off)
7687 global
7688 {not in Vi}
7689 Use visual bell instead of beeping. The terminal code to display the
7690 visual bell is given with 't_vb'. When no beep or flash is wanted,
7691 use ":set vb t_vb=".
7692 Note: When the GUI starts, 't_vb' is reset to its default value. You
7693 might want to set it again in your |gvimrc|.
7694 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7695 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7696 where 40 is the time in msec.
7697 Does not work on the Amiga, you always get a screen flash.
7698 Also see 'errorbells'.
7699
7700 *'warn'* *'nowarn'*
7701'warn' boolean (default on)
7702 global
7703 Give a warning message when a shell command is used while the buffer
7704 has been changed.
7705
7706 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7707'weirdinvert' 'wiv' boolean (default off)
7708 global
7709 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007710 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 It is provided for backwards compatibility with version 4.x.
7712 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7713 vice versa. Has no effect when the GUI is running.
7714
7715 *'whichwrap'* *'ww'*
7716'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7717 global
7718 {not in Vi}
7719 Allow specified keys that move the cursor left/right to move to the
7720 previous/next line when the cursor is on the first/last character in
7721 the line. Concatenate characters to allow this for these keys:
7722 char key mode ~
7723 b <BS> Normal and Visual
7724 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007725 h "h" Normal and Visual (not recommended)
7726 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 < <Left> Normal and Visual
7728 > <Right> Normal and Visual
7729 ~ "~" Normal
7730 [ <Left> Insert and Replace
7731 ] <Right> Insert and Replace
7732 For example: >
7733 :set ww=<,>,[,]
7734< allows wrap only when cursor keys are used.
7735 When the movement keys are used in combination with a delete or change
7736 operator, the <EOL> also counts for a character. This makes "3h"
7737 different from "3dh" when the cursor crosses the end of a line. This
7738 is also true for "x" and "X", because they do the same as "dl" and
7739 "dh". If you use this, you may also want to use the mapping
7740 ":map <BS> X" to make backspace delete the character in front of the
7741 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007742 When 'l' is included and it is used after an operator at the end of a
7743 line then it will not move to the next line. This makes "dl", "cl",
7744 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 NOTE: This option is set to the Vi default value when 'compatible' is
7746 set and to the Vim default value when 'compatible' is reset.
7747
7748 *'wildchar'* *'wc'*
7749'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7750 global
7751 {not in Vi}
7752 Character you have to type to start wildcard expansion in the
7753 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007754 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007755 The character is not recognized when used inside a macro. See
7756 'wildcharm' for that.
7757 Although 'wc' is a number option, you can set it to a special key: >
7758 :set wc=<Esc>
7759< NOTE: This option is set to the Vi default value when 'compatible' is
7760 set and to the Vim default value when 'compatible' is reset.
7761
7762 *'wildcharm'* *'wcm'*
7763'wildcharm' 'wcm' number (default: none (0))
7764 global
7765 {not in Vi}
7766 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007767 recognized when used inside a macro. You can find "spare" command-line
7768 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769 you'll never actually type 'wildcharm', just use it in mappings that
7770 automatically invoke completion mode, e.g.: >
7771 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007772 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773< Then after typing :ss you can use CTRL-P & CTRL-N.
7774
7775 *'wildignore'* *'wig'*
7776'wildignore' 'wig' string (default "")
7777 global
7778 {not in Vi}
7779 {not available when compiled without the |+wildignore|
7780 feature}
7781 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007782 patterns is ignored when completing file or directory names, and
7783 influences the result of |expand()|, |glob()| and |globpath()| unless
7784 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7786 Also see 'suffixes'.
7787 Example: >
7788 :set wildignore=*.o,*.obj
7789< The use of |:set+=| and |:set-=| is preferred when adding or removing
7790 a pattern from the list. This avoids problems when a future version
7791 uses another default.
7792
Bram Moolenaar94950a92010-12-02 16:01:29 +01007793
Bram Moolenaar81af9252010-12-10 20:35:50 +01007794 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007795'wildignorecase' 'wic' boolean (default off)
7796 global
7797 {not in Vi}
7798 When set case is ignored when completing file names and directories.
7799 Has no effect on systems where file name case is generally ignored.
7800 Does not apply when the shell is used to expand wildcards, which
7801 happens when there are special characters.
7802
7803
Bram Moolenaar071d4272004-06-13 20:20:40 +00007804 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7805'wildmenu' 'wmnu' boolean (default off)
7806 global
7807 {not in Vi}
7808 {not available if compiled without the |+wildmenu|
7809 feature}
7810 When 'wildmenu' is on, command-line completion operates in an enhanced
7811 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7812 the possible matches are shown just above the command line, with the
7813 first match highlighted (overwriting the status line, if there is
7814 one). Keys that show the previous/next match, such as <Tab> or
7815 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7816 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7817 specified. "longest" and "list" do not start "wildmenu" mode.
7818 If there are more matches than can fit in the line, a ">" is shown on
7819 the right and/or a "<" is shown on the left. The status line scrolls
7820 as needed.
7821 The "wildmenu" mode is abandoned when a key is hit that is not used
7822 for selecting a completion.
7823 While the "wildmenu" is active the following keys have special
7824 meanings:
7825
7826 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7827 <Down> - in filename/menu name completion: move into a
7828 subdirectory or submenu.
7829 <CR> - in menu completion, when the cursor is just after a
7830 dot: move into a submenu.
7831 <Up> - in filename/menu name completion: move up into
7832 parent directory or parent menu.
7833
7834 This makes the menus accessible from the console |console-menus|.
7835
7836 If you prefer the <Left> and <Right> keys to move the cursor instead
7837 of selecting a different match, use this: >
7838 :cnoremap <Left> <Space><BS><Left>
7839 :cnoremap <Right> <Space><BS><Right>
7840<
7841 The "WildMenu" highlighting is used for displaying the current match
7842 |hl-WildMenu|.
7843
7844 *'wildmode'* *'wim'*
7845'wildmode' 'wim' string (Vim default: "full")
7846 global
7847 {not in Vi}
7848 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007849 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007850 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 first part specifies the behavior for the first use of 'wildchar',
7852 The second part for the second use, etc.
7853 These are the possible values for each part:
7854 "" Complete only the first match.
7855 "full" Complete the next full match. After the last match,
7856 the original string is used and then the first match
7857 again.
7858 "longest" Complete till longest common string. If this doesn't
7859 result in a longer string, use the next part.
7860 "longest:full" Like "longest", but also start 'wildmenu' if it is
7861 enabled.
7862 "list" When more than one match, list all matches.
7863 "list:full" When more than one match, list all matches and
7864 complete first match.
7865 "list:longest" When more than one match, list all matches and
7866 complete till longest common string.
7867 When there is only a single match, it is fully completed in all cases.
7868
7869 Examples: >
7870 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007871< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 :set wildmode=longest,full
7873< Complete longest common string, then each full match >
7874 :set wildmode=list:full
7875< List all matches and complete each full match >
7876 :set wildmode=list,full
7877< List all matches without completing, then each full match >
7878 :set wildmode=longest,list
7879< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007880 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007882 *'wildoptions'* *'wop'*
7883'wildoptions' 'wop' string (default "")
7884 global
7885 {not in Vi}
7886 {not available when compiled without the |+wildignore|
7887 feature}
7888 A list of words that change how command line completion is done.
7889 Currently only one word is allowed:
7890 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007891 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007892 is displayed per line. Often used tag kinds are:
7893 d #define
7894 f function
7895 Also see |cmdline-completion|.
7896
Bram Moolenaar071d4272004-06-13 20:20:40 +00007897 *'winaltkeys'* *'wak'*
7898'winaltkeys' 'wak' string (default "menu")
7899 global
7900 {not in Vi}
7901 {only used in Win32, Motif, GTK and Photon GUI}
7902 Some GUI versions allow the access to menu entries by using the ALT
7903 key in combination with a character that appears underlined in the
7904 menu. This conflicts with the use of the ALT key for mappings and
7905 entering special characters. This option tells what to do:
7906 no Don't use ALT keys for menus. ALT key combinations can be
7907 mapped, but there is no automatic handling. This can then be
7908 done with the |:simalt| command.
7909 yes ALT key handling is done by the windowing system. ALT key
7910 combinations cannot be mapped.
7911 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007912 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 keys can be mapped.
7914 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7915 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007916 This option is not used for <F10>; on Win32 and with GTK <F10> will
7917 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007919 *'window'* *'wi'*
7920'window' 'wi' number (default screen height - 1)
7921 global
7922 Window height. Do not confuse this with the height of the Vim window,
7923 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007924 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7925 value is smaller than 'lines' minus one. The screen will scroll
7926 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007927 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7928 in a much smarter way, taking care of wrapping lines.
7929 When resizing the Vim window, the value is smaller than 1 or more than
7930 or equal to 'lines' it will be set to 'lines' minus 1.
7931 {Vi also uses the option to specify the number of displayed lines}
7932
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933 *'winheight'* *'wh'* *E591*
7934'winheight' 'wh' number (default 1)
7935 global
7936 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007937 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 feature}
7939 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007940 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007941 focus goes to a window that is smaller, its size is increased, at the
7942 cost of the height of other windows.
7943 Set 'winheight' to a small number for normal editing.
7944 Set it to 999 to make the current window fill most of the screen.
7945 Other windows will be only 'winminheight' high. This has the drawback
7946 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7947 to create only two windows, set the option after startup is done,
7948 using the |VimEnter| event: >
7949 au VimEnter * set winheight=999
7950< Minimum value is 1.
7951 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 height of the current window.
7953 'winheight' applies to the current window. Use 'winminheight' to set
7954 the minimal height for other windows.
7955
7956 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7957'winfixheight' 'wfh' boolean (default off)
7958 local to window
7959 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007960 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 feature}
7962 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007963 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7964 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 The height may be changed anyway when running out of room.
7966
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007967 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7968'winfixwidth' 'wfw' boolean (default off)
7969 local to window
7970 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007971 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007972 feature}
7973 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007974 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007975 The width may be changed anyway when running out of room.
7976
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977 *'winminheight'* *'wmh'*
7978'winminheight' 'wmh' number (default 1)
7979 global
7980 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007981 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 feature}
7983 The minimal height of a window, when it's not the current window.
7984 This is a hard minimum, windows will never become smaller.
7985 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7986 status bar) if necessary. They will return to at least one line when
7987 they become active (since the cursor has to have somewhere to go.)
7988 Use 'winheight' to set the minimal height of the current window.
7989 This option is only checked when making a window smaller. Don't use a
7990 large number, it will cause errors when opening more than a few
7991 windows. A value of 0 to 3 is reasonable.
7992
7993 *'winminwidth'* *'wmw'*
7994'winminwidth' 'wmw' number (default 1)
7995 global
7996 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007997 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 feature}
7999 The minimal width of a window, when it's not the current window.
8000 This is a hard minimum, windows will never become smaller.
8001 When set to zero, windows may be "squashed" to zero columns (i.e. just
8002 a vertical separator) if necessary. They will return to at least one
8003 line when they become active (since the cursor has to have somewhere
8004 to go.)
8005 Use 'winwidth' to set the minimal width of the current window.
8006 This option is only checked when making a window smaller. Don't use a
8007 large number, it will cause errors when opening more than a few
8008 windows. A value of 0 to 12 is reasonable.
8009
8010 *'winwidth'* *'wiw'* *E592*
8011'winwidth' 'wiw' number (default 20)
8012 global
8013 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008014 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 feature}
8016 Minimal number of columns for the current window. This is not a hard
8017 minimum, Vim will use fewer columns if there is not enough room. If
8018 the current window is smaller, its size is increased, at the cost of
8019 the width of other windows. Set it to 999 to make the current window
8020 always fill the screen. Set it to a small number for normal editing.
8021 The width is not adjusted after one of the commands to change the
8022 width of the current window.
8023 'winwidth' applies to the current window. Use 'winminwidth' to set
8024 the minimal width for other windows.
8025
8026 *'wrap'* *'nowrap'*
8027'wrap' boolean (default on)
8028 local to window
8029 {not in Vi}
8030 This option changes how text is displayed. It doesn't change the text
8031 in the buffer, see 'textwidth' for that.
8032 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008033 displaying continues on the next line. When off lines will not wrap
8034 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 moved to a part that is not shown, the screen will scroll
8036 horizontally.
8037 The line will be broken in the middle of a word if necessary. See
8038 'linebreak' to get the break at a word boundary.
8039 To make scrolling horizontally a bit more useful, try this: >
8040 :set sidescroll=5
8041 :set listchars+=precedes:<,extends:>
8042< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008043 This option can't be set from a |modeline| when the 'diff' option is
8044 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045
8046 *'wrapmargin'* *'wm'*
8047'wrapmargin' 'wm' number (default 0)
8048 local to buffer
8049 Number of characters from the right window border where wrapping
8050 starts. When typing text beyond this limit, an <EOL> will be inserted
8051 and inserting continues on the next line.
8052 Options that add a margin, such as 'number' and 'foldcolumn', cause
8053 the text width to be further reduced. This is Vi compatible.
8054 When 'textwidth' is non-zero, this option is not used.
8055 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8056 and less usefully}
8057
8058 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8059'wrapscan' 'ws' boolean (default on) *E384* *E385*
8060 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008061 Searches wrap around the end of the file. Also applies to |]s| and
8062 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063
8064 *'write'* *'nowrite'*
8065'write' boolean (default on)
8066 global
8067 {not in Vi}
8068 Allows writing files. When not set, writing a file is not allowed.
8069 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008070 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 argument. Filtering text is still possible, even though this requires
8072 writing a temporary file.
8073
8074 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8075'writeany' 'wa' boolean (default off)
8076 global
8077 Allows writing to any file with no need for "!" override.
8078
8079 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8080'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8081 otherwise)
8082 global
8083 {not in Vi}
8084 Make a backup before overwriting a file. The backup is removed after
8085 the file was successfully written, unless the 'backup' option is
8086 also on. Reset this option if your file system is almost full. See
8087 |backup-table| for another explanation.
8088 When the 'backupskip' pattern matches, a backup is not made anyway.
8089 NOTE: This option is set to the default value when 'compatible' is
8090 set.
8091
8092 *'writedelay'* *'wd'*
8093'writedelay' 'wd' number (default 0)
8094 global
8095 {not in Vi}
8096 The number of microseconds to wait for each character sent to the
8097 screen. When non-zero, characters are sent to the terminal one by
8098 one. For MS-DOS pcterm this does not work. For debugging purposes.
8099
8100 vim:tw=78:ts=8:ft=help:norl: