blob: c7614742196077b3b2614434e840dee4ed613a36 [file] [log] [blame]
Bram Moolenaar15146672011-10-20 22:22:38 +02001*options.txt* For Vim version 7.3. Last change: 2011 Sep 30
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.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002120 *cpo-;*
2121 ; When using |,| or |;| to repeat the last |t| search
2122 and the cursor is right in front of the searched
2123 character, the cursor won't move. When not included,
2124 the cursor would skip over it and jump to the
2125 following occurence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002126
2127 POSIX flags. These are not included in the Vi default value, except
2128 when $VIM_POSIX was set on startup. |posix|
2129
2130 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002131 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002132 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002133 *cpo-&*
2134 & When ":preserve" was used keep the swap file when
2135 exiting normally while this buffer is still loaded.
2136 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002137 *cpo-\*
2138 \ Backslash in a [] range in a search pattern is taken
2139 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002140 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2141 '\' excluded: "/[ \-]" finds <Space> and '-'
2142 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002143 *cpo-/*
2144 / When "%" is used as the replacement string in a |:s|
2145 command, use the previous replacement string. |:s%|
2146 *cpo-{*
2147 { The |{| and |}| commands also stop at a "{" character
2148 at the start of a line.
2149 *cpo-.*
2150 . The ":chdir" and ":cd" commands fail if the current
2151 buffer is modified, unless ! is used. Vim doesn't
2152 need this, since it remembers the full path of an
2153 opened file.
2154 *cpo-bar*
2155 | The value of the $LINES and $COLUMNS environment
2156 variables overrule the terminal size values obtained
2157 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002158
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002160 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002161'cryptmethod' string (default "zip")
2162 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002163 {not in Vi}
2164 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002165 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002166 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002167 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002168 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002169 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002170 or later, files can NOT be read by Vim 7.2 and older.
2171 This adds a "seed" to the file, every time you write
2172 the file the encrypted bytes will be different.
2173
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002174 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002175 to the detected method of the file being read. Thus if you write it
2176 without changing 'cryptmethod' the same method will be used.
2177 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002178 explicitly write it, you don't get a warning unless there are other
2179 modifications. Also see |:X|.
2180
2181 When setting the global value to an empty string, it will end up with
2182 the value "zip". When setting the local value to an empty string the
2183 buffer will use the global value.
2184
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002185 When a new encryption method is added in a later version of Vim, and
2186 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002187 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002188
2189
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 *'cscopepathcomp'* *'cspc'*
2191'cscopepathcomp' 'cspc' number (default 0)
2192 global
2193 {not available when compiled without the |+cscope|
2194 feature}
2195 {not in Vi}
2196 Determines how many components of the path to show in a list of tags.
2197 See |cscopepathcomp|.
2198
2199 *'cscopeprg'* *'csprg'*
2200'cscopeprg' 'csprg' string (default "cscope")
2201 global
2202 {not available when compiled without the |+cscope|
2203 feature}
2204 {not in Vi}
2205 Specifies the command to execute cscope. See |cscopeprg|.
2206 This option cannot be set from a |modeline| or in the |sandbox|, for
2207 security reasons.
2208
2209 *'cscopequickfix'* *'csqf'*
2210'cscopequickfix' 'csqf' string (default "")
2211 global
2212 {not available when compiled without the |+cscope|
2213 or |+quickfix| features}
2214 {not in Vi}
2215 Specifies whether to use quickfix window to show cscope results.
2216 See |cscopequickfix|.
2217
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002218 *'cscoperelative'* *'csre'*
2219'cscoperelative' 'csre' boolean (default off)
2220 global
2221 {not available when compiled without the |+cscope|
2222 feature}
2223 {not in Vi}
2224 In the absence of a prefix (-P) for cscope. setting this option enables
2225 to use the basename of cscope.out path as the prefix.
2226 See |cscoperelative|.
2227
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2229'cscopetag' 'cst' boolean (default off)
2230 global
2231 {not available when compiled without the |+cscope|
2232 feature}
2233 {not in Vi}
2234 Use cscope for tag commands. See |cscope-options|.
2235 NOTE: This option is reset when 'compatible' is set.
2236
2237 *'cscopetagorder'* *'csto'*
2238'cscopetagorder' 'csto' number (default 0)
2239 global
2240 {not available when compiled without the |+cscope|
2241 feature}
2242 {not in Vi}
2243 Determines the order in which ":cstag" performs a search. See
2244 |cscopetagorder|.
2245 NOTE: This option is set to 0 when 'compatible' is set.
2246
2247 *'cscopeverbose'* *'csverb'*
2248 *'nocscopeverbose'* *'nocsverb'*
2249'cscopeverbose' 'csverb' boolean (default off)
2250 global
2251 {not available when compiled without the |+cscope|
2252 feature}
2253 {not in Vi}
2254 Give messages when adding a cscope database. See |cscopeverbose|.
2255 NOTE: This option is reset when 'compatible' is set.
2256
Bram Moolenaar860cae12010-06-05 23:22:07 +02002257 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2258'cursorbind' 'crb' boolean (default off)
2259 local to window
2260 {not in Vi}
2261 {not available when compiled without the |+cursorbind|
2262 feature}
2263 When this option is set, as the cursor in the current
2264 window moves other cursorbound windows (windows that also have
2265 this option set) move their cursors to the corresponding line and
2266 column. This option is useful for viewing the
2267 differences between two versions of a file (see 'diff'); in diff mode,
2268 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002269 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002270
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002271
2272 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2273'cursorcolumn' 'cuc' boolean (default off)
2274 local to window
2275 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002276 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002277 feature}
2278 Highlight the screen column of the cursor with CursorColumn
2279 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2280 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002281 If you only want the highlighting in the current window you can use
2282 these autocommands: >
2283 au WinLeave * set nocursorline nocursorcolumn
2284 au WinEnter * set cursorline cursorcolumn
2285<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002286
2287 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2288'cursorline' 'cul' boolean (default off)
2289 local to window
2290 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002291 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002292 feature}
2293 Highlight the screen line of the cursor with CursorLine
2294 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2295 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002296 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002297 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002298
2299
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 *'debug'*
2301'debug' string (default "")
2302 global
2303 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002304 These values can be used:
2305 msg Error messages that would otherwise be omitted will be given
2306 anyway.
2307 throw Error messages that would otherwise be omitted will be given
2308 anyway and also throw an exception and set |v:errmsg|.
2309 beep A message will be given when otherwise only a beep would be
2310 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002311 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002312 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2313 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314
2315 *'define'* *'def'*
2316'define' 'def' string (default "^\s*#\s*define")
2317 global or local to buffer |global-local|
2318 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002319 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320 pattern, just like for the "/" command. This option is used for the
2321 commands like "[i" and "[d" |include-search|. The 'isident' option is
2322 used to recognize the defined name after the match:
2323 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2324 See |option-backslash| about inserting backslashes to include a space
2325 or backslash.
2326 The default value is for C programs. For C++ this value would be
2327 useful, to include const type declarations: >
2328 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2329< When using the ":set" command, you need to double the backslashes!
2330
2331 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2332'delcombine' 'deco' boolean (default off)
2333 global
2334 {not in Vi}
2335 {only available when compiled with the |+multi_byte|
2336 feature}
2337 If editing Unicode and this option is set, backspace and Normal mode
2338 "x" delete each combining character on its own. When it is off (the
2339 default) the character along with its combining characters are
2340 deleted.
2341 Note: When 'delcombine' is set "xx" may work different from "2x"!
2342
2343 This is useful for Arabic, Hebrew and many other languages where one
2344 may have combining characters overtop of base characters, and want
2345 to remove only the combining ones.
2346
2347 *'dictionary'* *'dict'*
2348'dictionary' 'dict' string (default "")
2349 global or local to buffer |global-local|
2350 {not in Vi}
2351 List of file names, separated by commas, that are used to lookup words
2352 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2353 contain a list of words. This can be one word per line, or several
2354 words per line, separated by non-keyword characters (white space is
2355 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002356 When this option is empty, or an entry "spell" is present, spell
2357 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002358 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 after a comma are ignored, otherwise spaces are included in the file
2360 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002361 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362 Where to find a list of words?
2363 - On FreeBSD, there is the file "/usr/share/dict/words".
2364 - In the Simtel archive, look in the "msdos/linguist" directory.
2365 - In "miscfiles" of the GNU collection.
2366 The use of |:set+=| and |:set-=| is preferred when adding or removing
2367 directories from the list. This avoids problems when a future version
2368 uses another default.
2369 Backticks cannot be used in this option for security reasons.
2370
2371 *'diff'* *'nodiff'*
2372'diff' boolean (default off)
2373 local to window
2374 {not in Vi}
2375 {not available when compiled without the |+diff|
2376 feature}
2377 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002378 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379
2380 *'dex'* *'diffexpr'*
2381'diffexpr' 'dex' string (default "")
2382 global
2383 {not in Vi}
2384 {not available when compiled without the |+diff|
2385 feature}
2386 Expression which is evaluated to obtain an ed-style diff file from two
2387 versions of a file. See |diff-diffexpr|.
2388 This option cannot be set from a |modeline| or in the |sandbox|, for
2389 security reasons.
2390
2391 *'dip'* *'diffopt'*
2392'diffopt' 'dip' string (default "filler")
2393 global
2394 {not in Vi}
2395 {not available when compiled without the |+diff|
2396 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002397 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 All are optional. Items must be separated by a comma.
2399
2400 filler Show filler lines, to keep the text
2401 synchronized with a window that has inserted
2402 lines at the same position. Mostly useful
2403 when windows are side-by-side and 'scrollbind'
2404 is set.
2405
2406 context:{n} Use a context of {n} lines between a change
2407 and a fold that contains unchanged lines.
2408 When omitted a context of six lines is used.
2409 See |fold-diff|.
2410
2411 icase Ignore changes in case of text. "a" and "A"
2412 are considered the same. Adds the "-i" flag
2413 to the "diff" command if 'diffexpr' is empty.
2414
2415 iwhite Ignore changes in amount of white space. Adds
2416 the "-b" flag to the "diff" command if
2417 'diffexpr' is empty. Check the documentation
2418 of the "diff" command for what this does
2419 exactly. It should ignore adding trailing
2420 white space, but not leading white space.
2421
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002422 horizontal Start diff mode with horizontal splits (unless
2423 explicitly specified otherwise).
2424
2425 vertical Start diff mode with vertical splits (unless
2426 explicitly specified otherwise).
2427
2428 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2429 starting diff mode. Without this 2 is used.
2430
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 Examples: >
2432
2433 :set diffopt=filler,context:4
2434 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002435 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436<
2437 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2438'digraph' 'dg' boolean (default off)
2439 global
2440 {not in Vi}
2441 {not available when compiled without the |+digraphs|
2442 feature}
2443 Enable the entering of digraphs in Insert mode with {char1} <BS>
2444 {char2}. See |digraphs|.
2445 NOTE: This option is reset when 'compatible' is set.
2446
2447 *'directory'* *'dir'*
2448'directory' 'dir' string (default for Amiga: ".,t:",
2449 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2450 for Unix: ".,~/tmp,/var/tmp,/tmp")
2451 global
2452 List of directory names for the swap file, separated with commas.
2453 - The swap file will be created in the first directory where this is
2454 possible.
2455 - Empty means that no swap file will be used (recovery is
2456 impossible!).
2457 - A directory "." means to put the swap file in the same directory as
2458 the edited file. On Unix, a dot is prepended to the file name, so
2459 it doesn't show in a directory listing. On MS-Windows the "hidden"
2460 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002461 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 put the swap file relative to where the edited file is. The leading
2463 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002464 - For Unix and Win32, if a directory ends in two path separators "//"
2465 or "\\", the swap file name will be built from the complete path to
2466 the file with all path separators substituted to percent '%' signs.
2467 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002468 On Win32, when a separating comma is following, you must use "//",
2469 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470 - Spaces after the comma are ignored, other spaces are considered part
2471 of the directory name. To have a space at the start of a directory
2472 name, precede it with a backslash.
2473 - To include a comma in a directory name precede it with a backslash.
2474 - A directory name may end in an ':' or '/'.
2475 - Environment variables are expanded |:set_env|.
2476 - Careful with '\' characters, type one before a space, type two to
2477 get one in the option (see |option-backslash|), for example: >
2478 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2479< - For backwards compatibility with Vim version 3.0 a '>' at the start
2480 of the option is removed.
2481 Using "." first in the list is recommended. This means that editing
2482 the same file twice will result in a warning. Using "/tmp" on Unix is
2483 discouraged: When the system crashes you lose the swap file.
2484 "/var/tmp" is often not cleared when rebooting, thus is a better
2485 choice than "/tmp". But it can contain a lot of files, your swap
2486 files get lost in the crowd. That is why a "tmp" directory in your
2487 home directory is tried first.
2488 The use of |:set+=| and |:set-=| is preferred when adding or removing
2489 directories from the list. This avoids problems when a future version
2490 uses another default.
2491 This option cannot be set from a |modeline| or in the |sandbox|, for
2492 security reasons.
2493 {Vi: directory to put temp file in, defaults to "/tmp"}
2494
2495 *'display'* *'dy'*
2496'display' 'dy' string (default "")
2497 global
2498 {not in Vi}
2499 Change the way text is displayed. This is comma separated list of
2500 flags:
2501 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002502 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503 last line that doesn't fit is replaced with "@" lines.
2504 uhex Show unprintable characters hexadecimal as <xx>
2505 instead of using ^C and ~C.
2506
2507 *'eadirection'* *'ead'*
2508'eadirection' 'ead' string (default "both")
2509 global
2510 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002511 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002512 feature}
2513 Tells when the 'equalalways' option applies:
2514 ver vertically, width of windows is not affected
2515 hor horizontally, height of windows is not affected
2516 both width and height of windows is affected
2517
2518 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2519'edcompatible' 'ed' boolean (default off)
2520 global
2521 Makes the 'g' and 'c' flags of the ":substitute" command to be
2522 toggled each time the flag is given. See |complex-change|. See
2523 also 'gdefault' option.
2524 Switching this option on is discouraged!
2525
2526 *'encoding'* *'enc'* *E543*
2527'encoding' 'enc' string (default: "latin1" or value from $LANG)
2528 global
2529 {only available when compiled with the |+multi_byte|
2530 feature}
2531 {not in Vi}
2532 Sets the character encoding used inside Vim. It applies to text in
2533 the buffers, registers, Strings in expressions, text stored in the
2534 viminfo file, etc. It sets the kind of characters which Vim can work
2535 with. See |encoding-names| for the possible values.
2536
2537 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002538 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002540 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541
Bram Moolenaar865242e2010-07-14 21:12:05 +02002542 This option cannot be set from a |modeline|. It would most likely
2543 corrupt the text.
2544
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2546 "utf-8". Although care has been taken to allow different values of
2547 'encoding', "utf-8" is the natural choice for the environment and
2548 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002549 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 versions, and to avoid changing the encoding of newly created files
2551 without your knowledge (in case 'fileencodings' is empty).
2552
2553 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002554 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 iconv() or as specified with 'charconvert'.
2556
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002557 If you need to know whether 'encoding' is a multi-byte encoding, you
2558 can use: >
2559 if has("multi_byte_encoding")
2560<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 Normally 'encoding' will be equal to your current locale. This will
2562 be the default if Vim recognizes your environment settings. If
2563 'encoding' is not set to the current locale, 'termencoding' must be
2564 set to convert typed and displayed text. See |encoding-table|.
2565
2566 When you set this option, it fires the |EncodingChanged| autocommand
2567 event so that you can set up fonts if necessary.
2568
2569 When the option is set, the value is converted to lowercase. Thus
2570 you can set it with uppercase values too. Underscores are translated
2571 to '-' signs.
2572 When the encoding is recognized, it is changed to the standard name.
2573 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2574 "iso-8859-2" and "utf8" becomes "utf-8".
2575
2576 Note: "latin1" is also used when the encoding could not be detected.
2577 This only works when editing files in the same encoding! When the
2578 actual character set is not latin1, make sure 'fileencoding' and
2579 'fileencodings' are empty. When conversion is needed, switch to using
2580 utf-8.
2581
2582 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2583 You don't notice this while editing, but it does matter for the
2584 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2585 setting 'encoding' to one of these values instead of utf-8 only has
2586 effect for encoding used for files when 'fileencoding' is empty.
2587
Bram Moolenaar661b1822005-07-28 22:36:45 +00002588 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2589 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590
2591 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2592'endofline' 'eol' boolean (default on)
2593 local to buffer
2594 {not in Vi}
2595 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002596 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 option is automatically set when starting to edit a new file, unless
2598 the file does not have an <EOL> for the last line in the file, in
2599 which case it is reset. Normally you don't have to set or reset this
2600 option. When 'binary' is off the value is not used when writing the
2601 file. When 'binary' is on it is used to remember the presence of a
2602 <EOL> for the last line in the file, so that when you write the file
2603 the situation from the original file can be kept. But you can change
2604 it if you want to.
2605
2606 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2607'equalalways' 'ea' boolean (default on)
2608 global
2609 {not in Vi}
2610 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002611 splitting or closing a window. This also happens the moment the
2612 option is switched on. When off, splitting a window will reduce the
2613 size of the current window and leave the other windows the same. When
2614 closing a window the extra lines are given to the window next to it
2615 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 When mixing vertically and horizontally split windows, a minimal size
2617 is computed and some windows may be larger if there is room. The
2618 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002619 Changing the height and width of a window can be avoided by setting
2620 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002621 If a window size is specified when creating a new window sizes are
2622 currently not equalized (it's complicated, but may be implemented in
2623 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624
2625 *'equalprg'* *'ep'*
2626'equalprg' 'ep' string (default "")
2627 global or local to buffer |global-local|
2628 {not in Vi}
2629 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002630 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002631 or 'indentexpr'. When Vim was compiled without internal formatting,
2632 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002633 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 about including spaces and backslashes.
2635 This option cannot be set from a |modeline| or in the |sandbox|, for
2636 security reasons.
2637
2638 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2639'errorbells' 'eb' boolean (default off)
2640 global
2641 Ring the bell (beep or screen flash) for error messages. This only
2642 makes a difference for error messages, the bell will be used always
2643 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002644 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 screen flash or do nothing.
2646
2647 *'errorfile'* *'ef'*
2648'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2649 others: "errors.err")
2650 global
2651 {not in Vi}
2652 {not available when compiled without the |+quickfix|
2653 feature}
2654 Name of the errorfile for the QuickFix mode (see |:cf|).
2655 When the "-q" command-line argument is used, 'errorfile' is set to the
2656 following argument. See |-q|.
2657 NOT used for the ":make" command. See 'makeef' for that.
2658 Environment variables are expanded |:set_env|.
2659 See |option-backslash| about including spaces and backslashes.
2660 This option cannot be set from a |modeline| or in the |sandbox|, for
2661 security reasons.
2662
2663 *'errorformat'* *'efm'*
2664'errorformat' 'efm' string (default is very long)
2665 global or local to buffer |global-local|
2666 {not in Vi}
2667 {not available when compiled without the |+quickfix|
2668 feature}
2669 Scanf-like description of the format for the lines in the error file
2670 (see |errorformat|).
2671
2672 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2673'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2674 global
2675 {not in Vi}
2676 Function keys that start with an <Esc> are recognized in Insert
2677 mode. When this option is off, the cursor and function keys cannot be
2678 used in Insert mode if they start with an <Esc>. The advantage of
2679 this is that the single <Esc> is recognized immediately, instead of
2680 after one second. Instead of resetting this option, you might want to
2681 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2682 when 'esckeys' is off, you can still map anything, but the cursor keys
2683 won't work by default.
2684 NOTE: This option is set to the Vi default value when 'compatible' is
2685 set and to the Vim default value when 'compatible' is reset.
2686
2687 *'eventignore'* *'ei'*
2688'eventignore' 'ei' string (default "")
2689 global
2690 {not in Vi}
2691 {not available when compiled without the |+autocmd|
2692 feature}
2693 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002694 When set to "all" or when "all" is one of the items, all autocommand
2695 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 Otherwise this is a comma separated list of event names. Example: >
2697 :set ei=WinEnter,WinLeave
2698<
2699 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2700'expandtab' 'et' boolean (default off)
2701 local to buffer
2702 {not in Vi}
2703 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002704 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2706 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2707 NOTE: This option is reset when 'compatible' is set.
2708
2709 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2710'exrc' 'ex' boolean (default off)
2711 global
2712 {not in Vi}
2713 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2714 directory. If you switch this option on you should also consider
2715 setting the 'secure' option (see |initialization|). Using a local
2716 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2717 also see |.vimrc| and |gui-init|.
2718 This option cannot be set from a |modeline| or in the |sandbox|, for
2719 security reasons.
2720
2721 *'fileencoding'* *'fenc'* *E213*
2722'fileencoding' 'fenc' string (default: "")
2723 local to buffer
2724 {only available when compiled with the |+multi_byte|
2725 feature}
2726 {not in Vi}
2727 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002728
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002730 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 When 'fileencoding' is empty, the same value as 'encoding' will be
2732 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002733 Conversion will also be done when 'encoding' and 'fileencoding' are
2734 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2735 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002737 'encoding' is "utf-8" or another Unicode encoding, conversion
2738 is most likely done in a way that the reverse conversion
2739 results in the same text. When 'encoding' is not "utf-8" some
2740 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002741
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 See 'encoding' for the possible values. Additionally, values may be
2743 specified that can be handled by the converter, see
2744 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002745
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 When reading a file 'fileencoding' will be set from 'fileencodings'.
2747 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002748 'fileencoding', use the |++enc| argument. One exception: when
2749 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002750 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002751
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2753 When the option is set, the value is converted to lowercase. Thus
2754 you can set it with uppercase values too. '_' characters are
2755 replaced with '-'. If a name is recognized from the list for
2756 'encoding', it is replaced by the standard name. For example
2757 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002758
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 When this option is set, after starting to edit a file, the 'modified'
2760 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002761
2762 Keep in mind that changing 'fenc' from a modeline happens
2763 AFTER the text has been read, thus it applies to when the file will be
2764 written. If you do set 'fenc' in a modeline, you might want to set
2765 'nomodified' to avoid not being able to ":q".
2766
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 This option can not be changed when 'modifiable' is off.
2768
2769 *'fe'*
2770 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002771 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 old short name was 'fe', which is no longer used.
2773
2774 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002775'fileencodings' 'fencs' string (default: "ucs-bom",
2776 "ucs-bom,utf-8,default,latin1" when
2777 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 global
2779 {only available when compiled with the |+multi_byte|
2780 feature}
2781 {not in Vi}
2782 This is a list of character encodings considered when starting to edit
2783 an existing file. When a file is read, Vim tries to use the first
2784 mentioned character encoding. If an error is detected, the next one
2785 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002786 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 an empty string, which means the value of 'encoding' is used.
2788 WARNING: Conversion can cause loss of information! When
2789 'encoding' is "utf-8" (or one of the other Unicode variants)
2790 conversion is most likely done in a way that the reverse
2791 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002792 "utf-8" some non-ASCII characters may be lost! You can use
2793 the |++bad| argument to specify what is done with characters
2794 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 For an empty file or a file with only ASCII characters most encodings
2796 will work and the first entry of 'fileencodings' will be used (except
2797 "ucs-bom", which requires the BOM to be present). If you prefer
2798 another encoding use an BufReadPost autocommand event to test if your
2799 preferred encoding is to be used. Example: >
2800 au BufReadPost * if search('\S', 'w') == 0 |
2801 \ set fenc=iso-2022-jp | endif
2802< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2803 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002804 When the |++enc| argument is used then the value of 'fileencodings' is
2805 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002806 Note that 'fileencodings' is not used for a new file, the global value
2807 of 'fileencoding' is used instead. You can set it with: >
2808 :setglobal fenc=iso-8859-2
2809< This means that a non-existing file may get a different encoding than
2810 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 The special value "ucs-bom" can be used to check for a Unicode BOM
2812 (Byte Order Mark) at the start of the file. It must not be preceded
2813 by "utf-8" or another Unicode encoding for this to work properly.
2814 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2815 because Vim cannot detect an error, thus the encoding is always
2816 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002817 The special value "default" can be used for the encoding from the
2818 environment. This is the default value for 'encoding'. It is useful
2819 when 'encoding' is set to "utf-8" and your environment uses a
2820 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002821 When 'encoding' is "utf-8" and a file contains an illegal byte
2822 sequence it won't be recognized as UTF-8. You can use the |8g8|
2823 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 WRONG VALUES: WHAT'S WRONG:
2825 latin1,utf-8 "latin1" will always be used
2826 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2827 file
2828 cp1250,latin1 "cp1250" will always be used
2829 If 'fileencodings' is empty, 'fileencoding' is not modified.
2830 See 'fileencoding' for the possible values.
2831 Setting this option does not have an effect until the next time a file
2832 is read.
2833
2834 *'fileformat'* *'ff'*
2835'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2836 Unix default: "unix",
2837 Macintosh default: "mac")
2838 local to buffer
2839 {not in Vi}
2840 This gives the <EOL> of the current buffer, which is used for
2841 reading/writing the buffer from/to a file:
2842 dos <CR> <NL>
2843 unix <NL>
2844 mac <CR>
2845 When "dos" is used, CTRL-Z at the end of a file is ignored.
2846 See |file-formats| and |file-read|.
2847 For the character encoding of the file see 'fileencoding'.
2848 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2849 works like it was set to "unix'.
2850 This option is set automatically when starting to edit a file and
2851 'fileformats' is not empty and 'binary' is off.
2852 When this option is set, after starting to edit a file, the 'modified'
2853 option is set, because the file would be different when written.
2854 This option can not be changed when 'modifiable' is off.
2855 For backwards compatibility: When this option is set to "dos",
2856 'textmode' is set, otherwise 'textmode' is reset.
2857
2858 *'fileformats'* *'ffs'*
2859'fileformats' 'ffs' string (default:
2860 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2861 Vim Unix: "unix,dos",
2862 Vim Mac: "mac,unix,dos",
2863 Vi Cygwin: "unix,dos",
2864 Vi others: "")
2865 global
2866 {not in Vi}
2867 This gives the end-of-line (<EOL>) formats that will be tried when
2868 starting to edit a new buffer and when reading a file into an existing
2869 buffer:
2870 - When empty, the format defined with 'fileformat' will be used
2871 always. It is not set automatically.
2872 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002873 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 'fileformats' name will be used when a file is read into an existing
2875 buffer, no matter what 'fileformat' for that buffer is set to.
2876 - When more than one name is present, separated by commas, automatic
2877 <EOL> detection will be done when reading a file. When starting to
2878 edit a file, a check is done for the <EOL>:
2879 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2880 'fileformat' is set to "dos".
2881 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002882 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002884 3. If 'fileformat' has not yet been set, and if 'fileformats'
2885 includes "mac", 'fileformat' is set to "mac".
2886 This means that "mac" is only chosen when:
2887 "unix" is not present or no <NL> is found in the file, and
2888 "dos" is not present or no <CR><NL> is found in the file.
2889 Except: if "unix" was chosen, but there is a <CR> before
2890 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002891 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 4. If 'fileformat' is still not set, the first name from
2893 'fileformats' is used.
2894 When reading a file into an existing buffer, the same is done, but
2895 this happens like 'fileformat' has been set appropriately for that
2896 file only, the option is not changed.
2897 When 'binary' is set, the value of 'fileformats' is not used.
2898
Bram Moolenaar81af9252010-12-10 20:35:50 +01002899 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002900 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002901
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2903 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2904 done:
2905 - When 'fileformats' is empty, there is no automatic detection. Dos
2906 format will be used.
2907 - When 'fileformats' is set to one or more names, automatic detection
2908 is done. This is based on the first <NL> in the file: If there is a
2909 <CR> in front of it, Dos format is used, otherwise Unix format is
2910 used.
2911 Also see |file-formats|.
2912 For backwards compatibility: When this option is set to an empty
2913 string or one format (no comma is included), 'textauto' is reset,
2914 otherwise 'textauto' is set.
2915 NOTE: This option is set to the Vi default value when 'compatible' is
2916 set and to the Vim default value when 'compatible' is reset.
2917
2918 *'filetype'* *'ft'*
2919'filetype' 'ft' string (default: "")
2920 local to buffer
2921 {not in Vi}
2922 {not available when compiled without the |+autocmd|
2923 feature}
2924 When this option is set, the FileType autocommand event is triggered.
2925 All autocommands that match with the value of this option will be
2926 executed. Thus the value of 'filetype' is used in place of the file
2927 name.
2928 Otherwise this option does not always reflect the current file type.
2929 This option is normally set when the file type is detected. To enable
2930 this use the ":filetype on" command. |:filetype|
2931 Setting this option to a different value is most useful in a modeline,
2932 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002933 Example, for in an IDL file:
2934 /* vim: set filetype=idl : */ ~
2935 |FileType| |filetypes|
2936 When a dot appears in the value then this separates two filetype
2937 names. Example:
2938 /* vim: set filetype=c.doxygen : */ ~
2939 This will use the "c" filetype first, then the "doxygen" filetype.
2940 This works both for filetype plugins and for syntax files. More than
2941 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 This option is not copied to another buffer, independent of the 's' or
2943 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002944 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945
2946 *'fillchars'* *'fcs'*
2947'fillchars' 'fcs' string (default "vert:|,fold:-")
2948 global
2949 {not in Vi}
2950 {not available when compiled without the |+windows|
2951 and |+folding| features}
2952 Characters to fill the statuslines and vertical separators.
2953 It is a comma separated list of items:
2954
2955 item default Used for ~
2956 stl:c ' ' or '^' statusline of the current window
2957 stlnc:c ' ' or '-' statusline of the non-current windows
2958 vert:c '|' vertical separators |:vsplit|
2959 fold:c '-' filling 'foldtext'
2960 diff:c '-' deleted lines of the 'diff' option
2961
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002962 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 "stlnc" the space will be used when there is highlighting, '^' or '-'
2964 otherwise.
2965
2966 Example: >
2967 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2968< This is similar to the default, except that these characters will also
2969 be used when there is highlighting.
2970
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002971 for "stl" and "stlnc" only single-byte values are supported.
2972
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 The highlighting used for these items:
2974 item highlight group ~
2975 stl:c StatusLine |hl-StatusLine|
2976 stlnc:c StatusLineNC |hl-StatusLineNC|
2977 vert:c VertSplit |hl-VertSplit|
2978 fold:c Folded |hl-Folded|
2979 diff:c DiffDelete |hl-DiffDelete|
2980
2981 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2982'fkmap' 'fk' boolean (default off) *E198*
2983 global
2984 {not in Vi}
2985 {only available when compiled with the |+rightleft|
2986 feature}
2987 When on, the keyboard is mapped for the Farsi character set.
2988 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002989 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990
2991 *'foldclose'* *'fcl'*
2992'foldclose' 'fcl' string (default "")
2993 global
2994 {not in Vi}
2995 {not available when compiled without the |+folding|
2996 feature}
2997 When set to "all", a fold is closed when the cursor isn't in it and
2998 its level is higher than 'foldlevel'. Useful if you want folds to
2999 automatically close when moving out of them.
3000
3001 *'foldcolumn'* *'fdc'*
3002'foldcolumn' 'fdc' number (default 0)
3003 local to window
3004 {not in Vi}
3005 {not available when compiled without the |+folding|
3006 feature}
3007 When non-zero, a column with the specified width is shown at the side
3008 of the window which indicates open and closed folds. The maximum
3009 value is 12.
3010 See |folding|.
3011
3012 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3013'foldenable' 'fen' boolean (default on)
3014 local to window
3015 {not in Vi}
3016 {not available when compiled without the |+folding|
3017 feature}
3018 When off, all folds are open. This option can be used to quickly
3019 switch between showing all text unfolded and viewing the text with
3020 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003021 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 'foldenable' is off.
3023 This option is set by commands that create a new fold or close a fold.
3024 See |folding|.
3025
3026 *'foldexpr'* *'fde'*
3027'foldexpr' 'fde' string (default: "0")
3028 local to window
3029 {not in Vi}
3030 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003031 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003033 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003034
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003035 The expression may be evaluated in the |sandbox|, see
3036 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003037 This option can't be set from a |modeline| when the 'diff' option is
3038 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003039
3040 It is not allowed to change text or jump to another window while
3041 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042
3043 *'foldignore'* *'fdi'*
3044'foldignore' 'fdi' string (default: "#")
3045 local to window
3046 {not in Vi}
3047 {not available when compiled without the |+folding|
3048 feature}
3049 Used only when 'foldmethod' is "indent". Lines starting with
3050 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003051 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 The default "#" works well for C programs. See |fold-indent|.
3053
3054 *'foldlevel'* *'fdl'*
3055'foldlevel' 'fdl' number (default: 0)
3056 local to window
3057 {not in Vi}
3058 {not available when compiled without the |+folding|
3059 feature}
3060 Sets the fold level: Folds with a higher level will be closed.
3061 Setting this option to zero will close all folds. Higher numbers will
3062 close fewer folds.
3063 This option is set by commands like |zm|, |zM| and |zR|.
3064 See |fold-foldlevel|.
3065
3066 *'foldlevelstart'* *'fdls'*
3067'foldlevelstart' 'fdls' number (default: -1)
3068 global
3069 {not in Vi}
3070 {not available when compiled without the |+folding|
3071 feature}
3072 Sets 'foldlevel' when starting to edit another buffer in a window.
3073 Useful to always start editing with all folds closed (value zero),
3074 some folds closed (one) or no folds closed (99).
3075 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003076 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 ignores this option and closes all folds.
3078 It is also done before BufReadPre autocommands, to allow an autocmd to
3079 overrule the 'foldlevel' value for specific files.
3080 When the value is negative, it is not used.
3081
3082 *'foldmarker'* *'fmr'* *E536*
3083'foldmarker' 'fmr' string (default: "{{{,}}}")
3084 local to window
3085 {not in Vi}
3086 {not available when compiled without the |+folding|
3087 feature}
3088 The start and end marker used when 'foldmethod' is "marker". There
3089 must be one comma, which separates the start and end marker. The
3090 marker is a literal string (a regular expression would be too slow).
3091 See |fold-marker|.
3092
3093 *'foldmethod'* *'fdm'*
3094'foldmethod' 'fdm' string (default: "manual")
3095 local to window
3096 {not in Vi}
3097 {not available when compiled without the |+folding|
3098 feature}
3099 The kind of folding used for the current window. Possible values:
3100 |fold-manual| manual Folds are created manually.
3101 |fold-indent| indent Lines with equal indent form a fold.
3102 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3103 |fold-marker| marker Markers are used to specify folds.
3104 |fold-syntax| syntax Syntax highlighting items specify folds.
3105 |fold-diff| diff Fold text that is not changed.
3106
3107 *'foldminlines'* *'fml'*
3108'foldminlines' 'fml' number (default: 1)
3109 local to window
3110 {not in Vi}
3111 {not available when compiled without the |+folding|
3112 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003113 Sets the number of screen lines above which a fold can be displayed
3114 closed. Also for manually closed folds. With the default value of
3115 one a fold can only be closed if it takes up two or more screen lines.
3116 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003117 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 "zc" to close a fold, which is displayed open because it's smaller
3119 than 'foldminlines', a following "zc" may close a containing fold.
3120
3121 *'foldnestmax'* *'fdn'*
3122'foldnestmax' 'fdn' number (default: 20)
3123 local to window
3124 {not in Vi}
3125 {not available when compiled without the |+folding|
3126 feature}
3127 Sets the maximum nesting of folds for the "indent" and "syntax"
3128 methods. This avoids that too many folds will be created. Using more
3129 than 20 doesn't work, because the internal limit is 20.
3130
3131 *'foldopen'* *'fdo'*
3132'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3133 search,tag,undo")
3134 global
3135 {not in Vi}
3136 {not available when compiled without the |+folding|
3137 feature}
3138 Specifies for which type of commands folds will be opened, if the
3139 command moves the cursor into a closed fold. It is a comma separated
3140 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003141 NOTE: When the command is part of a mapping this option is not used.
3142 Add the |zv| command to the mapping to get the same effect.
3143 (rationale: the mapping may want to control opening folds itself)
3144
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 item commands ~
3146 all any
3147 block "(", "{", "[[", "[{", etc.
3148 hor horizontal movements: "l", "w", "fx", etc.
3149 insert any command in Insert mode
3150 jump far jumps: "G", "gg", etc.
3151 mark jumping to a mark: "'m", CTRL-O, etc.
3152 percent "%"
3153 quickfix ":cn", ":crew", ":make", etc.
3154 search search for a pattern: "/", "n", "*", "gd", etc.
3155 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003156 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 tag jumping to a tag: ":ta", CTRL-T, etc.
3158 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 When a movement command is used for an operator (e.g., "dl" or "y%")
3160 this option is not used. This means the operator will include the
3161 whole closed fold.
3162 Note that vertical movements are not here, because it would make it
3163 very difficult to move onto a closed fold.
3164 In insert mode the folds containing the cursor will always be open
3165 when text is inserted.
3166 To close folds you can re-apply 'foldlevel' with the |zx| command or
3167 set the 'foldclose' option to "all".
3168
3169 *'foldtext'* *'fdt'*
3170'foldtext' 'fdt' string (default: "foldtext()")
3171 local to window
3172 {not in Vi}
3173 {not available when compiled without the |+folding|
3174 feature}
3175 An expression which is used to specify the text displayed for a closed
3176 fold. See |fold-foldtext|.
3177
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003178 The expression may be evaluated in the |sandbox|, see
3179 |sandbox-option|.
3180
3181 It is not allowed to change text or jump to another window while
3182 evaluating 'foldtext' |textlock|.
3183
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 *'formatoptions'* *'fo'*
3185'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3186 local to buffer
3187 {not in Vi}
3188 This is a sequence of letters which describes how automatic
3189 formatting is to be done. See |fo-table|. When the 'paste' option is
3190 on, no formatting is done (like 'formatoptions' is empty). Commas can
3191 be inserted for readability.
3192 To avoid problems with flags that are added in the future, use the
3193 "+=" and "-=" feature of ":set" |add-option-flags|.
3194 NOTE: This option is set to the Vi default value when 'compatible' is
3195 set and to the Vim default value when 'compatible' is reset.
3196
Bram Moolenaar86b68352004-12-27 21:59:20 +00003197 *'formatlistpat'* *'flp'*
3198'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3199 local to buffer
3200 {not in Vi}
3201 A pattern that is used to recognize a list header. This is used for
3202 the "n" flag in 'formatoptions'.
3203 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003204 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003205 while still checking more characters. There must be a character
3206 following the pattern, when it matches the whole line it is handled
3207 like there is no match.
3208 The default recognizes a number, followed by an optional punctuation
3209 character and white space.
3210
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 *'formatprg'* *'fp'*
3212'formatprg' 'fp' string (default "")
3213 global
3214 {not in Vi}
3215 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003216 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003218 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003219 If the 'formatexpr' option is not empty it will be used instead.
3220 Otherwise, if 'formatprg' option is an empty string, the internal
3221 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003222 Environment variables are expanded |:set_env|. See |option-backslash|
3223 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003224 The expression may be evaluated in the |sandbox|, see
3225 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003227 *'formatexpr'* *'fex'*
3228'formatexpr' 'fex' string (default "")
3229 local to buffer
3230 {not in Vi}
3231 {not available when compiled without the |+eval|
3232 feature}
3233 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003234 operator or automatic formatting (see 'formatoptions'). When this
3235 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003236
3237 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003238 The |v:count| variable holds the number of lines to be formatted.
3239 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003240 inserted if the expression is being evaluated due to
3241 automatic formatting. This can be empty. Don't insert
3242 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003243
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003244 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003245 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003246< This will invoke the mylang#Format() function in the
3247 autoload/mylang.vim file in 'runtimepath'. |autoload|
3248
3249 The expression is also evaluated when 'textwidth' is set and adding
3250 text beyond that limit. This happens under the same conditions as
3251 when internal formatting is used. Make sure the cursor is kept in the
3252 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003253 return "i" or "R" in this situation.
3254
3255 When the expression evaluates to non-zero Vim will fall back to using
3256 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003257
3258 The expression may be evaluated in the |sandbox|, see
Bram Moolenaar81af9252010-12-10 20:35:50 +01003259 |sandbox-option|. That stops the option from working, since changing
3260 the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003261
3262 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003263'fsync' 'fs' boolean (default on)
3264 global
3265 {not in Vi}
3266 When on, the library function fsync() will be called after writing a
3267 file. This will flush a file to disk, ensuring that it is safely
3268 written even on filesystems which do metadata-only journaling. This
3269 will force the harddrive to spin up on Linux systems running in laptop
3270 mode, so it may be undesirable in some situations. Be warned that
3271 turning this off increases the chances of data loss after a crash. On
3272 systems without an fsync() implementation, this variable is always
3273 off.
3274 Also see 'swapsync' for controlling fsync() on swap files.
3275
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3277'gdefault' 'gd' boolean (default off)
3278 global
3279 {not in Vi}
3280 When on, the ":substitute" flag 'g' is default on. This means that
3281 all matches in a line are substituted instead of one. When a 'g' flag
3282 is given to a ":substitute" command, this will toggle the substitution
3283 of all or one match. See |complex-change|.
3284
3285 command 'gdefault' on 'gdefault' off ~
3286 :s/// subst. all subst. one
3287 :s///g subst. one subst. all
3288 :s///gg subst. all subst. one
3289
3290 NOTE: This option is reset when 'compatible' is set.
3291
3292 *'grepformat'* *'gfm'*
3293'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3294 global
3295 {not in Vi}
3296 Format to recognize for the ":grep" command output.
3297 This is a scanf-like string that uses the same format as the
3298 'errorformat' option: see |errorformat|.
3299
3300 *'grepprg'* *'gp'*
3301'grepprg' 'gp' string (default "grep -n ",
3302 Unix: "grep -n $* /dev/null",
3303 Win32: "findstr /n" or "grep -n",
3304 VMS: "SEARCH/NUMBERS ")
3305 global or local to buffer |global-local|
3306 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003307 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 and '#' characters, which are expanded like when used in a command-
3309 line. The placeholder "$*" is allowed to specify where the arguments
3310 will be included. Environment variables are expanded |:set_env|. See
3311 |option-backslash| about including spaces and backslashes.
3312 When your "grep" accepts the "-H" argument, use this to make ":grep"
3313 also work well with a single file: >
3314 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003315< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003316 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3317 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003318 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 apply equally to 'grepprg'.
3320 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3321 otherwise it's "grep -n".
3322 This option cannot be set from a |modeline| or in the |sandbox|, for
3323 security reasons.
3324
3325 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3326'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3327 ve:ver35-Cursor,
3328 o:hor50-Cursor,
3329 i-ci:ver25-Cursor/lCursor,
3330 r-cr:hor20-Cursor/lCursor,
3331 sm:block-Cursor
3332 -blinkwait175-blinkoff150-blinkon175",
3333 for MS-DOS and Win32 console:
3334 "n-v-c:block,o:hor50,i-ci:hor15,
3335 r-cr:hor30,sm:block")
3336 global
3337 {not in Vi}
3338 {only available when compiled with GUI enabled, and
3339 for MS-DOS and Win32 console}
3340 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003341 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 the height of the cursor can be changed. This can be done by
3343 specifying a block cursor, or a percentage for a vertical or
3344 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003345 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003347 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 mode-list and an argument-list:
3349 mode-list:argument-list,mode-list:argument-list,..
3350 The mode-list is a dash separated list of these modes:
3351 n Normal mode
3352 v Visual mode
3353 ve Visual mode with 'selection' "exclusive" (same as 'v',
3354 if not specified)
3355 o Operator-pending mode
3356 i Insert mode
3357 r Replace mode
3358 c Command-line Normal (append) mode
3359 ci Command-line Insert mode
3360 cr Command-line Replace mode
3361 sm showmatch in Insert mode
3362 a all modes
3363 The argument-list is a dash separated list of these arguments:
3364 hor{N} horizontal bar, {N} percent of the character height
3365 ver{N} vertical bar, {N} percent of the character width
3366 block block cursor, fills the whole character
3367 [only one of the above three should be present]
3368 blinkwait{N} *cursor-blinking*
3369 blinkon{N}
3370 blinkoff{N}
3371 blink times for cursor: blinkwait is the delay before
3372 the cursor starts blinking, blinkon is the time that
3373 the cursor is shown and blinkoff is the time that the
3374 cursor is not shown. The times are in msec. When one
3375 of the numbers is zero, there is no blinking. The
3376 default is: "blinkwait700-blinkon400-blinkoff250".
3377 These numbers are used for a missing entry. This
3378 means that blinking is enabled by default. To switch
3379 blinking off you can use "blinkon0". The cursor only
3380 blinks when Vim is waiting for input, not while
3381 executing a command.
3382 To make the cursor blink in an xterm, see
3383 |xterm-blink|.
3384 {group-name}
3385 a highlight group name, that sets the color and font
3386 for the cursor
3387 {group-name}/{group-name}
3388 Two highlight group names, the first is used when
3389 no language mappings are used, the other when they
3390 are. |language-mapping|
3391
3392 Examples of parts:
3393 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3394 block cursor with colors from the "nCursor"
3395 highlight group
3396 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3397 In Insert and Command-line Insert mode, use a
3398 30% vertical bar cursor with colors from the
3399 "iCursor" highlight group. Blink a bit
3400 faster.
3401
3402 The 'a' mode is different. It will set the given argument-list for
3403 all modes. It does not reset anything to defaults. This can be used
3404 to do a common setting for all modes. For example, to switch off
3405 blinking: "a:blinkon0"
3406
3407 Examples of cursor highlighting: >
3408 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3409 :highlight Cursor gui=NONE guifg=bg guibg=fg
3410<
3411 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003412 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413'guifont' 'gfn' string (default "")
3414 global
3415 {not in Vi}
3416 {only available when compiled with GUI enabled}
3417 This is a list of fonts which will be used for the GUI version of Vim.
3418 In its simplest form the value is just one font name. When
3419 the font cannot be found you will get an error message. To try other
3420 font names a list can be specified, font names separated with commas.
3421 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003422
Bram Moolenaar05159a02005-02-26 23:04:13 +00003423 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3424 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003425
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 Spaces after a comma are ignored. To include a comma in a font name
3427 precede it with a backslash. Setting an option requires an extra
3428 backslash before a space and a backslash. See also
3429 |option-backslash|. For example: >
3430 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003431< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003433
3434 If none of the fonts can be loaded, Vim will keep the current setting.
3435 If an empty font list is given, Vim will try using other resource
3436 settings (for X, it will use the Vim.font resource), and finally it
3437 will try some builtin default which should always be there ("7x13" in
3438 the case of X). The font names given should be "normal" fonts. Vim
3439 will try to find the related bold and italic fonts.
3440
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003441 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003442 :set guifont=*
3443< will bring up a font requester, where you can pick the font you want.
3444
3445 The font name depends on the GUI used. See |setting-guifont| for a
3446 way to set 'guifont' for various systems.
3447
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 For the GTK+ 2 GUI the font name looks like this: >
3449 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003450< That's all. XLFDs are not used. For Chinese this is reported to work
3451 well: >
3452 if has("gui_gtk2")
3453 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3454 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3455 endif
3456<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003457 For Mac OSX you can use something like this: >
3458 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003459< Also see 'macatsui', it can help fix display problems.
3460 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003462 width). An exception is GTK 2: all fonts are accepted, but
3463 mono-spaced fonts look best.
3464
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 To preview a font on X11, you might be able to use the "xfontsel"
3466 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003467
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 For the Win32 GUI *E244* *E245*
3469 - takes these options in the font name:
3470 hXX - height is XX (points, can be floating-point)
3471 wXX - width is XX (points, can be floating-point)
3472 b - bold
3473 i - italic
3474 u - underline
3475 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003476 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3478 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3479 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003480 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481
3482 Use a ':' to separate the options.
3483 - A '_' can be used in the place of a space, so you don't need to use
3484 backslashes to escape the spaces.
3485 - Examples: >
3486 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3487 :set guifont=Andale_Mono:h7.5:w4.5
3488< See also |font-sizes|.
3489
3490 *'guifontset'* *'gfs'*
3491 *E250* *E252* *E234* *E597* *E598*
3492'guifontset' 'gfs' string (default "")
3493 global
3494 {not in Vi}
3495 {only available when compiled with GUI enabled and
3496 with the |+xfontset| feature}
3497 {not available in the GTK+ 2 GUI}
3498 When not empty, specifies two (or more) fonts to be used. The first
3499 one for normal English, the second one for your special language. See
3500 |xfontset|.
3501 Setting this option also means that all font names will be handled as
3502 a fontset name. Also the ones used for the "font" argument of the
3503 |:highlight| command.
3504 The fonts must match with the current locale. If fonts for the
3505 character sets that the current locale uses are not included, setting
3506 'guifontset' will fail.
3507 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3508 the comma-separated names are alternative names, one of which will be
3509 used. In 'guifontset' the whole string is one fontset name,
3510 including the commas. It is not possible to specify alternative
3511 fontset names.
3512 This example works on many X11 systems: >
3513 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3514<
3515 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3516'guifontwide' 'gfw' string (default "")
3517 global
3518 {not in Vi}
3519 {only available when compiled with GUI enabled}
3520 When not empty, specifies a comma-separated list of fonts to be used
3521 for double-width characters. The first font that can be loaded is
3522 used.
3523 Note: The size of these fonts must be exactly twice as wide as the one
3524 specified with 'guifont' and the same height.
3525
3526 All GUI versions but GTK+ 2:
3527
3528 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3529 'guifontset' is empty or invalid.
3530 When 'guifont' is set and a valid font is found in it and
3531 'guifontwide' is empty Vim will attempt to find a matching
3532 double-width font and set 'guifontwide' to it.
3533
3534 GTK+ 2 GUI only: *guifontwide_gtk2*
3535
3536 If set and valid, 'guifontwide' is always used for double width
3537 characters, even if 'encoding' is not set to "utf-8".
3538 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003539 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 font for characters not available in 'guifont'. Thus you do not need
3541 to set 'guifontwide' at all unless you want to override the choice
3542 made by Pango/Xft.
3543
3544 *'guiheadroom'* *'ghr'*
3545'guiheadroom' 'ghr' number (default 50)
3546 global
3547 {not in Vi} {only for GTK and X11 GUI}
3548 The number of pixels subtracted from the screen height when fitting
3549 the GUI window on the screen. Set this before the GUI is started,
3550 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003551 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 lines will be left for window decorations and other items on the
3553 screen. Set it to a negative value to allow windows taller than the
3554 screen.
3555
3556 *'guioptions'* *'go'*
3557'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003558 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 global
3560 {not in Vi}
3561 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003562 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 sequence of letters which describes what components and options of the
3564 GUI should be used.
3565 To avoid problems with flags that are added in the future, use the
3566 "+=" and "-=" feature of ":set" |add-option-flags|.
3567
3568 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003569 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 'a' Autoselect: If present, then whenever VISUAL mode is started,
3571 or the Visual area extended, Vim tries to become the owner of
3572 the windowing system's global selection. This means that the
3573 Visually highlighted text is available for pasting into other
3574 applications as well as into Vim itself. When the Visual mode
3575 ends, possibly due to an operation on the text, or when an
3576 application wants to paste the selection, the highlighted text
3577 is automatically yanked into the "* selection register.
3578 Thus the selection is still available for pasting into other
3579 applications after the VISUAL mode has ended.
3580 If not present, then Vim won't become the owner of the
3581 windowing system's global selection unless explicitly told to
3582 by a yank or delete operation for the "* register.
3583 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003584 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003585 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 applies to the modeless selection.
3587
3588 'guioptions' autoselect Visual autoselect modeless ~
3589 "" - -
3590 "a" yes yes
3591 "A" - yes
3592 "aA" yes yes
3593
Bram Moolenaar02467872007-05-06 13:22:01 +00003594 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 'c' Use console dialogs instead of popup dialogs for simple
3596 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003597 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003598 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003599 'guitablabel' can be used to change the text in the labels.
3600 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003601 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003602 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003603 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 'f' Foreground: Don't use fork() to detach the GUI from the shell
3605 where it was started. Use this for programs that wait for the
3606 editor to finish (e.g., an e-mail program). Alternatively you
3607 can use "gvim -f" or ":gui -f" to start the GUI in the
3608 foreground. |gui-fork|
3609 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003610 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003611 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3613 corner of the window. It's black&white on non-GTK, because of
3614 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003615 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003617 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003618 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003620 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 file is sourced the system menu has already been loaded; the
3622 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003623 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 'g' Grey menu items: Make menu items that are not active grey. If
3625 'g' is not included inactive menu items are not shown at all.
3626 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003627 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 't' Include tearoff menu items. Currently only works for Win32,
3629 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003630 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003631 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003632 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003633 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003635 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 'R' Right-hand scrollbar is present when there is a vertically
3637 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003638 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003640 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 'L' Left-hand scrollbar is present when there is a vertically
3642 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003643 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3645 the longest visible line, or on the cursor line if the 'h'
3646 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003647 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 'h' Limit horizontal scrollbar size to the length of the cursor
3649 line. Reduces computations. |gui-horiz-scroll|
3650
3651 And yes, you may even have scrollbars on the left AND the right if
3652 you really want to :-). See |gui-scrollbars| for more information.
3653
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003654 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655 'v' Use a vertical button layout for dialogs. When not included,
3656 a horizontal layout is preferred, but when it doesn't fit a
3657 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003658 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 'p' Use Pointer callbacks for X11 GUI. This is required for some
3660 window managers. If the cursor is not blinking or hollow at
3661 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003662 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003664 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003665 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666
Bram Moolenaar02467872007-05-06 13:22:01 +00003667
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 *'guipty'* *'noguipty'*
3669'guipty' boolean (default on)
3670 global
3671 {not in Vi}
3672 {only available when compiled with GUI enabled}
3673 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3674 I/O to/from shell commands. See |gui-pty|.
3675
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003676 *'guitablabel'* *'gtl'*
3677'guitablabel' 'gtl' string (default empty)
3678 global
3679 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003680 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003681 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003682 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003683 pages line. When empty and when the result is empty Vim will use a
3684 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003685
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003686 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003687 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003688
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003689 Only used when the GUI tab pages line is displayed. 'e' must be
3690 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3691 used.
3692
Bram Moolenaar57657d82006-04-21 22:12:41 +00003693 *'guitabtooltip'* *'gtt'*
3694'guitabtooltip' 'gtt' string (default empty)
3695 global
3696 {not in Vi}
3697 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003698 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003699 When nonempty describes the text to use in a tooltip for the GUI tab
3700 pages line. When empty Vim will use a default tooltip.
3701 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003702 You can include a line break. Simplest method is to use |:let|: >
3703 :let &guitabtooltip = "line one\nline two"
3704<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003705
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 *'helpfile'* *'hf'*
3707'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3708 (others) "$VIMRUNTIME/doc/help.txt")
3709 global
3710 {not in Vi}
3711 Name of the main help file. All distributed help files should be
3712 placed together in one directory. Additionally, all "doc" directories
3713 in 'runtimepath' will be used.
3714 Environment variables are expanded |:set_env|. For example:
3715 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003716 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 spaces and backslashes.
3718 This option cannot be set from a |modeline| or in the |sandbox|, for
3719 security reasons.
3720
3721 *'helpheight'* *'hh'*
3722'helpheight' 'hh' number (default 20)
3723 global
3724 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003725 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 feature}
3727 Minimal initial height of the help window when it is opened with the
3728 ":help" command. The initial height of the help window is half of the
3729 current window, or (when the 'ea' option is on) the same as other
3730 windows. When the height is less than 'helpheight', the height is
3731 set to 'helpheight'. Set to zero to disable.
3732
3733 *'helplang'* *'hlg'*
3734'helplang' 'hlg' string (default: messages language or empty)
3735 global
3736 {only available when compiled with the |+multi_lang|
3737 feature}
3738 {not in Vi}
3739 Comma separated list of languages. Vim will use the first language
3740 for which the desired help can be found. The English help will always
3741 be used as a last resort. You can add "en" to prefer English over
3742 another language, but that will only find tags that exist in that
3743 language and not in the English help.
3744 Example: >
3745 :set helplang=de,it
3746< This will first search German, then Italian and finally English help
3747 files.
3748 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3749 try to find the tag in the current language before using this option.
3750 See |help-translated|.
3751
3752 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3753'hidden' 'hid' boolean (default off)
3754 global
3755 {not in Vi}
3756 When off a buffer is unloaded when it is |abandon|ed. When on a
3757 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3758 displayed in another window, it does not become hidden, of course.
3759 The commands that move through the buffer list sometimes make a buffer
3760 hidden although the 'hidden' option is off: When the buffer is
3761 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003762 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003763 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 This option is set for one command with ":hide {command}" |:hide|.
3765 WARNING: It's easy to forget that you have changes in hidden buffers.
3766 Think twice when using ":q!" or ":qa!".
3767
3768 *'highlight'* *'hl'*
3769'highlight' 'hl' string (default (as a single string):
3770 "8:SpecialKey,@:NonText,d:Directory,
3771 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3772 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003773 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3775 f:Folded,F:FoldColumn,A:DiffAdd,
3776 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003777 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003778 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003779 +:Pmenu,=:PmenuSel,
3780 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 global
3782 {not in Vi}
3783 This option can be used to set highlighting mode for various
3784 occasions. It is a comma separated list of character pairs. The
3785 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003786 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3788 |hl-NonText| @ '~' and '@' at the end of the window and
3789 characters from 'showbreak'
3790 |hl-Directory| d directories in CTRL-D listing and other special
3791 things in listings
3792 |hl-ErrorMsg| e error messages
3793 h (obsolete, ignored)
3794 |hl-IncSearch| i 'incsearch' highlighting
3795 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3796 |hl-MoreMsg| m |more-prompt|
3797 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003798 |hl-LineNr| n line number for ":number" and ":#" commands, and
3799 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 |hl-Question| r |hit-enter| prompt and yes/no questions
3801 |hl-StatusLine| s status line of current window |status-line|
3802 |hl-StatusLineNC| S status lines of not-current windows
3803 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3804 |hl-VertSplit| c column used to separate vertically split windows
3805 |hl-Visual| v Visual mode
3806 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3807 Selection" Only X11 Gui's |gui-x11| and
3808 |xterm-clipboard|.
3809 |hl-WarningMsg| w warning messages
3810 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3811 |hl-Folded| f line used for closed folds
3812 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003813 |hl-DiffAdd| A added line in diff mode
3814 |hl-DiffChange| C changed line in diff mode
3815 |hl-DiffDelete| D deleted line in diff mode
3816 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003818 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003819 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003820 |hl-SpellRare| R rare word |spell|
3821 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003822 |hl-Conceal| - the placeholders used for concealed characters
3823 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003824 |hl-Pmenu| + popup menu normal line
3825 |hl-PmenuSel| = popup menu normal line
3826 |hl-PmenuSbar| x popup menu scrollbar
3827 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828
3829 The display modes are:
3830 r reverse (termcap entry "mr" and "me")
3831 i italic (termcap entry "ZH" and "ZR")
3832 b bold (termcap entry "md" and "me")
3833 s standout (termcap entry "so" and "se")
3834 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003835 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 n no highlighting
3837 - no highlighting
3838 : use a highlight group
3839 The default is used for occasions that are not included.
3840 If you want to change what the display modes do, see |dos-colors|
3841 for an example.
3842 When using the ':' display mode, this must be followed by the name of
3843 a highlight group. A highlight group can be used to define any type
3844 of highlighting, including using color. See |:highlight| on how to
3845 define one. The default uses a different group for each occasion.
3846 See |highlight-default| for the default highlight groups.
3847
3848 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3849'hlsearch' 'hls' boolean (default off)
3850 global
3851 {not in Vi}
3852 {not available when compiled without the
3853 |+extra_search| feature}
3854 When there is a previous search pattern, highlight all its matches.
3855 The type of highlighting used can be set with the 'l' occasion in the
3856 'highlight' option. This uses the "Search" highlight group by
3857 default. Note that only the matching text is highlighted, any offsets
3858 are not applied.
3859 See also: 'incsearch' and |:match|.
3860 When you get bored looking at the highlighted matches, you can turn it
3861 off with |:nohlsearch|. As soon as you use a search command, the
3862 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003863 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 When the search pattern can match an end-of-line, Vim will try to
3865 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003866 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003868 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 NOTE: This option is reset when 'compatible' is set.
3870
3871 *'history'* *'hi'*
3872'history' 'hi' number (Vim default: 20, Vi default: 0)
3873 global
3874 {not in Vi}
3875 A history of ":" commands, and a history of previous search patterns
3876 are remembered. This option decides how many entries may be stored in
3877 each of these histories (see |cmdline-editing|).
3878 NOTE: This option is set to the Vi default value when 'compatible' is
3879 set and to the Vim default value when 'compatible' is reset.
3880
3881 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3882'hkmap' 'hk' boolean (default off)
3883 global
3884 {not in Vi}
3885 {only available when compiled with the |+rightleft|
3886 feature}
3887 When on, the keyboard is mapped for the Hebrew character set.
3888 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3889 toggle this option. See |rileft.txt|.
3890 NOTE: This option is reset when 'compatible' is set.
3891
3892 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3893'hkmapp' 'hkp' boolean (default off)
3894 global
3895 {not in Vi}
3896 {only available when compiled with the |+rightleft|
3897 feature}
3898 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3899 This is useful if you have a non-Hebrew keyboard.
3900 See |rileft.txt|.
3901 NOTE: This option is reset when 'compatible' is set.
3902
3903 *'icon'* *'noicon'*
3904'icon' boolean (default off, on when title can be restored)
3905 global
3906 {not in Vi}
3907 {not available when compiled without the |+title|
3908 feature}
3909 When on, the icon text of the window will be set to the value of
3910 'iconstring' (if it is not empty), or to the name of the file
3911 currently being edited. Only the last part of the name is used.
3912 Overridden by the 'iconstring' option.
3913 Only works if the terminal supports setting window icons (currently
3914 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3915 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3916 builtin termcap).
3917 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003918 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 X11.
3920
3921 *'iconstring'*
3922'iconstring' string (default "")
3923 global
3924 {not in Vi}
3925 {not available when compiled without the |+title|
3926 feature}
3927 When this option is not empty, it will be used for the icon text of
3928 the window. This happens only when the 'icon' option is on.
3929 Only works if the terminal supports setting window icon text
3930 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3931 Does not work for MS Windows.
3932 When Vim was compiled with HAVE_X11 defined, the original icon will be
3933 restored if possible |X11|.
3934 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003935 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 'titlestring' for example settings.
3937 {not available when compiled without the |+statusline| feature}
3938
3939 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3940'ignorecase' 'ic' boolean (default off)
3941 global
3942 Ignore case in search patterns. Also used when searching in the tags
3943 file.
3944 Also see 'smartcase'.
3945 Can be overruled by using "\c" or "\C" in the pattern, see
3946 |/ignorecase|.
3947
3948 *'imactivatekey'* *'imak'*
3949'imactivatekey' 'imak' string (default "")
3950 global
3951 {not in Vi}
3952 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003953 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 Specifies the key that your Input Method in X-Windows uses for
3955 activation. When this is specified correctly, vim can fully control
3956 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3957 You can't use this option to change the activation key, the option
3958 tells Vim what the key is.
3959 Format:
3960 [MODIFIER_FLAG-]KEY_STRING
3961
3962 These characters can be used for MODIFIER_FLAG (case is ignored):
3963 S Shift key
3964 L Lock key
3965 C Control key
3966 1 Mod1 key
3967 2 Mod2 key
3968 3 Mod3 key
3969 4 Mod4 key
3970 5 Mod5 key
3971 Combinations are allowed, for example "S-C-space" or "SC-space" are
3972 both shift+ctrl+space.
3973 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3974
3975 Example: >
3976 :set imactivatekey=S-space
3977< "S-space" means shift+space. This is the activation key for kinput2 +
3978 canna (Japanese), and ami (Korean).
3979
3980 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3981'imcmdline' 'imc' boolean (default off)
3982 global
3983 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003984 {only available when compiled with the |+xim|,
3985 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 When set the Input Method is always on when starting to edit a command
3987 line, unless entering a search pattern (see 'imsearch' for that).
3988 Setting this option is useful when your input method allows entering
3989 English characters directly, e.g., when it's used to type accented
3990 characters with dead keys.
3991
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003992 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3994 global
3995 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003996 {only available when compiled with the |+xim|,
3997 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 When set the Input Method is never used. This is useful to disable
3999 the IM when it doesn't work properly.
4000 Currently this option is on by default for SGI/IRIX machines. This
4001 may change in later releases.
4002
4003 *'iminsert'* *'imi'*
4004'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4005 local to buffer
4006 {not in Vi}
4007 Specifies whether :lmap or an Input Method (IM) is to be used in
4008 Insert mode. Valid values:
4009 0 :lmap is off and IM is off
4010 1 :lmap is ON and IM is off
4011 2 :lmap is off and IM is ON
4012 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4013 or |global-ime|.
4014 To always reset the option to zero when leaving Insert mode with <Esc>
4015 this can be used: >
4016 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4017< This makes :lmap and IM turn off automatically when leaving Insert
4018 mode.
4019 Note that this option changes when using CTRL-^ in Insert mode
4020 |i_CTRL-^|.
4021 The value is set to 1 when setting 'keymap' to a valid keymap name.
4022 It is also used for the argument of commands like "r" and "f".
4023 The value 0 may not work correctly with Athena and Motif with some XIM
4024 methods. Use 'imdisable' to disable XIM then.
4025
4026 *'imsearch'* *'ims'*
4027'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4028 local to buffer
4029 {not in Vi}
4030 Specifies whether :lmap or an Input Method (IM) is to be used when
4031 entering a search pattern. Valid values:
4032 -1 the value of 'iminsert' is used, makes it look like
4033 'iminsert' is also used when typing a search pattern
4034 0 :lmap is off and IM is off
4035 1 :lmap is ON and IM is off
4036 2 :lmap is off and IM is ON
4037 Note that this option changes when using CTRL-^ in Command-line mode
4038 |c_CTRL-^|.
4039 The value is set to 1 when it is not -1 and setting the 'keymap'
4040 option to a valid keymap name.
4041 The value 0 may not work correctly with Athena and Motif with some XIM
4042 methods. Use 'imdisable' to disable XIM then.
4043
4044 *'include'* *'inc'*
4045'include' 'inc' string (default "^\s*#\s*include")
4046 global or local to buffer |global-local|
4047 {not in Vi}
4048 {not available when compiled without the
4049 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004050 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 pattern, just like for the "/" command (See |pattern|). The default
4052 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004053 "]I", "[d", etc.
4054 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004055 comes after the matched pattern. But if "\zs" appears in the pattern
4056 then the text matched from "\zs" to the end, or until "\ze" if it
4057 appears, is used as the file name. Use this to include characters
4058 that are not in 'isfname', such as a space. You can then use
4059 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004060 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061
4062 *'includeexpr'* *'inex'*
4063'includeexpr' 'inex' string (default "")
4064 local to buffer
4065 {not in Vi}
4066 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004067 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004069 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 :set includeexpr=substitute(v:fname,'\\.','/','g')
4071< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004072
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004074 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 Also used for |<cfile>|.
4076
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004077 The expression may be evaluated in the |sandbox|, see
4078 |sandbox-option|.
4079
4080 It is not allowed to change text or jump to another window while
4081 evaluating 'includeexpr' |textlock|.
4082
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4084'incsearch' 'is' boolean (default off)
4085 global
4086 {not in Vi}
4087 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004088 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004089 While typing a search command, show where the pattern, as it was typed
4090 so far, matches. The matched string is highlighted. If the pattern
4091 is invalid or not found, nothing is shown. The screen will be updated
4092 often, this is only useful on fast terminals.
4093 Note that the match will be shown, but the cursor will return to its
4094 original position when no match is found and when pressing <Esc>. You
4095 still need to finish the search command with <Enter> to move the
4096 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004097 When compiled with the |+reltime| feature Vim only searches for about
4098 half a second. With a complicated pattern and/or a lot of text the
4099 match may not be found. This is to avoid that Vim hangs while you
4100 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004101 The highlighting can be set with the 'i' flag in 'highlight'.
4102 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004103 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004104 to the command line. If 'ignorecase' and 'smartcase' are set and the
4105 command line has no uppercase characters, the added character is
4106 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004107 CTRL-R CTRL-W can be used to add the word at the end of the current
4108 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 NOTE: This option is reset when 'compatible' is set.
4110
4111 *'indentexpr'* *'inde'*
4112'indentexpr' 'inde' string (default "")
4113 local to buffer
4114 {not in Vi}
4115 {not available when compiled without the |+cindent|
4116 or |+eval| features}
4117 Expression which is evaluated to obtain the proper indent for a line.
4118 It is used when a new line is created, for the |=| operator and
4119 in Insert mode as specified with the 'indentkeys' option.
4120 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004121 'smartindent' indenting. When 'lisp' is set, this option is
4122 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 When 'paste' is set this option is not used for indenting.
4124 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004125 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 when the expression is evaluated (but it may be moved around).
4127 The expression must return the number of spaces worth of indent. It
4128 can return "-1" to keep the current indent (this means 'autoindent' is
4129 used for the indent).
4130 Functions useful for computing the indent are |indent()|, |cindent()|
4131 and |lispindent()|.
4132 The evaluation of the expression must not have side effects! It must
4133 not change the text, jump to another window, etc. Afterwards the
4134 cursor position is always restored, thus the cursor may be moved.
4135 Normally this option would be set to call a function: >
4136 :set indentexpr=GetMyIndent()
4137< Error messages will be suppressed, unless the 'debug' option contains
4138 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004139 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 NOTE: This option is made empty when 'compatible' is set.
4141
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004142 The expression may be evaluated in the |sandbox|, see
4143 |sandbox-option|.
4144
4145 It is not allowed to change text or jump to another window while
4146 evaluating 'indentexpr' |textlock|.
4147
4148
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 *'indentkeys'* *'indk'*
4150'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4151 local to buffer
4152 {not in Vi}
4153 {not available when compiled without the |+cindent|
4154 feature}
4155 A list of keys that, when typed in Insert mode, cause reindenting of
4156 the current line. Only happens if 'indentexpr' isn't empty.
4157 The format is identical to 'cinkeys', see |indentkeys-format|.
4158 See |C-indenting| and |indent-expression|.
4159
4160 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4161'infercase' 'inf' boolean (default off)
4162 local to buffer
4163 {not in Vi}
4164 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004165 'ignorecase' is also on, the case of the match is adjusted depending
4166 on the typed text. If the typed text contains a lowercase letter
4167 where the match has an upper case letter, the completed part is made
4168 lowercase. If the typed text has no lowercase letters and the match
4169 has a lowercase letter where the typed text has an uppercase letter,
4170 and there is a letter before it, the completed part is made uppercase.
4171 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172
4173 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4174'insertmode' 'im' boolean (default off)
4175 global
4176 {not in Vi}
4177 Makes Vim work in a way that Insert mode is the default mode. Useful
4178 if you want to use Vim as a modeless editor. Used for |evim|.
4179 These Insert mode commands will be useful:
4180 - Use the cursor keys to move around.
4181 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4182 this is a mapping, it is executed as if 'insertmode' was off.
4183 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004185 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4186 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187
4188 These items change when 'insertmode' is set:
4189 - when starting to edit of a file, Vim goes to Insert mode.
4190 - <Esc> in Insert mode is a no-op and beeps.
4191 - <Esc> in Normal mode makes Vim go to Insert mode.
4192 - CTRL-L in Insert mode is a command, it is not inserted.
4193 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4194 However, when <Esc> is used inside a mapping, it behaves like
4195 'insertmode' was not set. This was done to be able to use the same
4196 mappings with 'insertmode' set or not set.
4197 When executing commands with |:normal| 'insertmode' is not used.
4198
4199 NOTE: This option is reset when 'compatible' is set.
4200
4201 *'isfname'* *'isf'*
4202'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4203 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4204 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4205 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4206 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4207 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4208 global
4209 {not in Vi}
4210 The characters specified by this option are included in file names and
4211 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004212 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 Multi-byte characters 256 and above are always included, only the
4214 characters up to 255 are specified with this option.
4215 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004216 Think twice before adding white space to this option. Although a
4217 space may appear inside a file name, the effect will be that Vim
4218 doesn't know where a file name starts or ends when doing completion.
4219 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220
4221 Note that on systems using a backslash as path separator, Vim tries to
4222 do its best to make it work as you would expect. That is a bit
4223 tricky, since Vi originally used the backslash to escape special
4224 characters. Vim will not remove a backslash in front of a normal file
4225 name character on these systems, but it will on Unix and alikes. The
4226 '&' and '^' are not included by default, because these are special for
4227 cmd.exe.
4228
4229 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004230 Each part can be a single character number or a range. A range is two
4231 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 decimal number between 0 and 255 or the ASCII character itself (does
4233 not work for digits). Example:
4234 "_,-,128-140,#-43" (include '_' and '-' and the range
4235 128 to 140 and '#' to 43)
4236 If a part starts with '^', the following character number or range
4237 will be excluded from the option. The option is interpreted from left
4238 to right. Put the excluded character after the range where it is
4239 included. To include '^' itself use it as the last character of the
4240 option or the end of a range. Example:
4241 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4242 If the character is '@', all characters where isalpha() returns TRUE
4243 are included. Normally these are the characters a to z and A to Z,
4244 plus accented characters. To include '@' itself use "@-@". Examples:
4245 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004246 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 "a-z,A-Z,@-@" All letters plus the '@' character.
4248 A comma can be included by using it where a character number is
4249 expected. Example:
4250 "48-57,,,_" Digits, comma and underscore.
4251 A comma can be excluded by prepending a '^'. Example:
4252 " -~,^,,9" All characters from space to '~', excluding
4253 comma, plus <Tab>.
4254 See |option-backslash| about including spaces and backslashes.
4255
4256 *'isident'* *'isi'*
4257'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4258 "@,48-57,_,128-167,224-235"
4259 otherwise: "@,48-57,_,192-255")
4260 global
4261 {not in Vi}
4262 The characters given by this option are included in identifiers.
4263 Identifiers are used in recognizing environment variables and after a
4264 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004265 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 option.
4267 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004268 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4270
4271 *'iskeyword'* *'isk'*
4272'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4273 "@,48-57,_,128-167,224-235"
4274 otherwise: "@,48-57,_,192-255"
4275 Vi default: "@,48-57,_")
4276 local to buffer
4277 {not in Vi}
4278 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004279 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 'isfname' for a description of the format of this option. For C
4281 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4282 For a help file it is set to all non-blank printable characters except
4283 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4284 command).
4285 When the 'lisp' option is on the '-' character is always included.
4286 NOTE: This option is set to the Vi default value when 'compatible' is
4287 set and to the Vim default value when 'compatible' is reset.
4288
4289 *'isprint'* *'isp'*
4290'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4291 "@,~-255"; otherwise: "@,161-255")
4292 global
4293 {not in Vi}
4294 The characters given by this option are displayed directly on the
4295 screen. It is also used for "\p" in a |pattern|. The characters from
4296 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4297 even when they are not included in 'isprint' or excluded. See
4298 'isfname' for a description of the format of this option.
4299
4300 Non-printable characters are displayed with two characters:
4301 0 - 31 "^@" - "^_"
4302 32 - 126 always single characters
4303 127 "^?"
4304 128 - 159 "~@" - "~_"
4305 160 - 254 "| " - "|~"
4306 255 "~?"
4307 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4308 displayed as <xx>, with the hexadecimal value of the byte.
4309 When 'display' contains "uhex" all unprintable characters are
4310 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004311 The SpecialKey highlighting will be used for unprintable characters.
4312 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313
4314 Multi-byte characters 256 and above are always included, only the
4315 characters up to 255 are specified with this option. When a character
4316 is printable but it is not available in the current font, a
4317 replacement character will be shown.
4318 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4319 There is no option to specify these characters.
4320
4321 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4322'joinspaces' 'js' boolean (default on)
4323 global
4324 {not in Vi}
4325 Insert two spaces after a '.', '?' and '!' with a join command.
4326 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4327 Otherwise only one space is inserted.
4328 NOTE: This option is set when 'compatible' is set.
4329
4330 *'key'*
4331'key' string (default "")
4332 local to buffer
4333 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004334 {only available when compiled with the |+cryptv|
4335 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004337 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 Careful: Do not set the key value by hand, someone might see the typed
4339 key. Use the |:X| command. But you can make 'key' empty: >
4340 :set key=
4341< It is not possible to get the value of this option with ":set key" or
4342 "echo &key". This is to avoid showing it to someone who shouldn't
4343 know. It also means you cannot see it yourself once you have set it,
4344 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004345 You can use "&key" in an expression to detect whether encryption is
4346 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347
4348 *'keymap'* *'kmp'* *E544*
4349'keymap' 'kmp' string (default "")
4350 local to buffer
4351 {not in Vi}
4352 {only available when compiled with the |+keymap|
4353 feature}
4354 Name of a keyboard mapping. See |mbyte-keymap|.
4355 Setting this option to a valid keymap name has the side effect of
4356 setting 'iminsert' to one, so that the keymap becomes effective.
4357 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004358 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359
4360 *'keymodel'* *'km'*
4361'keymodel' 'km' string (default "")
4362 global
4363 {not in Vi}
4364 List of comma separated words, which enable special things that keys
4365 can do. These values can be used:
4366 startsel Using a shifted special key starts selection (either
4367 Select mode or Visual mode, depending on "key" being
4368 present in 'selectmode').
4369 stopsel Using a not-shifted special key stops selection.
4370 Special keys in this context are the cursor keys, <End>, <Home>,
4371 <PageUp> and <PageDown>.
4372 The 'keymodel' option is set by the |:behave| command.
4373
4374 *'keywordprg'* *'kp'*
4375'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4376 OS/2: "view /", VMS: "help")
4377 global or local to buffer |global-local|
4378 {not in Vi}
4379 Program to use for the |K| command. Environment variables are
4380 expanded |:set_env|. ":help" may be used to access the Vim internal
4381 help. (Note that previously setting the global option to the empty
4382 value did this, which is now deprecated.)
4383 When "man" is used, Vim will automatically translate a count for the
4384 "K" command to a section number. Also for "man -s", in which case the
4385 "-s" is removed when there is no count.
4386 See |option-backslash| about including spaces and backslashes.
4387 Example: >
4388 :set keywordprg=man\ -s
4389< This option cannot be set from a |modeline| or in the |sandbox|, for
4390 security reasons.
4391
4392 *'langmap'* *'lmap'* *E357* *E358*
4393'langmap' 'lmap' string (default "")
4394 global
4395 {not in Vi}
4396 {only available when compiled with the |+langmap|
4397 feature}
4398 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004399 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 inserted directly. When in command mode the 'langmap' option takes
4401 care of translating these special characters to the original meaning
4402 of the key. This means you don't have to change the keyboard mode to
4403 be able to execute Normal mode commands.
4404 This is the opposite of the 'keymap' option, where characters are
4405 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004407 Example (for Greek, in UTF-8): *greek* >
4408 :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 +00004409< Example (exchanges meaning of z and y for commands): >
4410 :set langmap=zy,yz,ZY,YZ
4411<
4412 The 'langmap' option is a list of parts, separated with commas. Each
4413 part can be in one of two forms:
4414 1. A list of pairs. Each pair is a "from" character immediately
4415 followed by the "to" character. Examples: "aA", "aAbBcC".
4416 2. A list of "from" characters, a semi-colon and a list of "to"
4417 characters. Example: "abc;ABC"
4418 Example: "aA,fgh;FGH,cCdDeE"
4419 Special characters need to be preceded with a backslash. These are
4420 ";", ',' and backslash itself.
4421
4422 This will allow you to activate vim actions without having to switch
4423 back and forth between the languages. Your language characters will
4424 be understood as normal vim English characters (according to the
4425 langmap mappings) in the following cases:
4426 o Normal/Visual mode (commands, buffer/register names, user mappings)
4427 o Insert/Replace Mode: Register names after CTRL-R
4428 o Insert/Replace Mode: Mappings
4429 Characters entered in Command-line mode will NOT be affected by
4430 this option. Note that this option can be changed at any time
4431 allowing to switch between mappings for different languages/encodings.
4432 Use a mapping to avoid having to type it each time!
4433
4434 *'langmenu'* *'lm'*
4435'langmenu' 'lm' string (default "")
4436 global
4437 {not in Vi}
4438 {only available when compiled with the |+menu| and
4439 |+multi_lang| features}
4440 Language to use for menu translation. Tells which file is loaded
4441 from the "lang" directory in 'runtimepath': >
4442 "lang/menu_" . &langmenu . ".vim"
4443< (without the spaces). For example, to always use the Dutch menus, no
4444 matter what $LANG is set to: >
4445 :set langmenu=nl_NL.ISO_8859-1
4446< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004447 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 If your $LANG is set to a non-English language but you do want to use
4449 the English menus: >
4450 :set langmenu=none
4451< This option must be set before loading menus, switching on filetype
4452 detection or syntax highlighting. Once the menus are defined setting
4453 this option has no effect. But you could do this: >
4454 :source $VIMRUNTIME/delmenu.vim
4455 :set langmenu=de_DE.ISO_8859-1
4456 :source $VIMRUNTIME/menu.vim
4457< Warning: This deletes all menus that you defined yourself!
4458
4459 *'laststatus'* *'ls'*
4460'laststatus' 'ls' number (default 1)
4461 global
4462 {not in Vi}
4463 The value of this option influences when the last window will have a
4464 status line:
4465 0: never
4466 1: only if there are at least two windows
4467 2: always
4468 The screen looks nicer with a status line if you have several
4469 windows, but it takes another screen line. |status-line|
4470
4471 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4472'lazyredraw' 'lz' boolean (default off)
4473 global
4474 {not in Vi}
4475 When this option is set, the screen will not be redrawn while
4476 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004477 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 update use |:redraw|.
4479
4480 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4481'linebreak' 'lbr' boolean (default off)
4482 local to window
4483 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004484 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 feature}
4486 If on Vim will wrap long lines at a character in 'breakat' rather
4487 than at the last character that fits on the screen. Unlike
4488 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4489 it only affects the way the file is displayed, not its contents. The
4490 value of 'showbreak' is used to put in front of wrapped lines.
4491 This option is not used when the 'wrap' option is off or 'list' is on.
4492 Note that <Tab> characters after an <EOL> are mostly not displayed
4493 with the right amount of white space.
4494
4495 *'lines'* *E593*
4496'lines' number (default 24 or terminal height)
4497 global
4498 Number of lines of the Vim window.
4499 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004500 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 When Vim is running in the GUI or in a resizable window, setting this
4502 option will cause the window size to be changed. When you only want
4503 to use the size for the GUI, put the command in your |gvimrc| file.
4504 Vim limits the number of lines to what fits on the screen. You can
4505 use this command to get the tallest window possible: >
4506 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004507< Minimum value is 2, maximum value is 1000.
4508 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 When you set this option and Vim is unable to change the physical
4510 number of lines of the display, the display may be messed up.
4511
4512 *'linespace'* *'lsp'*
4513'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4514 global
4515 {not in Vi}
4516 {only in the GUI}
4517 Number of pixel lines inserted between characters. Useful if the font
4518 uses the full character cell height, making lines touch each other.
4519 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004520 With some fonts there can be too much room between lines (to have
4521 space for ascents and descents). Then it makes sense to set
4522 'linespace' to a negative value. This may cause display problems
4523 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524
4525 *'lisp'* *'nolisp'*
4526'lisp' boolean (default off)
4527 local to buffer
4528 {not available when compiled without the |+lispindent|
4529 feature}
4530 Lisp mode: When <Enter> is typed in insert mode set the indent for
4531 the next line to Lisp standards (well, sort of). Also happens with
4532 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4533 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4534 better. Also see 'lispwords'.
4535 The '-' character is included in keyword characters. Redefines the
4536 "=" operator to use this same indentation algorithm rather than
4537 calling an external program if 'equalprg' is empty.
4538 This option is not used when 'paste' is set.
4539 {Vi: Does it a little bit differently}
4540
4541 *'lispwords'* *'lw'*
4542'lispwords' 'lw' string (default is very long)
4543 global
4544 {not in Vi}
4545 {not available when compiled without the |+lispindent|
4546 feature}
4547 Comma separated list of words that influence the Lisp indenting.
4548 |'lisp'|
4549
4550 *'list'* *'nolist'*
4551'list' boolean (default off)
4552 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004553 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4554 line. Useful to see the difference between tabs and spaces and for
4555 trailing blanks. Further changed by the 'listchars' option.
4556
4557 The cursor is displayed at the start of the space a Tab character
4558 occupies, not at the end as usual in Normal mode. To get this cursor
4559 position while displaying Tabs with spaces, use: >
4560 :set list lcs=tab\ \
4561<
4562 Note that list mode will also affect formatting (set with 'textwidth'
4563 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564 changing the way tabs are displayed.
4565
4566 *'listchars'* *'lcs'*
4567'listchars' 'lcs' string (default "eol:$")
4568 global
4569 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004570 Strings to use in 'list' mode and for the |:list| command. It is a
4571 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 eol:c Character to show at the end of each line. When
4573 omitted, there is no extra character at the end of the
4574 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004575 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004577 fill the space that the tab normally occupies.
4578 "tab:>-" will show a tab that takes four spaces as
4579 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004580 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 trailing spaces are blank.
4582 extends:c Character to show in the last column, when 'wrap' is
4583 off and the line continues beyond the right of the
4584 screen.
4585 precedes:c Character to show in the first column, when 'wrap'
4586 is off and there is text preceding the character
4587 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004588 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004589 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004590 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004591 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004593 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004595 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596
4597 Examples: >
4598 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004599 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 :set lcs=extends:>,precedes:<
4601< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004602 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004603 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604
4605 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4606'loadplugins' 'lpl' boolean (default on)
4607 global
4608 {not in Vi}
4609 When on the plugin scripts are loaded when starting up |load-plugins|.
4610 This option can be reset in your |vimrc| file to disable the loading
4611 of plugins.
4612 Note that using the "-u NONE" and "--noplugin" command line arguments
4613 reset this option. |-u| |--noplugin|
4614
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004615 *'macatsui'* *'nomacatsui'*
4616'macatsui' boolean (default on)
4617 global
4618 {only available in Mac GUI version}
4619 This is a workaround for when drawing doesn't work properly. When set
4620 and compiled with multi-byte support ATSUI text drawing is used. When
4621 not set ATSUI text drawing is not used. Switch this option off when
4622 you experience drawing problems. In a future version the problems may
4623 be solved and this option becomes obsolete. Therefore use this method
4624 to unset it: >
4625 if exists('&macatsui')
4626 set nomacatsui
4627 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004628< Another option to check if you have drawing problems is
4629 'termencoding'.
4630
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 *'magic'* *'nomagic'*
4632'magic' boolean (default on)
4633 global
4634 Changes the special characters that can be used in search patterns.
4635 See |pattern|.
4636 NOTE: To avoid portability problems with using patterns, always keep
4637 this option at the default "on". Only switch it off when working with
4638 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004639 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640
4641 *'makeef'* *'mef'*
4642'makeef' 'mef' string (default: "")
4643 global
4644 {not in Vi}
4645 {not available when compiled without the |+quickfix|
4646 feature}
4647 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4648 and the |:grep| command.
4649 When it is empty, an internally generated temp file will be used.
4650 When "##" is included, it is replaced by a number to make the name
4651 unique. This makes sure that the ":make" command doesn't overwrite an
4652 existing file.
4653 NOT used for the ":cf" command. See 'errorfile' for that.
4654 Environment variables are expanded |:set_env|.
4655 See |option-backslash| about including spaces and backslashes.
4656 This option cannot be set from a |modeline| or in the |sandbox|, for
4657 security reasons.
4658
4659 *'makeprg'* *'mp'*
4660'makeprg' 'mp' string (default "make", VMS: "MMS")
4661 global or local to buffer |global-local|
4662 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004663 Program to use for the ":make" command. See |:make_makeprg|.
4664 This option may contain '%' and '#' characters, which are expanded to
4665 the current and alternate file name. |:_%| |:_#|
4666 Environment variables are expanded |:set_env|. See |option-backslash|
4667 about including spaces and backslashes.
4668 Note that a '|' must be escaped twice: once for ":set" and once for
4669 the interpretation of a command. When you use a filter called
4670 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 :set makeprg=gmake\ \\\|\ myfilter
4672< The placeholder "$*" can be given (even multiple times) to specify
4673 where the arguments will be included, for example: >
4674 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4675< This option cannot be set from a |modeline| or in the |sandbox|, for
4676 security reasons.
4677
4678 *'matchpairs'* *'mps'*
4679'matchpairs' 'mps' string (default "(:),{:},[:]")
4680 local to buffer
4681 {not in Vi}
4682 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004683 other. Currently only single byte character pairs are allowed, and
4684 they must be different. The characters must be separated by a colon.
4685 The pairs must be separated by a comma. Example for including '<' and
4686 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 :set mps+=<:>
4688
4689< A more exotic example, to jump between the '=' and ';' in an
4690 assignment, useful for languages like C and Java: >
4691 :au FileType c,cpp,java set mps+==:;
4692
4693< For a more advanced way of using "%", see the matchit.vim plugin in
4694 the $VIMRUNTIME/macros directory. |add-local-help|
4695
4696 *'matchtime'* *'mat'*
4697'matchtime' 'mat' number (default 5)
4698 global
4699 {not in Vi}{in Nvi}
4700 Tenths of a second to show the matching paren, when 'showmatch' is
4701 set. Note that this is not in milliseconds, like other options that
4702 set a time. This is to be compatible with Nvi.
4703
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004704 *'maxcombine'* *'mco'*
4705'maxcombine' 'mco' number (default 2)
4706 global
4707 {not in Vi}
4708 {only available when compiled with the |+multi_byte|
4709 feature}
4710 The maximum number of combining characters supported for displaying.
4711 Only used when 'encoding' is "utf-8".
4712 The default is OK for most languages. Hebrew may require 4.
4713 Maximum value is 6.
4714 Even when this option is set to 2 you can still edit text with more
4715 combining characters, you just can't see them. Use |g8| or |ga|.
4716 See |mbyte-combining|.
4717
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 *'maxfuncdepth'* *'mfd'*
4719'maxfuncdepth' 'mfd' number (default 100)
4720 global
4721 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004722 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004723 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 Maximum depth of function calls for user functions. This normally
4725 catches endless recursion. When using a recursive function with
4726 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4727 more memory, there is the danger of failing when memory is exhausted.
4728 See also |:function|.
4729
4730 *'maxmapdepth'* *'mmd'* *E223*
4731'maxmapdepth' 'mmd' number (default 1000)
4732 global
4733 {not in Vi}
4734 Maximum number of times a mapping is done without resulting in a
4735 character to be used. This normally catches endless mappings, like
4736 ":map x y" with ":map y x". It still does not catch ":map g wg",
4737 because the 'w' is used before the next mapping is done. See also
4738 |key-mapping|.
4739
4740 *'maxmem'* *'mm'*
4741'maxmem' 'mm' number (default between 256 to 5120 (system
4742 dependent) or half the amount of memory
4743 available)
4744 global
4745 {not in Vi}
4746 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4747 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004748 other memory to be freed. The maximum usable value is about 2000000.
4749 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004751 *'maxmempattern'* *'mmp'*
4752'maxmempattern' 'mmp' number (default 1000)
4753 global
4754 {not in Vi}
4755 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004756 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004757 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004758 When Vim runs into the limit it gives an error message and mostly
4759 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004760 Running into the limit often means that the pattern is very
4761 inefficient or too complex. This may already happen with the pattern
4762 "\(.\)*" on a very long line. ".*" works much better.
4763 Vim may run out of memory before hitting the 'maxmempattern' limit.
4764
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 *'maxmemtot'* *'mmt'*
4766'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4767 dependent) or half the amount of memory
4768 available)
4769 global
4770 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004771 Maximum amount of memory in Kbyte to use for all buffers together.
4772 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4773 without a limit. On 64 bit machines higher values might work. But
4774 hey, do you really need more than 2 Gbyte for text editing?
4775 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776
4777 *'menuitems'* *'mis'*
4778'menuitems' 'mis' number (default 25)
4779 global
4780 {not in Vi}
4781 {not available when compiled without the |+menu|
4782 feature}
4783 Maximum number of items to use in a menu. Used for menus that are
4784 generated from a list of items, e.g., the Buffers menu. Changing this
4785 option has no direct effect, the menu must be refreshed first.
4786
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004787 *'mkspellmem'* *'msm'*
4788'mkspellmem' 'msm' string (default "460000,2000,500")
4789 global
4790 {not in Vi}
4791 {not available when compiled without the |+syntax|
4792 feature}
4793 Parameters for |:mkspell|. This tunes when to start compressing the
4794 word tree. Compression can be slow when there are many words, but
4795 it's needed to avoid running out of memory. The amount of memory used
4796 per word depends very much on how similar the words are, that's why
4797 this tuning is complicated.
4798
4799 There are three numbers, separated by commas:
4800 {start},{inc},{added}
4801
4802 For most languages the uncompressed word tree fits in memory. {start}
4803 gives the amount of memory in Kbyte that can be used before any
4804 compression is done. It should be a bit smaller than the amount of
4805 memory that is available to Vim.
4806
4807 When going over the {start} limit the {inc} number specifies the
4808 amount of memory in Kbyte that can be allocated before another
4809 compression is done. A low number means compression is done after
4810 less words are added, which is slow. A high number means more memory
4811 will be allocated.
4812
4813 After doing compression, {added} times 1024 words can be added before
4814 the {inc} limit is ignored and compression is done when any extra
4815 amount of memory is needed. A low number means there is a smaller
4816 chance of hitting the {inc} limit, less memory is used but it's
4817 slower.
4818
4819 The languages for which these numbers are important are Italian and
4820 Hungarian. The default works for when you have about 512 Mbyte. If
4821 you have 1 Gbyte you could use: >
4822 :set mkspellmem=900000,3000,800
4823< If you have less than 512 Mbyte |:mkspell| may fail for some
4824 languages, no matter what you set 'mkspellmem' to.
4825
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004827'modeline' 'ml' boolean (Vim default: on (off for root),
4828 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 local to buffer
4830 *'modelines'* *'mls'*
4831'modelines' 'mls' number (default 5)
4832 global
4833 {not in Vi}
4834 If 'modeline' is on 'modelines' gives the number of lines that is
4835 checked for set commands. If 'modeline' is off or 'modelines' is zero
4836 no lines are checked. See |modeline|.
4837 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4838 set and to the Vim default value when 'compatible' is reset.
4839
4840 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4841'modifiable' 'ma' boolean (default on)
4842 local to buffer
4843 {not in Vi} *E21*
4844 When off the buffer contents cannot be changed. The 'fileformat' and
4845 'fileencoding' options also can't be changed.
4846 Can be reset with the |-M| command line argument.
4847
4848 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4849'modified' 'mod' boolean (default off)
4850 local to buffer
4851 {not in Vi}
4852 When on, the buffer is considered to be modified. This option is set
4853 when:
4854 1. A change was made to the text since it was last written. Using the
4855 |undo| command to go back to the original text will reset the
4856 option. But undoing changes that were made before writing the
4857 buffer will set the option again, since the text is different from
4858 when it was written.
4859 2. 'fileformat' or 'fileencoding' is different from its original
4860 value. The original value is set when the buffer is read or
4861 written. A ":set nomodified" command also resets the original
4862 values to the current values and the 'modified' option will be
4863 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004864 This option is not set when a change is made to the buffer as the
4865 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4866 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4867 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4869 will be ignored.
4870
4871 *'more'* *'nomore'*
4872'more' boolean (Vim default: on, Vi default: off)
4873 global
4874 {not in Vi}
4875 When on, listings pause when the whole screen is filled. You will get
4876 the |more-prompt|. When this option is off there are no pauses, the
4877 listing continues until finished.
4878 NOTE: This option is set to the Vi default value when 'compatible' is
4879 set and to the Vim default value when 'compatible' is reset.
4880
4881 *'mouse'* *E538*
4882'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4883 global
4884 {not in Vi}
4885 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004886 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4887 sysmouse and Linux console with gpm). For using the mouse in the
4888 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 The mouse can be enabled for different modes:
4890 n Normal mode
4891 v Visual mode
4892 i Insert mode
4893 c Command-line mode
4894 h all previous modes when editing a help file
4895 a all previous modes
4896 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 Normally you would enable the mouse in all four modes with: >
4898 :set mouse=a
4899< When the mouse is not enabled, the GUI will still use the mouse for
4900 modeless selection. This doesn't move the text cursor.
4901
4902 See |mouse-using|. Also see |'clipboard'|.
4903
4904 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004905 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 the mouse buttons can still be used by keeping the shift key pressed.
4907 Also see the 'clipboard' option.
4908
4909 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4910'mousefocus' 'mousef' boolean (default off)
4911 global
4912 {not in Vi}
4913 {only works in the GUI}
4914 The window that the mouse pointer is on is automatically activated.
4915 When changing the window layout or window focus in another way, the
4916 mouse pointer is moved to the window with keyboard focus. Off is the
4917 default because it makes using the pull down menus a little goofy, as
4918 a pointer transit may activate a window unintentionally.
4919
4920 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4921'mousehide' 'mh' boolean (default on)
4922 global
4923 {not in Vi}
4924 {only works in the GUI}
4925 When on, the mouse pointer is hidden when characters are typed.
4926 The mouse pointer is restored when the mouse is moved.
4927
4928 *'mousemodel'* *'mousem'*
4929'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4930 global
4931 {not in Vi}
4932 Sets the model to use for the mouse. The name mostly specifies what
4933 the right mouse button is used for:
4934 extend Right mouse button extends a selection. This works
4935 like in an xterm.
4936 popup Right mouse button pops up a menu. The shifted left
4937 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004938 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 popup_setpos Like "popup", but the cursor will be moved to the
4940 position where the mouse was clicked, and thus the
4941 selected operation will act upon the clicked object.
4942 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004943 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 course, that right clicking outside a selection will
4945 end Visual mode.
4946 Overview of what button does what for each model:
4947 mouse extend popup(_setpos) ~
4948 left click place cursor place cursor
4949 left drag start selection start selection
4950 shift-left search word extend selection
4951 right click extend selection popup menu (place cursor)
4952 right drag extend selection -
4953 middle click paste paste
4954
4955 In the "popup" model the right mouse button produces a pop-up menu.
4956 You need to define this first, see |popup-menu|.
4957
4958 Note that you can further refine the meaning of buttons with mappings.
4959 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4960 selection (because that's handled in the GUI code directly).
4961
4962 The 'mousemodel' option is set by the |:behave| command.
4963
4964 *'mouseshape'* *'mouses'* *E547*
4965'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004966 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 global
4968 {not in Vi}
4969 {only available when compiled with the |+mouseshape|
4970 feature}
4971 This option tells Vim what the mouse pointer should look like in
4972 different modes. The option is a comma separated list of parts, much
4973 like used for 'guicursor'. Each part consist of a mode/location-list
4974 and an argument-list:
4975 mode-list:shape,mode-list:shape,..
4976 The mode-list is a dash separated list of these modes/locations:
4977 In a normal window: ~
4978 n Normal mode
4979 v Visual mode
4980 ve Visual mode with 'selection' "exclusive" (same as 'v',
4981 if not specified)
4982 o Operator-pending mode
4983 i Insert mode
4984 r Replace mode
4985
4986 Others: ~
4987 c appending to the command-line
4988 ci inserting in the command-line
4989 cr replacing in the command-line
4990 m at the 'Hit ENTER' or 'More' prompts
4991 ml idem, but cursor in the last line
4992 e any mode, pointer below last window
4993 s any mode, pointer on a status line
4994 sd any mode, while dragging a status line
4995 vs any mode, pointer on a vertical separator line
4996 vd any mode, while dragging a vertical separator line
4997 a everywhere
4998
4999 The shape is one of the following:
5000 avail name looks like ~
5001 w x arrow Normal mouse pointer
5002 w x blank no pointer at all (use with care!)
5003 w x beam I-beam
5004 w x updown up-down sizing arrows
5005 w x leftright left-right sizing arrows
5006 w x busy The system's usual busy pointer
5007 w x no The system's usual 'no input' pointer
5008 x udsizing indicates up-down resizing
5009 x lrsizing indicates left-right resizing
5010 x crosshair like a big thin +
5011 x hand1 black hand
5012 x hand2 white hand
5013 x pencil what you write with
5014 x question big ?
5015 x rightup-arrow arrow pointing right-up
5016 w x up-arrow arrow pointing up
5017 x <number> any X11 pointer number (see X11/cursorfont.h)
5018
5019 The "avail" column contains a 'w' if the shape is available for Win32,
5020 x for X11.
5021 Any modes not specified or shapes not available use the normal mouse
5022 pointer.
5023
5024 Example: >
5025 :set mouseshape=s:udsizing,m:no
5026< will make the mouse turn to a sizing arrow over the status lines and
5027 indicate no input when the hit-enter prompt is displayed (since
5028 clicking the mouse has no effect in this state.)
5029
5030 *'mousetime'* *'mouset'*
5031'mousetime' 'mouset' number (default 500)
5032 global
5033 {not in Vi}
5034 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5035 time in msec between two mouse clicks for the second click to be
5036 recognized as a multi click.
5037
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005038 *'mzquantum'* *'mzq'*
5039'mzquantum' 'mzq' number (default 100)
5040 global
5041 {not in Vi}
5042 {not available when compiled without the |+mzscheme|
5043 feature}
5044 The number of milliseconds between polls for MzScheme threads.
5045 Negative or zero value means no thread scheduling.
5046
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 *'nrformats'* *'nf'*
5048'nrformats' 'nf' string (default "octal,hex")
5049 local to buffer
5050 {not in Vi}
5051 This defines what bases Vim will consider for numbers when using the
5052 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5053 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005054 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02005056 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005057 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005059 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 considered to be hexadecimal. Example: Using CTRL-X on
5061 "0x100" results in "0x0ff".
5062 Numbers which simply begin with a digit in the range 1-9 are always
5063 considered decimal. This also happens for numbers that are not
5064 recognized as octal or hex.
5065
5066 *'number'* *'nu'* *'nonumber'* *'nonu'*
5067'number' 'nu' boolean (default off)
5068 local to window
5069 Print the line number in front of each line. When the 'n' option is
5070 excluded from 'cpoptions' a wrapped line will not use the column of
5071 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005072 The 'numberwidth' option can be used to set the room used for the line
5073 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 When a long, wrapped line doesn't start with the first character, '-'
5075 characters are put before the number.
5076 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005077 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005079 *'numberwidth'* *'nuw'*
5080'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5081 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005082 {not in Vi}
5083 {only available when compiled with the |+linebreak|
5084 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005085 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005086 when the 'number' or 'relativenumber' option is set or printing lines
5087 with a line number. Since one space is always between the number and
5088 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005089 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005090 fit the highest line number in the buffer respectively the number of
5091 rows in the window, depending on whether 'number' or 'relativenumber'
5092 is set. Thus with the Vim default of 4 there is room for a line number
5093 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005094 The minimum value is 1, the maximum value is 10.
5095 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5096
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005097 *'omnifunc'* *'ofu'*
5098'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005099 local to buffer
5100 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005101 {not available when compiled without the |+eval|
5102 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005103 This option specifies a function to be used for Insert mode omni
5104 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005105 See |complete-functions| for an explanation of how the function is
5106 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005107 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005108 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005109
5110
Bram Moolenaar02467872007-05-06 13:22:01 +00005111 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005112'opendevice' 'odev' boolean (default off)
5113 global
5114 {not in Vi}
5115 {only for MS-DOS, MS-Windows and OS/2}
5116 Enable reading and writing from devices. This may get Vim stuck on a
5117 device that can be opened but doesn't actually do the I/O. Therefore
5118 it is off by default.
5119 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5120 result in editing a device.
5121
5122
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005123 *'operatorfunc'* *'opfunc'*
5124'operatorfunc' 'opfunc' string (default: empty)
5125 global
5126 {not in Vi}
5127 This option specifies a function to be called by the |g@| operator.
5128 See |:map-operator| for more info and an example.
5129
5130 This option cannot be set from a |modeline| or in the |sandbox|, for
5131 security reasons.
5132
5133
Bram Moolenaar251e1912011-06-19 05:09:16 +02005134 *'osfiletype'* *'oft'*
5135'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 local to buffer
5137 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005138 This option was supported on RISC OS, which has been removed.
5139
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140
5141 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005142'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 global
5144 Specifies the nroff macros that separate paragraphs. These are pairs
5145 of two letters (see |object-motions|).
5146
5147 *'paste'* *'nopaste'*
5148'paste' boolean (default off)
5149 global
5150 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005151 Put Vim in Paste mode. This is useful if you want to cut or copy
5152 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 unexpected effects.
5154 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005155 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 knows about pasting and will mostly do the right thing without 'paste'
5157 being set. The same is true for a terminal where Vim handles the
5158 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005159 This option is reset when starting the GUI. Thus if you set it in
5160 your .vimrc it will work in a terminal, but not in the GUI. Setting
5161 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5162 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 When the 'paste' option is switched on (also when it was already on):
5164 - mapping in Insert mode and Command-line mode is disabled
5165 - abbreviations are disabled
5166 - 'textwidth' is set to 0
5167 - 'wrapmargin' is set to 0
5168 - 'autoindent' is reset
5169 - 'smartindent' is reset
5170 - 'softtabstop' is set to 0
5171 - 'revins' is reset
5172 - 'ruler' is reset
5173 - 'showmatch' is reset
5174 - 'formatoptions' is used like it is empty
5175 These options keep their value, but their effect is disabled:
5176 - 'lisp'
5177 - 'indentexpr'
5178 - 'cindent'
5179 NOTE: When you start editing another file while the 'paste' option is
5180 on, settings from the modelines or autocommands may change the
5181 settings again, causing trouble when pasting text. You might want to
5182 set the 'paste' option again.
5183 When the 'paste' option is reset the mentioned options are restored to
5184 the value before the moment 'paste' was switched from off to on.
5185 Resetting 'paste' before ever setting it does not have any effect.
5186 Since mapping doesn't work while 'paste' is active, you need to use
5187 the 'pastetoggle' option to toggle the 'paste' option with some key.
5188
5189 *'pastetoggle'* *'pt'*
5190'pastetoggle' 'pt' string (default "")
5191 global
5192 {not in Vi}
5193 When non-empty, specifies the key sequence that toggles the 'paste'
5194 option. This is like specifying a mapping: >
5195 :map {keys} :set invpaste<CR>
5196< Where {keys} is the value of 'pastetoggle'.
5197 The difference is that it will work even when 'paste' is set.
5198 'pastetoggle' works in Insert mode and Normal mode, but not in
5199 Command-line mode.
5200 Mappings are checked first, thus overrule 'pastetoggle'. However,
5201 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5202 this: >
5203 :map <F10> :set paste<CR>
5204 :map <F11> :set nopaste<CR>
5205 :imap <F10> <C-O>:set paste<CR>
5206 :imap <F11> <nop>
5207 :set pastetoggle=<F11>
5208< This will make <F10> start paste mode and <F11> stop paste mode.
5209 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5210 mode everything is inserted literally, except the 'pastetoggle' key
5211 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005212 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213
5214 *'pex'* *'patchexpr'*
5215'patchexpr' 'pex' string (default "")
5216 global
5217 {not in Vi}
5218 {not available when compiled without the |+diff|
5219 feature}
5220 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005221 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222
5223 *'patchmode'* *'pm'* *E206*
5224'patchmode' 'pm' string (default "")
5225 global
5226 {not in Vi}
5227 When non-empty the oldest version of a file is kept. This can be used
5228 to keep the original version of a file if you are changing files in a
5229 source distribution. Only the first time that a file is written a
5230 copy of the original file will be kept. The name of the copy is the
5231 name of the original file with the string in the 'patchmode' option
5232 appended. This option should start with a dot. Use a string like
5233 ".org". 'backupdir' must not be empty for this to work (Detail: The
5234 backup file is renamed to the patchmode file after the new file has
5235 been successfully written, that's why it must be possible to write a
5236 backup file). If there was no file to be backed up, an empty file is
5237 created.
5238 When the 'backupskip' pattern matches, a patchmode file is not made.
5239 Using 'patchmode' for compressed files appends the extension at the
5240 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5241 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005242 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243
5244 *'path'* *'pa'* *E343* *E345* *E347*
5245'path' 'pa' string (default on Unix: ".,/usr/include,,"
5246 on OS/2: ".,/emx/include,,"
5247 other systems: ".,,")
5248 global or local to buffer |global-local|
5249 {not in Vi}
5250 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005251 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5252 provided that the file being searched for has a relative path (not
5253 starting with "/", "./" or "../"). The directories in the 'path'
5254 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 - Use commas to separate directory names: >
5256 :set path=.,/usr/local/include,/usr/include
5257< - Spaces can also be used to separate directory names (for backwards
5258 compatibility with version 3.0). To have a space in a directory
5259 name, precede it with an extra backslash, and escape the space: >
5260 :set path=.,/dir/with\\\ space
5261< - To include a comma in a directory name precede it with an extra
5262 backslash: >
5263 :set path=.,/dir/with\\,comma
5264< - To search relative to the directory of the current file, use: >
5265 :set path=.
5266< - To search in the current directory use an empty string between two
5267 commas: >
5268 :set path=,,
5269< - A directory name may end in a ':' or '/'.
5270 - Environment variables are expanded |:set_env|.
5271 - When using |netrw.vim| URLs can be used. For example, adding
5272 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005273 - Search upwards and downwards in a directory tree using "*", "**" and
5274 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 {not available when compiled without the |+path_extra| feature}
5276 - Careful with '\' characters, type two to get one in the option: >
5277 :set path=.,c:\\include
5278< Or just use '/' instead: >
5279 :set path=.,c:/include
5280< Don't forget "." or files won't even be found in the same directory as
5281 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005282 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 it is something like 256 or 1024 characters.
5284 You can check if all the include files are found, using the value of
5285 'path', see |:checkpath|.
5286 The use of |:set+=| and |:set-=| is preferred when adding or removing
5287 directories from the list. This avoids problems when a future version
5288 uses another default. To remove the current directory use: >
5289 :set path-=
5290< To add the current directory use: >
5291 :set path+=
5292< To use an environment variable, you probably need to replace the
5293 separator. Here is an example to append $INCL, in which directory
5294 names are separated with a semi-colon: >
5295 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5296< Replace the ';' with a ':' or whatever separator is used. Note that
5297 this doesn't work when $INCL contains a comma or white space.
5298
5299 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5300'preserveindent' 'pi' boolean (default off)
5301 local to buffer
5302 {not in Vi}
5303 When changing the indent of the current line, preserve as much of the
5304 indent structure as possible. Normally the indent is replaced by a
5305 series of tabs followed by spaces as required (unless |'expandtab'| is
5306 enabled, in which case only spaces are used). Enabling this option
5307 means the indent will preserve as many existing characters as possible
5308 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005309 'expandtab' does not apply to the preserved white space, a Tab remains
5310 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 NOTE: When using ">>" multiple times the resulting indent is a mix of
5312 tabs and spaces. You might not like this.
5313 NOTE: 'preserveindent' is reset when 'compatible' is set.
5314 Also see 'copyindent'.
5315 Use |:retab| to clean up white space.
5316
5317 *'previewheight'* *'pvh'*
5318'previewheight' 'pvh' number (default 12)
5319 global
5320 {not in Vi}
5321 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005322 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323 Default height for a preview window. Used for |:ptag| and associated
5324 commands. Used for |CTRL-W_}| when no count is given.
5325
5326 *'previewwindow'* *'nopreviewwindow'*
5327 *'pvw'* *'nopvw'* *E590*
5328'previewwindow' 'pvw' boolean (default off)
5329 local to window
5330 {not in Vi}
5331 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005332 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005333 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 set. It's normally not set directly, but by using one of the commands
5335 |:ptag|, |:pedit|, etc.
5336
5337 *'printdevice'* *'pdev'*
5338'printdevice' 'pdev' string (default empty)
5339 global
5340 {not in Vi}
5341 {only available when compiled with the |+printer|
5342 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005343 The name of the printer to be used for |:hardcopy|.
5344 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005345 This option cannot be set from a |modeline| or in the |sandbox|, for
5346 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347
Bram Moolenaar8299df92004-07-10 09:47:34 +00005348 *'printencoding'* *'penc'*
5349'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 global
5351 {not in Vi}
5352 {only available when compiled with the |+printer|
5353 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005354 Sets the character encoding used when printing.
5355 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356
5357 *'printexpr'* *'pexpr'*
5358'printexpr' 'pexpr' String (default: see below)
5359 global
5360 {not in Vi}
5361 {only available when compiled with the |+printer|
5362 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005363 Expression used to print the PostScript produced with |:hardcopy|.
5364 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365
Bram Moolenaar8299df92004-07-10 09:47:34 +00005366 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367'printfont' 'pfn' string (default "courier")
5368 global
5369 {not in Vi}
5370 {only available when compiled with the |+printer|
5371 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005372 The name of the font that will be used for |:hardcopy|.
5373 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374
5375 *'printheader'* *'pheader'*
5376'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5377 global
5378 {not in Vi}
5379 {only available when compiled with the |+printer|
5380 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005381 The format of the header produced in |:hardcopy| output.
5382 See |pheader-option|.
5383
5384 *'printmbcharset'* *'pmbcs'*
5385'printmbcharset' 'pmbcs' string (default "")
5386 global
5387 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005388 {only available when compiled with the |+printer|,
5389 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005390 The CJK character set to be used for CJK output from |:hardcopy|.
5391 See |pmbcs-option|.
5392
5393 *'printmbfont'* *'pmbfn'*
5394'printmbfont' 'pmbfn' string (default "")
5395 global
5396 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005397 {only available when compiled with the |+printer|,
5398 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005399 List of font names to be used for CJK output from |:hardcopy|.
5400 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401
5402 *'printoptions'* *'popt'*
5403'printoptions' 'popt' string (default "")
5404 global
5405 {not in Vi}
5406 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005407 List of items that control the format of the output of |:hardcopy|.
5408 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005410 *'prompt'* *'noprompt'*
5411'prompt' boolean (default on)
5412 global
5413 When on a ":" prompt is used in Ex mode.
5414
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005415 *'pumheight'* *'ph'*
5416'pumheight' 'ph' number (default 0)
5417 global
5418 {not available when compiled without the
5419 |+insert_expand| feature}
5420 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005421 Determines the maximum number of items to show in the popup menu for
5422 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005423 |ins-completion-menu|.
5424
5425
Bram Moolenaar677ee682005-01-27 14:41:15 +00005426 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005427'quoteescape' 'qe' string (default "\")
5428 local to buffer
5429 {not in Vi}
5430 The characters that are used to escape quotes in a string. Used for
5431 objects like a', a" and a` |a'|.
5432 When one of the characters in this option is found inside a string,
5433 the following character will be skipped. The default value makes the
5434 text "foo\"bar\\" considered to be one string.
5435
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5437'readonly' 'ro' boolean (default off)
5438 local to buffer
5439 If on, writes fail unless you use a '!'. Protects you from
5440 accidentally overwriting a file. Default on when Vim is started
5441 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005442 When using ":w!" the 'readonly' option is reset for the current
5443 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005445 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005447 *'redrawtime'* *'rdt'*
5448'redrawtime' 'rdt' number (default 2000)
5449 global
5450 {not in Vi}
5451 {only available when compiled with the |+reltime|
5452 feature}
5453 The time in milliseconds for redrawing the display. This applies to
5454 searching for patterns for 'hlsearch' and |:match| highlighting.
5455 When redrawing takes more than this many milliseconds no further
5456 matches will be highlighted. This is used to avoid that Vim hangs
5457 when using a very complicated pattern.
5458
Bram Moolenaar64486672010-05-16 15:46:46 +02005459 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5460'relativenumber' 'rnu' boolean (default off)
5461 local to window
5462 {not in Vi}
5463 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005464 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005465 precede some vertical motion commands (e.g. j k + -) with, without
5466 having to calculate it yourself. Especially useful in combination with
5467 other commands (e.g. y d c < > gq gw =).
5468 When the 'n' option is excluded from 'cpoptions' a wrapped
5469 line will not use the column of line numbers (this is the default when
5470 'compatible' isn't set).
5471 The 'numberwidth' option can be used to set the room used for the line
5472 number.
5473 When a long, wrapped line doesn't start with the first character, '-'
5474 characters are put before the number.
5475 See |hl-LineNr| for the highlighting used for the number.
5476 When setting this option, 'number' is reset.
5477
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478 *'remap'* *'noremap'*
5479'remap' boolean (default on)
5480 global
5481 Allows for mappings to work recursively. If you do not want this for
5482 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005483 NOTE: To avoid portability problems with Vim scripts, always keep
5484 this option at the default "on". Only switch it off when working with
5485 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486
5487 *'report'*
5488'report' number (default 2)
5489 global
5490 Threshold for reporting number of lines changed. When the number of
5491 changed lines is more than 'report' a message will be given for most
5492 ":" commands. If you want it always, set 'report' to 0.
5493 For the ":substitute" command the number of substitutions is used
5494 instead of the number of lines.
5495
5496 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5497'restorescreen' 'rs' boolean (default on)
5498 global
5499 {not in Vi} {only in Windows 95/NT console version}
5500 When set, the screen contents is restored when exiting Vim. This also
5501 happens when executing external commands.
5502
5503 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5504 options in your .vimrc. To disable restoring:
5505 set t_ti= t_te=
5506 To enable restoring (for an xterm):
5507 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5508 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5509
5510 *'revins'* *'ri'* *'norevins'* *'nori'*
5511'revins' 'ri' boolean (default off)
5512 global
5513 {not in Vi}
5514 {only available when compiled with the |+rightleft|
5515 feature}
5516 Inserting characters in Insert mode will work backwards. See "typing
5517 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5518 command in Insert mode, when 'allowrevins' is set.
5519 NOTE: This option is reset when 'compatible' or 'paste' is set.
5520
5521 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5522'rightleft' 'rl' boolean (default off)
5523 local to window
5524 {not in Vi}
5525 {only available when compiled with the |+rightleft|
5526 feature}
5527 When on, display orientation becomes right-to-left, i.e., characters
5528 that are stored in the file appear from the right to the left.
5529 Using this option, it is possible to edit files for languages that
5530 are written from the right to the left such as Hebrew and Arabic.
5531 This option is per window, so it is possible to edit mixed files
5532 simultaneously, or to view the same file in both ways (this is
5533 useful whenever you have a mixed text file with both right-to-left
5534 and left-to-right strings so that both sets are displayed properly
5535 in different windows). Also see |rileft.txt|.
5536
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005537 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538'rightleftcmd' 'rlc' string (default "search")
5539 local to window
5540 {not in Vi}
5541 {only available when compiled with the |+rightleft|
5542 feature}
5543 Each word in this option enables the command line editing to work in
5544 right-to-left mode for a group of commands:
5545
5546 search "/" and "?" commands
5547
5548 This is useful for languages such as Hebrew, Arabic and Farsi.
5549 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5550
5551 *'ruler'* *'ru'* *'noruler'* *'noru'*
5552'ruler' 'ru' boolean (default off)
5553 global
5554 {not in Vi}
5555 {not available when compiled without the
5556 |+cmdline_info| feature}
5557 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005558 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 text in the file is shown on the far right:
5560 Top first line is visible
5561 Bot last line is visible
5562 All first and last line are visible
5563 45% relative position in the file
5564 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005565 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005567 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 this option takes precedence over 'ruler' and 'rulerformat'
5569 If the number of characters displayed is different from the number of
5570 bytes in the text (e.g., for a TAB or a multi-byte character), both
5571 the text column (byte number) and the screen column are shown,
5572 separated with a dash.
5573 For an empty line "0-1" is shown.
5574 For an empty buffer the line number will also be zero: "0,0-1".
5575 This option is reset when the 'paste' option is set.
5576 If you don't want to see the ruler all the time but want to know where
5577 you are, use "g CTRL-G" |g_CTRL-G|.
5578 NOTE: This option is reset when 'compatible' is set.
5579
5580 *'rulerformat'* *'ruf'*
5581'rulerformat' 'ruf' string (default empty)
5582 global
5583 {not in Vi}
5584 {not available when compiled without the |+statusline|
5585 feature}
5586 When this option is not empty, it determines the content of the ruler
5587 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005588 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 The default ruler width is 17 characters. To make the ruler 15
5590 characters wide, put "%15(" at the start and "%)" at the end.
5591 Example: >
5592 :set rulerformat=%15(%c%V\ %p%%%)
5593<
5594 *'runtimepath'* *'rtp'* *vimfiles*
5595'runtimepath' 'rtp' string (default:
5596 Unix: "$HOME/.vim,
5597 $VIM/vimfiles,
5598 $VIMRUNTIME,
5599 $VIM/vimfiles/after,
5600 $HOME/.vim/after"
5601 Amiga: "home:vimfiles,
5602 $VIM/vimfiles,
5603 $VIMRUNTIME,
5604 $VIM/vimfiles/after,
5605 home:vimfiles/after"
5606 PC, OS/2: "$HOME/vimfiles,
5607 $VIM/vimfiles,
5608 $VIMRUNTIME,
5609 $VIM/vimfiles/after,
5610 $HOME/vimfiles/after"
5611 Macintosh: "$VIM:vimfiles,
5612 $VIMRUNTIME,
5613 $VIM:vimfiles:after"
5614 RISC-OS: "Choices:vimfiles,
5615 $VIMRUNTIME,
5616 Choices:vimfiles/after"
5617 VMS: "sys$login:vimfiles,
5618 $VIM/vimfiles,
5619 $VIMRUNTIME,
5620 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005621 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 global
5623 {not in Vi}
5624 This is a list of directories which will be searched for runtime
5625 files:
5626 filetype.vim filetypes by file name |new-filetype|
5627 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005628 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 colors/ color scheme files |:colorscheme|
5630 compiler/ compiler files |:compiler|
5631 doc/ documentation |write-local-help|
5632 ftplugin/ filetype plugins |write-filetype-plugin|
5633 indent/ indent scripts |indent-expression|
5634 keymap/ key mapping files |mbyte-keymap|
5635 lang/ menu translations |:menutrans|
5636 menu.vim GUI menus |menu.vim|
5637 plugin/ plugin scripts |write-plugin|
5638 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005639 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 syntax/ syntax files |mysyntaxfile|
5641 tutor/ files for vimtutor |tutor|
5642
5643 And any other file searched for with the |:runtime| command.
5644
5645 The defaults for most systems are setup to search five locations:
5646 1. In your home directory, for your personal preferences.
5647 2. In a system-wide Vim directory, for preferences from the system
5648 administrator.
5649 3. In $VIMRUNTIME, for files distributed with Vim.
5650 *after-directory*
5651 4. In the "after" directory in the system-wide Vim directory. This is
5652 for the system administrator to overrule or add to the distributed
5653 defaults (rarely needed)
5654 5. In the "after" directory in your home directory. This is for
5655 personal preferences to overrule or add to the distributed defaults
5656 or system-wide settings (rarely needed).
5657
5658 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5659 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005660 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 wildcards.
5662 See |:runtime|.
5663 Example: >
5664 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5665< This will use the directory "~/vimruntime" first (containing your
5666 personal Vim runtime files), then "/mygroup/vim" (shared between a
5667 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5668 files).
5669 You probably should always include $VIMRUNTIME somewhere, to use the
5670 distributed runtime files. You can put a directory before $VIMRUNTIME
5671 to find files which replace a distributed runtime files. You can put
5672 a directory after $VIMRUNTIME to find files which add to distributed
5673 runtime files.
5674 This option cannot be set from a |modeline| or in the |sandbox|, for
5675 security reasons.
5676
5677 *'scroll'* *'scr'*
5678'scroll' 'scr' number (default: half the window height)
5679 local to window
5680 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5681 set to half the number of lines in the window when the window size
5682 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005683 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5685 the number of screen lines instead of file lines, makes a difference
5686 when lines wrap}
5687
5688 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5689'scrollbind' 'scb' boolean (default off)
5690 local to window
5691 {not in Vi}
5692 {not available when compiled without the |+scrollbind|
5693 feature}
5694 See also |scroll-binding|. When this option is set, the current
5695 window scrolls as other scrollbind windows (windows that also have
5696 this option set) scroll. This option is useful for viewing the
5697 differences between two versions of a file, see 'diff'.
5698 See |'scrollopt'| for options that determine how this option should be
5699 interpreted.
5700 This option is mostly reset when splitting a window to edit another
5701 file. This means that ":split | edit file" results in two windows
5702 with scroll-binding, but ":split file" does not.
5703
5704 *'scrolljump'* *'sj'*
5705'scrolljump' 'sj' number (default 1)
5706 global
5707 {not in Vi}
5708 Minimal number of lines to scroll when the cursor gets off the
5709 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5710 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005711 When set to a negative number from -1 to -100 this is used as the
5712 percentage of the window height. Thus -50 scrolls half the window
5713 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 NOTE: This option is set to 1 when 'compatible' is set.
5715
5716 *'scrolloff'* *'so'*
5717'scrolloff' 'so' number (default 0)
5718 global
5719 {not in Vi}
5720 Minimal number of screen lines to keep above and below the cursor.
5721 This will make some context visible around where you are working. If
5722 you set it to a very large value (999) the cursor line will always be
5723 in the middle of the window (except at the start or end of the file or
5724 when long lines wrap).
5725 For scrolling horizontally see 'sidescrolloff'.
5726 NOTE: This option is set to 0 when 'compatible' is set.
5727
5728 *'scrollopt'* *'sbo'*
5729'scrollopt' 'sbo' string (default "ver,jump")
5730 global
5731 {not available when compiled without the |+scrollbind|
5732 feature}
5733 {not in Vi}
5734 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005735 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5736 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 The following words are available:
5738 ver Bind vertical scrolling for 'scrollbind' windows
5739 hor Bind horizontal scrolling for 'scrollbind' windows
5740 jump Applies to the offset between two windows for vertical
5741 scrolling. This offset is the difference in the first
5742 displayed line of the bound windows. When moving
5743 around in a window, another 'scrollbind' window may
5744 reach a position before the start or after the end of
5745 the buffer. The offset is not changed though, when
5746 moving back the 'scrollbind' window will try to scroll
5747 to the desired position when possible.
5748 When now making that window the current one, two
5749 things can be done with the relative offset:
5750 1. When "jump" is not included, the relative offset is
5751 adjusted for the scroll position in the new current
5752 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005753 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754 2. When "jump" is included, the other windows are
5755 scrolled to keep the same relative offset. When
5756 going back to the other window, it still uses the
5757 same relative offset.
5758 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005759 When 'diff' mode is active there always is vertical scroll binding,
5760 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761
5762 *'sections'* *'sect'*
5763'sections' 'sect' string (default "SHNHH HUnhsh")
5764 global
5765 Specifies the nroff macros that separate sections. These are pairs of
5766 two letters (See |object-motions|). The default makes a section start
5767 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5768
5769 *'secure'* *'nosecure'* *E523*
5770'secure' boolean (default off)
5771 global
5772 {not in Vi}
5773 When on, ":autocmd", shell and write commands are not allowed in
5774 ".vimrc" and ".exrc" in the current directory and map commands are
5775 displayed. Switch it off only if you know that you will not run into
5776 problems, or when the 'exrc' option is off. On Unix this option is
5777 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005778 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779 'secure' at the end of your ~/.vimrc then.
5780 This option cannot be set from a |modeline| or in the |sandbox|, for
5781 security reasons.
5782
5783 *'selection'* *'sel'*
5784'selection' 'sel' string (default "inclusive")
5785 global
5786 {not in Vi}
5787 This option defines the behavior of the selection. It is only used
5788 in Visual and Select mode.
5789 Possible values:
5790 value past line inclusive ~
5791 old no yes
5792 inclusive yes yes
5793 exclusive yes no
5794 "past line" means that the cursor is allowed to be positioned one
5795 character past the line.
5796 "inclusive" means that the last character of the selection is included
5797 in an operation. For example, when "x" is used to delete the
5798 selection.
5799 Note that when "exclusive" is used and selecting from the end
5800 backwards, you cannot include the last character of a line, when
5801 starting in Normal mode and 'virtualedit' empty.
5802
5803 The 'selection' option is set by the |:behave| command.
5804
5805 *'selectmode'* *'slm'*
5806'selectmode' 'slm' string (default "")
5807 global
5808 {not in Vi}
5809 This is a comma separated list of words, which specifies when to start
5810 Select mode instead of Visual mode, when a selection is started.
5811 Possible values:
5812 mouse when using the mouse
5813 key when using shifted special keys
5814 cmd when using "v", "V" or CTRL-V
5815 See |Select-mode|.
5816 The 'selectmode' option is set by the |:behave| command.
5817
5818 *'sessionoptions'* *'ssop'*
5819'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005820 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 global
5822 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005823 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 feature}
5825 Changes the effect of the |:mksession| command. It is a comma
5826 separated list of words. Each word enables saving and restoring
5827 something:
5828 word save and restore ~
5829 blank empty windows
5830 buffers hidden and unloaded buffers, not just those in windows
5831 curdir the current directory
5832 folds manually created folds, opened/closed folds and local
5833 fold options
5834 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005835 and contain at least one lowercase letter. Only
5836 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 help the help window
5838 localoptions options and mappings local to a window or buffer (not
5839 global values for local options)
5840 options all options and mappings (also global values for local
5841 options)
5842 resize size of the Vim window: 'lines' and 'columns'
5843 sesdir the directory in which the session file is located
5844 will become the current directory (useful with
5845 projects accessed over a network from different
5846 systems)
5847 slash backslashes in file names replaced with forward
5848 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005849 tabpages all tab pages; without this only the current tab page
5850 is restored, so that you can make a session for each
5851 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 unix with Unix end-of-line format (single <NL>), even when
5853 on Windows or DOS
5854 winpos position of the whole Vim window
5855 winsize window sizes
5856
5857 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005858 When neither "curdir" nor "sesdir" is included, file names are stored
5859 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005860 "slash" and "unix" are useful on Windows when sharing session files
5861 with Unix. The Unix version of Vim cannot source dos format scripts,
5862 but the Windows version of Vim can source unix format scripts.
5863
5864 *'shell'* *'sh'* *E91*
5865'shell' 'sh' string (default $SHELL or "sh",
5866 MS-DOS and Win32: "command.com" or
5867 "cmd.exe", OS/2: "cmd")
5868 global
5869 Name of the shell to use for ! and :! commands. When changing the
5870 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5871 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005872 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 See |option-backslash| about including spaces and backslashes.
5874 Environment variables are expanded |:set_env|.
5875 If the name of the shell contains a space, you might need to enclose
5876 it in quotes. Example: >
5877 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5878< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005879 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 "-f" is not inside the quotes, because it is not part of the command
5881 name. And Vim automagically recognizes the backslashes that are path
5882 separators.
5883 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5884 variable to change the way external commands are executed. See the
5885 libc.inf file of DJGPP.
5886 Under MS-Windows, when the executable ends in ".com" it must be
5887 included. Thus setting the shell to "command.com" or "4dos.com"
5888 works, but "command" and "4dos" do not work for all commands (e.g.,
5889 filtering).
5890 For unknown reasons, when using "4dos.com" the current directory is
5891 changed to "C:\". To avoid this set 'shell' like this: >
5892 :set shell=command.com\ /c\ 4dos
5893< This option cannot be set from a |modeline| or in the |sandbox|, for
5894 security reasons.
5895
5896 *'shellcmdflag'* *'shcf'*
5897'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5898 does not contain "sh" somewhere: "/c")
5899 global
5900 {not in Vi}
5901 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5902 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5903 systems, the default is set according to the value of 'shell', to
5904 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005905 OS/2 (EMX figures this out itself).
5906 On Unix it can have more than one flag. Each white space separated
5907 part is passed as an argument to the shell command.
5908 See |option-backslash| about including spaces and backslashes.
5909 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 This option cannot be set from a |modeline| or in the |sandbox|, for
5911 security reasons.
5912
5913 *'shellpipe'* *'sp'*
5914'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5915 global
5916 {not in Vi}
5917 {not available when compiled without the |+quickfix|
5918 feature}
5919 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005920 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 including spaces and backslashes.
5922 The name of the temporary file can be represented by "%s" if necessary
5923 (the file name is appended automatically if no %s appears in the value
5924 of this option).
5925 For the Amiga and MS-DOS the default is ">". The output is directly
5926 saved in a file and not echoed to the screen.
5927 For Unix the default it "| tee". The stdout of the compiler is saved
5928 in a file and echoed to the screen. If the 'shell' option is "csh" or
5929 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02005930 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
5931 default becomes "2>&1| tee". This means that stderr is also included.
5932 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
5933 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 The initialization of this option is done after reading the ".vimrc"
5935 and the other initializations, so that when the 'shell' option is set
5936 there, the 'shellpipe' option changes automatically, unless it was
5937 explicitly set before.
5938 When 'shellpipe' is set to an empty string, no redirection of the
5939 ":make" output will be done. This is useful if you use a 'makeprg'
5940 that writes to 'makeef' by itself. If you want no piping, but do
5941 want to include the 'makeef', set 'shellpipe' to a single space.
5942 Don't forget to precede the space with a backslash: ":set sp=\ ".
5943 In the future pipes may be used for filtering and this option will
5944 become obsolete (at least for Unix).
5945 This option cannot be set from a |modeline| or in the |sandbox|, for
5946 security reasons.
5947
5948 *'shellquote'* *'shq'*
5949'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5950 contains "sh" somewhere: "\"")
5951 global
5952 {not in Vi}
5953 Quoting character(s), put around the command passed to the shell, for
5954 the "!" and ":!" commands. The redirection is kept outside of the
5955 quoting. See 'shellxquote' to include the redirection. It's
5956 probably not useful to set both options.
5957 This is an empty string by default. Only known to be useful for
5958 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5959 or bash, where it should be "\"". The default is adjusted according
5960 the value of 'shell', to reduce the need to set this option by the
5961 user. See |dos-shell|.
5962 This option cannot be set from a |modeline| or in the |sandbox|, for
5963 security reasons.
5964
5965 *'shellredir'* *'srr'*
5966'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5967 global
5968 {not in Vi}
5969 String to be used to put the output of a filter command in a temporary
5970 file. See also |:!|. See |option-backslash| about including spaces
5971 and backslashes.
5972 The name of the temporary file can be represented by "%s" if necessary
5973 (the file name is appended automatically if no %s appears in the value
5974 of this option).
5975 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5976 or "zsh" during initializations, the default becomes ">&". If the
5977 'shell' option is "sh", "ksh" or "bash" the default becomes
5978 ">%s 2>&1". This means that stderr is also included.
5979 For Win32, the Unix checks are done and additionally "cmd" is checked
5980 for, which makes the default ">%s 2>&1". Also, the same names with
5981 ".exe" appended are checked for.
5982 The initialization of this option is done after reading the ".vimrc"
5983 and the other initializations, so that when the 'shell' option is set
5984 there, the 'shellredir' option changes automatically unless it was
5985 explicitly set before.
5986 In the future pipes may be used for filtering and this option will
5987 become obsolete (at least for Unix).
5988 This option cannot be set from a |modeline| or in the |sandbox|, for
5989 security reasons.
5990
5991 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5992'shellslash' 'ssl' boolean (default off)
5993 global
5994 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5995 When set, a forward slash is used when expanding file names. This is
5996 useful when a Unix-like shell is used instead of command.com or
5997 cmd.exe. Backward slashes can still be typed, but they are changed to
5998 forward slashes by Vim.
5999 Note that setting or resetting this option has no effect for some
6000 existing file names, thus this option needs to be set before opening
6001 any file for best results. This might change in the future.
6002 'shellslash' only works when a backslash can be used as a path
6003 separator. To test if this is so use: >
6004 if exists('+shellslash')
6005<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006006 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6007'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6008 global
6009 {not in Vi}
6010 When on, use temp files for shell commands. When off use a pipe.
6011 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006012 Currently a pipe is only supported on Unix and MS-Windows 2K and
6013 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006014 :if has("filterpipe")
6015< The advantage of using a pipe is that nobody can read the temp file
6016 and the 'shell' command does not need to support redirection.
6017 The advantage of using a temp file is that the file type and encoding
6018 can be detected.
6019 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6020 |FilterWritePost| autocommands event are not triggered when
6021 'shelltemp' is off.
6022
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 *'shelltype'* *'st'*
6024'shelltype' 'st' number (default 0)
6025 global
6026 {not in Vi} {only for the Amiga}
6027 On the Amiga this option influences the way how the commands work
6028 which use a shell.
6029 0 and 1: always use the shell
6030 2 and 3: use the shell only to filter lines
6031 4 and 5: use shell only for ':sh' command
6032 When not using the shell, the command is executed directly.
6033
6034 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6035 1 and 3: use "shell cmd" to start external commands
6036
6037 *'shellxquote'* *'sxq'*
6038'shellxquote' 'sxq' string (default: "";
6039 for Win32, when 'shell' contains "sh"
6040 somewhere: "\""
6041 for Unix, when using system(): "\"")
6042 global
6043 {not in Vi}
6044 Quoting character(s), put around the command passed to the shell, for
6045 the "!" and ":!" commands. Includes the redirection. See
6046 'shellquote' to exclude the redirection. It's probably not useful
6047 to set both options.
6048 This is an empty string by default. Known to be useful for
6049 third-party shells when using the Win32 version, such as the MKS Korn
6050 Shell or bash, where it should be "\"". The default is adjusted
6051 according the value of 'shell', to reduce the need to set this option
6052 by the user. See |dos-shell|.
6053 This option cannot be set from a |modeline| or in the |sandbox|, for
6054 security reasons.
6055
6056 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6057'shiftround' 'sr' boolean (default off)
6058 global
6059 {not in Vi}
6060 Round indent to multiple of 'shiftwidth'. Applies to > and <
6061 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6062 a multiple of 'shiftwidth' (this is Vi compatible).
6063 NOTE: This option is reset when 'compatible' is set.
6064
6065 *'shiftwidth'* *'sw'*
6066'shiftwidth' 'sw' number (default 8)
6067 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006068 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006069 |'cindent'|, |>>|, |<<|, etc.
6070
6071 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006072'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6073 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 global
6075 {not in Vi}
6076 This option helps to avoid all the |hit-enter| prompts caused by file
6077 messages, for example with CTRL-G, and to avoid some other messages.
6078 It is a list of flags:
6079 flag meaning when present ~
6080 f use "(3 of 5)" instead of "(file 3 of 5)"
6081 i use "[noeol]" instead of "[Incomplete last line]"
6082 l use "999L, 888C" instead of "999 lines, 888 characters"
6083 m use "[+]" instead of "[Modified]"
6084 n use "[New]" instead of "[New File]"
6085 r use "[RO]" instead of "[readonly]"
6086 w use "[w]" instead of "written" for file write message
6087 and "[a]" instead of "appended" for ':w >> file' command
6088 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6089 "[unix format]" and "[mac]" instead of "[mac format]".
6090 a all of the above abbreviations
6091
6092 o overwrite message for writing a file with subsequent message
6093 for reading a file (useful for ":wn" or when 'autowrite' on)
6094 O message for reading a file overwrites any previous message.
6095 Also for quickfix message (e.g., ":cn").
6096 s don't give "search hit BOTTOM, continuing at TOP" or "search
6097 hit TOP, continuing at BOTTOM" messages
6098 t truncate file message at the start if it is too long to fit
6099 on the command-line, "<" will appear in the left most column.
6100 Ignored in Ex mode.
6101 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006102 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 Ignored in Ex mode.
6104 W don't give "written" or "[w]" when writing a file
6105 A don't give the "ATTENTION" message when an existing swap file
6106 is found.
6107 I don't give the intro message when starting Vim |:intro|.
6108
6109 This gives you the opportunity to avoid that a change between buffers
6110 requires you to hit <Enter>, but still gives as useful a message as
6111 possible for the space available. To get the whole message that you
6112 would have got with 'shm' empty, use ":file!"
6113 Useful values:
6114 shm= No abbreviation of message.
6115 shm=a Abbreviation, but no loss of information.
6116 shm=at Abbreviation, and truncate message when necessary.
6117
6118 NOTE: This option is set to the Vi default value when 'compatible' is
6119 set and to the Vim default value when 'compatible' is reset.
6120
6121 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6122'shortname' 'sn' boolean (default off)
6123 local to buffer
6124 {not in Vi, not in MS-DOS versions}
6125 Filenames are assumed to be 8 characters plus one extension of 3
6126 characters. Multiple dots in file names are not allowed. When this
6127 option is on, dots in file names are replaced with underscores when
6128 adding an extension (".~" or ".swp"). This option is not available
6129 for MS-DOS, because then it would always be on. This option is useful
6130 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6131 or crossdos. When running the Win32 GUI version under Win32s, this
6132 option is always on by default.
6133
6134 *'showbreak'* *'sbr'* *E595*
6135'showbreak' 'sbr' string (default "")
6136 global
6137 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006138 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 feature}
6140 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006141 values are "> " or "+++ ": >
6142 :set showbreak=>\
6143< Note the backslash to escape the trailing space. It's easier like
6144 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006145 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006146< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 comma (in a future version the comma might be used to separate the
6148 part that is shown at the end and at the start of a line).
6149 The characters are highlighted according to the '@' flag in
6150 'highlight'.
6151 Note that tabs after the showbreak will be displayed differently.
6152 If you want the 'showbreak' to appear in between line numbers, add the
6153 "n" flag to 'cpoptions'.
6154
6155 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6156'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6157 off)
6158 global
6159 {not in Vi}
6160 {not available when compiled without the
6161 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006162 Show (partial) command in the last line of the screen. Set this
6163 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 In Visual mode the size of the selected area is shown:
6165 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006166 If the number of bytes is different it is also displayed: "2-6"
6167 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006169 - When selecting a block, the size in screen characters:
6170 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 NOTE: This option is set to the Vi default value when 'compatible' is
6172 set and to the Vim default value when 'compatible' is reset.
6173
6174 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6175'showfulltag' 'sft' boolean (default off)
6176 global
6177 {not in Vi}
6178 When completing a word in insert mode (see |ins-completion|) from the
6179 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006180 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 matched a C function, you can see a template for what arguments are
6182 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006183 Note that this doesn't work well together with having "longest" in
6184 'completeopt', because the completion from the search pattern may not
6185 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186
6187 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6188'showmatch' 'sm' boolean (default off)
6189 global
6190 When a bracket is inserted, briefly jump to the matching one. The
6191 jump is only done if the match can be seen on the screen. The time to
6192 show the match can be set with 'matchtime'.
6193 A Beep is given if there is no match (no matter if the match can be
6194 seen or not). This option is reset when the 'paste' option is set.
6195 When the 'm' flag is not included in 'cpoptions', typing a character
6196 will immediately move the cursor back to where it belongs.
6197 See the "sm" field in 'guicursor' for setting the cursor shape and
6198 blinking when showing the match.
6199 The 'matchpairs' option can be used to specify the characters to show
6200 matches for. 'rightleft' and 'revins' are used to look for opposite
6201 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006202 Also see the matchparen plugin for highlighting the match when moving
6203 around |pi_paren.txt|.
6204 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205
6206 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6207'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6208 global
6209 If in Insert, Replace or Visual mode put a message on the last line.
6210 Use the 'M' flag in 'highlight' to set the type of highlighting for
6211 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006212 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 doesn't mean XIM is really active, especially when 'imactivatekey' is
6214 not set.
6215 NOTE: This option is set to the Vi default value when 'compatible' is
6216 set and to the Vim default value when 'compatible' is reset.
6217
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006218 *'showtabline'* *'stal'*
6219'showtabline' 'stal' number (default 1)
6220 global
6221 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006222 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006223 feature}
6224 The value of this option specifies when the line with tab page labels
6225 will be displayed:
6226 0: never
6227 1: only if there are at least two tab pages
6228 2: always
6229 This is both for the GUI and non-GUI implementation of the tab pages
6230 line.
6231 See |tab-page| for more information about tab pages.
6232
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 *'sidescroll'* *'ss'*
6234'sidescroll' 'ss' number (default 0)
6235 global
6236 {not in Vi}
6237 The minimal number of columns to scroll horizontally. Used only when
6238 the 'wrap' option is off and the cursor is moved off of the screen.
6239 When it is zero the cursor will be put in the middle of the screen.
6240 When using a slow terminal set it to a large number or 0. When using
6241 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6242 commands.
6243
6244 *'sidescrolloff'* *'siso'*
6245'sidescrolloff' 'siso' number (default 0)
6246 global
6247 {not in Vi}
6248 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006249 right of the cursor if 'nowrap' is set. Setting this option to a
6250 value greater than 0 while having |'sidescroll'| also at a non-zero
6251 value makes some context visible in the line you are scrolling in
6252 horizontally (except at beginning of the line). Setting this option
6253 to a large value (like 999) has the effect of keeping the cursor
6254 horizontally centered in the window, as long as one does not come too
6255 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 NOTE: This option is set to 0 when 'compatible' is set.
6257
6258 Example: Try this together with 'sidescroll' and 'listchars' as
6259 in the following example to never allow the cursor to move
6260 onto the "extends" character:
6261
6262 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6263 :set sidescrolloff=1
6264
6265
6266 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6267'smartcase' 'scs' boolean (default off)
6268 global
6269 {not in Vi}
6270 Override the 'ignorecase' option if the search pattern contains upper
6271 case characters. Only used when the search pattern is typed and
6272 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006273 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6275 recalling the search pattern from history and hitting <Enter>.
6276 NOTE: This option is reset when 'compatible' is set.
6277
6278 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6279'smartindent' 'si' boolean (default off)
6280 local to buffer
6281 {not in Vi}
6282 {not available when compiled without the
6283 |+smartindent| feature}
6284 Do smart autoindenting when starting a new line. Works for C-like
6285 programs, but can also be used for other languages. 'cindent' does
6286 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006287 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006288 setting 'si' has no effect. 'indentexpr' is a more advanced
6289 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 Normally 'autoindent' should also be on when using 'smartindent'.
6291 An indent is automatically inserted:
6292 - After a line ending in '{'.
6293 - After a line starting with a keyword from 'cinwords'.
6294 - Before a line starting with '}' (only with the "O" command).
6295 When typing '}' as the first character in a new line, that line is
6296 given the same indent as the matching '{'.
6297 When typing '#' as the first character in a new line, the indent for
6298 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006299 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6301 When using the ">>" command, lines starting with '#' are not shifted
6302 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006303 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 is set smart indenting is disabled.
6305
6306 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6307'smarttab' 'sta' boolean (default off)
6308 global
6309 {not in Vi}
6310 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006311 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6312 <BS> will delete a 'shiftwidth' worth of space at the start of the
6313 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006314 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006315 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6316 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006317 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006319 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 NOTE: This option is reset when 'compatible' is set.
6321
6322 *'softtabstop'* *'sts'*
6323'softtabstop' 'sts' number (default 0)
6324 local to buffer
6325 {not in Vi}
6326 Number of spaces that a <Tab> counts for while performing editing
6327 operations, like inserting a <Tab> or using <BS>. It "feels" like
6328 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6329 used. This is useful to keep the 'ts' setting at its standard value
6330 of 8, while being able to edit like it is set to 'sts'. However,
6331 commands like "x" still work on the actual characters.
6332 When 'sts' is zero, this feature is off.
6333 'softtabstop' is set to 0 when the 'paste' option is set.
6334 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6335 spaces is minimized by using <Tab>s.
6336 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6337 set.
6338 NOTE: This option is set to 0 when 'compatible' is set.
6339
Bram Moolenaar217ad922005-03-20 22:37:15 +00006340 *'spell'* *'nospell'*
6341'spell' boolean (default off)
6342 local to window
6343 {not in Vi}
6344 {not available when compiled without the |+syntax|
6345 feature}
6346 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006347 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006348
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006349 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006350'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006351 local to buffer
6352 {not in Vi}
6353 {not available when compiled without the |+syntax|
6354 feature}
6355 Pattern to locate the end of a sentence. The following word will be
6356 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006357 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006358 When this check is not wanted make this option empty.
6359 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006360 Be careful with special characters, see |option-backslash| about
6361 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006362 To set this option automatically depending on the language, see
6363 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006364
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006365 *'spellfile'* *'spf'*
6366'spellfile' 'spf' string (default empty)
6367 local to buffer
6368 {not in Vi}
6369 {not available when compiled without the |+syntax|
6370 feature}
6371 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006372 commands. It must end in ".{encoding}.add". You need to include the
6373 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006374 *E765*
6375 It may also be a comma separated list of names. A count before the
6376 |zg| and |zw| commands can be used to access each. This allows using
6377 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006378 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006379 you: Using the first directory in 'runtimepath' that is writable. If
6380 there is no "spell" directory yet it will be created. For the file
6381 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006382 ignoring the region.
6383 The resulting ".spl" file will be used for spell checking, it does not
6384 have to appear in 'spelllang'.
6385 Normally one file is used for all regions, but you can add the region
6386 name if you want to. However, it will then only be used when
6387 'spellfile' is set to it, for entries in 'spelllang' only files
6388 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006389 This option cannot be set from a |modeline| or in the |sandbox|, for
6390 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006391
Bram Moolenaar217ad922005-03-20 22:37:15 +00006392 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006393'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006394 local to buffer
6395 {not in Vi}
6396 {not available when compiled without the |+syntax|
6397 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006398 A comma separated list of word list names. When the 'spell' option is
6399 on spellchecking will be done for these languages. Example: >
6400 set spelllang=en_us,nl,medical
6401< This means US English, Dutch and medical words are recognized. Words
6402 that are not recognized will be highlighted.
6403 The word list name must not include a comma or dot. Using a dash is
6404 recommended to separate the two letter language name from a
6405 specification. Thus "en-rare" is used for rare English words.
6406 A region name must come last and have the form "_xx", where "xx" is
6407 the two-letter, lower case region name. You can use more than one
6408 region by listing them: "en_us,en_ca" supports both US and Canadian
6409 English, but not words specific for Australia, New Zealand or Great
6410 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006411 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006412 As a special case the name of a .spl file can be given as-is. The
6413 first "_xx" in the name is removed and used as the region name
6414 (_xx is an underscore, two letters and followed by a non-letter).
6415 This is mainly for testing purposes. You must make sure the correct
6416 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006417 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006418 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6419 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006420 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006421
Bram Moolenaar98692072006-02-04 00:57:42 +00006422 If the |spellfile.vim| plugin is active and you use a language name
6423 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6424 will ask you if you want to download the file.
6425
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006426 After this option has been set successfully, Vim will source the files
6427 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006428 up to the first comma, dot or underscore.
6429 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006430
6431
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006432 *'spellsuggest'* *'sps'*
6433'spellsuggest' 'sps' string (default "best")
6434 global
6435 {not in Vi}
6436 {not available when compiled without the |+syntax|
6437 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006438 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006439 the |spellsuggest()| function. This is a comma-separated list of
6440 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006441
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006442 best Internal method that works best for English. Finds
6443 changes like "fast" and uses a bit of sound-a-like
6444 scoring to improve the ordering.
6445
6446 double Internal method that uses two methods and mixes the
6447 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006448 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006449 word. That only works when the language specifies
6450 sound folding. Can be slow and doesn't always give
6451 better results.
6452
6453 fast Internal method that only checks for simple changes:
6454 character inserts/deletes/swaps. Works well for
6455 simple typing mistakes.
6456
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006457 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006458 Not used for |spellsuggest()|. The number of
6459 suggestions is never more than the value of 'lines'
6460 minus two.
6461
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006462 file:{filename} Read file {filename}, which must have two columns,
6463 separated by a slash. The first column contains the
6464 bad word, the second column the suggested good word.
6465 Example:
6466 theribal/terrible ~
6467 Use this for common mistakes that do not appear at the
6468 top of the suggestion list with the internal methods.
6469 Lines without a slash are ignored, use this for
6470 comments.
6471 The file is used for all languages.
6472
6473 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6474 trouble with spaces. |v:val| holds the badly spelled
6475 word. The expression must evaluate to a List of
6476 Lists, each with a suggestion and a score.
6477 Example:
6478 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006479 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006480 internal methods use. A lower score is better.
6481 This may invoke |spellsuggest()| if you temporarily
6482 set 'spellsuggest' to exclude the "expr:" part.
6483 Errors are silently ignored, unless you set the
6484 'verbose' option to a non-zero value.
6485
6486 Only one of "best", "double" or "fast" may be used. The others may
6487 appear several times in any order. Example: >
6488 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6489<
6490 This option cannot be set from a |modeline| or in the |sandbox|, for
6491 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006492
6493
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6495'splitbelow' 'sb' boolean (default off)
6496 global
6497 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006498 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499 feature}
6500 When on, splitting a window will put the new window below the current
6501 one. |:split|
6502
6503 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6504'splitright' 'spr' boolean (default off)
6505 global
6506 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006507 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 feature}
6509 When on, splitting a window will put the new window right of the
6510 current one. |:vsplit|
6511
6512 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6513'startofline' 'sol' boolean (default on)
6514 global
6515 {not in Vi}
6516 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006517 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006518 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006519 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 with a linewise operator, with "%" with a count and to buffer changing
6521 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6522 only has a line number, e.g., ":25" or ":+".
6523 In case of buffer changing commands the cursor is placed at the column
6524 where it was the last time the buffer was edited.
6525 NOTE: This option is set when 'compatible' is set.
6526
Bram Moolenaar00654022011-02-25 14:42:19 +01006527 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006529 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 {not in Vi}
6531 {not available when compiled without the |+statusline|
6532 feature}
6533 When nonempty, this option determines the content of the status line.
6534 Also see |status-line|.
6535
6536 The option consists of printf style '%' items interspersed with
6537 normal text. Each status line item is of the form:
6538 %-0{minwid}.{maxwid}{item}
6539 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006540 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541
Bram Moolenaar238a5642006-02-21 22:12:05 +00006542 When the option starts with "%!" then it is used as an expression,
6543 evaluated and the result is used as the option value. Example: >
6544 :set statusline=%!MyStatusLine()
6545< The result can contain %{} items that will be evaluated too.
6546
6547 When there is error while evaluating the option then it will be made
6548 empty to avoid further errors. Otherwise screen updating would loop.
6549
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 Note that the only effect of 'ruler' when this option is set (and
6551 'laststatus' is 2) is controlling the output of |CTRL-G|.
6552
6553 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006554 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006556 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 minwid Minimum width of the item, padding as set by '-' & '0'.
6558 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006559 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 on the left for text items. Numeric items will be
6561 shifted down to maxwid-2 digits followed by '>'number
6562 where number is the amount of missing digits, much like
6563 an exponential notation.
6564 item A one letter code as described below.
6565
6566 Following is a description of the possible statusline items. The
6567 second character in "item" is the type:
6568 N for number
6569 S for string
6570 F for flags as described below
6571 - not applicable
6572
6573 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006574 f S Path to the file in the buffer, as typed or relative to current
6575 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 F S Full path to the file in the buffer.
6577 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006578 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006580 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006582 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006584 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006586 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6588 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006589 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6591 being used: "<keymap>"
6592 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006593 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 B N As above, in hexadecimal.
6595 o N Byte number in file of byte under cursor, first byte is 1.
6596 Mnemonic: Offset from start of file (with one added)
6597 {not available when compiled without |+byte_offset| feature}
6598 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006599 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 l N Line number.
6601 L N Number of lines in buffer.
6602 c N Column number.
6603 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006604 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 p N Percentage through file in lines as in |CTRL-G|.
6606 P S Percentage through file of displayed window. This is like the
6607 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006608 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006610 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006611 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 ( - Start of item group. Can be used for setting the width and
6613 alignment of a section. Must be followed by %) somewhere.
6614 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006615 T N For 'tabline': start of tab page N label. Use %T after the last
6616 label. This information is used for mouse clicks.
6617 X N For 'tabline': start of close tab N label. Use %X after the
6618 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6619 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 < - Where to truncate line if too long. Default is at the start.
6621 No width fields allowed.
6622 = - Separation point between left and right aligned items.
6623 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006624 # - Set highlight group. The name must follow and then a # again.
6625 Thus use %#HLname# for highlight group HLname. The same
6626 highlighting is used, also for the statusline of non-current
6627 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006629 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 The difference between User{N} and StatusLine will be applied
6631 to StatusLineNC for the statusline of non-current windows.
6632 The number N must be between 1 and 9. See |hl-User1..9|
6633
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006634 When displaying a flag, Vim removes the leading comma, if any, when
6635 that flag comes right after plaintext. This will make a nice display
6636 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637
Bram Moolenaar582fd852005-03-28 20:58:01 +00006638 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 not set) and a minwid is not set for the group, the whole group will
6640 become empty. This will make a group like the following disappear
6641 completely from the statusline when none of the flags are set. >
6642 :set statusline=...%(\ [%M%R%H]%)...
6643<
6644 Beware that an expression is evaluated each and every time the status
6645 line is displayed. The current buffer and current window will be set
6646 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006647 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006649 real current buffer.
6650
6651 The 'statusline' option may be evaluated in the |sandbox|, see
6652 |sandbox-option|.
6653
6654 It is not allowed to change text or jump to another window while
6655 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656
6657 If the statusline is not updated when you want it (e.g., after setting
6658 a variable that's used in an expression), you can force an update by
6659 setting an option without changing its value. Example: >
6660 :let &ro = &ro
6661
6662< A result of all digits is regarded a number for display purposes.
6663 Otherwise the result is taken as flag text and applied to the rules
6664 described above.
6665
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006666 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6668 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6669
6670 Examples:
6671 Emulate standard status line with 'ruler' set >
6672 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6673< Similar, but add ASCII value of char under the cursor (like "ga") >
6674 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6675< Display byte count and byte value, modified flag in red. >
6676 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6677 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6678< Display a ,GZ flag if a compressed file is loaded >
6679 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6680< In the |:autocmd|'s: >
6681 :let b:gzflag = 1
6682< And: >
6683 :unlet b:gzflag
6684< And define this function: >
6685 :function VarExists(var, val)
6686 : if exists(a:var) | return a:val | else | return '' | endif
6687 :endfunction
6688<
6689 *'suffixes'* *'su'*
6690'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6691 global
6692 {not in Vi}
6693 Files with these suffixes get a lower priority when multiple files
6694 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006695 suffixes. Spaces after the comma are ignored. A dot is also seen as
6696 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 separator, precede it with a backslash (see |option-backslash| about
6698 including spaces and backslashes).
6699 See 'wildignore' for completely ignoring files.
6700 The use of |:set+=| and |:set-=| is preferred when adding or removing
6701 suffixes from the list. This avoids problems when a future version
6702 uses another default.
6703
6704 *'suffixesadd'* *'sua'*
6705'suffixesadd' 'sua' string (default "")
6706 local to buffer
6707 {not in Vi}
6708 {not available when compiled without the
6709 |+file_in_path| feature}
6710 Comma separated list of suffixes, which are used when searching for a
6711 file for the "gf", "[I", etc. commands. Example: >
6712 :set suffixesadd=.java
6713<
6714 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6715'swapfile' 'swf' boolean (default on)
6716 local to buffer
6717 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006718 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 swapfile is not wanted for a specific buffer. For example, with
6720 confidential information that even root must not be able to access.
6721 Careful: All text will be in memory:
6722 - Don't use this for big files.
6723 - Recovery will be impossible!
6724 A swapfile will only be present when |'updatecount'| is non-zero and
6725 'swapfile' is set.
6726 When 'swapfile' is reset, the swap file for the current buffer is
6727 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6728 non-zero, a swap file is immediately created.
6729 Also see |swap-file| and |'swapsync'|.
6730
6731 This option is used together with 'bufhidden' and 'buftype' to
6732 specify special kinds of buffers. See |special-buffers|.
6733
6734 *'swapsync'* *'sws'*
6735'swapsync' 'sws' string (default "fsync")
6736 global
6737 {not in Vi}
6738 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006739 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 When this option is empty parts of the swap file may be in memory and
6741 not written to disk. When the system crashes you may lose more work.
6742 On Unix the system does a sync now and then without Vim asking for it,
6743 so the disadvantage of setting this option off is small. On some
6744 systems the swap file will not be written at all. For a unix system
6745 setting it to "sync" will use the sync() call instead of the default
6746 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006747 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748
6749 *'switchbuf'* *'swb'*
6750'switchbuf' 'swb' string (default "")
6751 global
6752 {not in Vi}
6753 This option controls the behavior when switching between buffers.
6754 Possible values (comma separated list):
6755 useopen If included, jump to the first open window that
6756 contains the specified buffer (if there is one).
6757 Otherwise: Do not examine other windows.
6758 This setting is checked with |quickfix| commands, when
6759 jumping to errors (":cc", ":cn", "cp", etc.). It is
6760 also used in all buffer related split commands, for
6761 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006762 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006763 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006765 a buffer for a |quickfix| command that display errors.
6766 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006767 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006768 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006770 *'synmaxcol'* *'smc'*
6771'synmaxcol' 'smc' number (default 3000)
6772 local to buffer
6773 {not in Vi}
6774 {not available when compiled without the |+syntax|
6775 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006776 Maximum column in which to search for syntax items. In long lines the
6777 text after this column is not highlighted and following lines may not
6778 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006779 This helps to avoid very slow redrawing for an XML file that is one
6780 long line.
6781 Set to zero to remove the limit.
6782
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 *'syntax'* *'syn'*
6784'syntax' 'syn' string (default empty)
6785 local to buffer
6786 {not in Vi}
6787 {not available when compiled without the |+syntax|
6788 feature}
6789 When this option is set, the syntax with this name is loaded, unless
6790 syntax highlighting has been switched off with ":syntax off".
6791 Otherwise this option does not always reflect the current syntax (the
6792 b:current_syntax variable does).
6793 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006794 not automatically recognized. Example, in an IDL file:
6795 /* vim: set syntax=idl : */ ~
6796 When a dot appears in the value then this separates two filetype
6797 names. Example:
6798 /* vim: set syntax=c.doxygen : */ ~
6799 This will use the "c" syntax first, then the "doxygen" syntax.
6800 Note that the second one must be prepared to be loaded as an addition,
6801 otherwise it will be skipped. More than one dot may appear.
6802 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 :set syntax=OFF
6804< To switch syntax highlighting on according to the current value of the
6805 'filetype' option: >
6806 :set syntax=ON
6807< What actually happens when setting the 'syntax' option is that the
6808 Syntax autocommand event is triggered with the value as argument.
6809 This option is not copied to another buffer, independent of the 's' or
6810 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006811 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006813 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006814'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006815 global
6816 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006817 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006818 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006819 When nonempty, this option determines the content of the tab pages
6820 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006821 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006822
6823 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006824 option and only when there is no GUI tab line. When 'e' is in
6825 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006826 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006827
6828 The value is evaluated like with 'statusline'. You can use
6829 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006830 the text to be displayed. Use "%1T" for the first label, "%2T" for
6831 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006832
6833 Keep in mind that only one of the tab pages is the current one, others
6834 are invisible and you can't jump to their windows.
6835
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006836
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006837 *'tabpagemax'* *'tpm'*
6838'tabpagemax' 'tpm' number (default 10)
6839 global
6840 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006841 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006842 feature}
6843 Maximum number of tab pages to be opened by the |-p| command line
6844 argument or the ":tab all" command. |tabpage|
6845
6846
6847 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848'tabstop' 'ts' number (default 8)
6849 local to buffer
6850 Number of spaces that a <Tab> in the file counts for. Also see
6851 |:retab| command, and 'softtabstop' option.
6852
6853 Note: Setting 'tabstop' to any other value than 8 can make your file
6854 appear wrong in many places (e.g., when printing it).
6855
6856 There are four main ways to use tabs in Vim:
6857 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6858 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006859 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 behave like a tab appears every 4 (or 3) characters.
6861 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6862 'expandtab'. This way you will always insert spaces. The
6863 formatting will never be messed up when 'tabstop' is changed.
6864 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006865 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 works when using Vim to edit the file.
6867 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6868 'noexpandtab'. This should then work (for initial indents only)
6869 for any tabstop setting that people use. It might be nice to have
6870 tabs after the first non-blank inserted as spaces if you do this
6871 though. Otherwise aligned comments will be wrong when 'tabstop' is
6872 changed.
6873
6874 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6875'tagbsearch' 'tbs' boolean (default on)
6876 global
6877 {not in Vi}
6878 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006879 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 searching makes searching for a tag a LOT faster, but a linear search
6881 will find more tags if the tags file wasn't properly sorted.
6882 Vim normally assumes that your tags files are sorted, or indicate that
6883 they are not sorted. Only when this is not the case does the
6884 'tagbsearch' option need to be switched off.
6885
6886 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006887 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 certain files, or retry all files with a linear search. When
6889 'tagbsearch' is off, only a linear search is done.
6890
6891 Linear searching is done anyway, for one file, when Vim finds a line
6892 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006893 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894< [The whitespace before and after the '0' must be a single <Tab>]
6895
6896 When a binary search was done and no match was found in any of the
6897 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6898 instead of a normal tag name, a retry is done with a linear search.
6899 Tags in unsorted tags files, and matches with different case will only
6900 be found in the retry.
6901
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006902 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 linear search can be avoided for the 'ignorecase' case. Use a value
6904 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6905 case-fold sorted with the -f switch to "sort" in most unices, as in
6906 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006907 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6908 for this as well. Note that case must be folded to uppercase for this
6909 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910
6911 When 'tagbsearch' is off, tags searching is slower when a full match
6912 exists, but faster when no full match exists. Tags in unsorted tags
6913 files may only be found with 'tagbsearch' off.
6914 When the tags file is not sorted, or sorted in a wrong way (not on
6915 ASCII byte value), 'tagbsearch' should be off, or the line given above
6916 must be included in the tags file.
6917 This option doesn't affect commands that find all matching tags (e.g.,
6918 command-line completion and ":help").
6919 {Vi: always uses binary search in some versions}
6920
6921 *'taglength'* *'tl'*
6922'taglength' 'tl' number (default 0)
6923 global
6924 If non-zero, tags are significant up to this number of characters.
6925
6926 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6927'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6928 global
6929 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006930 If on and using a tags file in another directory, file names in that
6931 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 NOTE: This option is set to the Vi default value when 'compatible' is
6933 set and to the Vim default value when 'compatible' is reset.
6934
6935 *'tags'* *'tag'* *E433*
6936'tags' 'tag' string (default "./tags,tags", when compiled with
6937 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6938 global or local to buffer |global-local|
6939 Filenames for the tag command, separated by spaces or commas. To
6940 include a space or comma in a file name, precede it with a backslash
6941 (see |option-backslash| about including spaces and backslashes).
6942 When a file name starts with "./", the '.' is replaced with the path
6943 of the current file. But only when the 'd' flag is not included in
6944 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6945 |tags-option|.
6946 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006947 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6948 find all files named "tags" below "/lib". The filename itself cannot
6949 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6950 files called "tags?". {not available when compiled without the
6951 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006952 The |tagfiles()| function can be used to get a list of the file names
6953 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6955 files are also supported. They are automatically recognized. The
6956 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6957 differences are ignored (MS-Windows). |emacs-tags|
6958 The use of |:set+=| and |:set-=| is preferred when adding or removing
6959 file names from the list. This avoids problems when a future version
6960 uses another default.
6961 {Vi: default is "tags /usr/lib/tags"}
6962
6963 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6964'tagstack' 'tgst' boolean (default on)
6965 global
6966 {not in all versions of Vi}
6967 When on, the |tagstack| is used normally. When off, a ":tag" or
6968 ":tselect" command with an argument will not push the tag onto the
6969 tagstack. A following ":tag" without an argument, a ":pop" command or
6970 any other command that uses the tagstack will use the unmodified
6971 tagstack, but does change the pointer to the active entry.
6972 Resetting this option is useful when using a ":tag" command in a
6973 mapping which should not change the tagstack.
6974
6975 *'term'* *E529* *E530* *E531*
6976'term' string (default is $TERM, if that fails:
6977 in the GUI: "builtin_gui"
6978 on Amiga: "amiga"
6979 on BeOS: "beos-ansi"
6980 on Mac: "mac-ansi"
6981 on MiNT: "vt52"
6982 on MS-DOS: "pcterm"
6983 on OS/2: "os2ansi"
6984 on Unix: "ansi"
6985 on VMS: "ansi"
6986 on Win 32: "win32")
6987 global
6988 Name of the terminal. Used for choosing the terminal control
6989 characters. Environment variables are expanded |:set_env|.
6990 For example: >
6991 :set term=$TERM
6992< See |termcap|.
6993
6994 *'termbidi'* *'tbidi'*
6995 *'notermbidi'* *'notbidi'*
6996'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6997 global
6998 {not in Vi}
6999 {only available when compiled with the |+arabic|
7000 feature}
7001 The terminal is in charge of Bi-directionality of text (as specified
7002 by Unicode). The terminal is also expected to do the required shaping
7003 that some languages (such as Arabic) require.
7004 Setting this option implies that 'rightleft' will not be set when
7005 'arabic' is set and the value of 'arabicshape' will be ignored.
7006 Note that setting 'termbidi' has the immediate effect that
7007 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7008 This option is reset when the GUI is started.
7009 For further details see |arabic.txt|.
7010
7011 *'termencoding'* *'tenc'*
7012'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7013 Macintosh GUI: "macroman")
7014 global
7015 {only available when compiled with the |+multi_byte|
7016 feature}
7017 {not in Vi}
7018 Encoding used for the terminal. This specifies what character
7019 encoding the keyboard produces and the display will understand. For
7020 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007021 display). Except for the Mac when 'macatsui' is off, then
7022 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007023 In the Win32 console version the default value is the console codepage
7024 when it differs from the ANSI codepage.
7025 *E617*
7026 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7027 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7028 Any attempts to set a different value will be rejected, and an error
7029 message is shown.
7030 For the Win32 GUI 'termencoding' is not used for typed characters,
7031 because the Win32 system always passes Unicode characters.
7032 When empty, the same encoding is used as for the 'encoding' option.
7033 This is the normal value.
7034 Not all combinations for 'termencoding' and 'encoding' are valid. See
7035 |encoding-table|.
7036 The value for this option must be supported by internal conversions or
7037 iconv(). When this is not possible no conversion will be done and you
7038 will probably experience problems with non-ASCII characters.
7039 Example: You are working with the locale set to euc-jp (Japanese) and
7040 want to edit a UTF-8 file: >
7041 :let &termencoding = &encoding
7042 :set encoding=utf-8
7043< You need to do this when your system has no locale support for UTF-8.
7044
7045 *'terse'* *'noterse'*
7046'terse' boolean (default off)
7047 global
7048 When set: Add 's' flag to 'shortmess' option (this makes the message
7049 for a search that hits the start or end of the file not being
7050 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7051 shortens a lot of messages}
7052
7053 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7054'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7055 global
7056 {not in Vi}
7057 This option is obsolete. Use 'fileformats'.
7058 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7059 set to the default value for the current system. When 'textauto' is
7060 reset, 'fileformats' is made empty.
7061 NOTE: This option is set to the Vi default value when 'compatible' is
7062 set and to the Vim default value when 'compatible' is reset.
7063
7064 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7065'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7066 others: default off)
7067 local to buffer
7068 {not in Vi}
7069 This option is obsolete. Use 'fileformat'.
7070 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7071 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7072 "unix".
7073
7074 *'textwidth'* *'tw'*
7075'textwidth' 'tw' number (default 0)
7076 local to buffer
7077 {not in Vi}
7078 Maximum width of text that is being inserted. A longer line will be
7079 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007080 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7081 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007083 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 NOTE: This option is set to 0 when 'compatible' is set.
7085
7086 *'thesaurus'* *'tsr'*
7087'thesaurus' 'tsr' string (default "")
7088 global or local to buffer |global-local|
7089 {not in Vi}
7090 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007091 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 the file should contain words with similar meaning, separated by
7093 non-keyword characters (white space is preferred). Maximum line
7094 length is 510 bytes.
7095 To obtain a file to be used here, check out the wordlist FAQ at
7096 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007097 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 after a comma are ignored, otherwise spaces are included in the file
7099 name. See |option-backslash| about using backslashes.
7100 The use of |:set+=| and |:set-=| is preferred when adding or removing
7101 directories from the list. This avoids problems when a future version
7102 uses another default.
7103 Backticks cannot be used in this option for security reasons.
7104
7105 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7106'tildeop' 'top' boolean (default off)
7107 global
7108 {not in Vi}
7109 When on: The tilde command "~" behaves like an operator.
7110 NOTE: This option is reset when 'compatible' is set.
7111
7112 *'timeout'* *'to'* *'notimeout'* *'noto'*
7113'timeout' 'to' boolean (default on)
7114 global
7115 *'ttimeout'* *'nottimeout'*
7116'ttimeout' boolean (default off)
7117 global
7118 {not in Vi}
7119 These two options together determine the behavior when part of a
7120 mapped key sequence or keyboard code has been received:
7121
7122 'timeout' 'ttimeout' action ~
7123 off off do not time out
7124 on on or off time out on :mappings and key codes
7125 off on time out on key codes
7126
7127 If both options are off, Vim will wait until either the complete
7128 mapping or key sequence has been received, or it is clear that there
7129 is no mapping or key sequence for the received characters. For
7130 example: if you have mapped "vl" and Vim has received 'v', the next
7131 character is needed to see if the 'v' is followed by an 'l'.
7132 When one of the options is on, Vim will wait for about 1 second for
7133 the next character to arrive. After that the already received
7134 characters are interpreted as single characters. The waiting time can
7135 be changed with the 'timeoutlen' option.
7136 On slow terminals or very busy systems timing out may cause
7137 malfunctioning cursor keys. If both options are off, Vim waits
7138 forever after an entered <Esc> if there are key codes that start
7139 with <Esc>. You will have to type <Esc> twice. If you do not have
7140 problems with key codes, but would like to have :mapped key
7141 sequences not timing out in 1 second, set the 'ttimeout' option and
7142 reset the 'timeout' option.
7143
7144 NOTE: 'ttimeout' is reset when 'compatible' is set.
7145
7146 *'timeoutlen'* *'tm'*
7147'timeoutlen' 'tm' number (default 1000)
7148 global
7149 {not in all versions of Vi}
7150 *'ttimeoutlen'* *'ttm'*
7151'ttimeoutlen' 'ttm' number (default -1)
7152 global
7153 {not in Vi}
7154 The time in milliseconds that is waited for a key code or mapped key
7155 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7156 when part of a command has been typed.
7157 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7158 different timeout value for key codes is desired set 'ttimeoutlen' to
7159 a non-negative number.
7160
7161 ttimeoutlen mapping delay key code delay ~
7162 < 0 'timeoutlen' 'timeoutlen'
7163 >= 0 'timeoutlen' 'ttimeoutlen'
7164
7165 The timeout only happens when the 'timeout' and 'ttimeout' options
7166 tell so. A useful setting would be >
7167 :set timeout timeoutlen=3000 ttimeoutlen=100
7168< (time out on mapping after three seconds, time out on key codes after
7169 a tenth of a second).
7170
7171 *'title'* *'notitle'*
7172'title' boolean (default off, on when title can be restored)
7173 global
7174 {not in Vi}
7175 {not available when compiled without the |+title|
7176 feature}
7177 When on, the title of the window will be set to the value of
7178 'titlestring' (if it is not empty), or to:
7179 filename [+=-] (path) - VIM
7180 Where:
7181 filename the name of the file being edited
7182 - indicates the file cannot be modified, 'ma' off
7183 + indicates the file was modified
7184 = indicates the file is read-only
7185 =+ indicates the file is read-only and modified
7186 (path) is the path of the file being edited
7187 - VIM the server name |v:servername| or "VIM"
7188 Only works if the terminal supports setting window titles
7189 (currently Amiga console, Win32 console, all GUI versions and
7190 terminals with a non- empty 't_ts' option - these are Unix xterm and
7191 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7192 *X11*
7193 When Vim was compiled with HAVE_X11 defined, the original title will
7194 be restored if possible. The output of ":version" will include "+X11"
7195 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7196 works for the icon name |'icon'|.
7197 But: When Vim was started with the |-X| argument, restoring the title
7198 will not work (except in the GUI).
7199 If the title cannot be restored, it is set to the value of 'titleold'.
7200 You might want to restore the title outside of Vim then.
7201 When using an xterm from a remote machine you can use this command:
7202 rsh machine_name xterm -display $DISPLAY &
7203 then the WINDOWID environment variable should be inherited and the
7204 title of the window should change back to what it should be after
7205 exiting Vim.
7206
7207 *'titlelen'*
7208'titlelen' number (default 85)
7209 global
7210 {not in Vi}
7211 {not available when compiled without the |+title|
7212 feature}
7213 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007214 title. When the title is longer, only the end of the path name is
7215 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 Using a percentage makes this adapt to the width of the window. But
7217 it won't work perfectly, because the actual number of characters
7218 available also depends on the font used and other things in the title
7219 bar. When 'titlelen' is zero the full path is used. Otherwise,
7220 values from 1 to 30000 percent can be used.
7221 'titlelen' is also used for the 'titlestring' option.
7222
7223 *'titleold'*
7224'titleold' string (default "Thanks for flying Vim")
7225 global
7226 {not in Vi}
7227 {only available when compiled with the |+title|
7228 feature}
7229 This option will be used for the window title when exiting Vim if the
7230 original title cannot be restored. Only happens if 'title' is on or
7231 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007232 This option cannot be set from a |modeline| or in the |sandbox|, for
7233 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 *'titlestring'*
7235'titlestring' string (default "")
7236 global
7237 {not in Vi}
7238 {not available when compiled without the |+title|
7239 feature}
7240 When this option is not empty, it will be used for the title of the
7241 window. This happens only when the 'title' option is on.
7242 Only works if the terminal supports setting window titles (currently
7243 Amiga console, Win32 console, all GUI versions and terminals with a
7244 non-empty 't_ts' option).
7245 When Vim was compiled with HAVE_X11 defined, the original title will
7246 be restored if possible |X11|.
7247 When this option contains printf-style '%' items, they will be
7248 expanded according to the rules used for 'statusline'.
7249 Example: >
7250 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7251 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7252< The value of 'titlelen' is used to align items in the middle or right
7253 of the available space.
7254 Some people prefer to have the file name first: >
7255 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7256< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007257 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258 separating space only when needed.
7259 NOTE: Use of special characters in 'titlestring' may cause the display
7260 to be garbled (e.g., when it contains a CR or NL character).
7261 {not available when compiled without the |+statusline| feature}
7262
7263 *'toolbar'* *'tb'*
7264'toolbar' 'tb' string (default "icons,tooltips")
7265 global
7266 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7267 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007268 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 possible values are:
7270 icons Toolbar buttons are shown with icons.
7271 text Toolbar buttons shown with text.
7272 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007273 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 tooltips Tooltips are active for toolbar buttons.
7275 Tooltips refer to the popup help text which appears after the mouse
7276 cursor is placed over a toolbar button for a brief moment.
7277
7278 If you want the toolbar to be shown with icons as well as text, do the
7279 following: >
7280 :set tb=icons,text
7281< Motif and Athena cannot display icons and text at the same time. They
7282 will show icons if both are requested.
7283
7284 If none of the strings specified in 'toolbar' are valid or if
7285 'toolbar' is empty, this option is ignored. If you want to disable
7286 the toolbar, you need to set the 'guioptions' option. For example: >
7287 :set guioptions-=T
7288< Also see |gui-toolbar|.
7289
7290 *'toolbariconsize'* *'tbis'*
7291'toolbariconsize' 'tbis' string (default "small")
7292 global
7293 {not in Vi}
7294 {only in the GTK+ 2 GUI}
7295 Controls the size of toolbar icons. The possible values are:
7296 tiny Use tiny toolbar icons.
7297 small Use small toolbar icons (default).
7298 medium Use medium-sized toolbar icons.
7299 large Use large toolbar icons.
7300 The exact dimensions in pixels of the various icon sizes depend on
7301 the current theme. Common dimensions are large=32x32, medium=24x24,
7302 small=20x20 and tiny=16x16.
7303
7304 If 'toolbariconsize' is empty, the global default size as determined
7305 by user preferences or the current theme is used.
7306
7307 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7308'ttybuiltin' 'tbi' boolean (default on)
7309 global
7310 {not in Vi}
7311 When on, the builtin termcaps are searched before the external ones.
7312 When off the builtin termcaps are searched after the external ones.
7313 When this option is changed, you should set the 'term' option next for
7314 the change to take effect, for example: >
7315 :set notbi term=$TERM
7316< See also |termcap|.
7317 Rationale: The default for this option is "on", because the builtin
7318 termcap entries are generally better (many systems contain faulty
7319 xterm entries...).
7320
7321 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7322'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7323 sun-cmd, screen, rxvt, dtterm or
7324 iris-ansi; also on when running Vim in
7325 a DOS console)
7326 global
7327 {not in Vi}
7328 Indicates a fast terminal connection. More characters will be sent to
7329 the screen for redrawing, instead of using insert/delete line
7330 commands. Improves smoothness of redrawing when there are multiple
7331 windows and the terminal does not support a scrolling region.
7332 Also enables the extra writing of characters at the end of each screen
7333 line for lines that wrap. This helps when using copy/paste with the
7334 mouse in an xterm and other terminals.
7335
7336 *'ttymouse'* *'ttym'*
7337'ttymouse' 'ttym' string (default depends on 'term')
7338 global
7339 {not in Vi}
7340 {only in Unix and VMS, doesn't work in the GUI; not
7341 available when compiled without |+mouse|}
7342 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007343 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 *xterm-mouse*
7345 xterm xterm-like mouse handling. The mouse generates
7346 "<Esc>[Mscr", where "scr" is three bytes:
7347 "s" = button state
7348 "c" = column plus 33
7349 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007350 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007351 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007352 xterm2 Works like "xterm", but with the xterm reporting the
7353 mouse position while the mouse is dragged. This works
7354 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007355 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 work. See below for how Vim detects this
7357 automatically.
7358 *netterm-mouse*
7359 netterm NetTerm mouse handling. The mouse generates
7360 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7361 for the row and column.
7362 *dec-mouse*
7363 dec DEC terminal mouse handling. The mouse generates a
7364 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007365 This is also available for an Xterm, if it was
7366 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367 *jsbterm-mouse*
7368 jsbterm JSB term mouse handling.
7369 *pterm-mouse*
7370 pterm QNX pterm mouse handling.
7371
7372 The mouse handling must be enabled at compile time |+mouse_xterm|
7373 |+mouse_dec| |+mouse_netterm|.
7374 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7375 recognized, if enabled at compile time. DEC terminal mouse codes
7376 are recognized if enabled at compile time, and 'ttymouse' is not
7377 "xterm" (because the xterm and dec mouse codes conflict).
7378 This option is automatically set to "xterm", when the 'term' option is
7379 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7380 or "xterm2" already. The main use of this option is to set it to
7381 "xterm", when the terminal name doesn't start with "xterm", but it can
7382 handle xterm mouse codes.
7383 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007384 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 feature and if |t_RV| is set to the escape sequence to request the
7386 xterm version number. Otherwise "xterm2" must be set explicitly.
7387 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7388 t_RV to an empty string: >
7389 :set t_RV=
7390<
7391 *'ttyscroll'* *'tsl'*
7392'ttyscroll' 'tsl' number (default 999)
7393 global
7394 Maximum number of lines to scroll the screen. If there are more lines
7395 to scroll the window is redrawn. For terminals where scrolling is
7396 very slow and redrawing is not slow this can be set to a small number,
7397 e.g., 3, to speed up displaying.
7398
7399 *'ttytype'* *'tty'*
7400'ttytype' 'tty' string (default from $TERM)
7401 global
7402 Alias for 'term', see above.
7403
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007404 *'undodir'* *'udir'*
7405'undodir' 'udir' string (default ".")
7406 global
7407 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007408 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007409 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007410 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007411 "." means using the directory of the file. The undo file name for
7412 "file.txt" is ".file.txt.un~".
7413 For other directories the file name is the full path of the edited
7414 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007415 When writing: The first directory that exists is used. "." always
7416 works, no directories after "." will be used for writing.
7417 When reading all entries are tried to find an undo file. The first
7418 undo file that exists is used. When it cannot be read an error is
7419 given, no further entry is used.
7420 See |undo-persistence|.
7421
7422 *'undofile'* *'udf'*
7423'undofile' 'udf' boolean (default off)
7424 local to buffer
7425 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007426 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007427 When on, Vim automatically saves undo history to an undo file when
7428 writing a buffer to a file, and restores undo history from the same
7429 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007430 The directory where the undo file is stored is specified by 'undodir'.
7431 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007432 The undo file is not read when 'undoreload' causes the buffer from
7433 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007434 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007435
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 *'undolevels'* *'ul'*
7437'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7438 Win32 and OS/2)
7439 global
7440 {not in Vi}
7441 Maximum number of changes that can be undone. Since undo information
7442 is kept in memory, higher numbers will cause more memory to be used
7443 (nevertheless, a single change can use an unlimited amount of memory).
7444 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7445 itself: >
7446 set ul=0
7447< But you can also get Vi compatibility by including the 'u' flag in
7448 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007449 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 Set to a negative number for no undo at all: >
7451 set ul=-1
7452< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007453 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007455 *'undoreload'* *'ur'*
7456'undoreload' 'ur' number (default 10000)
7457 global
7458 {not in Vi}
7459 Save the whole buffer for undo when reloading it. This applies to the
7460 ":e!" command and reloading for when the buffer changed outside of
7461 Vim. |FileChangedShell|
7462 The save only happens when this options is negative or when the number
7463 of lines is smaller than the value of this option.
7464 Set this option to zero to disable undo for a reload.
7465
7466 When saving undo for a reload, any undo file is not read.
7467
7468 Note that this causes the whole buffer to be stored in memory. Set
7469 this option to a lower value if you run out of memory.
7470
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 *'updatecount'* *'uc'*
7472'updatecount' 'uc' number (default: 200)
7473 global
7474 {not in Vi}
7475 After typing this many characters the swap file will be written to
7476 disk. When zero, no swap file will be created at all (see chapter on
7477 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7478 Vim with the "-n" option, see |startup|. When editing in readonly
7479 mode this option will be initialized to 10000.
7480 The swapfile can be disabled per buffer with |'swapfile'|.
7481 When 'updatecount' is set from zero to non-zero, swap files are
7482 created for all buffers that have 'swapfile' set. When 'updatecount'
7483 is set to zero, existing swap files are not deleted.
7484 Also see |'swapsync'|.
7485 This option has no meaning in buffers where |'buftype'| is "nofile"
7486 or "nowrite".
7487
7488 *'updatetime'* *'ut'*
7489'updatetime' 'ut' number (default 4000)
7490 global
7491 {not in Vi}
7492 If this many milliseconds nothing is typed the swap file will be
7493 written to disk (see |crash-recovery|). Also used for the
7494 |CursorHold| autocommand event.
7495
7496 *'verbose'* *'vbs'*
7497'verbose' 'vbs' number (default 0)
7498 global
7499 {not in Vi, although some versions have a boolean
7500 verbose option}
7501 When bigger than zero, Vim will give messages about what it is doing.
7502 Currently, these messages are given:
7503 >= 1 When the viminfo file is read or written.
7504 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007505 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506 >= 8 Files for which a group of autocommands is executed.
7507 >= 9 Every executed autocommand.
7508 >= 12 Every executed function.
7509 >= 13 When an exception is thrown, caught, finished, or discarded.
7510 >= 14 Anything pending in a ":finally" clause.
7511 >= 15 Every executed Ex command (truncated at 200 characters).
7512
7513 This option can also be set with the "-V" argument. See |-V|.
7514 This option is also set by the |:verbose| command.
7515
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007516 When the 'verbosefile' option is set then the verbose messages are not
7517 displayed.
7518
7519 *'verbosefile'* *'vfile'*
7520'verbosefile' 'vfile' string (default empty)
7521 global
7522 {not in Vi}
7523 When not empty all messages are written in a file with this name.
7524 When the file exists messages are appended.
7525 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007526 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007527 Setting 'verbosefile' to a new value is like making it empty first.
7528 The difference with |:redir| is that verbose messages are not
7529 displayed when 'verbosefile' is set.
7530
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 *'viewdir'* *'vdir'*
7532'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7533 "$VIM/vimfiles/view",
7534 for Unix: "~/.vim/view",
7535 for Macintosh: "$VIM:vimfiles:view"
7536 for VMS: "sys$login:vimfiles/view"
7537 for RiscOS: "Choices:vimfiles/view")
7538 global
7539 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007540 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 feature}
7542 Name of the directory where to store files for |:mkview|.
7543 This option cannot be set from a |modeline| or in the |sandbox|, for
7544 security reasons.
7545
7546 *'viewoptions'* *'vop'*
7547'viewoptions' 'vop' string (default: "folds,options,cursor")
7548 global
7549 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007550 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 feature}
7552 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007553 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 word save and restore ~
7555 cursor cursor position in file and in window
7556 folds manually created folds, opened/closed folds and local
7557 fold options
7558 options options and mappings local to a window or buffer (not
7559 global values for local options)
7560 slash backslashes in file names replaced with forward
7561 slashes
7562 unix with Unix end-of-line format (single <NL>), even when
7563 on Windows or DOS
7564
7565 "slash" and "unix" are useful on Windows when sharing view files
7566 with Unix. The Unix version of Vim cannot source dos format scripts,
7567 but the Windows version of Vim can source unix format scripts.
7568
7569 *'viminfo'* *'vi'* *E526* *E527* *E528*
7570'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007571 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7572 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7573 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574 global
7575 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007576 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 feature}
7578 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007579 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 separated list of parameters, each consisting of a single character
7581 identifying the particular parameter, followed by a number or string
7582 which specifies the value of that parameter. If a particular
7583 character is left out, then the default value is used for that
7584 parameter. The following is a list of the identifying characters and
7585 the effect of their value.
7586 CHAR VALUE ~
7587 ! When included, save and restore global variables that start
7588 with an uppercase letter, and don't contain a lowercase
7589 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007590 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007591 read back correctly, you end up with an empty item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 " Maximum number of lines saved for each register. Old name of
7593 the '<' item, with the disadvantage that you need to put a
7594 backslash before the ", otherwise it will be recognized as the
7595 start of a comment!
7596 % When included, save and restore the buffer list. If Vim is
7597 started with a file name argument, the buffer list is not
7598 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007599 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 without a file name and buffers for help files are not written
7601 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007602 When followed by a number, the number specifies the maximum
7603 number of buffers that are stored. Without a number all
7604 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 ' Maximum number of previously edited files for which the marks
7606 are remembered. This parameter must always be included when
7607 'viminfo' is non-empty.
7608 Including this item also means that the |jumplist| and the
7609 |changelist| are stored in the viminfo file.
7610 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007611 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 patterns are also saved. When not included, the value of
7613 'history' is used.
7614 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007615 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 < Maximum number of lines saved for each register. If zero then
7617 registers are not saved. When not included, all lines are
7618 saved. '"' is the old name for this item.
7619 Also see the 's' item below: limit specified in Kbyte.
7620 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007621 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 c When included, convert the text in the viminfo file from the
7623 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007624 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 f Whether file marks need to be stored. If zero, file marks ('0
7626 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007627 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 cursor position (when exiting or when doing ":wviminfo").
7629 h Disable the effect of 'hlsearch' when loading the viminfo
7630 file. When not included, it depends on whether ":nohlsearch"
7631 has been used since the last search command.
7632 n Name of the viminfo file. The name must immediately follow
7633 the 'n'. Must be the last one! If the "-i" argument was
7634 given when starting Vim, that file name overrides the one
7635 given here with 'viminfo'. Environment variables are expanded
7636 when opening the file, not when setting the option.
7637 r Removable media. The argument is a string (up to the next
7638 ','). This parameter can be given several times. Each
7639 specifies the start of a path for which no marks will be
7640 stored. This is to avoid removable media. For MS-DOS you
7641 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7642 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7643 ignored. Maximum length of each 'r' argument is 50
7644 characters.
7645 s Maximum size of an item in Kbyte. If zero then registers are
7646 not saved. Currently only applies to registers. The default
7647 "s10" will exclude registers with more than 10 Kbyte of text.
7648 Also see the '<' item above: line count limit.
7649
7650 Example: >
7651 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7652<
7653 '50 Marks will be remembered for the last 50 files you
7654 edited.
7655 <1000 Contents of registers (up to 1000 lines each) will be
7656 remembered.
7657 s100 Registers with more than 100 Kbyte text are skipped.
7658 :0 Command-line history will not be saved.
7659 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7660 no / Since '/' is not specified, the default will be used,
7661 that is, save all of the search history, and also the
7662 previous search and substitute patterns.
7663 no % The buffer list will not be saved nor read back.
7664 no h 'hlsearch' highlighting will be restored.
7665
7666 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7667 load the contents of the file, this is not done automatically.
7668
7669 This option cannot be set from a |modeline| or in the |sandbox|, for
7670 security reasons.
7671
7672 *'virtualedit'* *'ve'*
7673'virtualedit' 've' string (default "")
7674 global
7675 {not in Vi}
7676 {not available when compiled without the
7677 |+virtualedit| feature}
7678 A comma separated list of these words:
7679 block Allow virtual editing in Visual block mode.
7680 insert Allow virtual editing in Insert mode.
7681 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007682 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007683
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007685 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 of the line. Useful for selecting a rectangle in Visual mode and
7687 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007688 "onemore" is not the same, it will only allow moving the cursor just
7689 after the last character of the line. This makes some commands more
7690 consistent. Previously the cursor was always past the end of the line
7691 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007692 break some plugins or Vim scripts. For example because |l| can move
7693 the cursor after the last character. Use with care!
7694 Using the |$| command will move to the last character in the line, not
7695 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007696 It doesn't make sense to combine "all" with "onemore", but you will
7697 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698
7699 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7700'visualbell' 'vb' boolean (default off)
7701 global
7702 {not in Vi}
7703 Use visual bell instead of beeping. The terminal code to display the
7704 visual bell is given with 't_vb'. When no beep or flash is wanted,
7705 use ":set vb t_vb=".
7706 Note: When the GUI starts, 't_vb' is reset to its default value. You
7707 might want to set it again in your |gvimrc|.
7708 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7709 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7710 where 40 is the time in msec.
7711 Does not work on the Amiga, you always get a screen flash.
7712 Also see 'errorbells'.
7713
7714 *'warn'* *'nowarn'*
7715'warn' boolean (default on)
7716 global
7717 Give a warning message when a shell command is used while the buffer
7718 has been changed.
7719
7720 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7721'weirdinvert' 'wiv' boolean (default off)
7722 global
7723 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007724 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 It is provided for backwards compatibility with version 4.x.
7726 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7727 vice versa. Has no effect when the GUI is running.
7728
7729 *'whichwrap'* *'ww'*
7730'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7731 global
7732 {not in Vi}
7733 Allow specified keys that move the cursor left/right to move to the
7734 previous/next line when the cursor is on the first/last character in
7735 the line. Concatenate characters to allow this for these keys:
7736 char key mode ~
7737 b <BS> Normal and Visual
7738 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007739 h "h" Normal and Visual (not recommended)
7740 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741 < <Left> Normal and Visual
7742 > <Right> Normal and Visual
7743 ~ "~" Normal
7744 [ <Left> Insert and Replace
7745 ] <Right> Insert and Replace
7746 For example: >
7747 :set ww=<,>,[,]
7748< allows wrap only when cursor keys are used.
7749 When the movement keys are used in combination with a delete or change
7750 operator, the <EOL> also counts for a character. This makes "3h"
7751 different from "3dh" when the cursor crosses the end of a line. This
7752 is also true for "x" and "X", because they do the same as "dl" and
7753 "dh". If you use this, you may also want to use the mapping
7754 ":map <BS> X" to make backspace delete the character in front of the
7755 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007756 When 'l' is included and it is used after an operator at the end of a
7757 line then it will not move to the next line. This makes "dl", "cl",
7758 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759 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 *'wildchar'* *'wc'*
7763'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7764 global
7765 {not in Vi}
7766 Character you have to type to start wildcard expansion in the
7767 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007768 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769 The character is not recognized when used inside a macro. See
7770 'wildcharm' for that.
7771 Although 'wc' is a number option, you can set it to a special key: >
7772 :set wc=<Esc>
7773< NOTE: This option is set to the Vi default value when 'compatible' is
7774 set and to the Vim default value when 'compatible' is reset.
7775
7776 *'wildcharm'* *'wcm'*
7777'wildcharm' 'wcm' number (default: none (0))
7778 global
7779 {not in Vi}
7780 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007781 recognized when used inside a macro. You can find "spare" command-line
7782 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783 you'll never actually type 'wildcharm', just use it in mappings that
7784 automatically invoke completion mode, e.g.: >
7785 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007786 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787< Then after typing :ss you can use CTRL-P & CTRL-N.
7788
7789 *'wildignore'* *'wig'*
7790'wildignore' 'wig' string (default "")
7791 global
7792 {not in Vi}
7793 {not available when compiled without the |+wildignore|
7794 feature}
7795 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007796 patterns is ignored when completing file or directory names, and
7797 influences the result of |expand()|, |glob()| and |globpath()| unless
7798 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7800 Also see 'suffixes'.
7801 Example: >
7802 :set wildignore=*.o,*.obj
7803< The use of |:set+=| and |:set-=| is preferred when adding or removing
7804 a pattern from the list. This avoids problems when a future version
7805 uses another default.
7806
Bram Moolenaar94950a92010-12-02 16:01:29 +01007807
Bram Moolenaar81af9252010-12-10 20:35:50 +01007808 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007809'wildignorecase' 'wic' boolean (default off)
7810 global
7811 {not in Vi}
7812 When set case is ignored when completing file names and directories.
7813 Has no effect on systems where file name case is generally ignored.
7814 Does not apply when the shell is used to expand wildcards, which
7815 happens when there are special characters.
7816
7817
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7819'wildmenu' 'wmnu' boolean (default off)
7820 global
7821 {not in Vi}
7822 {not available if compiled without the |+wildmenu|
7823 feature}
7824 When 'wildmenu' is on, command-line completion operates in an enhanced
7825 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7826 the possible matches are shown just above the command line, with the
7827 first match highlighted (overwriting the status line, if there is
7828 one). Keys that show the previous/next match, such as <Tab> or
7829 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7830 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7831 specified. "longest" and "list" do not start "wildmenu" mode.
7832 If there are more matches than can fit in the line, a ">" is shown on
7833 the right and/or a "<" is shown on the left. The status line scrolls
7834 as needed.
7835 The "wildmenu" mode is abandoned when a key is hit that is not used
7836 for selecting a completion.
7837 While the "wildmenu" is active the following keys have special
7838 meanings:
7839
7840 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7841 <Down> - in filename/menu name completion: move into a
7842 subdirectory or submenu.
7843 <CR> - in menu completion, when the cursor is just after a
7844 dot: move into a submenu.
7845 <Up> - in filename/menu name completion: move up into
7846 parent directory or parent menu.
7847
7848 This makes the menus accessible from the console |console-menus|.
7849
7850 If you prefer the <Left> and <Right> keys to move the cursor instead
7851 of selecting a different match, use this: >
7852 :cnoremap <Left> <Space><BS><Left>
7853 :cnoremap <Right> <Space><BS><Right>
7854<
7855 The "WildMenu" highlighting is used for displaying the current match
7856 |hl-WildMenu|.
7857
7858 *'wildmode'* *'wim'*
7859'wildmode' 'wim' string (Vim default: "full")
7860 global
7861 {not in Vi}
7862 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007863 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007864 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 first part specifies the behavior for the first use of 'wildchar',
7866 The second part for the second use, etc.
7867 These are the possible values for each part:
7868 "" Complete only the first match.
7869 "full" Complete the next full match. After the last match,
7870 the original string is used and then the first match
7871 again.
7872 "longest" Complete till longest common string. If this doesn't
7873 result in a longer string, use the next part.
7874 "longest:full" Like "longest", but also start 'wildmenu' if it is
7875 enabled.
7876 "list" When more than one match, list all matches.
7877 "list:full" When more than one match, list all matches and
7878 complete first match.
7879 "list:longest" When more than one match, list all matches and
7880 complete till longest common string.
7881 When there is only a single match, it is fully completed in all cases.
7882
7883 Examples: >
7884 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007885< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 :set wildmode=longest,full
7887< Complete longest common string, then each full match >
7888 :set wildmode=list:full
7889< List all matches and complete each full match >
7890 :set wildmode=list,full
7891< List all matches without completing, then each full match >
7892 :set wildmode=longest,list
7893< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007894 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007895
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007896 *'wildoptions'* *'wop'*
7897'wildoptions' 'wop' string (default "")
7898 global
7899 {not in Vi}
7900 {not available when compiled without the |+wildignore|
7901 feature}
7902 A list of words that change how command line completion is done.
7903 Currently only one word is allowed:
7904 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007905 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007906 is displayed per line. Often used tag kinds are:
7907 d #define
7908 f function
7909 Also see |cmdline-completion|.
7910
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911 *'winaltkeys'* *'wak'*
7912'winaltkeys' 'wak' string (default "menu")
7913 global
7914 {not in Vi}
7915 {only used in Win32, Motif, GTK and Photon GUI}
7916 Some GUI versions allow the access to menu entries by using the ALT
7917 key in combination with a character that appears underlined in the
7918 menu. This conflicts with the use of the ALT key for mappings and
7919 entering special characters. This option tells what to do:
7920 no Don't use ALT keys for menus. ALT key combinations can be
7921 mapped, but there is no automatic handling. This can then be
7922 done with the |:simalt| command.
7923 yes ALT key handling is done by the windowing system. ALT key
7924 combinations cannot be mapped.
7925 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007926 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 keys can be mapped.
7928 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7929 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007930 This option is not used for <F10>; on Win32 and with GTK <F10> will
7931 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007933 *'window'* *'wi'*
7934'window' 'wi' number (default screen height - 1)
7935 global
7936 Window height. Do not confuse this with the height of the Vim window,
7937 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007938 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7939 value is smaller than 'lines' minus one. The screen will scroll
7940 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007941 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7942 in a much smarter way, taking care of wrapping lines.
7943 When resizing the Vim window, the value is smaller than 1 or more than
7944 or equal to 'lines' it will be set to 'lines' minus 1.
7945 {Vi also uses the option to specify the number of displayed lines}
7946
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 *'winheight'* *'wh'* *E591*
7948'winheight' 'wh' number (default 1)
7949 global
7950 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007951 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 feature}
7953 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007954 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007955 focus goes to a window that is smaller, its size is increased, at the
7956 cost of the height of other windows.
7957 Set 'winheight' to a small number for normal editing.
7958 Set it to 999 to make the current window fill most of the screen.
7959 Other windows will be only 'winminheight' high. This has the drawback
7960 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7961 to create only two windows, set the option after startup is done,
7962 using the |VimEnter| event: >
7963 au VimEnter * set winheight=999
7964< Minimum value is 1.
7965 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 height of the current window.
7967 'winheight' applies to the current window. Use 'winminheight' to set
7968 the minimal height for other windows.
7969
7970 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7971'winfixheight' 'wfh' boolean (default off)
7972 local to window
7973 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007974 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 feature}
7976 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007977 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7978 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007979 The height may be changed anyway when running out of room.
7980
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007981 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7982'winfixwidth' 'wfw' boolean (default off)
7983 local to window
7984 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007985 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007986 feature}
7987 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007988 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007989 The width may be changed anyway when running out of room.
7990
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 *'winminheight'* *'wmh'*
7992'winminheight' 'wmh' number (default 1)
7993 global
7994 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007995 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996 feature}
7997 The minimal height of a window, when it's not the current window.
7998 This is a hard minimum, windows will never become smaller.
7999 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8000 status bar) if necessary. They will return to at least one line when
8001 they become active (since the cursor has to have somewhere to go.)
8002 Use 'winheight' to set the minimal height of the current window.
8003 This option is only checked when making a window smaller. Don't use a
8004 large number, it will cause errors when opening more than a few
8005 windows. A value of 0 to 3 is reasonable.
8006
8007 *'winminwidth'* *'wmw'*
8008'winminwidth' 'wmw' number (default 1)
8009 global
8010 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008011 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 feature}
8013 The minimal width of a window, when it's not the current window.
8014 This is a hard minimum, windows will never become smaller.
8015 When set to zero, windows may be "squashed" to zero columns (i.e. just
8016 a vertical separator) if necessary. They will return to at least one
8017 line when they become active (since the cursor has to have somewhere
8018 to go.)
8019 Use 'winwidth' to set the minimal width of the current window.
8020 This option is only checked when making a window smaller. Don't use a
8021 large number, it will cause errors when opening more than a few
8022 windows. A value of 0 to 12 is reasonable.
8023
8024 *'winwidth'* *'wiw'* *E592*
8025'winwidth' 'wiw' number (default 20)
8026 global
8027 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008028 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 feature}
8030 Minimal number of columns for the current window. This is not a hard
8031 minimum, Vim will use fewer columns if there is not enough room. If
8032 the current window is smaller, its size is increased, at the cost of
8033 the width of other windows. Set it to 999 to make the current window
8034 always fill the screen. Set it to a small number for normal editing.
8035 The width is not adjusted after one of the commands to change the
8036 width of the current window.
8037 'winwidth' applies to the current window. Use 'winminwidth' to set
8038 the minimal width for other windows.
8039
8040 *'wrap'* *'nowrap'*
8041'wrap' boolean (default on)
8042 local to window
8043 {not in Vi}
8044 This option changes how text is displayed. It doesn't change the text
8045 in the buffer, see 'textwidth' for that.
8046 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008047 displaying continues on the next line. When off lines will not wrap
8048 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 moved to a part that is not shown, the screen will scroll
8050 horizontally.
8051 The line will be broken in the middle of a word if necessary. See
8052 'linebreak' to get the break at a word boundary.
8053 To make scrolling horizontally a bit more useful, try this: >
8054 :set sidescroll=5
8055 :set listchars+=precedes:<,extends:>
8056< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008057 This option can't be set from a |modeline| when the 'diff' option is
8058 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008059
8060 *'wrapmargin'* *'wm'*
8061'wrapmargin' 'wm' number (default 0)
8062 local to buffer
8063 Number of characters from the right window border where wrapping
8064 starts. When typing text beyond this limit, an <EOL> will be inserted
8065 and inserting continues on the next line.
8066 Options that add a margin, such as 'number' and 'foldcolumn', cause
8067 the text width to be further reduced. This is Vi compatible.
8068 When 'textwidth' is non-zero, this option is not used.
8069 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8070 and less usefully}
8071
8072 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8073'wrapscan' 'ws' boolean (default on) *E384* *E385*
8074 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008075 Searches wrap around the end of the file. Also applies to |]s| and
8076 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077
8078 *'write'* *'nowrite'*
8079'write' boolean (default on)
8080 global
8081 {not in Vi}
8082 Allows writing files. When not set, writing a file is not allowed.
8083 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008084 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 argument. Filtering text is still possible, even though this requires
8086 writing a temporary file.
8087
8088 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8089'writeany' 'wa' boolean (default off)
8090 global
8091 Allows writing to any file with no need for "!" override.
8092
8093 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8094'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8095 otherwise)
8096 global
8097 {not in Vi}
8098 Make a backup before overwriting a file. The backup is removed after
8099 the file was successfully written, unless the 'backup' option is
8100 also on. Reset this option if your file system is almost full. See
8101 |backup-table| for another explanation.
8102 When the 'backupskip' pattern matches, a backup is not made anyway.
8103 NOTE: This option is set to the default value when 'compatible' is
8104 set.
8105
8106 *'writedelay'* *'wd'*
8107'writedelay' 'wd' number (default 0)
8108 global
8109 {not in Vi}
8110 The number of microseconds to wait for each character sent to the
8111 screen. When non-zero, characters are sent to the terminal one by
8112 one. For MS-DOS pcterm this does not work. For debugging purposes.
8113
8114 vim:tw=78:ts=8:ft=help:norl: